API Reference / API Parameters

Scope

Each parameter in this page has a scope. Scope signifies the timing of when the parameter takes effect.

There are three scopes:

  • settings: They can only be used in the setSettings method.
  • search: They can only be used in the search method.
  • settings search: The setting can be used in the setSettings method and be overridden in the search method.

All parameters used in setSettings are called "Index Settings". They change the index during indexing time; they impact all searches. All parameters used in search are called "Query Parameters". Their effect is temporary, impacting only the current query.

While many query parameters override an index setting, some add new functionality. Some parameters can be used at both indexing and query time. See more here.

Parameters list

query
search

The text used to search an index.

similarQuery
search

Overrides the query parameter and performs a more generic search to find “similar” results.

Attributes

searchableAttributes
settings

The complete list of attributes used for searching.

attributesForFaceting
settings

List of attributes to use for faceting.

unretrievableAttributes
settings

List of attributes you don’t want the engine to retrieve at query time.

attributesToRetrieve
settings search

This parameter controls which attributes to retrieve and which not to retrieve.

restrictSearchableAttributes
search

Limit the search for a given query to a subset of your searchable attributes.

Ranking

mode
settings

Activate or deactivate NeuralSearch for a participating index.

ranking
settings

Controls how Algolia sorts your results.

customRanking
settings

Specifies which attributes to assign to Algolia’s custom ranking criterion.

relevancyStrictness
settings search

Controls the relevancy threshold below which less relevant results aren’t included in the results.

replicas
settings

Creates replicas (copies) of an index.

Filtering

filters
search

Filter the query with numeric, facet, or tag filters.

facetFilters
search

Filter hits by facet value.

optionalFilters
search

Boost or bury records based on specific criteria, but without hiding those records.

numericFilters
search

Filter on numeric attributes.

tagFilters
search

Filter hits by tags.

sumOrFiltersScores
search

Determines how to calculate the total score for filtering.

Faceting

facets
search

Retrieve facets, their facet values, and the number of matching facet values.

maxValuesPerFacet
settings search

The maximum number of values to return for each facet.

facetingAfterDistinct
search

Compute facet counts after deduplication (via the distinct setting).

sortFacetValuesBy
settings search

Controls how facet values are fetched.

Highlighting/Snippeting

attributesToHighlight
settings search

List of attributes to highlight.

attributesToSnippet
settings search

Attributes to snippet, with an optional maximum word limit.

highlightPreTag
settings search

The HTML string to insert before the highlighted parts in all highlight and snippet results.

highlightPostTag
settings search

The HTML string to insert after the highlighted parts in all highlight and snippet results.

snippetEllipsisText
settings search

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

restrictHighlightAndSnippetArrays
settings search

Restrict highlighting and snippeting to items that matched the query.

Pagination

page
search

Specify the page to retrieve.

hitsPerPage
settings search

Set the number of hits per page for paginating the search results.

offset
search

Determine the position of a particular record in the dataset.

length
search

Set the number of hits to retrieve (used only with offset).

paginationLimitedTo
settings

Maximum number of hits accessible through pagination.

Typos

minWordSizefor1Typo
settings search

The minimum number of characters in a query word before typos are considered.

minWordSizefor2Typos
settings search

The minimum number of characters in a query word before two typos are considered.

typoTolerance
settings search

Controls whether typo tolerance is enabled and how it is applied.

allowTyposOnNumericTokens
settings search

Whether to allow numeric typos in the query.

disableTypoToleranceOnAttributes
settings search

A list of searchable attributes for which you want to turn off typo tolerance.

disableTypoToleranceOnWords
settings

A list of words for which you want to turn off typo tolerance.

separatorsToIndex
settings

Control which separators are indexed.

aroundLatLng
search

Search for entries around a central location, enabling a geographical search within a circular area.

aroundLatLngViaIP
search

Search for entries around a central location automatically computed from the user’s IP address, enabling a geographical search within a circular area.

aroundRadius
search

Define the maximum radius for a geo search (in meters).

