algoliasearch.recommend

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object ExactPhrase.type

object ExcludeWords.type

AdvancedSyntaxFeatures enumeration

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

AlternativesAsExact enumeration

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

Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal.

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

Range object with lower and upper values in meters to define custom ranges.

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

Maximum radius for a search around a central location. This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

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

Return all records with a valid _geoloc attribute. Don't filter by distance.

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

Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.

Value parameters

facet: Facet attribute.
negative: Whether the filter is negative. If true, recommendations must not have the same value for the facet attribute. If false, recommendations must have the same value for the facet attribute.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

BaseRecommendRequest

Value parameters

indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

case class BaseSearchParams(query: Option[String], similarQuery: Option[String], filters: Option[String], facetFilters: Option[FacetFilters], optionalFilters: Option[OptionalFilters], numericFilters: Option[NumericFilters], tagFilters: Option[TagFilters], sumOrFiltersScores: Option[Boolean], restrictSearchableAttributes: Option[Seq[String]], facets: Option[Seq[String]], facetingAfterDistinct: Option[Boolean], page: Option[Int], offset: Option[Int], length: Option[Int], aroundLatLng: Option[String], aroundLatLngViaIP: Option[Boolean], aroundRadius: Option[AroundRadius], aroundPrecision: Option[AroundPrecision], minimumAroundRadius: Option[Int], insideBoundingBox: Option[Seq[Seq[Double]]], insidePolygon: Option[Seq[Seq[Double]]], naturalLanguages: Option[Seq[SupportedLanguage]], ruleContexts: Option[Seq[String]], personalizationImpact: Option[Int], userToken: Option[String], getRankingInfo: Option[Boolean], synonyms: Option[Boolean], clickAnalytics: Option[Boolean], analytics: Option[Boolean], analyticsTags: Option[Seq[String]], percentileComputation: Option[Boolean], enableABTest: Option[Boolean])

BaseSearchParams

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

case class BaseSearchParamsWithoutQuery(similarQuery: Option[String], filters: Option[String], facetFilters: Option[FacetFilters], optionalFilters: Option[OptionalFilters], numericFilters: Option[NumericFilters], tagFilters: Option[TagFilters], sumOrFiltersScores: Option[Boolean], restrictSearchableAttributes: Option[Seq[String]], facets: Option[Seq[String]], facetingAfterDistinct: Option[Boolean], page: Option[Int], offset: Option[Int], length: Option[Int], aroundLatLng: Option[String], aroundLatLngViaIP: Option[Boolean], aroundRadius: Option[AroundRadius], aroundPrecision: Option[AroundPrecision], minimumAroundRadius: Option[Int], insideBoundingBox: Option[Seq[Seq[Double]]], insidePolygon: Option[Seq[Seq[Double]]], naturalLanguages: Option[Seq[SupportedLanguage]], ruleContexts: Option[Seq[String]], personalizationImpact: Option[Int], userToken: Option[String], getRankingInfo: Option[Boolean], synonyms: Option[Boolean], clickAnalytics: Option[Boolean], analytics: Option[Boolean], analyticsTags: Option[Seq[String]], percentileComputation: Option[Boolean], enableABTest: Option[Boolean])

BaseSearchParamsWithoutQuery

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

case class BaseSearchResponse(abTestID: Option[Int], abTestVariantID: Option[Int], aroundLatLng: Option[String], automaticRadius: Option[String], exhaustive: Option[Exhaustive], exhaustiveFacetsCount: Option[Boolean], exhaustiveNbHits: Option[Boolean], exhaustiveTypo: Option[Boolean], facets: Option[Map[String, Map[String, Int]]], facetsStats: Option[Map[String, FacetsStats]], hitsPerPage: Int, index: Option[String], indexUsed: Option[String], message: Option[String], nbHits: Int, nbPages: Int, nbSortedHits: Option[Int], page: Int, parsedQuery: Option[String], processingTimeMS: Int, processingTimingsMS: Option[Any], queryAfterRemoval: Option[String], redirect: Option[Redirect], renderingContent: Option[RenderingContent], serverTimeMS: Option[Int], serverUsed: Option[String], userData: Option[Any], queryID: Option[String], additionalProperties: Option[List[JField]])

BaseSearchResponse

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

BoughtTogetherQuery

Value parameters

indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
objectID: Unique record identifier.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.

Value parameters

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Effect of the rule.

Value parameters

hide: Exclude items from recommendations.
promote: Place items at specific positions in the list of recommendations.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Response, taskID, and deletion timestamp.

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

Determines how many records of a group are included in the search results. Records with the same value for the attributeForDistinct attribute are considered a group. The distinct setting controls how many members of the group are returned. This is useful for deduplication and grouping. The distinct setting is ignored if attributeForDistinct is not set.

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

Error.

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

Determines how the Exact ranking criterion is computed when the search query has only one word. - attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - none. The Exact ranking criterion is ignored on single-word searches. - word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.

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

Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

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

Filter the search by facet values, so that only records with the same facet values are retrieved. Prefer using the filters parameter, which supports all filter types and combinations with boolean operators. - [filter1, filter2] is interpreted as filter1 AND filter2. - [[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3. - facet:-value is interpreted as NOT facet:value. While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\\-value.

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

Order of facet names and facet values in your UI.

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

Order of facet names.

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

FacetsStats

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.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

case class FallbackParams(query: Option[String], similarQuery: Option[String], filters: Option[String], facetFilters: Option[FacetFilters], optionalFilters: Option[OptionalFilters], numericFilters: Option[NumericFilters], tagFilters: Option[TagFilters], sumOrFiltersScores: Option[Boolean], restrictSearchableAttributes: Option[Seq[String]], facets: Option[Seq[String]], facetingAfterDistinct: Option[Boolean], page: Option[Int], offset: Option[Int], length: Option[Int], aroundLatLng: Option[String], aroundLatLngViaIP: Option[Boolean], aroundRadius: Option[AroundRadius], aroundPrecision: Option[AroundPrecision], minimumAroundRadius: Option[Int], insideBoundingBox: Option[Seq[Seq[Double]]], insidePolygon: Option[Seq[Seq[Double]]], naturalLanguages: Option[Seq[SupportedLanguage]], ruleContexts: Option[Seq[String]], personalizationImpact: Option[Int], userToken: Option[String], getRankingInfo: Option[Boolean], synonyms: Option[Boolean], clickAnalytics: Option[Boolean], analytics: Option[Boolean], analyticsTags: Option[Seq[String]], percentileComputation: Option[Boolean], enableABTest: Option[Boolean], attributesToRetrieve: Option[Seq[String]], ranking: Option[Seq[String]], customRanking: Option[Seq[String]], relevancyStrictness: Option[Int], attributesToHighlight: Option[Seq[String]], attributesToSnippet: Option[Seq[String]], highlightPreTag: Option[String], highlightPostTag: Option[String], snippetEllipsisText: Option[String], restrictHighlightAndSnippetArrays: Option[Boolean], hitsPerPage: Option[Int], minWordSizefor1Typo: Option[Int], minWordSizefor2Typos: Option[Int], typoTolerance: Option[TypoTolerance], allowTyposOnNumericTokens: Option[Boolean], disableTypoToleranceOnAttributes: Option[Seq[String]], ignorePlurals: Option[IgnorePlurals], removeStopWords: Option[RemoveStopWords], keepDiacriticsOnCharacters: Option[String], queryLanguages: Option[Seq[SupportedLanguage]], decompoundQuery: Option[Boolean], enableRules: Option[Boolean], enablePersonalization: Option[Boolean], queryType: Option[QueryType], removeWordsIfNoResults: Option[RemoveWordsIfNoResults], mode: Option[Mode], semanticSearch: Option[SemanticSearch], advancedSyntax: Option[Boolean], optionalWords: Option[Seq[String]], disableExactOnAttributes: Option[Seq[String]], exactOnSingleWordQuery: Option[ExactOnSingleWordQuery], alternativesAsExact: Option[Seq[AlternativesAsExact]], advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]], distinct: Option[Distinct], replaceSynonymsInHighlight: Option[Boolean], minProximity: Option[Int], responseFields: Option[Seq[String]], maxFacetHits: Option[Int], maxValuesPerFacet: Option[Int], sortFacetValuesBy: Option[String], attributeCriteriaComputedByMinProximity: Option[Boolean], renderingContent: Option[RenderingContent], enableReRanking: Option[Boolean], reRankingApplyFilter: Option[ReRankingApplyFilter])

