algolia settings

Manage your Algolia settings.

algolia settings get

algolia settings get <index> [flags]

Get the settings of the specified index.

Examples

1
2
3
# Store the settings of an index in a file
$ algolia settings get MOVIES > movies_settings.json

Output formatting flags

--allow-missing-template-keys

If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

-o, --output

Output format. One of: (json, jsonpath, jsonpath-as-json, jsonpath-file).

--template

Template string or path to template file to use when –output=jsonpath, –output=jsonpath-file.

algolia settings import

algolia settings import <index> -F <file> [flags]

Import the index settings from the given file.

Examples

1
2
3
# Import the settings from "settings.json" to the "MOVIES" index
$ algolia settings import MOVIES -F settings.json

Flags

-F, --file

Read settings from file (use “-“ to read from standard input)

algolia settings set

algolia settings set <index> [flags]

Set the settings of the specified index.

Examples

1
2
3
# 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: https://www.algolia.com/doc/api-reference/api-parameters/attributeCriteriaComputedByMinProximity/

--distinct

Determines how many records of a group are included in the search results.
See: https://www.algolia.com/doc/api-reference/api-parameters/distinct/

--maxFacetHits

Maximum number of facet values to return when searching for facet values.
See: https://www.algolia.com/doc/api-reference/api-parameters/maxFacetHits/

--minProximity

Minimum proximity score for two matching words.
See: https://www.algolia.com/doc/api-reference/api-parameters/minProximity/

--renderingContent

Extra data that can be used in the search UI.
See: https://www.algolia.com/doc/api-reference/api-parameters/renderingContent/

--responseFields

Properties to include in the API response of search and browse requests.
See: https://www.algolia.com/doc/api-reference/api-parameters/responseFields/

--userData

An object with custom data.
See: https://www.algolia.com/doc/api-reference/api-parameters/userData/

Attributes

--attributesToRetrieve

Attributes to include in the API response.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributesToRetrieve/

--searchableAttributes

Attributes used for searching. Attribute names are case-sensitive.
See: https://www.algolia.com/doc/api-reference/api-parameters/searchableAttributes/

--unretrievableAttributes

Attributes that can’t be retrieved at query time.
See: https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/

Faceting

--attributesForFaceting

Attributes used for faceting.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/

--maxValuesPerFacet

Maximum number of facet values to return for each facet.
See: https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/

--sortFacetValuesBy

Order in which to retrieve facet values.
See: https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/

Filtering

--enableReRanking

Whether this search will use Dynamic Re-Ranking.
See: https://www.algolia.com/doc/api-reference/api-parameters/enableReRanking/

Highlighting and Snippeting

--attributesToHighlight

Attributes to highlight.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/

--attributesToSnippet

Attributes for which to enable snippets.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/

--highlightPostTag

HTML tag to insert after the highlighted parts in all highlighted results and snippets.
See: https://www.algolia.com/doc/api-reference/api-parameters/highlightPostTag/

--highlightPreTag

HTML tag to insert before the highlighted parts in all highlighted results and snippets.
See: https://www.algolia.com/doc/api-reference/api-parameters/highlightPreTag/

--replaceSynonymsInHighlight

Whether to replace a highlighted word with the matched synonym.
See: https://www.algolia.com/doc/api-reference/api-parameters/replaceSynonymsInHighlight/

--restrictHighlightAndSnippetArrays

Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
See: https://www.algolia.com/doc/api-reference/api-parameters/restrictHighlightAndSnippetArrays/

--snippetEllipsisText

String used as an ellipsis indicator when a snippet is truncated.
See: https://www.algolia.com/doc/api-reference/api-parameters/snippetEllipsisText/

Languages

--attributesToTransliterate

Attributes, for which you want to support Japanese transliteration.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributesToTransliterate/

--camelCaseAttributes

Attributes for which to split camel case words.
See: https://www.algolia.com/doc/api-reference/api-parameters/camelCaseAttributes/

--customNormalization

Characters and their normalized replacements.
See: https://www.algolia.com/doc/api-reference/api-parameters/customNormalization/

--decompoundQuery

Whether to split compound words into their building blocks.
See: https://www.algolia.com/doc/api-reference/api-parameters/decompoundQuery/

--decompoundedAttributes

Searchable attributes to which Algolia should apply word segmentation (decompounding).
See: https://www.algolia.com/doc/api-reference/api-parameters/decompoundedAttributes/

--ignorePlurals

Treat singular, plurals, and other forms of declensions as equivalent.
See: https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/

--indexLanguages

Languages for language-specific processing steps, such as word detection and dictionary settings.
See: https://www.algolia.com/doc/api-reference/api-parameters/indexLanguages/

