algolia settings set

Specify index settings.

Usage

algolia settings set <index> [flags]

Examples

Set the typo tolerance to false on the MOVIES index:

algolia settings set MOVIES --typoTolerance="false"

Advanced

--attributeCriteriaComputedByMinProximity

Whether the best matching attribute should be determined by minimum proximity. See: attributeCriteriaComputedByMinProximity

--distinct

Determines how many records of a group are included in the search results. See: distinct

--maxFacetHits

Maximum number of facet values to return when searching for facet values. See: maxFacetHits

--minProximity

Minimum proximity score for two matching words. See: minProximity

--renderingContent

Extra data that can be used in the search UI. See: renderingContent

--responseFields

Properties to include in the API response of search and browse requests. See: responseFields

--userData

An object with custom data. See: userData

Attributes

--attributesToRetrieve

Attributes to include in the API response. See: attributesToRetrieve

--searchableAttributes

Attributes used for searching. Attribute names are case-sensitive. See: searchableAttributes

--unretrievableAttributes

Attributes that can’t be retrieved at query time. See: unretrievableAttributes

Faceting

--attributesForFaceting

Attributes used for faceting. See: attributesForFaceting

--maxValuesPerFacet

Maximum number of facet values to return for each facet. See: maxValuesPerFacet

--sortFacetValuesBy

Order in which to retrieve facet values. See: sortFacetValuesBy

Filtering

--enableReRanking

Whether this search will use Dynamic Re-Ranking. See: enableReRanking

Highlighting and Snippeting

--attributesToHighlight

Attributes to highlight. See: attributesToHighlight

--attributesToSnippet

Attributes for which to enable snippets. See: attributesToSnippet

--highlightPostTag

HTML tag to insert after the highlighted parts in all highlighted results and snippets. See: highlightPostTag

--highlightPreTag

HTML tag to insert before the highlighted parts in all highlighted results and snippets. See: highlightPreTag

--replaceSynonymsInHighlight

Whether to replace a highlighted word with the matched synonym. See: replaceSynonymsInHighlight

--restrictHighlightAndSnippetArrays

Whether to restrict highlighting and snippeting to items that at least partially matched the search query. See: restrictHighlightAndSnippetArrays

--snippetEllipsisText

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

Languages

--attributesToTransliterate

Attributes, for which you want to support Japanese transliteration. See: attributesToTransliterate

--camelCaseAttributes

Attributes for which to split camel case words. See: camelCaseAttributes

--customNormalization

Characters and their normalized replacements. See: customNormalization

--decompoundQuery

Whether to split compound words in the query into their building blocks. See: decompoundQuery

--decompoundedAttributes

Searchable attributes to which Algolia should apply word segmentation (decompounding). See: decompoundedAttributes

--ignorePlurals

Treat singular, plurals, and other forms of declensions as equivalent. See: ignorePlurals

--indexLanguages

Languages for language-specific processing steps, such as word detection and dictionary settings. See: indexLanguages

--keepDiacriticsOnCharacters

Characters for which diacritics should be preserved. See: keepDiacriticsOnCharacters

--queryLanguages

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. See: queryLanguages

--removeStopWords

Removes stop words from the search query. See: removeStopWords

Other flags

--attributeForDistinct

Attribute that should be used to establish groups of results. See: attributeForDistinct

-f, --forward-to-replicas

Whether to apply settings changes also to replicas

--optionalWords

Words that should be considered optional when found in the query. See: optionalWords

--paginationLimitedTo

Maximum number of search results that can be obtained through pagination. See: paginationLimitedTo

--reRankingApplyFilter

Restrict Dynamic Re-Ranking to records that match these filters.

--semanticSearch

Settings for the semantic search part of NeuralSearch.

-w, --wait

Wait for the operation to complete

Pagination

--hitsPerPage

Number of hits per page. See: hitsPerPage

Performance

--allowCompressionOfIntegerArray

Whether arrays with exclusively non-negative integers should be compressed for better performance. See: allowCompressionOfIntegerArray

--numericAttributesForFiltering

Numeric attributes that can be used as numerical filters. See: numericAttributesForFiltering

Personalization

--enablePersonalization

Whether to enable Personalization. See: enablePersonalization

Query strategy

--advancedSyntax

Whether to support phrase matching and excluding words from search queries. See: advancedSyntax

--advancedSyntaxFeatures

Advanced search syntax features you want to support. See: advancedSyntaxFeatures

--alternativesAsExact

Determine which plurals and synonyms should be considered an exact matches. See: alternativesAsExact

--disableExactOnAttributes

Searchable attributes for which you want to turn off the Exact ranking criterion. See: disableExactOnAttributes

--disablePrefixOnAttributes

Searchable attributes for which you want to turn off prefix matching. See: disablePrefixOnAttributes

--exactOnSingleWordQuery

Determines how the Exact ranking criterion is computed when the search query has only one word. One of: attribute, none, word. See: exactOnSingleWordQuery

--mode

Search mode the index will use to query for results. One of: neuralSearch, keywordSearch. See: mode

--queryType

Determines if and how query words are interpreted as prefixes. One of: prefixLast, prefixAll, prefixNone. See: queryType

--removeWordsIfNoResults

Strategy for removing words from the query when it doesn’t return any results. One of: none, lastWords, firstWords, allOptional. See: removeWordsIfNoResults

Ranking

--customRanking

Attributes to use as custom ranking. See: customRanking

--ranking

Determines the order in which Algolia returns your results. See: ranking

--relevancyStrictness

Relevancy threshold below which less relevant results aren’t included in the results. See: relevancyStrictness

--replicas

Creates replica indices. See: replicas

Rules

--enableRules

Whether to enable rules. See: enableRules

Typos

--allowTyposOnNumericTokens

Whether to allow typos on numbers in the search query. See: allowTyposOnNumericTokens

--disableTypoToleranceOnAttributes

Attributes for which you want to turn off typo tolerance. See: disableTypoToleranceOnAttributes

--disableTypoToleranceOnWords

Creates a list of words which require exact matches. See: disableTypoToleranceOnWords

--minWordSizefor1Typo

Minimum number of characters a word in the search query must contain to accept matches with one typo. See: minWordSizefor1Typo

--minWordSizefor2Typos

Minimum number of characters a word in the search query must contain to accept matches with two typos. See: minWordSizefor2Typos

--separatorsToIndex

Control which non-alphanumeric characters are indexed. See: separatorsToIndex

--typoTolerance

Whether typo tolerance is enabled and how it is applied. See: typoTolerance