Meilisearch PHP | Documentation

HandlesSettings

Table of Contents

Methods

getDictionary()  : array<int, non-empty-string>
getDisplayedAttributes()  : array<int, non-empty-string>
getDistinctAttribute()  : non-empty-string|null
getEmbedders()  : array<string|int, mixed>|null
getFaceting()  : array{maxValuesPerFacet: int, sortFacetValuesBy: array}
getFacetSearch()  : bool
getFilterableAttributes()  : array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>
getLocalizedAttributes()  : array<int, array{attributePatterns: list, locales: list}>|null
getNonSeparatorTokens()  : array<int, non-empty-string>
getPagination()  : array{maxTotalHits: positive-int}
getPrefixSearch()  : "indexingTime"|"disabled"
getProximityPrecision()  : "byWord"|"byAttribute"
getRankingRules()  : array<int, non-empty-string>
getSearchableAttributes()  : array<int, non-empty-string>
getSearchCutoffMs()  : int|null
getSeparatorTokens()  : array<string|int, mixed>
getSortableAttributes()  : array<int, non-empty-string>
getStopWords()  : array<int, non-empty-string>
getSynonyms()  : array<non-empty-string, array<int, non-empty-string>>
getTypoTolerance()  : array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list}
resetDictionary()  : array<string|int, mixed>
resetDisplayedAttributes()  : array<string|int, mixed>
resetDistinctAttribute()  : array<string|int, mixed>
resetEmbedders()  : array<string|int, mixed>
resetFaceting()  : array<string|int, mixed>
resetFacetSearch()  : array<string|int, mixed>
resetFilterableAttributes()  : array<string|int, mixed>
resetLocalizedAttributes()  : array<string|int, mixed>
resetNonSeparatorTokens()  : array<string|int, mixed>
resetPagination()  : array<string|int, mixed>
resetPrefixSearch()  : array<string|int, mixed>
resetProximityPrecision()  : array<string|int, mixed>
resetRankingRules()  : array<string|int, mixed>
resetSearchableAttributes()  : array<string|int, mixed>
resetSearchCutoffMs()  : array<string|int, mixed>
resetSeparatorTokens()  : array<string|int, mixed>
resetSortableAttributes()  : array<string|int, mixed>
resetStopWords()  : array<string|int, mixed>
resetSynonyms()  : array<string|int, mixed>
resetTypoTolerance()  : array<string|int, mixed>
updateDictionary()  : array<string|int, mixed>
updateDisplayedAttributes()  : array<string|int, mixed>
updateDistinctAttribute()  : array<string|int, mixed>
updateEmbedders()  : array<string|int, mixed>
updateFaceting()  : array<string|int, mixed>
updateFacetSearch()  : array<string|int, mixed>
updateFilterableAttributes()  : array<string|int, mixed>
updateLocalizedAttributes()  : array<string|int, mixed>
updateNonSeparatorTokens()  : array<string|int, mixed>
updatePagination()  : array<string|int, mixed>
updatePrefixSearch()  : array<string|int, mixed>
updateProximityPrecision()  : array<string|int, mixed>
updateRankingRules()  : array<string|int, mixed>
updateSearchableAttributes()  : array<string|int, mixed>
updateSearchCutoffMs()  : array<string|int, mixed>
updateSeparatorTokens()  : array<string|int, mixed>
updateSortableAttributes()  : array<string|int, mixed>
updateStopWords()  : array<string|int, mixed>
updateSynonyms()  : array<string|int, mixed>
updateTypoTolerance()  : array<string|int, mixed>

Methods

getDictionary()

public getDictionary() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getDisplayedAttributes()

public getDisplayedAttributes() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getDistinctAttribute()

public getDistinctAttribute() : non-empty-string|null
Return values
non-empty-string|null

getEmbedders()

public getEmbedders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getFaceting()

public getFaceting() : array{maxValuesPerFacet: int, sortFacetValuesBy: array}
Return values
array{maxValuesPerFacet: int, sortFacetValuesBy: array}

getFacetSearch()

public getFacetSearch() : bool
Tags
since

Meilisearch v1.12.0

Return values
bool

getFilterableAttributes()

public getFilterableAttributes() : array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>
Return values
array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>

getLocalizedAttributes()

public getLocalizedAttributes() : array<int, array{attributePatterns: list, locales: list}>|null
Return values
array<int, array{attributePatterns: list, locales: list}>|null

getNonSeparatorTokens()

public getNonSeparatorTokens() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getPagination()

public getPagination() : array{maxTotalHits: positive-int}
Return values
array{maxTotalHits: positive-int}

getPrefixSearch()

public getPrefixSearch() : "indexingTime"|"disabled"
Tags
since

Meilisearch v1.12.0

Return values
"indexingTime"|"disabled"

getProximityPrecision()

public getProximityPrecision() : "byWord"|"byAttribute"
Return values
"byWord"|"byAttribute"

getRankingRules()

public getRankingRules() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getSearchableAttributes()

public getSearchableAttributes() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getSearchCutoffMs()

public getSearchCutoffMs() : int|null
Return values
int|null

getSeparatorTokens()

public getSeparatorTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSortableAttributes()

public getSortableAttributes() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getStopWords()

public getStopWords() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

getSynonyms()

public getSynonyms() : array<non-empty-string, array<int, non-empty-string>>
Return values
array<non-empty-string, array<int, non-empty-string>>

getTypoTolerance()

public getTypoTolerance() : array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list}
Return values
array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list}

resetDictionary()

public resetDictionary() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetDisplayedAttributes()

public resetDisplayedAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetDistinctAttribute()

