BaseSearchParamsWithoutQuery

Value parameters

analytics

Indicates whether this query will be included in analytics.

analyticsTags

Tags to apply to the query for segmenting analytics data.

aroundLatLng

Search for entries around a central location, enabling a geographical search within a circular area.

aroundLatLngViaIP

Search for entries around a location. The location is automatically computed from the requester's IP address.

clickAnalytics

Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.

enableABTest

Incidates whether this search will be considered in A/B testing.

explain

Enriches the API's response with information about how the query was processed.

facetingAfterDistinct

Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the afterDistinct modifier of attributesForFaceting allows for more granular control.

facets

Returns facets, their facet values, and the number of matching facet values.

filters

Filter the query with numeric, facet, or tag filters.

getRankingInfo

Incidates whether the search response includes detailed ranking information.

insideBoundingBox

Search inside a rectangular area (in geographical coordinates).

insidePolygon

Search inside a polygon (in geographical coordinates).

length

Sets the number of hits to retrieve (for use with offset). > Note: Using page and hitsPerPage is the recommended method for paging results. However, you can use offset and length to implement an alternative approach to paging.

minimumAroundRadius

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

naturalLanguages

Changes the default values of parameters that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags, and ruleContexts. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.

offset

Specifies the offset of the first hit to return. > Note: Using page and hitsPerPage is the recommended method for paging results. However, you can use offset and length to implement an alternative approach to paging.

page

Page to retrieve (the first page is 0, not 1).

percentileComputation

Whether to include or exclude a query from the processing-time percentile computation.

personalizationImpact

Defines how much Personalization affects results.

restrictSearchableAttributes

Restricts a query to only look at a subset of your searchable attributes.

ruleContexts

Assigns rule contexts to search queries.

similarQuery

Overrides the query parameter and performs a more generic search.

sumOrFiltersScores

Determines how to calculate filter scores. If false, maximum score is kept. If true, score is summed.

synonyms

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

userToken

Associates a user token with the current search.

Attributes

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all