SearchForFacets

Value parameters

advancedSyntax

Whether to support phrase matching and excluding words from search queries. Use the advancedSyntaxFeatures parameter to control which feature is supported.

advancedSyntaxFeatures

Advanced search syntax features you want to support. - exactPhrase. Phrases in quotes must match exactly. For example, sparkly blue \"iPhone case\" only returns records with the exact string "iPhone case". - excludeWords. Query words prefixed with a - must not occur in a record. For example, search -engine matches records that contain "search" but not "engine". This setting only has an effect if advancedSyntax is true.

allowTyposOnNumericTokens

Whether to allow typos on numbers in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

alternativesAsExact

Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - ignorePlurals. Plurals and similar declensions added by the ignorePlurals setting are considered exact matches. - singleWordSynonym. Single-word synonyms, such as "NY/NYC" are considered exact matches. - multiWordsSynonym. Multi-word synonyms, such as "NY/New York" are considered exact matches.

analytics

Whether this search will be included in Analytics.

analyticsTags

Tags to apply to the query for segmenting analytics data.

aroundLatLng

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the aroundRadius and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

aroundLatLngViaIP

Whether to obtain the coordinates from the request's IP address.

attributeCriteriaComputedByMinProximity

Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the ranking setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the searchableAttributes setting.

attributesToHighlight

Attributes to highlight. By default, all searchable attributes are highlighted. Use * to highlight all attributes or use an empty array [] to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by highlightPreTag and highlightPostTag. You can use this to visually highlight matching parts of a search query in your UI. For more information, see Highlighting and snippeting.

attributesToRetrieve

Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - * retrieves all attributes, except attributes included in the customRanking and unretrievableAttributes settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the *: [\"*\", \"-ATTRIBUTE\"]. - The objectID attribute is always included.

attributesToSnippet

Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: ATTRIBUTE:NUMBER, where NUMBER is the number of words to be extracted.

clickAnalytics

Whether to include a queryID attribute in the response. The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

customRanking

Attributes to use as custom ranking. Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. Modifiers - asc(\"ATTRIBUTE\"). Sort the index by the values of an attribute, in ascending order. - desc(\"ATTRIBUTE\"). Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, reduce the precision of your first attributes, or the other attributes will never be applied.

decompoundQuery

Whether to split compound words into their building blocks. For more information, see Word segmentation. Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.

disableExactOnAttributes

Searchable attributes for which you want to turn off the Exact ranking criterion. Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

disableTypoToleranceOnAttributes

Attributes for which you want to turn off typo tolerance. Attribute names are case-sensitive. Returning only exact matches can help when: - Searching in hyphenated attributes. - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as disableTypoToleranceOnWords or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

enableABTest

Whether to enable A/B testing for this search.

enablePersonalization

Whether to enable Personalization.

enableReRanking

Whether this search will use Dynamic Re-Ranking. This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

enableRules

Whether to enable rules.

facet

Facet name.

facetQuery

Text to search inside the facet's values.

facetingAfterDistinct

Whether faceting should be applied after deduplication with distinct. This leads to accurate facet counts when using faceting in combination with distinct. It's usually better to use afterDistinct modifiers in the attributesForFaceting setting, as facetingAfterDistinct only computes correct facet counts if all records have the same facet values for the attributeForDistinct.

facets

Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character *. For more information, see facets.

filters

Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=. - Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive). - Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value. - Tag filters. _tags:<value> or just <value> (case-sensitive). - Boolean filters. <facet>: true | false. You can combine filters with AND, OR, and NOT operators with the following restrictions: - You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3. - You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value) - You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value) Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see Filters.

getRankingInfo

Whether the search response should include detailed ranking information.

highlightPostTag

HTML tag to insert after the highlighted parts in all highlighted results and snippets.

highlightPreTag

HTML tag to insert before the highlighted parts in all highlighted results and snippets.

hitsPerPage

Number of hits per page.

indexName

Index name (case-sensitive).

