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 thesetSettings
method. -
search
: They can only be used in thesearch
method. -
settings
search
: The setting can be used in thesetSettings
method and be overridden in thesearch
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
Search
query
search
|
The text to search in the 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
|
The complete list of attributes that will be used for faceting. |
unretrievableAttributes
settings
|
List of attributes that can’t be retrieved at query time. |
attributesToRetrieve
settings search
|
This parameter controls which attributes to retrieve and which not to retrieve. |
restrictSearchableAttributes
search
|
Restricts a given query to look in only a subset of your searchable attributes. This setting overrides |
Ranking
ranking
settings
|
Controls how Algolia should sort your results. |
customRanking
settings
|
Specifies the |
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 and/or tag filters. |
facetFilters
search
|
Filter hits by facet value. |
optionalFilters
search
|
Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. |
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
|
Maximum number of facet values to return for each facet during a regular search. If you want to change the number of retrieved facet hits during a search for facet values, see |
facetingAfterDistinct
search
|
Force faceting to be applied after de-duplication (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
|
List of attributes to snippet, with an optional maximum number of words to snippet. |
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. In most cases, |
offset
search
|
Specify the offset of the first hit to return. In most cases, |
length
search
|
Set the number of hits to retrieve (used only with offset). In most cases, |
paginationLimitedTo
settings
|
Set the maximum number of hits accessible via pagination. |
Typos
minWordSizefor1Typo
settings search
|
Minimum number of characters a word in the query string must contain to accept matches with 1 typo. |
minWordSizefor2Typos
settings search
|
Minimum number of characters a word in the query string must contain to accept matches with 2 typos. Changing this setting to a lower number can negatively affect relevance with short queries, because more records will be considered a match with two typos. |
typoTolerance
settings search
|
Controls whether typo tolerance is enabled and how it is applied. |
allowTyposOnNumericTokens
settings search
|
Whether to allow typos on numbers (“numeric tokens”) in the query string. |
disableTypoToleranceOnAttributes
settings search
|
List of attributes on which you want to disable typo tolerance. |
disableTypoToleranceOnWords
settings
|
A list of words for which you want to turn off typo tolerance. |
separatorsToIndex
settings
|
Control which separators are indexed. |
Geo Search
aroundLatLng
search
|
Search for entries around a central geolocation, enabling a geo search within a circular area. |
aroundLatLngViaIP
search
|
Search for entries around a given location automatically computed from the requester’s IP address. |
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 |
insideBoundingBox
search
|
Search inside a rectangular area (in geo coordinates). |
insidePolygon
search
|
Search inside a polygon (in geo 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 on which to do a decomposition of 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 the languages to be used by language-specific settings and functionalities such as |
indexLanguages
settings
|
Sets the languages at the index level for language-specific processing such as tokenization and normalization. |
naturalLanguages
search
|
This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as
|
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
|
Enables contextual rules. |
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 on which you want to disable prefix matching. |
disableExactOnAttributes
settings search
|
List of attributes on which you want to disable the |
exactOnSingleWordQuery
settings search
|
Controls how the |
alternativesAsExact
settings search
|
List of alternatives that should be considered an exact match by the |
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 de-duplication attribute to be used with the |
distinct
settings search
|
Enables de-duplication or grouping of results. |
getRankingInfo
search
|
Retrieve detailed ranking information. |
clickAnalytics
search
|
Enable the Click Analytics feature. |
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 |
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. If you want to change the number of retrieved facet values for a regular search, see |
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
|
Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules. |