FallbackParams

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

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object BoughtTogether.type

Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID objectID.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: FbtModel.type

Attributes

Supertypes: class CustomSerializer[FbtModel]

trait Serializer[FbtModel]

class Object

trait Matchable

class Any

FrequentlyBoughtTogether

Value parameters

objectID: Unique record identifier.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

GetRecommendTaskResponse

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Recommend request body.

Value parameters

requests: Recommendation request with parameters depending on the requested model.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

GetRecommendationsResponse

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object ID of the recommendation you want to exclude.

Value parameters

objectID: Unique record identifier.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

HighlightResult

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class MapOfStringHighlightResultOption

class SeqOfHighlightResultOption

trait HighlightResultTrait

class HighlightResultOption

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: HighlightResult.type

Surround words that match the query with HTML tags for highlighting.

Value parameters

fullyHighlighted: Whether the entire attribute value is highlighted.
matchedWords: List of matched words from the search query.
value: Highlighted attribute value, including HTML tags.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait HighlightResultTrait

trait HighlightResult

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializer[HighlightResult]

class Object

trait Matchable

class Any
Self type: HighlightResultSerializer.type

Attributes

Supertypes: trait HighlightResult

class Object

trait Matchable

class Any
Known subtypes: class HighlightResultOption

Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class BooleanValue

class SeqOfSupportedLanguage

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: IgnorePlurals.type

Attributes

Supertypes: trait Serializer[IgnorePlurals]

class Object

trait Matchable

class Any
Self type: IgnorePluralsSerializer.type

case class IndexSettingsAsSearchParams(attributesToRetrieve: Option[Seq[String]], ranking: Option[Seq[String]], customRanking: Option[Seq[String]], relevancyStrictness: Option[Int], attributesToHighlight: Option[Seq[String]], attributesToSnippet: Option[Seq[String]], highlightPreTag: Option[String], highlightPostTag: Option[String], snippetEllipsisText: Option[String], restrictHighlightAndSnippetArrays: Option[Boolean], hitsPerPage: Option[Int], minWordSizefor1Typo: Option[Int], minWordSizefor2Typos: Option[Int], typoTolerance: Option[TypoTolerance], allowTyposOnNumericTokens: Option[Boolean], disableTypoToleranceOnAttributes: Option[Seq[String]], ignorePlurals: Option[IgnorePlurals], removeStopWords: Option[RemoveStopWords], keepDiacriticsOnCharacters: Option[String], queryLanguages: Option[Seq[SupportedLanguage]], decompoundQuery: Option[Boolean], enableRules: Option[Boolean], enablePersonalization: Option[Boolean], queryType: Option[QueryType], removeWordsIfNoResults: Option[RemoveWordsIfNoResults], mode: Option[Mode], semanticSearch: Option[SemanticSearch], advancedSyntax: Option[Boolean], optionalWords: Option[Seq[String]], disableExactOnAttributes: Option[Seq[String]], exactOnSingleWordQuery: Option[ExactOnSingleWordQuery], alternativesAsExact: Option[Seq[AlternativesAsExact]], advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]], distinct: Option[Distinct], replaceSynonymsInHighlight: Option[Boolean], minProximity: Option[Int], responseFields: Option[Seq[String]], maxFacetHits: Option[Int], maxValuesPerFacet: Option[Int], sortFacetValuesBy: Option[String], attributeCriteriaComputedByMinProximity: Option[Boolean], renderingContent: Option[RenderingContent], enableReRanking: Option[Boolean], reRankingApplyFilter: Option[ReRankingApplyFilter])

IndexSettingsAsSearchParams

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

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: JsonSupport.type

LookingSimilar

Value parameters

objectID: Unique record identifier.

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

Looking similar model. This model recommends items that look similar to the item with the ID objectID based on image attributes in your index.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: LookingSimilarModel.type

Attributes

Supertypes: class CustomSerializer[LookingSimilarModel]

trait Serializer[LookingSimilarModel]

class Object

trait Matchable

class Any

LookingSimilarQuery

Value parameters

indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
objectID: Unique record identifier.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Full.type

object None.type

object Partial.type

Whether the whole query string matches or only a part.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: MatchLevel.type

Attributes

Supertypes: class CustomSerializer[MatchLevel]

trait Serializer[MatchLevel]

class Object

trait Matchable

class Any

