BrowseParamsObject

Value parameters

advancedSyntax

Enables the advanced query syntax.

advancedSyntaxFeatures

Allows you to specify which advanced syntax features are active when advancedSyntax is enabled.

allowTyposOnNumericTokens

Whether to allow typos on numbers ("numeric tokens") in the query string.

alternativesAsExact

Alternatives that should be considered an exact match by the exact ranking criterion.

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.

attributeCriteriaComputedByMinProximity

When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.

attributesForFaceting

Attributes used for faceting and the modifiers that can be applied: filterOnly, searchable, and afterDistinct.

attributesToHighlight

Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (highlightPreTag and highlightPostTag).

attributesToRetrieve

Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.

attributesToSnippet

Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: body:20.

clickAnalytics

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

cursor

Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, cursor is absent from the response.

customRanking

Specifies the Custom ranking criterion. Use the asc and desc modifiers to specify the ranking order: ascending or descending.

decompoundQuery

Splits compound words into their component word parts in the query.

disableExactOnAttributes

Attributes for which you want to turn off the exact ranking criterion.

disableTypoToleranceOnAttributes

Attributes for which you want to turn off typo tolerance.

enableABTest

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

enablePersonalization

Incidates whether Personalization is enabled.

enableReRanking

Indicates whether this search will use Dynamic Re-Ranking.

enableRules

Incidates whether Rules are enabled.

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.

highlightPostTag

HTML string to insert after the highlighted parts in all highlight and snippet results.

highlightPreTag

HTML string to insert before the highlighted parts in all highlight and snippet results.

hitsPerPage

Number of hits per page.

insideBoundingBox

Search inside a rectangular area (in geographical coordinates).

insidePolygon

Search inside a polygon (in geographical coordinates).

keepDiacriticsOnCharacters

Characters that the engine shouldn't automatically normalize.

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.

maxFacetHits

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

maxValuesPerFacet

Maximum number of facet values to return for each facet.

minProximity

Precision of the proximity ranking criterion.

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.

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.

optionalWords

Words which should be considered optional when found in a query.

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.

query

Text to search for in an index.

queryLanguages

Sets your user's search language. This adjusts language-specific settings and features such as ignorePlurals, removeStopWords, and CJK word detection.

ranking

Determines the order in which Algolia returns your results.

relevancyStrictness

Relevancy threshold below which less relevant results aren't included in the results.

replaceSynonymsInHighlight

Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

responseFields

Attributes to include in the API response for search and browse queries.

restrictHighlightAndSnippetArrays

Restrict highlighting and snippeting to items that matched the query.

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.

snippetEllipsisText

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

sortFacetValuesBy

Controls how facet values are fetched.

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

trait BrowseParamsTrait

trait BrowseParams

class Object

trait Matchable

class Any

Show all