BaseIndexSettings

Value parameters

allowCompressionOfIntegerArray

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

attributeForDistinct

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

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.

decompoundedAttributes

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

disablePrefixOnAttributes

Attributes for which you want to turn off prefix matching.

disableTypoToleranceOnWords

Words for which you want to turn off typo tolerance.

indexLanguages

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

numericAttributesForFiltering

Numeric attributes that can be used as numerical filters.

paginationLimitedTo

Maximum number of hits accessible through pagination.

replicas

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

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 $€£¥.

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