MatchedGeoLocation

Value parameters

distance: Distance between the matched location and the search location (in meters).
lat: Latitude of the matched location.
lng: Longitude of the matched location.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

MixedSearchFilters

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class SeqOfString

class StringValue

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: MixedSearchFilters.type

Attributes

Supertypes: trait Serializer[MixedSearchFilters]

class Object

trait Matchable

class Any
Self type: MixedSearchFiltersSerializer.type

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object KeywordSearch.type

object NeuralSearch.type

Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Mode.type

Attributes

Supertypes: class CustomSerializer[Mode]

trait Serializer[Mode]

class Object

trait Matchable

class Any

Filter by numeric facets. Prefer using the filters parameter, which supports all filter types and combinations with boolean operators. You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparsions are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

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: NumericFilters.type

Attributes

Supertypes: trait Serializer[NumericFilters]

class Object

trait Matchable

class Any
Self type: NumericFiltersSerializer.type

Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied after sort-by attributes. - Optional filters don't work with numeric attributes.

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: OptionalFilters.type

Attributes

Supertypes: trait Serializer[OptionalFilters]

class Object

trait Matchable

class Any
Self type: OptionalFiltersSerializer.type

Filter or boost recommendations matching a facet filter.

Value parameters

automaticFacetFilters: Filter recommendations that match or don't match the same facet:facet_value combination as the viewed item.
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.
optionalFilters: Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. Matches with higher weights (<score=N>) rank before matches with lower weights. If you're using a negative filter facet:-value, matching records rank after records that don't match.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Personalization

Value parameters

filtersScore: The score of the filters.
rankingScore: The score of the ranking.
score: The score of the event.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object ID and position of the recommendation you want to pin.

Value parameters

objectID: Unique record identifier.
position: Index in the list of recommendations where to place this item.

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

object PrefixLast.type