public resetDistinctAttribute() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetEmbedders()

public resetEmbedders() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetFaceting()

public resetFaceting() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetFacetSearch()

public resetFacetSearch() : array<string|int, mixed>
Tags
since

Meilisearch v1.12.0

Return values
array<string|int, mixed>

resetFilterableAttributes()

public resetFilterableAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetLocalizedAttributes()

public resetLocalizedAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetNonSeparatorTokens()

public resetNonSeparatorTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetPagination()

public resetPagination() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetPrefixSearch()

public resetPrefixSearch() : array<string|int, mixed>
Tags
since

Meilisearch v1.12.0

Return values
array<string|int, mixed>

resetProximityPrecision()

public resetProximityPrecision() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetRankingRules()

public resetRankingRules() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetSearchableAttributes()

public resetSearchableAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetSearchCutoffMs()

public resetSearchCutoffMs() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetSeparatorTokens()

public resetSeparatorTokens() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetSortableAttributes()

public resetSortableAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetStopWords()

public resetStopWords() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetSynonyms()

public resetSynonyms() : array<string|int, mixed>
Return values
array<string|int, mixed>

resetTypoTolerance()

public resetTypoTolerance() : array<string|int, mixed>
Return values
array<string|int, mixed>

updateDictionary()

public updateDictionary(array<int, non-empty-string> $wordDictionary) : array<string|int, mixed>
Parameters
$wordDictionary : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateDisplayedAttributes()

public updateDisplayedAttributes(array<int, non-empty-string> $displayedAttributes) : array<string|int, mixed>
Parameters
$displayedAttributes : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateDistinctAttribute()

public updateDistinctAttribute(non-empty-string $distinctAttribute) : array<string|int, mixed>
Parameters
$distinctAttribute : non-empty-string
Return values
array<string|int, mixed>

updateEmbedders()

public updateEmbedders(array<string|int, mixed> $embedders) : array<string|int, mixed>
Parameters
$embedders : array<string|int, mixed>
Return values
array<string|int, mixed>

updateFaceting()

public updateFaceting(array{maxValuesPerFacet?: int, sortFacetValuesBy?: array} $faceting) : array<string|int, mixed>
Parameters
$faceting : array{maxValuesPerFacet?: int, sortFacetValuesBy?: array}
Return values
array<string|int, mixed>

updateFacetSearch()

public updateFacetSearch(bool $facetSearch) : array<string|int, mixed>
Parameters
$facetSearch : bool
Tags
since

Meilisearch v1.12.0

Return values
array<string|int, mixed>

updateFilterableAttributes()

public updateFilterableAttributes(array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}> $filterableAttributes) : array<string|int, mixed>
Parameters
$filterableAttributes : array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>

Note: When attributePatterns contains '_geo', the features field is ignored

Return values
array<string|int, mixed>

updateLocalizedAttributes()

public updateLocalizedAttributes(array<int, array{attributePatterns: list, locales: list}> $localizedAttributes) : array<string|int, mixed>
Parameters
$localizedAttributes : array<int, array{attributePatterns: list, locales: list}>
Return values
array<string|int, mixed>

updateNonSeparatorTokens()

public updateNonSeparatorTokens(array<int, non-empty-string> $nonSeparatorTokens) : array<string|int, mixed>
Parameters
$nonSeparatorTokens : array<int, non-empty-string>
Return values
array<string|int, mixed>

updatePagination()

public updatePagination(array{maxTotalHits: positive-int} $pagination) : array<string|int, mixed>
Parameters
$pagination : array{maxTotalHits: positive-int}
Return values
array<string|int, mixed>

updatePrefixSearch()

public updatePrefixSearch("indexingTime"|"disabled" $prefixSearch) : array<string|int, mixed>
Parameters
$prefixSearch : "indexingTime"|"disabled"
Tags
since

Meilisearch v1.12.0

Return values
array<string|int, mixed>

updateProximityPrecision()

public updateProximityPrecision("byWord"|"byAttribute" $type) : array<string|int, mixed>
Parameters
$type : "byWord"|"byAttribute"
Return values
array<string|int, mixed>

updateRankingRules()

public updateRankingRules(array<int, non-empty-string> $rankingRules) : array<string|int, mixed>
Parameters
$rankingRules : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateSearchableAttributes()

public updateSearchableAttributes(array<int, non-empty-string> $searchableAttributes) : array<string|int, mixed>
Parameters
$searchableAttributes : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateSearchCutoffMs()

public updateSearchCutoffMs(int $value) : array<string|int, mixed>
Parameters
$value : int
Return values
array<string|int, mixed>

updateSeparatorTokens()

public updateSeparatorTokens(array<int, non-empty-string> $separatorTokens) : array<string|int, mixed>
Parameters
$separatorTokens : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateSortableAttributes()

public updateSortableAttributes(array<int, non-empty-string> $sortableAttributes) : array<string|int, mixed>
Parameters
$sortableAttributes : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateStopWords()

public updateStopWords(array<int, non-empty-string> $stopWords) : array<string|int, mixed>
Parameters
$stopWords : array<int, non-empty-string>
Return values
array<string|int, mixed>

updateSynonyms()

public updateSynonyms(array<non-empty-string, array<int, non-empty-string>> $synonyms) : array<string|int, mixed>
Parameters
$synonyms : array<non-empty-string, array<int, non-empty-string>>
Return values
array<string|int, mixed>

updateTypoTolerance()

public updateTypoTolerance(array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list} $typoTolerance) : array<string|int, mixed>
Parameters
$typoTolerance : array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list}
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results