aroundPrecision
search

Precision of geo search (in meters), to add grouping by geo location to the ranking formula.

minimumAroundRadius
search

Minimum radius (in meters) used for a geo search when the radius isn’t defined.

insideBoundingBox
search

Search inside a rectangular area (in geo coordinates).

insidePolygon
search

Search inside a polygon (using geographical coordinates).

Languages

ignorePlurals
settings search

Treats singular, plurals, and other forms of declensions as matching terms.

attributesToTransliterate
settings

Specify on which attributes to apply transliteration.

removeStopWords
settings search

Removes stop (common) words from the query before executing it.

camelCaseAttributes
settings

List of attributes for which to split camel case words.

decompoundedAttributes
settings

Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.

keepDiacriticsOnCharacters
settings

List of characters that the engine shouldn’t automatically normalize.

customNormalization
settings

Override the default normalization handled by the engine.

queryLanguages
settings search

Sets languages for language-specific settings such as plurals, stop words, and dictionaries for detecting words in CJK languages.

indexLanguages
settings

Sets the languages at the index level for language-specific processing, such as tokenization and normalization.

naturalLanguages
search

Change the default of parameters for handling natural language searches as opposed to keyword searches, for example, for voice search.

decompoundQuery
settings search

Splits compound words into their composing atoms in the query.

Rules

enableRules
search settings

Whether Rules should be globally enabled.

filterPromotes
save_rule

Whether promoted results should match the filters of the current search, except for geographic filters.

ruleContexts
search

Assigns rule contexts to search queries.

Personalization

enablePersonalization
search settings

Enable the Personalization feature.

personalizationImpact
search

Define the impact of the Personalization feature.

userToken
search

Associates a certain user token with the current search.

Query strategy

queryType
search settings

Controls if and how query words are interpreted as prefixes.

removeWordsIfNoResults
settings search

Selects a strategy to remove words from the query when it doesn’t match any hits.

advancedSyntax
settings search

Enables the advanced query syntax.

optionalWords
settings search

A list of words that should be considered optional when found in the query.

disablePrefixOnAttributes
settings

List of attributes for which you want to turn off prefix matching.

disableExactOnAttributes
settings search

List of attributes for which you want to turn off the exact ranking criterion.

exactOnSingleWordQuery
settings search

Controls how the exact ranking criterion is computed when the query contains only one word.

alternativesAsExact
settings search

List of alternatives that should be considered an exact match by the exact ranking criterion.

advancedSyntaxFeatures
settings search

Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled.

Performance

numericAttributesForFiltering
settings

List of numeric attributes that can be used as numerical filters.

allowCompressionOfIntegerArray
settings

Enables compression of large integer arrays.

Advanced

attributeForDistinct
settings

Name of the attribute to deduplicate or group records.

distinct
settings search

Deduplicate or group results.

getRankingInfo
search

Retrieve detailed ranking information.

clickAnalytics
search

Add a query ID parameter to the response for tracking click and conversion events.

analytics
search

Whether the current query will be taken into account in the Analytics.

analyticsTags
search

List of tags to apply to the query for analytics purposes.

synonyms
search

Whether to take into account an index’s synonyms for a particular search.

replaceSynonymsInHighlight
settings search

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

minProximity
settings search

Precision of the proximity ranking criterion.

responseFields
settings search

Choose which fields to return in the API response. This parameters applies to search and browse queries.

maxFacetHits
settings search

Maximum number of facet hits to return during a search for facet values.

percentileComputation
search

Whether to include or exclude a query from the processing-time percentile computation.

attributeCriteriaComputedByMinProximity
settings search

When the Attribute criterion is ranked higher than Proximity in your ranking formula, Proximity selects which searchable attribute is matched in the Attribute criterion.

userData
settings

Lets you store custom data in your indices.

enableABTest
search

Whether this search should participate in running AB tests.

enableReRanking
search

Whether this search should use Dynamic Re-ranking.

renderingContent
settings

Defines how you want to render results in the search interface.

Did you find this page helpful?