17 Oct 2018

Settings API parameters

Search “settings parameters”

Index settings parameters

Here is the list of parameters you can use with the set settings method (settings scope).

Parameters that can be overridden at search time also have the search scope.

attributes

searchableAttributes
settings

The complete list of attributes that will be used for searching.

attributesForFaceting
settings

The complete list of attributes that will be used for faceting.

unretrievableAttributes
settings

List of attributes that cannot be retrieved at query time.

attributesToRetrieve
settings search

Gives control over which attributes to retrieve and which not to retrieve.

ranking

ranking
settings

Controls the way results are sorted.

customRanking
settings

Specifies the custom ranking criterion.

replicas
settings

Creates replicas, exact copies of an index.

faceting

maxValuesPerFacet
settings search

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
settings search

Controls how facet values are sorted.

highlighting-snippeting

attributesToHighlight
settings search

List of attributes to highlight.

attributesToSnippet
settings search

List of attributes to snippet, with an optional maximum number of words to snippet.

highlightPreTag
settings search

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
settings search

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
settings search

String used as an ellipsis indicator when a snippet is truncated.

restrictHighlightAndSnippetArrays
settings search

Restrict highlighting and snippeting to items that matched the query.

pagination

hitsPerPage
settings search

Set the number of hits per page.

In most cases, page/hitsPerPage is the recommended method for pagination. Check our full discussion on pagination approaches.

paginationLimitedTo
settings

Set the maximum number of hits accessible via pagination.

typos

minWordSizefor1Typo
settings search

Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

minWordSizefor2Typos
settings search

Minimum number of characters a word in the query string must contain to accept matches with 2 typos.

typoTolerance
settings search

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
settings search

Whether to allow typos on numbers (“numeric tokens”) in the query string.

disableTypoToleranceOnAttributes
settings search

List of attributes on which you want to disable typo tolerance.

disableTypoToleranceOnWords
settings

List of words on which you want to disable typo tolerance.

separatorsToIndex
settings

Control which separators are indexed.

languages

ignorePlurals
settings search

Treats singular, plurals, and other forms of declensions as matching terms.

removeStopWords
settings search

Removes stop (common) words from the query before executing it.

camelCaseAttributes
settings

List of attributes on which to do a decomposition of camel case words.

decompoundedAttributes
settings

Specify on which attributes in your index Algolia should apply word-splitting (“decompounding”).

keepDiacriticsOnCharacters
settings

Characters that should not be automatically normalized by the search engine.

queryLanguages
settings search

Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.

query-rules

enableRules
search settings

Whether rules should be globally enabled.

query-strategy

queryType
search settings

Controls if and how query words are interpreted as prefixes.

removeWordsIfNoResults
settings search

Selects a strategy to remove words from the query when it doesn’t match any hits.

advancedSyntax
settings search

Enables the advanced query syntax.

optionalWords
settings search

A list of words that should be considered as optional when found in the query.

disablePrefixOnAttributes
settings

List of attributes on which you want to disable prefix matching.

disableExactOnAttributes
settings search

List of attributes on which you want to disable the exact ranking criterion.

exactOnSingleWordQuery
settings search

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
settings search

List of alternatives that should be considered an exact match by the exact ranking criterion.

performance

numericAttributesForFiltering
settings

List of numeric attributes that can be used as numerical filters.

allowCompressionOfIntegerArray
settings

Enables compression of large integer arrays.

advanced

attributeForDistinct
settings

Name of the de-duplication attribute to be used with the distinct feature.

distinct
settings search

Enables de-duplication or grouping of results.

replaceSynonymsInHighlight
settings search

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
settings search

Precision of the proximity ranking criterion.

responseFields
settings search

Choose which fields the response will contain. Applies to search and browse queries.

maxFacetHits
settings search

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.

© Algolia - Privacy Policy