HandlesSettings
Table of Contents
Methods
- getChat() : array<string|int, mixed>
- 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 , disableOnNumbers: bool} - resetDictionary() : Task
- resetDisplayedAttributes() : Task
- resetDistinctAttribute() : Task
- resetEmbedders() : Task
- resetFaceting() : Task
- resetFacetSearch() : Task
- resetFilterableAttributes() : Task
- resetLocalizedAttributes() : Task
- resetNonSeparatorTokens() : Task
- resetPagination() : Task
- resetPrefixSearch() : Task
- resetProximityPrecision() : Task
- resetRankingRules() : Task
- resetSearchableAttributes() : Task
- resetSearchCutoffMs() : Task
- resetSeparatorTokens() : Task
- resetSortableAttributes() : Task
- resetStopWords() : Task
- resetSynonyms() : Task
- resetTypoTolerance() : Task
- updateChat() : Task
- updateDictionary() : Task
- updateDisplayedAttributes() : Task
- updateDistinctAttribute() : Task
- updateEmbedders() : Task
- updateFaceting() : Task
- updateFacetSearch() : Task
- updateFilterableAttributes() : Task
- updateLocalizedAttributes() : Task
- updateNonSeparatorTokens() : Task
- updatePagination() : Task
- updatePrefixSearch() : Task
- updateProximityPrecision() : Task
- updateRankingRules() : Task
- updateSearchableAttributes() : Task
- updateSearchCutoffMs() : Task
- updateSeparatorTokens() : Task
- updateSortableAttributes() : Task
- updateStopWords() : Task
- updateSynonyms() : Task
- updateTypoTolerance() : Task
Methods
getChat()
public
getChat() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>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|nullgetEmbedders()
public
getEmbedders() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|nullgetFaceting()
public
getFaceting() : array{maxValuesPerFacet: int, sortFacetValuesBy: array}
Return values
array{maxValuesPerFacet: int, sortFacetValuesBy: arraygetFacetSearch()
public
getFacetSearch() : bool
Tags
Return values
boolgetFilterableAttributes()
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: listgetLocalizedAttributes()
public
getLocalizedAttributes() : array<int, array{attributePatterns: list, locales: list}>|null
Return values
array<int, array{attributePatterns: listgetNonSeparatorTokens()
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
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|nullgetSeparatorTokens()
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, disableOnNumbers: bool}
Return values
array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: listresetDictionary()
public
resetDictionary() : Task
Return values
TaskresetDisplayedAttributes()
public
resetDisplayedAttributes() : Task
Return values
TaskresetDistinctAttribute()
public
resetDistinctAttribute() : Task
Return values
TaskresetEmbedders()
public
resetEmbedders() : Task
Tags
Return values
TaskresetFaceting()
public
resetFaceting() : Task
Return values
TaskresetFacetSearch()
public
resetFacetSearch() : Task
Tags
Return values
TaskresetFilterableAttributes()
public
resetFilterableAttributes() : Task
Return values
TaskresetLocalizedAttributes()
public
resetLocalizedAttributes() : Task
Return values
TaskresetNonSeparatorTokens()
public
resetNonSeparatorTokens() : Task
Return values
TaskresetPagination()
public
resetPagination() : Task
Return values
TaskresetPrefixSearch()
public
resetPrefixSearch() : Task
Tags
Return values
TaskresetProximityPrecision()
public
resetProximityPrecision() : Task
Return values
TaskresetRankingRules()
public
resetRankingRules() : Task
Return values
TaskresetSearchableAttributes()
public
resetSearchableAttributes() : Task
Return values
TaskresetSearchCutoffMs()
public
resetSearchCutoffMs() : Task
Return values
TaskresetSeparatorTokens()
public
resetSeparatorTokens() : Task
Return values
TaskresetSortableAttributes()
public
resetSortableAttributes() : Task
Return values
TaskresetStopWords()
public
resetStopWords() : Task
Return values
TaskresetSynonyms()
public
resetSynonyms() : Task
Return values
TaskresetTypoTolerance()
public
resetTypoTolerance() : Task
Return values
TaskupdateChat()
public
updateChat(array<string|int, mixed> $chatSettings) : Task
Parameters
- $chatSettings : array<string|int, mixed>
Tags
Return values
TaskupdateDictionary()
public
updateDictionary(array<int, non-empty-string> $wordDictionary) : Task
Parameters
- $wordDictionary : array<int, non-empty-string>
Return values
TaskupdateDisplayedAttributes()
public
updateDisplayedAttributes(array<int, non-empty-string> $displayedAttributes) : Task
Parameters
- $displayedAttributes : array<int, non-empty-string>
Return values
TaskupdateDistinctAttribute()
public
updateDistinctAttribute(non-empty-string $distinctAttribute) : Task
Parameters
- $distinctAttribute : non-empty-string
Return values
TaskupdateEmbedders()
public
updateEmbedders(array<string|int, mixed> $embedders) : Task
Parameters
- $embedders : array<string|int, mixed>
Tags
Return values
TaskupdateFaceting()
public
updateFaceting(array{maxValuesPerFacet?: int, sortFacetValuesBy?: array} $faceting) : Task
Parameters
-
$faceting
: array{maxValuesPerFacet?: int, sortFacetValuesBy?: array
Return values
TaskupdateFacetSearch()
public
updateFacetSearch(bool $facetSearch) : Task
Parameters
- $facetSearch : bool
Tags
Return values
TaskupdateFilterableAttributes()
public
updateFilterableAttributes(array<int, non-empty-string|array{attributePatterns: list, features?: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}> $filterableAttributes) : Task
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
TaskupdateLocalizedAttributes()
public
updateLocalizedAttributes(array<int, array{attributePatterns: list, locales: list}> $localizedAttributes) : Task
Parameters
-
$localizedAttributes
: array<int, array{attributePatterns: list
, locales: list }>
Return values
TaskupdateNonSeparatorTokens()
public
updateNonSeparatorTokens(array<int, non-empty-string> $nonSeparatorTokens) : Task
Parameters
- $nonSeparatorTokens : array<int, non-empty-string>
Return values
TaskupdatePagination()
public
updatePagination(array{maxTotalHits: positive-int} $pagination) : Task
Parameters
- $pagination : array{maxTotalHits: positive-int}
Return values
TaskupdatePrefixSearch()
public
updatePrefixSearch("indexingTime"|"disabled" $prefixSearch) : Task
Parameters
- $prefixSearch : "indexingTime"|"disabled"
Tags
Return values
TaskupdateProximityPrecision()
public
updateProximityPrecision("byWord"|"byAttribute" $type) : Task
Parameters
- $type : "byWord"|"byAttribute"
Return values
TaskupdateRankingRules()
public
updateRankingRules(array<int, non-empty-string> $rankingRules) : Task
Parameters
- $rankingRules : array<int, non-empty-string>
Return values
TaskupdateSearchableAttributes()
public
updateSearchableAttributes(array<int, non-empty-string> $searchableAttributes) : Task
Parameters
- $searchableAttributes : array<int, non-empty-string>
Return values
TaskupdateSearchCutoffMs()
public
updateSearchCutoffMs(int $value) : Task
Parameters
- $value : int
Return values
TaskupdateSeparatorTokens()
public
updateSeparatorTokens(array<int, non-empty-string> $separatorTokens) : Task
Parameters
- $separatorTokens : array<int, non-empty-string>
Return values
TaskupdateSortableAttributes()
public
updateSortableAttributes(array<int, non-empty-string> $sortableAttributes) : Task
Parameters
- $sortableAttributes : array<int, non-empty-string>
Return values
TaskupdateStopWords()
public
updateStopWords(array<int, non-empty-string> $stopWords) : Task
Parameters
- $stopWords : array<int, non-empty-string>
Return values
TaskupdateSynonyms()
public
updateSynonyms(array<non-empty-string, array<int, non-empty-string>> $synonyms) : Task
Parameters
- $synonyms : array<non-empty-string, array<int, non-empty-string>>
Return values
TaskupdateTypoTolerance()
public
updateTypoTolerance(array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list, disableOnNumbers: bool} $typoTolerance) : Task
Parameters
-
$typoTolerance
: array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list
, disableOnAttributes: list , disableOnNumbers: bool}