insideBoundingBox

Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: [p1 lat, p1 long, p2 lat, p2 long]. Provide multiple bounding boxes as nested arrays. For more information, see rectangular area.

insidePolygon

Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see filtering inside polygons. This parameter is ignored if you also specify insideBoundingBox.

keepDiacriticsOnCharacters

Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, é becomes e. If this causes issues in your search, you can specify characters that should keep their diacritics.

length

Number of hits to retrieve (used in combination with offset).

maxFacetHits

Maximum number of facet values to return when searching for facet values.

maxValuesPerFacet

Maximum number of facet values to return for each facet.

minProximity

Minimum proximity score for two matching words. This adjusts the Proximity ranking criterion by equally scoring matches that are farther apart. For example, if minProximity is 2, neighboring matches and matches with one word between them would have the same score.

minWordSizefor1Typo

Minimum number of characters a word in the search query must contain to accept matches with one typo.

minWordSizefor2Typos

Minimum number of characters a word in the search query must contain to accept matches with two typos.

minimumAroundRadius

Minimum radius (in meters) for a search around a location when aroundRadius isn't set.

naturalLanguages

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets removeStopWords and ignorePlurals to the list of provided languages. - Sets removeWordsIfNoResults to allOptional. - Adds a natural_language attribute to ruleContexts and analyticsTags.

offset

Position of the first hit to retrieve.

optionalWords

Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is an optional word, the search engine runs two queries. One for "action video" and one for "action". Records that match all words are ranked higher. For a search query with 4 or more words and all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If optionalWords has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If optionalWords has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see Optional words.

page

Page of search results to retrieve.

params

Search parameters as a URL-encoded query string.

percentileComputation

Whether to include this search when calculating processing-time percentiles.

personalizationImpact

Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see Understanding Personalization impact.

query

Search query.

queryLanguages

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first. You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ranking

Determines the order in which Algolia returns your results. By default, each entry corresponds to a ranking criteria. The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for sorting by an attribute, you put the sorting attribute at the top of the list. Modifiers - asc(\"ATTRIBUTE\"). Sort the index by the values of an attribute, in ascending order. - desc(\"ATTRIBUTE\"). Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by A/B testing.

relevancyStrictness

Relevancy threshold below which less relevant results aren't included in the results. You can only set relevancyStrictness on virtual replica indices. Use this setting to strike a balance between the relevance and number of returned results.

replaceSynonymsInHighlight

Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with home as a synonym for house and a search for home, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted. With replaceSynonymsInHighlight set to true, a search for home still matches the same records, but all occurences of "house" are replaced by "home" in the highlighted response.

responseFields

Properties to include in the API response of search and browse requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can't exclude these properties: message, warning, cursor, serverUsed, indexUsed, abTestVariantID, parsedQuery, or any property triggered by the getRankingInfo parameter. Don't exclude properties that you might need in your search UI.

restrictHighlightAndSnippetArrays

Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

restrictSearchableAttributes

Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.

ruleContexts

Assigns a rule context to the search query. Rule contexts are strings that you can use to trigger matching rules.

similarQuery

Keywords to be used instead of the search query to conduct a more broader search. Using the similarQuery parameter changes other settings: - queryType is set to prefixNone. - removeStopWords is set to true. - words is set as the first ranking criterion. - All remaining words are treated as optionalWords. Since the similarQuery is supposed to do a broad search, they usually return many results. Combine it with filters to narrow down the list of results.

snippetEllipsisText

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

sortFacetValuesBy

Order in which to retrieve facet values. - count. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. - alpha. Retrieve facet values alphabetically. This setting doesn't influence how facet values are displayed in your UI (see renderingContent). For more information, see facet value display.

sumOrFiltersScores

Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see filter scores.

synonyms

Whether to take into account an index's synonyms for this search.

userToken

Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see user token.

Attributes

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

trait SearchQueryTrait

trait SearchQuery

class Object

trait Matchable

class Any

Show all