object PrefixNone.type

Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as prefix (prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see Prefix searching.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: QueryType.type

Attributes

Supertypes: class CustomSerializer[QueryType]

trait Serializer[QueryType]

class Object

trait Matchable

class Any

Object with detailed information about the record's ranking.

Value parameters

filters: Whether a filter matched the query.
firstMatchedWord: Position of the first matched word in the best matching attribute of the record.
geoDistance: Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
geoPrecision: Precision used when computing the geo distance, in meters.
nbExactWords: Number of exactly matched words.
nbTypos: Number of typos encountered when matching the record.
promoted: Whether the record was promoted by a rule.
promotedByReRanking: Whether the record is re-ranked.
proximityDistance: Number of words between multiple matches in the query plus 1. For single word queries, proximityDistance is 0.
userScore: Overall ranking of the record, expressed as a single integer. This attribute is internal.
words: Number of matched words.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Restrict Dynamic Re-Ranking to records that match these filters.

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: ReRankingApplyFilter.type

Attributes

Supertypes: trait Serializer[ReRankingApplyFilter]

class Object

trait Matchable

class Any
Self type: ReRankingApplyFilterSerializer.type

Recommend hit.

Value parameters

highlightResult: Surround words that match the query with HTML tags for highlighting.
objectID: Unique record identifier.
score: Recommendation score.
snippetResult: Snippets that show the context around a matching search query.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsHitTrait

trait RecommendationsHit

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializer[RecommendHit]

class Object

trait Matchable

class Any

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object BoughtTogether.type

object RelatedProducts.type

object TrendingFacets.type

object TrendingItems.type

RecommendModels enumeration

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RecommendModels.type

Attributes

Supertypes: class CustomSerializer[RecommendModels]

trait Serializer[RecommendModels]

class Object

trait Matchable

class Any

Recommend rule.

Value parameters

description: Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
enabled: Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
objectID: Unique identifier of a rule object.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Rule metadata.

Value parameters

lastUpdate: Date and time when the object was updated, in RFC 3339 format.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

RecommendationsHit

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class RecommendHitValue

trait RecommendationsHitTrait

class RecommendHit

class TrendingFacetHit

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: RecommendationsHit.type

Attributes

Supertypes: trait Serializer[RecommendationsHit]

class Object

trait Matchable

class Any
Self type: RecommendationsHitSerializer.type

Attributes

Supertypes: trait RecommendationsHit

class Object

trait Matchable

class Any
Known subtypes: class RecommendHit

class TrendingFacetHit

RecommendationsHits

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

RecommendationsRequest

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait RecommendationsRequestTrait

class BoughtTogetherQuery

class LookingSimilarQuery

class RecommendedForYouQuery

class RelatedQuery

class TrendingFacetsQuery

class TrendingItemsQuery
Show all

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: RecommendationsRequest.type

Attributes

Supertypes: trait Serializer[RecommendationsRequest]

class Object

trait Matchable

class Any
Self type: RecommendationsRequestSerializer.type

Attributes

Supertypes: trait RecommendationsRequest

class Object

trait Matchable

class Any
Known subtypes: class BoughtTogetherQuery

class LookingSimilarQuery

class RecommendedForYouQuery

class RelatedQuery

class TrendingFacetsQuery

class TrendingItemsQuery
Show all

case class RecommendationsResults(abTestID: Option[Int], abTestVariantID: Option[Int], aroundLatLng: Option[String], automaticRadius: Option[String], exhaustive: Option[Exhaustive], exhaustiveFacetsCount: Option[Boolean], exhaustiveNbHits: Option[Boolean], exhaustiveTypo: Option[Boolean], facets: Option[Map[String, Map[String, Int]]], facetsStats: Option[Map[String, FacetsStats]], hitsPerPage: Int, index: Option[String], indexUsed: Option[String], message: Option[String], nbHits: Int, nbPages: Int, nbSortedHits: Option[Int], page: Int, parsedQuery: Option[String], processingTimeMS: Int, processingTimingsMS: Option[Any], queryAfterRemoval: Option[String], redirect: Option[Redirect], renderingContent: Option[RenderingContent], serverTimeMS: Option[Int], serverUsed: Option[String], userData: Option[Any], queryID: Option[String], hits: Seq[RecommendationsHit])

RecommendationsResults

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

RecommendedForYou

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

"Recommened for you" model.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RecommendedForYouModel.type

Attributes

Supertypes: class CustomSerializer[RecommendedForYouModel]

trait Serializer[RecommendedForYouModel]

class Object

trait Matchable

class Any

RecommendedForYouQuery

Value parameters

indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

Redirect results to a URL.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

RedirectRuleIndexMetadata

Value parameters

dest: Destination index for the redirect rule.
reason: Reason for the redirect rule.
source: Source index for the redirect rule.
succeed: Redirect rule status.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Redirect rule data.

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

Related products or similar content model. This model recommends items that are similar to the item with the ID objectID. Similarity is determined from the user interactions and attributes.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RelatedModel.type

Attributes

Supertypes: class CustomSerializer[RelatedModel]

trait Serializer[RelatedModel]

class Object

trait Matchable

class Any

RelatedProducts

Value parameters

objectID: Unique record identifier.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

RelatedQuery

Value parameters

indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
objectID: Unique record identifier.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words. You should only use this feature for the languages used in your index.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class BooleanValue

class SeqOfSupportedLanguage

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RemoveStopWords.type

Attributes

Supertypes: trait Serializer[RemoveStopWords]

class Object

trait Matchable

class Any
Self type: RemoveStopWordsSerializer.type

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object AllOptional.type

object FirstWords.type

object LastWords.type

object None.type

Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - none. No words are removed when a query doesn't return results. - lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - allOptional. Treat all words as optional. For more information, see Remove words to improve results.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: RemoveWordsIfNoResults.type

Attributes

Supertypes: class CustomSerializer[RemoveWordsIfNoResults]

trait Serializer[RemoveWordsIfNoResults]

class Object

trait Matchable

class Any

Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

case class SearchParams(query: Option[String], similarQuery: Option[String], filters: Option[String], facetFilters: Option[FacetFilters], optionalFilters: Option[OptionalFilters], numericFilters: Option[NumericFilters], tagFilters: Option[TagFilters], sumOrFiltersScores: Option[Boolean], restrictSearchableAttributes: Option[Seq[String]], facets: Option[Seq[String]], facetingAfterDistinct: Option[Boolean], page: Option[Int], offset: Option[Int], length: Option[Int], aroundLatLng: Option[String], aroundLatLngViaIP: Option[Boolean], aroundRadius: Option[AroundRadius], aroundPrecision: Option[AroundPrecision], minimumAroundRadius: Option[Int], insideBoundingBox: Option[Seq[Seq[Double]]], insidePolygon: Option[Seq[Seq[Double]]], naturalLanguages: Option[Seq[SupportedLanguage]], ruleContexts: Option[Seq[String]], personalizationImpact: Option[Int], userToken: Option[String], getRankingInfo: Option[Boolean], synonyms: Option[Boolean], clickAnalytics: Option[Boolean], analytics: Option[Boolean], analyticsTags: Option[Seq[String]], percentileComputation: Option[Boolean], enableABTest: Option[Boolean], attributesToRetrieve: Option[Seq[String]], ranking: Option[Seq[String]], customRanking: Option[Seq[String]], relevancyStrictness: Option[Int], attributesToHighlight: Option[Seq[String]], attributesToSnippet: Option[Seq[String]], highlightPreTag: Option[String], highlightPostTag: Option[String], snippetEllipsisText: Option[String], restrictHighlightAndSnippetArrays: Option[Boolean], hitsPerPage: Option[Int], minWordSizefor1Typo: Option[Int], minWordSizefor2Typos: Option[Int], typoTolerance: Option[TypoTolerance], allowTyposOnNumericTokens: Option[Boolean], disableTypoToleranceOnAttributes: Option[Seq[String]], ignorePlurals: Option[IgnorePlurals], removeStopWords: Option[RemoveStopWords], keepDiacriticsOnCharacters: Option[String], queryLanguages: Option[Seq[SupportedLanguage]], decompoundQuery: Option[Boolean], enableRules: Option[Boolean], enablePersonalization: Option[Boolean], queryType: Option[QueryType], removeWordsIfNoResults: Option[RemoveWordsIfNoResults], mode: Option[Mode], semanticSearch: Option[SemanticSearch], advancedSyntax: Option[Boolean], optionalWords: Option[Seq[String]], disableExactOnAttributes: Option[Seq[String]], exactOnSingleWordQuery: Option[ExactOnSingleWordQuery], alternativesAsExact: Option[Seq[AlternativesAsExact]], advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]], distinct: Option[Distinct], replaceSynonymsInHighlight: Option[Boolean], minProximity: Option[Int], responseFields: Option[Seq[String]], maxFacetHits: Option[Int], maxValuesPerFacet: Option[Int], sortFacetValuesBy: Option[String], attributeCriteriaComputedByMinProximity: Option[Boolean], renderingContent: Option[RenderingContent], enableReRanking: Option[Boolean], reRankingApplyFilter: Option[ReRankingApplyFilter])

