Each parameter in this page has a scope. Depending on the scope, you can use the parameter within the
setSettings and/or the
There are three scopes:
settings: The setting can only be used in the
search: The setting can only be used in the
search: The setting can be used in the
setSettingsmethod and be overridden in the
| query || |
The text to search for in the index.
| searchableAttributes || |
List of attributes eligible for textual search.
| attributesForFaceting || |
List of attributes you want to use for faceting.
| unretrievableAttributes || |
List of attributes that cannot be retrieved at query time.
| attributesToRetrieve || |
List of object attributes you want to retrieve.
| restrictSearchableAttributes || |
List of attributes to be considered for textual search.
| ranking || |
Controls the way results are sorted.
| customRanking || |
| replicas || |
List of indices to which you want to replicate all write operations.
| filters || |
Filter the query with numeric, facet and/or tag filters.
| facetFilters || |
Filter hits by facet value.
| optionalFilters || |
Create filters for ranking purposes, to rank higher records that contain the filter(s)
| numericFilters || |
Filter hits based on values of 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 returned for each facet.
| facetingAfterDistinct || |
Force faceting to be applied after de-duplication.
| sortFacetValuesBy || |
Controls how facet values are sorted.
Highlighting / Snippeting
| attributesToHighlight || |
List of attributes to highlight.
| attributesToSnippet || |
List of attributes to snippet, with an optional maximum number of words to snippet.
| highlightPreTag || |
String inserted before highlighted parts in highlight and snippet results.
| highlightPostTag || |
String inserted after highlighted parts in highlight and snippet results.
| snippetEllipsisText || |
String used as an ellipsis indicator when a snippet is truncated.
| restrictHighlightAndSnippetArrays || |
Restrict arrays in highlight and snippet results 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 one typo.
| minWordSizefor2Typos || |
Minimum number of characters a word in the query string must contain to accept matches with two 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.
| ignorePlurals || |
Consider singular and plurals forms a match without typo.
| disableTypoToleranceOnAttributes || |
List of attributes on which you want to disable typo tolerance
| disableTypoToleranceOnWords || |
List of words on which typo tolerance will be disabled.
| separatorsToIndex || |
Separators (punctuation characters) to index.
| aroundLatLng || |
Search for entries around a given location.
| aroundLatLngViaIP || |
Search for entries around a given location automatically computed from the requester’s IP address.
| aroundRadius || |
Maximum radius for geo search (in meters).
| aroundPrecision || |
Precision of geo search (in meters).
| 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).
| 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 || |
List of words that should be considered as optional when found in the query.
| removeStopWords || |
Remove stop words from the query before executing it.
| disablePrefixOnAttributes || |
List of attributes on which you want to disable prefix matching
| disableExactOnAttributes || |
List of attributes on which you want to disable computation of the
| exactOnSingleWordQuery || |
Controls how the
| alternativesAsExact || |
List of alternatives that should be considered an exact match by the
| enableRules || |
Whether rules should be globally enabled.
| ruleContexts || |
Enables contextual rules.
| 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 for the distinct feature.
| 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.
| percentileComputation || |
Whether to include the query in processing time percentile computation.
| camelCaseAttributes || |
List of attributes on which to do a decomposition of camel case words.
| distinct || |
Controls de-duplication of results.
| getRankingInfo || |
Enables detailed ranking information.
| analytics || |
Whether the current query will be taken into account in the Analytics.
| analyticsTags || |
List of tags to apply to the query in the analytics.
| synonyms || |
Whether to take into account synonyms defined for the targeted index.
| replaceSynonymsInHighlight || |
Whether to replace words matched via synonym expansion by the matched synonym in highlight and snippet results.
Did you find this page helpful?
We're always looking for advice to help improve our documentation!
Please let us know what's working (or what's not!).
We're constantly iterating thanks to the feedback we receive.