algoliasearch.search

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object AddObject.type

object Analytics.type

object Browse.type

object DeleteIndex.type

object DeleteObject.type

object EditSettings.type

object Inference.type

object ListIndexes.type

object Logs.type

object Personalization.type

object Recommendation.type

object Search.type

object SeeUnretrievableAttributes.type

object Settings.type

object Usage.type

Show all

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

Acl.type

Attributes

Supertypes

class CustomSerializer[Acl]

trait Serializer[Acl]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object AddObject.type

object Clear.type

object Delete.type

object DeleteObject.type

object PartialUpdateObject.type

object PartialUpdateObjectNoCreate.type

object UpdateObject.type

Show all

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

Action.type

Attributes

Supertypes

class CustomSerializer[Action]

trait Serializer[Action]

class Object

trait Matchable

class Any

Value parameters

createdAt

Date and time when the object was created, in RFC 3339 format.

key

API key.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object ExactPhrase.type

object ExcludeWords.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

AdvancedSyntaxFeatures.type

Attributes

Supertypes

class CustomSerializer[AdvancedSyntaxFeatures]

trait Serializer[AdvancedSyntaxFeatures]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object IgnorePlurals.type

object MultiWordsSynonym.type

object SingleWordSynonym.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

AlternativesAsExact.type

Attributes

Supertypes

class CustomSerializer[AlternativesAsExact]

trait Serializer[AlternativesAsExact]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Contains.type

object EndsWith.type

object Is.type

object StartsWith.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

Anchoring.type

Attributes

Supertypes

class CustomSerializer[Anchoring]

trait Serializer[Anchoring]

class Object

trait Matchable

class Any

Value parameters

acl

Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see access control list.

description

Description of an API key to help you identify this API key.

indexes

Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (*): - dev_* matches all indices starting with "dev_". - *_dev matches all indices ending with "_dev". - *_products_* matches all indices containing "products".

maxHitsPerQuery

Maximum number of results this API key can retrieve in one query. By default, there's no limit.

maxQueriesPerIPPerHour

Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there's no limit.

queryParameters

Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address that's outside the restricted range.

referers

Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (*): - https://algolia.com/_* allows all referrers starting with "https://algolia.com/" - *.algolia.com allows all referrers ending with ".algolia.com" - *algolia.com* allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see HTTP referrer restrictions.

validity

Duration (in seconds) after which the API key expires. By default, API keys don't expire.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Add.type

object Delete.type

object Update.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

ApiKeyOperation.type

Attributes

Supertypes

class CustomSerializer[ApiKeyOperation]

trait Serializer[ApiKeyOperation]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class IntValue

class SeqOfAroundPrecisionFromValueInner

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

AroundPrecision.type

Value parameters

from

Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.

value

Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[AroundPrecision]

class Object

trait Matchable

class Any

Self type

AroundPrecisionSerializer.type

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class IntValue

trait AroundRadiusTrait

trait AroundRadiusAll

object All.type

Attributes

Companion

trait

Supertypes

class Object

trait Matchable

class Any

Self type

AroundRadius.type

Attributes

Companion

object

Supertypes

trait AroundRadiusTrait

trait AroundRadius

class Object

trait Matchable

class Any

Known subtypes

object All.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

AroundRadiusAll.type

Attributes

Supertypes

class CustomSerializer[AroundRadiusAll]

trait Serializer[AroundRadiusAll]

class Object

trait Matchable

class Any

Attributes

Supertypes

trait Serializer[AroundRadius]

class Object

trait Matchable

class Any

Self type

AroundRadiusSerializer.type

Attributes

Supertypes

trait AroundRadius

class Object

trait Matchable

class Any

Known subtypes

trait AroundRadiusAll

object All.type

Value parameters

cluster

Cluster name.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class StringValue

trait AttributeToUpdateTrait

class BuiltInOperation

Attributes

Companion

trait

Supertypes

class Object

trait Matchable

class Any

Self type

AttributeToUpdate.type

Attributes

Supertypes

trait Serializer[AttributeToUpdate]

class Object

trait Matchable

class Any

Self type

AttributeToUpdateSerializer.type

Attributes

Supertypes

trait AttributeToUpdate

class Object

trait Matchable

class Any

Known subtypes

class BuiltInOperation

Value parameters

disjunctive

Whether the filter is disjunctive or conjunctive. If true the filter has multiple matches, multiple occurences are combined with the logical OR operation. If false, multiple occurences are combined with the logical AND operation.