--keepDiacriticsOnCharacters

Characters for which diacritics should be preserved.
See: https://www.algolia.com/doc/api-reference/api-parameters/keepDiacriticsOnCharacters/

--queryLanguages

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
See: https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/

--removeStopWords

Removes stop words from the search query.
See: https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/

Other flags

--attributeForDistinct

Attribute that should be used to establish groups of results.
See: https://www.algolia.com/doc/api-reference/api-parameters/attributeForDistinct/

-f, --forward-to-replicas

Forward the settings to the replicas

--paginationLimitedTo

Maximum number of search results that can be obtained through pagination.
See: https://www.algolia.com/doc/api-reference/api-parameters/paginationLimitedTo/

--reRankingApplyFilter

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

--semanticSearch

Settings for the semantic search part of NeuralSearch.

Pagination

--hitsPerPage

Number of hits per page.
See: https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/

Performance

--allowCompressionOfIntegerArray

Whether arrays with exclusively non-negative integers should be compressed for better performance.
See: https://www.algolia.com/doc/api-reference/api-parameters/allowCompressionOfIntegerArray/

--numericAttributesForFiltering

Numeric attributes that can be used as numerical filters.
See: https://www.algolia.com/doc/api-reference/api-parameters/numericAttributesForFiltering/

Personalization

--enablePersonalization

Indicates whether Personalization is enabled.

Query strategy

--advancedSyntax

Whether to support phrase matching and excluding words from search queries.
See: https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/

--advancedSyntaxFeatures

Advanced search syntax features you want to support.
See: https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntaxFeatures/

--alternativesAsExact

Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.
See: https://www.algolia.com/doc/api-reference/api-parameters/alternativesAsExact/

--disableExactOnAttributes

Searchable attributes for which you want to turn off the Exact ranking criterion.
See: https://www.algolia.com/doc/api-reference/api-parameters/disableExactOnAttributes/

--disablePrefixOnAttributes

Searchable attributes for which you want to turn off prefix matching.
See: https://www.algolia.com/doc/api-reference/api-parameters/disablePrefixOnAttributes/

--exactOnSingleWordQuery

Determines how the Exact ranking criterion is computed when the search query has only one word. One of: attribute, none, word.
See: https://www.algolia.com/doc/api-reference/api-parameters/exactOnSingleWordQuery/

--mode

Search mode the index will use to query for results. One of: neuralSearch, keywordSearch.
See: https://www.algolia.com/doc/api-reference/api-parameters/mode/

--optionalWords

Words that should be considered optional when found in the query.
See: https://www.algolia.com/doc/api-reference/api-parameters/optionalWords/

--queryType

Determines if and how query words are interpreted as prefixes. One of: prefixLast, prefixAll, prefixNone.
See: https://www.algolia.com/doc/api-reference/api-parameters/queryType/

--removeWordsIfNoResults

Strategy for removing words from the query when it doesn’t return any results. One of: none, lastWords, firstWords, allOptional.
See: https://www.algolia.com/doc/api-reference/api-parameters/removeWordsIfNoResults/

Ranking

--customRanking

Attributes to use as custom ranking.
See: https://www.algolia.com/doc/api-reference/api-parameters/customRanking/

--ranking

Determines the order in which Algolia returns your results.
See: https://www.algolia.com/doc/api-reference/api-parameters/ranking/

--relevancyStrictness

Relevancy threshold below which less relevant results aren’t included in the results.
See: https://www.algolia.com/doc/api-reference/api-parameters/relevancyStrictness/

--replicas

Creates replica indices.
See: https://www.algolia.com/doc/api-reference/api-parameters/replicas/

Rules

--enableRules

Whether to enable rules.
See: https://www.algolia.com/doc/api-reference/api-parameters/enableRules/

Typos

--allowTyposOnNumericTokens

Whether to allow typos on numbers in the search query.
See: https://www.algolia.com/doc/api-reference/api-parameters/allowTyposOnNumericTokens/

--disableTypoToleranceOnAttributes

Attributes for which you want to turn off typo tolerance.
See: https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnAttributes/

--disableTypoToleranceOnWords

Words for which you want to turn off typo tolerance.
See: https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnWords/

--minWordSizefor1Typo

Minimum number of characters a word in the search query must contain to accept matches with one typo.
See: https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor1Typo/

--minWordSizefor2Typos

Minimum number of characters a word in the search query must contain to accept matches with two typos.
See: https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor2Typos/

--separatorsToIndex

Controls which separators are indexed.
See: https://www.algolia.com/doc/api-reference/api-parameters/separatorsToIndex/

--typoTolerance

Whether typo tolerance is enabled and how it is applied.
See: https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/