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
search: They can only be used in the
search: The setting can be used in the
setSettingsmethod and be overridden in the
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](/doc/guides/managing-results/relevance-overview/#index-setting-and-query-parameters).
| query || |
The text to search in the index.
| searchableAttributes || |
The complete list of attributes that will be used for searching.
| attributesForFaceting || |
The complete list of attributes that will be used for faceting.
| unretrievableAttributes || |
List of attributes that cannot be retrieved at query time.
| attributesToRetrieve || |
Gives control over which attributes to retrieve and which not to retrieve.
| restrictSearchableAttributes || |
Restricts a given query to look in only a subset of your searchable attributes.
This setting overrides searchableAttributes for specific searches.
| ranking || |
Controls the way results are sorted.
| customRanking || |
| replicas || |
Creates replicas, exact copies of an index.
| filters || |
Filter the query with numeric, facet and/or tag filters.
| facetFilters || |
Filter hits by facet value.
| optionalFilters || |
Create filters for ranking purposes, where records that match the filter are ranked highest.
| numericFilters || |
Filter on numeric attributes.
| tagFilters || |
Filter hits by tags.
| sumOrFiltersScores || |
Determines how to calculate the total score for filtering.
| facets || |
Facets to retrieve.
| maxValuesPerFacet || |
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 maxFacetHits.
| facetingAfterDistinct || |
Force faceting to be applied after de-duplication (via the Distinct setting).
| sortFacetValuesBy || |
Controls how facet values are sorted.
| attributesToHighlight || |
List of attributes to highlight.
| attributesToSnippet || |
List of attributes to snippet, with an optional maximum number of words to snippet.
| highlightPreTag || |
The HTML string to insert before the highlighted parts in all highlight and snippet results.
| highlightPostTag || |
The HTML string to insert after the highlighted parts in all highlight and snippet results.
| snippetEllipsisText || |
String used as an ellipsis indicator when a snippet is truncated.
| restrictHighlightAndSnippetArrays || |
Restrict highlighting and snippeting to items that matched the query.
| page || |
Specify the page to retrieve.
| hitsPerPage || |
Set the number of hits per page.
| offset || |
Specify the offset of the first hit to return.
| length || |
Set the number of hits to retrieve (used only with offset).
| paginationLimitedTo || |
Set the maximum number of hits accessible via pagination.
| minWordSizefor1Typo || |
Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
| minWordSizefor2Typos || |
Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
| typoTolerance || |
Controls whether typo tolerance is enabled and how it is applied.
| allowTyposOnNumericTokens || |
Whether to allow typos on numbers (“numeric tokens”) in the query string.
| disableTypoToleranceOnAttributes || |
List of attributes on which you want to disable typo tolerance.
| disableTypoToleranceOnWords || |
List of words on which you want to disable typo tolerance.
| separatorsToIndex || |
Control which separators are indexed.
| aroundLatLng || |
Search for entries around a central geolocation, enabling a geo search within a circular area.
| aroundLatLngViaIP || |
Search for entries around a given location automatically computed from the requester’s IP address.
| aroundRadius || |
Define the maximum radius for a geo search (in meters).
| aroundPrecision || |
Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
| minimumAroundRadius || |
Minimum radius (in meters) used for a geo search when aroundRadius is not set.
| insideBoundingBox || |
Search inside a rectangular area (in geo coordinates).
| insidePolygon || |
Search inside a polygon (in geo coordinates).
| ignorePlurals || |
Treats singular, plurals, and other forms of declensions as matching terms.
| removeStopWords || |
Removes stop (common) words from the query before executing it.
| camelCaseAttributes || |
List of attributes on which to do a decomposition of camel case words.
| decompoundedAttributes || |
Specify on which attributes in your index Algolia should apply word-splitting (“decompounding”).
| keepDiacriticsOnCharacters || |
Characters that should not be automatically normalized by the search engine.
| queryLanguages |
| enableRules || |
Whether rules should be globally enabled.
| ruleContexts || |
Enables contextual rules.
| enablePersonalization || |
Enable the Personalization feature.
| queryType || |
Controls if and how query words are interpreted as prefixes.
| removeWordsIfNoResults || |
Selects a strategy to remove words from the query when it doesn’t match any hits.
| advancedSyntax || |
Enables the advanced query syntax.
| optionalWords || |
A list of words that should be considered as optional when found in the query.
| disablePrefixOnAttributes || |
List of attributes on which you want to disable prefix matching.
| disableExactOnAttributes || |
List of attributes on which you want to disable the
| exactOnSingleWordQuery || |
Controls how the
| alternativesAsExact || |
List of alternatives that should be considered an exact match by the
| numericAttributesForFiltering || |
List of numeric attributes that can be used as numerical filters.
| allowCompressionOfIntegerArray || |
Enables compression of large integer arrays.
| attributeForDistinct || |
Name of the de-duplication attribute to be used with the distinct feature.
| distinct || |
Enables de-duplication or grouping of results.
| getRankingInfo || |
Retrieve detailed ranking information.
| clickAnalytics || |
Enable the Click Analytics feature.
| analytics || |
Whether the current query will be taken into account in the Analytics.
| analyticsTags || |
List of tags to apply to the query for analytics purposes.
| synonyms || |
Whether to take into account an index’s synonyms for a particular search.
| replaceSynonymsInHighlight || |
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
| minProximity || |
Precision of the
| responseFields || |
Choose which fields the response will contain. Applies to search and browse queries.
| maxFacetHits || |
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 maxValuesPerFacet.
| percentileComputation || |
Whether to include or exclude a query from the processing-time percentile computation.