Params

Value parameters

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 a 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.

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.

enableABTest

Whether to enable A/B testing for this search.

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.

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.

hitsPerPage

Number of hits per page.

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.

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.

page

Page of search results to retrieve.

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.

ruleContexts

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

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

class Object

trait Matchable

class Any

Show all