facet

Facet name to be applied as filter. The name must match placeholders in the pattern parameter. For example, with pattern: {facet:genre}, automaticFacetFilters must be genre.

score

Filter scores to give different weights to individual filters.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class SeqOfAutomaticFacetFilter

class SeqOfString

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

AutomaticFacetFilters.type

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object SeqOfAutomaticFacetFilterEvidence.type

object SeqOfStringEvidence.type

Attributes

Companion

trait

Supertypes

class Object

trait Matchable

class Any

Self type

AutomaticFacetFiltersEvidence.type

Attributes

Supertypes

trait Serializer[AutomaticFacetFilters]

class Object

trait Matchable

class Any

Self type

AutomaticFacetFiltersSerializer.type

Value parameters

createdAt

Timestamp when the object was created, in milliseconds since the Unix epoch.

value

API key.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

allowCompressionOfIntegerArray

Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.

attributeForDistinct

Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine attributeForDistinct with the distinct search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the afterDistinct modifier of the attributesForFaceting setting. This applies faceting after deduplication, which will result in accurate facet counts.

attributesForFaceting

Attributes used for faceting. Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. Modifiers - filterOnly(\"ATTRIBUTE\"). Allows using this attribute as a filter, but doesn't evalue the facet values. - searchable(\"ATTRIBUTE\"). Allows searching for facet values. - afterDistinct(\"ATTRIBUTE\"). Evaluates the facet count after deduplication with distinct. This ensures accurate facet counts. You can apply this modifier to searchable facets: afterDistinct(searchable(ATTRIBUTE)).

attributesToTransliterate

Attributes, for which you want to support Japanese transliteration. Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.

camelCaseAttributes

Attributes for which to split camel case words. Attribute names are case-sensitive.

customNormalization

Characters and their normalized replacements. This overrides Algolia's default normalization.

decompoundedAttributes

Searchable attributes to which Algolia should apply word segmentation (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (nl), German (de), Finnish (fi), Danish (da), Swedish (sv), and Norwegian (no).

disablePrefixOnAttributes

Searchable attributes for which you want to turn off prefix matching. Attribute names are case-sensitive.

disableTypoToleranceOnWords

Words for which you want to turn off typo tolerance. This also turns off word splitting and concatenation for the specified words.

indexLanguages

Languages for language-specific processing steps, such as word detection and dictionary settings. You should always specify an indexing 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.

numericAttributesForFiltering

Numeric attributes that can be used as numerical filters. Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your index, such as NO_NUMERIC_FILTERING. Modifier - equalOnly(\"ATTRIBUTE\"). Support only filtering based on equality comparisons = and !=.

paginationLimitedTo

Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.

replicas

Creates replica indices. Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. Modifier - virtual(\"REPLICA\"). Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for Relevant sorting.

searchableAttributes

Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the Attribute ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of searchableAttributes rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as \"title,alternate_title\". Attributes with the same priority are always unordered. For more information, see Searchable attributes. Modifier - unordered(\"ATTRIBUTE\"). Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end.

separatorsToIndex

Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With separatorsToIndex, Algolia treats separator characters as separate words. For example, a search for C# would report two matches.

unretrievableAttributes

Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to restrict access, but don't want to include it in the search results. Attribute names are case-sensitive.

userData

An object with custom data. You can store up to 32 kB as custom data.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

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

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.

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.

length

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

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.

page

Page of search results to retrieve.

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.

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.

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

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

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

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.

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.

length

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

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.

page

Page of search results to retrieve.

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.

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.

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

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

abTestID

A/B test ID. This is only included in the response for indices that are part of an A/B test.

abTestVariantID

Variant ID. This is only included in the response for indices that are part of an A/B test.

aroundLatLng

Computed geographical location.

automaticRadius

Distance from a central coordinate provided by aroundLatLng.

exhaustiveFacetsCount

See the facetsCount field of the exhaustive object in the response.

exhaustiveNbHits

See the nbHits field of the exhaustive object in the response.

exhaustiveTypo

See the typo field of the exhaustive object in the response.

facets

Facet counts.

facetsStats

Statistics for numerical facets.

hitsPerPage

Number of hits per page.

index

Index name used for the query.

indexUsed

Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

message

Warnings about the query.

nbHits

Number of results (hits).

nbPages

Number of pages of results.

nbSortedHits

Number of hits selected and sorted by the relevant sort algorithm.

page

Page of search results to retrieve.

parsedQuery

Post-normalization query string that will be searched.

processingTimeMS

Time the server took to process the request, in milliseconds.

processingTimingsMS

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

queryAfterRemoval

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

queryID

Unique identifier for the query. This is used for click analytics.

serverTimeMS

Time the server took to process the request, in milliseconds.

serverUsed

Host name of the server that processed the request.

userData

An object with custom data. You can store up to 32 kB as custom data.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[BaseSearchResponse]

class Object

trait Matchable

class Any

Value parameters

cluster

Cluster name.

users

User IDs to assign.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

clearExistingDictionaryEntries

Whether to replace all custom entries in the dictionary with the ones sent with this request.

requests

List of additions and deletions to your dictionaries.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

body

Operation arguments (varies with specified action).

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

objectIDs

Unique record identifiers.

taskID

Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this taskID.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

trait BrowseParamsTrait

class BrowseParamsObject

class SearchParamsString

Attributes

Companion

trait

Supertypes

class Object

trait Matchable

class Any

Self type

BrowseParams.type

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.

cursor

Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a cursor attribute.

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.

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.

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.

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

Supertypes

trait Serializable

trait Product

trait Equals

trait BrowseParamsTrait

trait BrowseParams

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[BrowseParams]

class Object

trait Matchable

class Any

Self type

BrowseParamsSerializer.type

Attributes

Supertypes

trait BrowseParams

class Object

trait Matchable

class Any

Known subtypes

class BrowseParamsObject

class SearchParamsString

Value parameters

abTestID

A/B test ID. This is only included in the response for indices that are part of an A/B test.

abTestVariantID

Variant ID. This is only included in the response for indices that are part of an A/B test.

aroundLatLng

Computed geographical location.

automaticRadius

Distance from a central coordinate provided by aroundLatLng.

cursor

Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a cursor attribute.

exhaustiveFacetsCount

See the facetsCount field of the exhaustive object in the response.

exhaustiveNbHits

See the nbHits field of the exhaustive object in the response.

exhaustiveTypo

See the typo field of the exhaustive object in the response.

facets

Facet counts.

facetsStats

Statistics for numerical facets.

hits

Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.

hitsPerPage

Number of hits per page.

index

Index name used for the query.

indexUsed

Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

message

Warnings about the query.

nbHits

Number of results (hits).

nbPages

Number of pages of results.

nbSortedHits

Number of hits selected and sorted by the relevant sort algorithm.

page

Page of search results to retrieve.

params

URL-encoded string of all search parameters.

parsedQuery

Post-normalization query string that will be searched.

processingTimeMS

Time the server took to process the request, in milliseconds.

processingTimingsMS

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

query

Search query.

queryAfterRemoval

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

queryID

Unique identifier for the query. This is used for click analytics.

serverTimeMS

Time the server took to process the request, in milliseconds.

serverUsed

Host name of the server that processed the request.

userData

An object with custom data. You can store up to 32 kB as custom data.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

value

Value that corresponds to the operation, for example an Increment or Decrement step, or an Add or Remove value.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

trait AttributeToUpdateTrait

trait AttributeToUpdate

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Add.type

object AddUnique.type

object Decrement.type

object Increment.type

object IncrementFrom.type

object IncrementSet.type

object Remove.type

Show all

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

BuiltInOperationType.type

Attributes

Supertypes

class CustomSerializer[BuiltInOperationType]

trait Serializer[BuiltInOperationType]

class Object

trait Matchable

class Any

Value parameters

alternatives

Whether the pattern should match plurals, synonyms, and typos.

context

An additional restriction that only triggers the rule, when the search has the same value as ruleContexts parameter. For example, if context: mobile, the rule is only triggered when the search request has a matching ruleContexts: mobile. A rule context must only contain alphanumeric characters.

filters

Filters that trigger the rule. You can add add filters using the syntax facet:value so that the rule is triggered, when the specific filter is selected. You can use filters on its own or combine it with the pattern parameter.

pattern

Query pattern that triggers the rule. You can use either a literal string, or a special pattern {facet:ATTRIBUTE}, where ATTRIBUTE is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with pattern: {facet:genre}, the rule is triggered when users search for a genre, such as "comedy".

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

filterPromotes

Whether promoted records must match an active filter for the consequence to be applied. This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the color: red attribute, and the user filters the search for color: blue, the "red" record won't be shown.

hide

Records you want to hide from the search results.

promote

Records you want to pin to a specific position in the search results. You can promote up to 300 records, either individually, or as groups of up to 100 records each.

userData

A JSON object with custom data that will be appended to the userData array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

objectID

Unique record identifier.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

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.

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.

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.

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.

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

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class StringValue

trait ConsequenceQueryTrait

class ConsequenceQueryObject

Attributes

Companion

trait

Supertypes

class Object

trait Matchable

class Any

Self type

ConsequenceQuery.type

Value parameters

edits

Changes to make to the search query.

remove

Words to remove from the search query.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

trait ConsequenceQueryTrait

trait ConsequenceQuery

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[ConsequenceQuery]

class Object

trait Matchable

class Any

Self type

ConsequenceQuerySerializer.type

Attributes

Supertypes

trait ConsequenceQuery

class Object

trait Matchable

class Any

Known subtypes

class ConsequenceQueryObject

Value parameters

createdAt

Date and time when the object was created, in RFC 3339 format.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

cursor

Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a cursor attribute.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

deletedAt

Date and time when the object was deleted, in RFC 3339 format.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

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.

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.

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.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

deletedAt

Date and time when the object was deleted, in RFC 3339 format.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

deletedAt

Date and time when the object was deleted, in RFC 3339 format.

taskID

Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this taskID.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object AddEntry.type

object DeleteEntry.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

DictionaryAction.type

Attributes

Supertypes

class CustomSerializer[DictionaryAction]

trait Serializer[DictionaryAction]

class Object

trait Matchable

class Any

Value parameters

decomposition

Invividual components of a compound word in the compounds dictionary.

objectID

Unique identifier for the dictionary entry.

word

Matching dictionary word for stopwords and compounds dictionaries.

words

Matching words in the plurals dictionary including declensions.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[DictionaryEntry]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Disabled.type

object Enabled.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

DictionaryEntryState.type

Attributes

Supertypes

class CustomSerializer[DictionaryEntryState]

trait Serializer[DictionaryEntryState]

class Object

trait Matchable

class Any

Value parameters

nbCustomEntries

Number of custom dictionary entries.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Compounds.type

object Plurals.type

object Stopwords.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

DictionaryType.type

Attributes

Supertypes

class CustomSerializer[DictionaryType]

trait Serializer[DictionaryType]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class BooleanValue

class IntValue

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

Distinct.type

Attributes

Supertypes

trait Serializer[Distinct]

class Object

trait Matchable

class Any

Self type

DistinctSerializer.type

Value parameters

delete

Text or patterns to remove from the query string.

insert

Text to be added in place of the deleted text inside the query string.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Remove.type

object Replace.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

EditType.type

Attributes

Supertypes

class CustomSerializer[EditType]

trait Serializer[EditType]

class Object

trait Matchable

class Any

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Supertypes

trait Serializer[ErrorBase]

class Object

trait Matchable

class Any

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

object Attribute.type

object None.type

object Word.type

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

ExactOnSingleWordQuery.type

Attributes

Supertypes

class CustomSerializer[ExactOnSingleWordQuery]

trait Serializer[ExactOnSingleWordQuery]

class Object

trait Matchable

class Any

Value parameters

facetValues

The value is false if not all facet values are retrieved.

facetsCount

Whether the facet count is exhaustive (true) or approximate (false). See the related discussion.

nbHits

Whether the nbHits is exhaustive (true) or approximate (false). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). nbHits is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.

rulesMatch

Rules matching exhaustivity. The value is false if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.

typo

Whether the typo search was exhaustive (true) or approximate (false). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

object

Supertypes

class Object

trait Matchable

class Any

Known subtypes

class SeqOfMixedSearchFilters

class StringValue

Attributes

Companion

trait

Supertypes

trait Sum

trait Mirror

class Object

trait Matchable

class Any

Self type

FacetFilters.type

Attributes

Supertypes

trait Serializer[FacetFilters]

class Object

trait Matchable

class Any

Self type

FacetFiltersSerializer.type

Value parameters

count

Number of records with this facet value. The count may be approximated.

highlighted

Highlighted attribute value, including HTML tags.

value

Facet value.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

values

Order of facet values. One object for each facet.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

order

Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.

Attributes

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Value parameters

avg

Average facet value in the results.

max

Maximum value in the results.

min

Minimum value in the results.

sum

Sum of all values in the results.