SearchParams

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

class Object

trait Matchable

class Any
Show all

case class SearchParamsObject(query: Option[String], similarQuery: Option[String], filters: Option[String], facetFilters: Option[FacetFilters], optionalFilters: Option[OptionalFilters], numericFilters: Option[NumericFilters], tagFilters: Option[TagFilters], sumOrFiltersScores: Option[Boolean], restrictSearchableAttributes: Option[Seq[String]], facets: Option[Seq[String]], facetingAfterDistinct: Option[Boolean], page: Option[Int], offset: Option[Int], length: Option[Int], aroundLatLng: Option[String], aroundLatLngViaIP: Option[Boolean], aroundRadius: Option[AroundRadius], aroundPrecision: Option[AroundPrecision], minimumAroundRadius: Option[Int], insideBoundingBox: Option[Seq[Seq[Double]]], insidePolygon: Option[Seq[Seq[Double]]], naturalLanguages: Option[Seq[SupportedLanguage]], ruleContexts: Option[Seq[String]], personalizationImpact: Option[Int], userToken: Option[String], getRankingInfo: Option[Boolean], synonyms: Option[Boolean], clickAnalytics: Option[Boolean], analytics: Option[Boolean], analyticsTags: Option[Seq[String]], percentileComputation: Option[Boolean], enableABTest: Option[Boolean], attributesToRetrieve: Option[Seq[String]], ranking: Option[Seq[String]], customRanking: Option[Seq[String]], relevancyStrictness: Option[Int], attributesToHighlight: Option[Seq[String]], attributesToSnippet: Option[Seq[String]], highlightPreTag: Option[String], highlightPostTag: Option[String], snippetEllipsisText: Option[String], restrictHighlightAndSnippetArrays: Option[Boolean], hitsPerPage: Option[Int], minWordSizefor1Typo: Option[Int], minWordSizefor2Typos: Option[Int], typoTolerance: Option[TypoTolerance], allowTyposOnNumericTokens: Option[Boolean], disableTypoToleranceOnAttributes: Option[Seq[String]], ignorePlurals: Option[IgnorePlurals], removeStopWords: Option[RemoveStopWords], keepDiacriticsOnCharacters: Option[String], queryLanguages: Option[Seq[SupportedLanguage]], decompoundQuery: Option[Boolean], enableRules: Option[Boolean], enablePersonalization: Option[Boolean], queryType: Option[QueryType], removeWordsIfNoResults: Option[RemoveWordsIfNoResults], mode: Option[Mode], semanticSearch: Option[SemanticSearch], advancedSyntax: Option[Boolean], optionalWords: Option[Seq[String]], disableExactOnAttributes: Option[Seq[String]], exactOnSingleWordQuery: Option[ExactOnSingleWordQuery], alternativesAsExact: Option[Seq[AlternativesAsExact]], advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]], distinct: Option[Distinct], replaceSynonymsInHighlight: Option[Boolean], minProximity: Option[Int], responseFields: Option[Seq[String]], maxFacetHits: Option[Int], maxValuesPerFacet: Option[Int], sortFacetValuesBy: Option[String], attributeCriteriaComputedByMinProximity: Option[Boolean], renderingContent: Option[RenderingContent], enableReRanking: Option[Boolean], reRankingApplyFilter: Option[ReRankingApplyFilter])

