Usage
Examples
Set the typo tolerance to false on the MOVIES index:Advanced
Whether the best matching attribute should be determined by minimum proximity.
See:
attributeCriteriaComputedByMinProximityMaximum number of facet values to return when searching for facet values.
See:
maxFacetHitsMinimum proximity score for two matching words.
See:
minProximityExtra data that can be used in the search UI.
See:
renderingContentProperties to include in the API response of search and browse requests.
See:
responseFieldsAttributes
Attributes to include in the API response.
See:
attributesToRetrieveAttributes used for searching. Attribute names are case-sensitive.
See:
searchableAttributesAttributes that can’t be retrieved at query time.
See:
unretrievableAttributesFaceting
Attributes used for faceting.
See:
attributesForFacetingMaximum number of facet values to return for each facet.
See:
maxValuesPerFacetOrder in which to retrieve facet values.
See:
sortFacetValuesByFiltering
Whether this search will use Dynamic Re-Ranking.
See:
enableReRankingHighlighting and Snippeting
Attributes to highlight.
See:
attributesToHighlightAttributes for which to enable snippets.
See:
attributesToSnippetHTML tag to insert after the highlighted parts in all highlighted results and snippets.
See:
highlightPostTagHTML tag to insert before the highlighted parts in all highlighted results and snippets.
See:
highlightPreTagWhether to replace a highlighted word with the matched synonym.
See:
replaceSynonymsInHighlightWhether to restrict highlighting and snippeting to items that at least partially matched the search query.
See:
restrictHighlightAndSnippetArraysString used as an ellipsis indicator when a snippet is truncated.
See:
snippetEllipsisTextLanguages
Attributes, for which you want to support Japanese transliteration.
See:
attributesToTransliterateAttributes for which to split camel case words.
See:
camelCaseAttributesCharacters and their normalized replacements.
See:
customNormalizationWhether to split compound words in the query into their building blocks.
See:
decompoundQuerySearchable attributes to which Algolia should apply word segmentation (decompounding).
See:
decompoundedAttributesTreat singular, plurals, and other forms of declensions as equivalent.
See:
ignorePluralsLanguages for language-specific processing steps, such as word detection and dictionary settings.
See:
indexLanguagesCharacters for which diacritics should be preserved.
See:
keepDiacriticsOnCharactersLanguages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
See:
queryLanguagesRemoves stop words from the search query.
See:
removeStopWordsOther flags
Attribute that should be used to establish groups of results.
See:
attributeForDistinctWhether to apply settings changes also to replicas
Words that should be considered optional when found in the query.
See:
optionalWordsMaximum number of search results that can be obtained through pagination.
See:
paginationLimitedToRestrict Dynamic Re-Ranking to records that match these filters.
Settings for the semantic search part of NeuralSearch.
Wait for the operation to complete
Output formatting flags
If true, ignore errors in templates due to missing fields or map keys. This only applies to golang and jsonpath output formats.
Output format. One of: (json, jsonl, ndjson, jsonpath, jsonpath-as-json, jsonpath-file).
Template string or path to a template file to use when —output=jsonpath, —output=jsonpath-file.
Pagination
Number of hits per page.
See:
hitsPerPagePerformance
Whether arrays with exclusively non-negative integers should be compressed for better performance.
See:
allowCompressionOfIntegerArrayNumeric attributes that can be used as numerical filters.
See:
numericAttributesForFilteringPersonalization
Whether to enable Personalization.
See:
enablePersonalizationQuery strategy
Whether to support phrase matching and excluding words from search queries.
See:
advancedSyntaxAdvanced search syntax features you want to support.
See:
advancedSyntaxFeaturesDetermine which plurals and synonyms should be considered an exact matches.
See:
alternativesAsExactSearchable attributes for which you want to turn off the Exact ranking criterion.
See:
disableExactOnAttributesSearchable attributes for which you want to turn off prefix matching.
See:
disablePrefixOnAttributesDetermines how the Exact ranking criterion is computed when the search query has only one word. One of: attribute, none, word.
See:
exactOnSingleWordQuerySearch mode the index will use to query for results. One of: neuralSearch, keywordSearch.
See:
modeDetermines if and how query words are interpreted as prefixes. One of: prefixLast, prefixAll, prefixNone.
See:
queryTypeStrategy for removing words from the query when it doesn’t return any results. One of: none, lastWords, firstWords, allOptional.
See:
removeWordsIfNoResultsRanking
Attributes to use as custom ranking.
See:
customRankingRelevancy threshold below which less relevant results aren’t included in the results.
See:
relevancyStrictnessRules
Whether to enable rules.
See:
enableRulesTypos
Whether to allow typos on numbers in the search query.
See:
allowTyposOnNumericTokensAttributes for which you want to turn off typo tolerance.
See:
disableTypoToleranceOnAttributesCreates a list of words which require exact matches.
See:
disableTypoToleranceOnWordsMinimum number of characters a word in the search query must contain to accept matches with one typo.
See:
minWordSizefor1TypoMinimum number of characters a word in the search query must contain to accept matches with two typos.
See:
minWordSizefor2TyposControl which non-alphanumeric characters are indexed.
See:
separatorsToIndexWhether typo tolerance is enabled and how it is applied.
See:
typoTolerance