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 || |
The complete list of attributes that will be used for searching.
| attributesForFaceting || |
The complete list of attributes that will be used for faceting.
| unretrievableAttributes || |
List of attributes that cannot be retrieved at query time.
| attributesToRetrieve || |
Gives control over which attributes to retrieve and which not to retrieve.
| ranking || |
Controls the way results are sorted.
| customRanking || |
| replicas || |
Creates replicas, exact copies of an index.
| maxValuesPerFacet || |
Maximum number of facet values to return for each facet during a regular search.
If you want to change the number of retrieved facet hits during a search for facet values, see maxFacetHits.
| sortFacetValuesBy || |
Controls how facet values are sorted.
| attributesToHighlight || |
List of attributes to highlight.
| attributesToSnippet || |
List of attributes to snippet, with an optional maximum number of words to snippet.
| highlightPreTag || |
The HTML string to insert before the highlighted parts in all highlight and snippet results.
| highlightPostTag || |
The HTML string to insert after the highlighted parts in all highlight and snippet results.
| snippetEllipsisText || |
String used as an ellipsis indicator when a snippet is truncated.
| restrictHighlightAndSnippetArrays || |
Restrict highlighting and snippeting 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 1 typo.
| minWordSizefor2Typos || |
Minimum number of characters a word in the query string must contain to accept matches with 2 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.
| disableTypoToleranceOnAttributes || |
List of attributes on which you want to disable typo tolerance.
| disableTypoToleranceOnWords || |
List of words on which you want to disable typo tolerance.
| separatorsToIndex || |
Control which separators are indexed.
| ignorePlurals || |
Treats singular, plurals, and other forms of declensions as matching terms.
| removeStopWords || |
Removes stop (common) words from the query before executing it.
| camelCaseAttributes || |
List of attributes on which to do a decomposition of camel case words.
| decompoundedAttributes || |
Specify on which attributes in your index Algolia should apply word-splitting (“decompounding”).
| keepDiacriticsOnCharacters || |
Characters that should not be automatically normalized by the search engine.
| queryLanguages |
| enableRules || |
Whether rules should be globally enabled.
| 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 || |
A list of words that should be considered as optional when found in the query.
| disablePrefixOnAttributes || |
List of attributes on which you want to disable prefix matching.
| disableExactOnAttributes || |
List of attributes on which you want to disable the
| exactOnSingleWordQuery || |
Controls how the
| alternativesAsExact || |
List of alternatives that should be considered an exact match by the
| 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 to be used with the distinct feature.
| distinct || |
Enables de-duplication or grouping of results.
| replaceSynonymsInHighlight || |
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
| 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.
If you want to change the number of retrieved facet values for a regular search, see maxValuesPerFacet.