Settings API Parameters

The complete list of attributes used for searching.

List of attributes to use for faceting.

List of attributes you don’t want the engine to retrieve at query time.

This parameter controls which attributes to retrieve and which not to retrieve.

Activate or deactivate NeuralSearch for a participating index.

Controls how Algolia should sort your results.

Specifies which attributes to assign to Algolia’s custom ranking criterion.

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

Creates replicas (copies) of an index.

The maximum number of facet values to return for each facet in a regular search.

Controls how facet values are fetched.

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 for paginating the search results.

Maximum number of hits accessible through pagination.

The minimum number of characters in a query word before typos are considered.

The minimum number of characters in a query word before two typos are considered.

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

Whether to allow numeric typos in the query.

A list of searchable attributes for which you want to turn off typo tolerance.

A list of words for which you want to turn off typo tolerance.

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 for which to split 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 languages for language-specific settings such as plurals, stop words, and dictionaries for detecting words in CJK languages.

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 optional when found in the query.

List of attributes for which you want to turn off prefix matching.

List of attributes for which you want to turn off 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 attribute to deduplicate or group records.

Deduplicate or group 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 to return in the API response. This parameters applies to search and browse queries.

Maximum number of facet hits to return during a search for facet values.

When the Attribute criterion is ranked higher than Proximity in your ranking formula, Proximity selects which searchable attribute is matched in the Attribute criterion.

Lets you store custom data in your indices.

Defines how you want to render results in the search interface.