Settings API Parameters

The complete list of attributes used for searching.

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

List of attributes that cannot be retrieved at query time.

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

Controls how Algolia should sort your results.

Specifies the custom ranking criterion.

Controls the relevancy threshold below which less relevant results aren’t included in the results.

Creates replicas, exact copies of an index.

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.

Controls how facet values are sorted.

List of attributes to highlight.

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

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

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

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

Restrict highlighting and snippeting to items that matched the query.

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.

Set the maximum number of hits accessible via pagination.

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

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

Changing this setting to a lower number can negatively affect relevance with short queries, because more records will be considered a match with two typos.

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

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

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

List of words on which you want to disable typo tolerance. This also disables splitting and concatenation on the specified words.

Control which separators are indexed.

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

Specify on which attributes to apply transliteration.

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

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

Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.

List of characters that the engine shouldn’t automatically normalize.

Override the default normalization handled by the engine.

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

Sets the languages at the index level for language-specific processing such as tokenization and normalization.

Splits compound words into their composing atoms in the query.

Whether Rules should be globally enabled.

Enable the Personalization feature.

Controls if and how query words are interpreted as prefixes.

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

Enables the advanced query syntax.

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

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

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

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

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

Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled.

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

Enables compression of large integer arrays.

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

Enables de-duplication or grouping of results.

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

Precision of the proximity ranking criterion.

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

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.

When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.

Lets you store custom data in your indices.