Each parameter value, including the query must not be larger than 512 bytes.

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

class Object

trait Matchable

class Any
Show all

SearchParamsQuery

Value parameters

query: Search query.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Recommend rules parameters.

Value parameters

context: Only search for rules with matching context.
enabled: Whether to only show rules where the value of their enabled property matches this parameter. If absent, show all rules, regardless of their enabled property.
facets: Include facets and facet values in the response. Use ['*'] to include all facets.
filters: Filter expression. This only searches for rules matching the filter expression.
hitsPerPage: Maximum number of hits per page.
maxValuesPerFacet: Maximum number of values to return for each facet.
page: Requested page of the API response.
query: Search query.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

SearchRecommendRulesResponse

Value parameters

hits: Recommend rules that match the search criteria.
nbHits: Number of results (hits).
nbPages: Number of pages of results.
page: Page of search results to retrieve.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Settings for the semantic search part of NeuralSearch. Only used when mode is neuralSearch.

Value parameters

eventSources: Indices from which to collect click and conversion events. If null, the current index and all its replicas are used.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

SnippetResult

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class MapOfStringSnippetResultOption

class SeqOfSnippetResultOption

trait SnippetResultTrait

class SnippetResultOption

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: SnippetResult.type

Snippets that show the context around a matching search query.

Value parameters

value: Highlighted attribute value, including HTML tags.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait SnippetResultTrait

trait SnippetResult

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializer[SnippetResult]

class Object

trait Matchable

class Any
Self type: SnippetResultSerializer.type

Attributes

Supertypes: trait SnippetResult

class Object

trait Matchable

class Any
Known subtypes: class SnippetResultOption

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Alpha.type

object Count.type

object Hidden.type

Order of facet values that aren't explicitly positioned with the order setting. - count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - alpha. Sort facet values alphabetically. - hidden. Don't show facet values that aren't explicitly positioned.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: SortRemainingBy.type

Attributes

Supertypes: class CustomSerializer[SortRemainingBy]

trait Serializer[SortRemainingBy]

class Object

trait Matchable

class Any

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object Af.type

object Ar.type

object Az.type

object Bg.type

object Bn.type

object Ca.type

object Cs.type

object Cy.type

object Da.type

object De.type

object El.type

object En.type

object Eo.type

object Es.type

object Et.type

object Eu.type

object Fa.type

object Fi.type

object Fo.type

object Fr.type

object Ga.type

object Gl.type

object He.type

object Hi.type

object Hu.type

object Hy.type

object Id.type

object Is.type

object It.type

object Ja.type

object Ka.type

object Kk.type

object Ko.type

object Ku.type

object Ky.type

object Lt.type

object Lv.type

object Mi.type

object Mn.type

object Mr.type

object Ms.type

object Mt.type

object Nb.type

object Nl.type

object No.type

object Ns.type

