IndexSettings

Value parameters

advancedSyntax

Enables the advanced query syntax.

advancedSyntaxFeatures

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

allowCompressionOfIntegerArray

Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.

allowTyposOnNumericTokens

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

alternativesAsExact

Alternatives that should be considered an exact match by the exact ranking criterion.

attributeCriteriaComputedByMinProximity

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

attributeForDistinct

Name of the deduplication attribute to be used with Algolia's distinct feature.

attributesForFaceting

Attributes used for faceting and the modifiers that can be applied: filterOnly, searchable, and afterDistinct.

attributesToHighlight

Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (highlightPreTag and highlightPostTag).

attributesToRetrieve

Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.

attributesToSnippet

Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: body:20.

attributesToTransliterate

Attributes in your index to which Japanese transliteration applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.

camelCaseAttributes

Attributes on which to split camel case words.

customNormalization

A list of characters and their normalized replacements to override Algolia's default normalization.

customRanking

Specifies the Custom ranking criterion. Use the asc and desc modifiers to specify the ranking order: ascending or descending.

decompoundQuery

Splits compound words into their component word parts in the query.

decompoundedAttributes

Attributes in your index to which word segmentation (decompounding) applies.

disableExactOnAttributes

Attributes for which you want to turn off the exact ranking criterion.

disablePrefixOnAttributes

Attributes for which you want to turn off prefix matching.

disableTypoToleranceOnAttributes

Attributes for which you want to turn off typo tolerance.

disableTypoToleranceOnWords

Words for which you want to turn off typo tolerance.

enablePersonalization

Incidates whether Personalization is enabled.

enableReRanking

Indicates whether this search will use Dynamic Re-Ranking.

enableRules

Incidates whether Rules are enabled.

highlightPostTag

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

highlightPreTag

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

hitsPerPage

Number of hits per page.

indexLanguages

Set the languages of your index, for language-specific processing steps such as tokenization and normalization.

keepDiacriticsOnCharacters

Characters that the engine shouldn't automatically normalize.

maxFacetHits

Maximum number of facet hits to return when searching for facet values.

maxValuesPerFacet

Maximum number of facet values to return for each facet.

minProximity

Precision of the proximity ranking criterion.

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.

numericAttributesForFiltering

Numeric attributes that can be used as numerical filters.

optionalWords

Words which should be considered optional when found in a query.

paginationLimitedTo

Maximum number of hits accessible through pagination.

queryLanguages

Sets your user's search language. This adjusts language-specific settings and features such as ignorePlurals, removeStopWords, and CJK word detection.

ranking

Determines the order in which Algolia returns your results.

relevancyStrictness

Relevancy threshold below which less relevant results aren't included in the results.

replaceSynonymsInHighlight

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

replicas

Creates replicas, which are copies of a primary index with the same records but different settings.

responseFields

Attributes to include in the API response for search and browse queries.

restrictHighlightAndSnippetArrays

Restrict highlighting and snippeting to items that matched the query.

searchableAttributes

Attributes used for searching, including determining if matches at the beginning of a word are important (ordered) or not (unordered).

separatorsToIndex

Controls which separators are added to an Algolia index as part of normalization. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.

snippetEllipsisText

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

sortFacetValuesBy

Controls how facet values are fetched.

unretrievableAttributes

Attributes that can't be retrieved at query time.

userData

Lets you store custom data in your indices.

Attributes

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all