Usage
Examples
Set the typo tolerance to false on the MOVIES index:Advanced
--attributeCriteriaComputedByMinProximity
Whether the best matching attribute should be determined by minimum proximity.
--distinct
Determines how many records of a group are included in the search results.
--maxFacetHits
Maximum number of facet values to return when searching for facet values.
--minProximity
Minimum proximity score for two matching words.
--renderingContent
Extra data that can be used in the search UI.
--responseFields
Properties to include in the API response of search and browse requests.
--userData
An object with custom data.
Attributes
--attributesToRetrieve
Attributes to include in the API response.
--searchableAttributes
Attributes used for searching. Attribute names are case-sensitive.
--unretrievableAttributes
Attributes that can’t be retrieved at query time.
Faceting
--attributesForFaceting
Attributes used for faceting.
--maxValuesPerFacet
Maximum number of facet values to return for each facet.
--sortFacetValuesBy
Order in which to retrieve facet values.
Filtering
--enableReRanking
Whether this search will use Dynamic Re-Ranking.
Highlighting and Snippeting
--attributesToHighlight
Attributes to highlight.
--attributesToSnippet
Attributes for which to enable snippets.
--highlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
--highlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
--replaceSynonymsInHighlight
Whether to replace a highlighted word with the matched synonym.
--restrictHighlightAndSnippetArrays
Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
--snippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.
Languages
--attributesToTransliterate
Attributes, for which you want to support Japanese transliteration.
--camelCaseAttributes
Attributes for which to split camel case words.
--customNormalization
Characters and their normalized replacements.
--decompoundQuery
Whether to split compound words in the query into their building blocks.
--decompoundedAttributes
Searchable attributes to which Algolia should apply word segmentation (decompounding).
--ignorePlurals
Treat singular, plurals, and other forms of declensions as equivalent.
--indexLanguages
Languages for language-specific processing steps, such as word detection and dictionary settings.
--keepDiacriticsOnCharacters
Characters for which diacritics should be preserved.
--queryLanguages
Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
--removeStopWords
Removes stop words from the search query.
Other flags
--attributeForDistinct
Attribute that should be used to establish groups of results.
-f, --forward-to-replicas
Whether to apply settings changes also to replicas
--optionalWords
Words that should be considered optional when found in the query.
--paginationLimitedTo
Maximum number of search results that can be obtained through pagination.
--reRankingApplyFilter
--semanticSearch
Settings for the semantic search part of NeuralSearch.
-w, --wait
Wait for the operation to complete
Pagination
--hitsPerPage
Number of hits per page.
Performance
--allowCompressionOfIntegerArray
Whether arrays with exclusively non-negative integers should be compressed for better performance.
--numericAttributesForFiltering
Numeric attributes that can be used as numerical filters.
Personalization
--enablePersonalization
Whether to enable Personalization.
Query strategy
--advancedSyntax
Whether to support phrase matching and excluding words from search queries.
--advancedSyntaxFeatures
Advanced search syntax features you want to support.
--alternativesAsExact
Determine which plurals and synonyms should be considered an exact matches.
--disableExactOnAttributes
Searchable attributes for which you want to turn off the Exact ranking criterion.
--disablePrefixOnAttributes
Searchable attributes for which you want to turn off prefix matching.
--exactOnSingleWordQuery
Determines how the Exact ranking criterion is computed when the search query has only one word. One of: attribute, none, word.
--mode
Search mode the index will use to query for results. One of: neuralSearch, keywordSearch.
--queryType
Determines if and how query words are interpreted as prefixes. One of: prefixLast, prefixAll, prefixNone.
--removeWordsIfNoResults
Strategy for removing words from the query when it doesn’t return any results. One of: none, lastWords, firstWords, allOptional.
Ranking
--customRanking
Attributes to use as custom ranking.
--ranking
Determines the order in which Algolia returns your results.
--relevancyStrictness
Relevancy threshold below which less relevant results aren’t included in the results.
--replicas
Creates replica indices.
Rules
--enableRules
Whether to enable rules.
Typos
--allowTyposOnNumericTokens
Whether to allow typos on numbers in the search query.
--disableTypoToleranceOnAttributes
Attributes for which you want to turn off typo tolerance.
--disableTypoToleranceOnWords
Creates a list of words which require exact matches.
--minWordSizefor1Typo
Minimum number of characters a word in the search query must contain to accept matches with one typo.
--minWordSizefor2Typos
Minimum number of characters a word in the search query must contain to accept matches with two typos.
--separatorsToIndex
Control which non-alphanumeric characters are indexed.
--typoTolerance
Whether typo tolerance is enabled and how it is applied.