object Pl.type

object Ps.type

object Pt.type

object PtBr.type

object Qu.type

object Ro.type

object Ru.type

object Sk.type

object Sq.type

object Sv.type

object Sw.type

object Ta.type

object Te.type

object Th.type

object Tl.type

object Tn.type

object Tr.type

object Tt.type

object Uk.type

object Ur.type

object Uz.type

object Zh.type
Show all

ISO code for a supported language.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: SupportedLanguage.type

Attributes

Supertypes: class CustomSerializer[SupportedLanguage]

trait Serializer[SupportedLanguage]

class Object

trait Matchable

class Any

Filter the search by values of the special _tags attribute. Prefer using the filters parameter, which supports all filter types and combinations with boolean operators. Different from regular facets, _tags can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for facetFilters.

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: TagFilters.type

Attributes

Supertypes: trait Serializer[TagFilters]

class Object

trait Matchable

class Any
Self type: TagFiltersSerializer.type

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object NotPublished.type

object Published.type

Task status, published if the task is completed, notPublished otherwise.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: TaskStatus.type

Attributes

Supertypes: class CustomSerializer[TaskStatus]

trait Serializer[TaskStatus]

class Object

trait Matchable

class Any

Trending facet hit.

Value parameters

facetName: Facet attribute. To be used in combination with facetValue. If specified, only recommendations matching the facet filter will be returned.
facetValue: Facet value. To be used in combination with facetName. If specified, only recommendations matching the facet filter will be returned.
score: Recommendation score.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsHitTrait

trait RecommendationsHit

class Object

trait Matchable

class Any
Show all

TrendingFacets

Value parameters

facetName: Facet attribute for which to retrieve trending facet values.

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

Trending facet values model. This model recommends trending facet values for the specified facet attribute.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: TrendingFacetsModel.type

Attributes

Supertypes: class CustomSerializer[TrendingFacetsModel]

trait Serializer[TrendingFacetsModel]

class Object

trait Matchable

class Any

TrendingFacetsQuery

Value parameters

facetName: Facet attribute for which to retrieve trending facet values.
indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

TrendingItems

Value parameters

facetName: Facet attribute. To be used in combination with facetValue. If specified, only recommendations matching the facet filter will be returned.
facetValue: Facet value. To be used in combination with facetName. If specified, only recommendations matching the facet filter will be returned.

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

Trending items model. Trending items are determined from the number of conversion events collected on them.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: TrendingItemsModel.type

Attributes

Supertypes: class CustomSerializer[TrendingItemsModel]

trait Serializer[TrendingItemsModel]

class Object

trait Matchable

class Any

TrendingItemsQuery

Value parameters

facetName: Facet attribute. To be used in combination with facetValue. If specified, only recommendations matching the facet filter will be returned.
facetValue: Facet value. To be used in combination with facetName. If specified, only recommendations matching the facet filter will be returned.
indexName: Index name (case-sensitive).
maxRecommendations: Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
threshold: Minimum score a recommendation must have to be included in the response.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RecommendationsRequestTrait

trait RecommendationsRequest

class Object

trait Matchable

class Any
Show all

Whether typo tolerance is enabled and how it is applied. If typo tolerance is true, min, or strict, word splitting and concetenation is also active.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class BooleanValue

trait TypoToleranceTrait

trait TypoToleranceEnum

object Min.type

object Strict.type

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: TypoTolerance.type

Attributes

Companion: object
Supertypes: trait TypoToleranceTrait

trait TypoTolerance

class Object

trait Matchable

class Any
Known subtypes: object Min.type

object Strict.type

min. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - strict. Return matches with the two lowest numbers of typos. With strict, the Typo ranking criterion is applied first in the ranking setting.

Attributes

Companion: trait
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: TypoToleranceEnum.type

Attributes

Supertypes: class CustomSerializer[TypoToleranceEnum]

trait Serializer[TypoToleranceEnum]

class Object

trait Matchable

class Any

Attributes

Supertypes: trait Serializer[TypoTolerance]

class Object

trait Matchable

class Any
Self type: TypoToleranceSerializer.type

Attributes

Supertypes: trait TypoTolerance

class Object

trait Matchable

class Any
Known subtypes: trait TypoToleranceEnum

object Min.type

object Strict.type

Value

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

algoliasearch.recommend

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes