Settings API parameters
Index settings parameters
Here is the list of parameters you can use with the set settings method (
Parameters that can be overridden at search time also have the
| searchableAttributes || |
List of attributes eligible for textual search.
| attributesForFaceting || |
List of attributes you want to use for faceting.
| unretrievableAttributes || |
List of attributes that cannot be retrieved at query time.
| attributesToRetrieve || |
List of object attributes you want to retrieve.
| ranking || |
Controls the way results are sorted.
| customRanking || |
| replicas || |
List of indices to which you want to replicate all write operations.
| maxValuesPerFacet || |
Maximum number of facet values returned for each facet.
| sortFacetValuesBy || |
Controls how facet values are sorted.
Highlighting / Snippeting
| attributesToHighlight || |
List of attributes to highlight.
| attributesToSnippet || |
List of attributes to snippet, with an optional maximum number of words to snippet.
| highlightPreTag || |
String inserted before highlighted parts in highlight and snippet results.
| highlightPostTag || |
String inserted after highlighted parts in highlight and snippet results.
| snippetEllipsisText || |
String used as an ellipsis indicator when a snippet is truncated.
| restrictHighlightAndSnippetArrays || |
Restrict arrays in highlight and snippet results to items that matched the query.
| hitsPerPage || |
Set the number of hits per page.
| paginationLimitedTo || |
Set the maximum number of hits accessible via pagination.
| minWordSizefor1Typo || |
Minimum number of characters a word in the query string must contain to accept matches with one typo.
| minWordSizefor2Typos || |
Minimum number of characters a word in the query string must contain to accept matches with two typos.
| typoTolerance || |
Controls whether typo tolerance is enabled and how it is applied:
| allowTyposOnNumericTokens || |
Whether to allow typos on numbers (“numeric tokens”) in the query string.
| ignorePlurals || |
Consider singular, plurals, and declensions as matching terms with no typo.
| disableTypoToleranceOnAttributes || |
List of attributes on which you want to disable typo tolerance
| disableTypoToleranceOnWords || |
List of words on which typo tolerance will be disabled.
| separatorsToIndex || |
Separators (all non-alphanumeric characters except space) to index.
| queryType || |
Controls if and how query words are interpreted as prefixes.
| removeWordsIfNoResults || |
Selects a strategy to remove words from the query when it doesn’t match any hits.
| advancedSyntax || |
Enables the advanced query syntax.
| optionalWords || |
List of words that should be considered as optional when found in the query.
| removeStopWords || |
Remove stop words from the query before executing it.
| disablePrefixOnAttributes || |
List of attributes on which you want to disable prefix matching
| disableExactOnAttributes || |
List of attributes on which you want to disable computation of the
| exactOnSingleWordQuery || |
Controls how the
| enableRules || |
Whether rules should be globally enabled.
| numericAttributesForFiltering || |
List of numeric attributes that can be used as numerical filters.
| allowCompressionOfIntegerArray || |
Enables compression of large integer arrays.
| attributeForDistinct || |
Name of the de-duplication attribute for the distinct feature.
| minProximity || |
Precision of the
| responseFields || |
Choose which fields the response will contain. Applies to search and browse queries.
| maxFacetHits || |
Maximum number of facet hits to return during a search for facet values.
| camelCaseAttributes || |
List of attributes on which to do a decomposition of camel case words.
| decompoundedAttributes || |
Specify on which attributes in your index we should apply word-splitting (“decompounding”).
| distinct || |
Controls de-duplication of results.
| replaceSynonymsInHighlight || |
Whether to replace words matched via synonym expansion by the matched synonym in highlight and snippet results.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.