recommend

package recommend

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

sealed trait AdvancedSyntaxFeatures extends AnyRef
class AdvancedSyntaxFeaturesSerializer extends CustomSerializer[AdvancedSyntaxFeatures]
sealed trait AlternativesAsExact extends AnyRef
class AlternativesAsExactSerializer extends CustomSerializer[AlternativesAsExact]
sealed trait AroundPrecision extends AnyRef
Precision of a coordinate-based search in meters to group results with similar distances.
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.
sealed trait AroundRadius extends AnyRef
Maximum radius for a search around a central location.
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.
sealed trait AroundRadiusAll extends AroundRadiusTrait
class AroundRadiusAllSerializer extends CustomSerializer[AroundRadiusAll]
trait AroundRadiusTrait extends AroundRadius
case class AutoFacetFilter(facet: Option[String] = scala.None, negative: Option[Boolean] = scala.None) extends Product with Serializable
Facet attribute.
Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
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.
case class BaseRecommendRequest(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None) extends Product with Serializable
BaseRecommendRequest
BaseRecommendRequest
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
case class BaseSearchParams(query: Option[String] = scala.None, similarQuery: Option[String] = scala.None, filters: Option[String] = scala.None, facetFilters: Option[FacetFilters] = scala.None, optionalFilters: Option[OptionalFilters] = scala.None, numericFilters: Option[NumericFilters] = scala.None, tagFilters: Option[TagFilters] = scala.None, sumOrFiltersScores: Option[Boolean] = scala.None, restrictSearchableAttributes: Option[Seq[String]] = scala.None, facets: Option[Seq[String]] = scala.None, facetingAfterDistinct: Option[Boolean] = scala.None, page: Option[Int] = scala.None, offset: Option[Int] = scala.None, length: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, aroundLatLngViaIP: Option[Boolean] = scala.None, aroundRadius: Option[AroundRadius] = scala.None, aroundPrecision: Option[AroundPrecision] = scala.None, minimumAroundRadius: Option[Int] = scala.None, insideBoundingBox: Option[Seq[Seq[Double]]] = scala.None, insidePolygon: Option[Seq[Seq[Double]]] = scala.None, naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None, ruleContexts: Option[Seq[String]] = scala.None, personalizationImpact: Option[Int] = scala.None, userToken: Option[String] = scala.None, getRankingInfo: Option[Boolean] = scala.None, synonyms: Option[Boolean] = scala.None, clickAnalytics: Option[Boolean] = scala.None, analytics: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, percentileComputation: Option[Boolean] = scala.None, enableABTest: Option[Boolean] = scala.None) extends Product with Serializable
BaseSearchParams
BaseSearchParams
query
Search query.
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.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
restrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
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.
page
Page of search results to retrieve.
offset
Position of the first hit to retrieve.
length
Number of hits to retrieve (used in combination with offset).
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.
minimumAroundRadius
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify insideBoundingBox.
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.
ruleContexts
Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
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](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
userToken
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
getRankingInfo
Whether the search response should include detailed ranking information.
synonyms
Whether to take into account an index's synonyms for this search.
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](https://www.algolia.com/guides/sending-events/getting-started/).
analytics
Whether this search will be included in Analytics.
analyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
percentileComputation
Whether to include this search when calculating processing-time percentiles.
enableABTest
Whether to enable A/B testing for this search.
case class BaseSearchParamsWithoutQuery(similarQuery: Option[String] = scala.None, filters: Option[String] = scala.None, facetFilters: Option[FacetFilters] = scala.None, optionalFilters: Option[OptionalFilters] = scala.None, numericFilters: Option[NumericFilters] = scala.None, tagFilters: Option[TagFilters] = scala.None, sumOrFiltersScores: Option[Boolean] = scala.None, restrictSearchableAttributes: Option[Seq[String]] = scala.None, facets: Option[Seq[String]] = scala.None, facetingAfterDistinct: Option[Boolean] = scala.None, page: Option[Int] = scala.None, offset: Option[Int] = scala.None, length: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, aroundLatLngViaIP: Option[Boolean] = scala.None, aroundRadius: Option[AroundRadius] = scala.None, aroundPrecision: Option[AroundPrecision] = scala.None, minimumAroundRadius: Option[Int] = scala.None, insideBoundingBox: Option[Seq[Seq[Double]]] = scala.None, insidePolygon: Option[Seq[Seq[Double]]] = scala.None, naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None, ruleContexts: Option[Seq[String]] = scala.None, personalizationImpact: Option[Int] = scala.None, userToken: Option[String] = scala.None, getRankingInfo: Option[Boolean] = scala.None, synonyms: Option[Boolean] = scala.None, clickAnalytics: Option[Boolean] = scala.None, analytics: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, percentileComputation: Option[Boolean] = scala.None, enableABTest: Option[Boolean] = scala.None) extends Product with Serializable
BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
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.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
restrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
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.
page
Page of search results to retrieve.
offset
Position of the first hit to retrieve.
length
Number of hits to retrieve (used in combination with offset).
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.
minimumAroundRadius
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify insideBoundingBox.
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.
ruleContexts
Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
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](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
userToken
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
getRankingInfo
Whether the search response should include detailed ranking information.
synonyms
Whether to take into account an index's synonyms for this search.
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](https://www.algolia.com/guides/sending-events/getting-started/).
analytics
Whether this search will be included in Analytics.
analyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
percentileComputation
Whether to include this search when calculating processing-time percentiles.
enableABTest
Whether to enable A/B testing for this search.
case class BaseSearchResponse(abTestID: Option[Int] = scala.None, abTestVariantID: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, automaticRadius: Option[String] = scala.None, exhaustive: Option[Exhaustive] = scala.None, exhaustiveFacetsCount: Option[Boolean] = scala.None, exhaustiveNbHits: Option[Boolean] = scala.None, exhaustiveTypo: Option[Boolean] = scala.None, facets: Option[Map[String, Map[String, Int]]] = scala.None, facetsStats: Option[Map[String, FacetsStats]] = scala.None, index: Option[String] = scala.None, indexUsed: Option[String] = scala.None, message: Option[String] = scala.None, nbSortedHits: Option[Int] = scala.None, parsedQuery: Option[String] = scala.None, processingTimeMS: Int, processingTimingsMS: Option[Any] = scala.None, queryAfterRemoval: Option[String] = scala.None, redirect: Option[Redirect] = scala.None, renderingContent: Option[RenderingContent] = scala.None, serverTimeMS: Option[Int] = scala.None, serverUsed: Option[String] = scala.None, userData: Option[Any] = scala.None, queryID: Option[String] = scala.None, additionalProperties: Option[List[JField]] = None) extends Product with Serializable
BaseSearchResponse
BaseSearchResponse
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.
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.
nbSortedHits
Number of hits selected and sorted by the relevant sort algorithm.
parsedQuery
Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) 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.
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 32kB as custom data.
queryID
Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
class BaseSearchResponseSerializer extends Serializer[BaseSearchResponse]
case class BoughtTogetherQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, model: FbtModel, objectID: String) extends RecommendationsRequestTrait with Product with Serializable
BoughtTogetherQuery
BoughtTogetherQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
case class Condition(filters: Option[String] = scala.None, context: Option[String] = scala.None) extends Product with Serializable
Condition that triggers the rule.
Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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.
case class Consequence(hide: Option[Seq[HideConsequenceObject]] = scala.None, promote: Option[Seq[PromoteConsequenceObject]] = scala.None, params: Option[ParamsConsequence] = scala.None) extends Product with Serializable
Effect of the rule.
Effect of the rule.
hide
Exclude items from recommendations.
promote
Place items at specific positions in the list of recommendations.
case class DeletedAtResponse(taskID: Long, deletedAt: String) extends Product with Serializable
Response, taskID, and deletion timestamp.
Response, taskID, and deletion timestamp.
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](#tag/Indices/operation/getTask) and this taskID.
deletedAt
Date and time when the object was deleted, in RFC 3339 format.
sealed trait Distinct extends AnyRef
Determines how many records of a group are included in the search results.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The distinct setting is ignored if attributeForDistinct is not set.
case class ErrorBase(message: Option[String] = scala.None, additionalProperties: Option[List[JField]] = None) extends Product with Serializable
Error.
class ErrorBaseSerializer extends Serializer[ErrorBase]
sealed trait ExactOnSingleWordQuery extends AnyRef
class ExactOnSingleWordQuerySerializer extends CustomSerializer[ExactOnSingleWordQuery]
case class Exhaustive(facetsCount: Option[Boolean] = scala.None, facetValues: Option[Boolean] = scala.None, nbHits: Option[Boolean] = scala.None, rulesMatch: Option[Boolean] = scala.None, typo: Option[Boolean] = scala.None) extends Product with Serializable
Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
facetsCount
Whether the facet count is exhaustive (true) or approximate (false). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
facetValues
The value is false if not all facet values are retrieved.
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.
sealed trait FacetFilters extends AnyRef
Filter the search by facet values, so that only records with the same facet values are retrieved.
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. - 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.
case class FacetOrdering(facets: Option[Facets] = scala.None, values: Option[Map[String, Value]] = scala.None) extends Product with Serializable
Order of facet names and facet values in your UI.
Order of facet names and facet values in your UI.
values
Order of facet values. One object for each facet.
case class Facets(order: Option[Seq[String]] = scala.None) extends Product with Serializable
Order of facet names.
Order of facet names.
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.
case class FacetsStats(min: Option[Double] = scala.None, max: Option[Double] = scala.None, avg: Option[Double] = scala.None, sum: Option[Double] = scala.None) extends Product with Serializable
FacetsStats
FacetsStats
min
Minimum value in the results.
max
Maximum value in the results.
avg
Average facet value in the results.
sum
Sum of all values in the results.
case class FallbackParams(query: Option[String] = scala.None, similarQuery: Option[String] = scala.None, filters: Option[String] = scala.None, facetFilters: Option[FacetFilters] = scala.None, optionalFilters: Option[OptionalFilters] = scala.None, numericFilters: Option[NumericFilters] = scala.None, tagFilters: Option[TagFilters] = scala.None, sumOrFiltersScores: Option[Boolean] = scala.None, restrictSearchableAttributes: Option[Seq[String]] = scala.None, facets: Option[Seq[String]] = scala.None, facetingAfterDistinct: Option[Boolean] = scala.None, page: Option[Int] = scala.None, offset: Option[Int] = scala.None, length: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, aroundLatLngViaIP: Option[Boolean] = scala.None, aroundRadius: Option[AroundRadius] = scala.None, aroundPrecision: Option[AroundPrecision] = scala.None, minimumAroundRadius: Option[Int] = scala.None, insideBoundingBox: Option[Seq[Seq[Double]]] = scala.None, insidePolygon: Option[Seq[Seq[Double]]] = scala.None, naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None, ruleContexts: Option[Seq[String]] = scala.None, personalizationImpact: Option[Int] = scala.None, userToken: Option[String] = scala.None, getRankingInfo: Option[Boolean] = scala.None, synonyms: Option[Boolean] = scala.None, clickAnalytics: Option[Boolean] = scala.None, analytics: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, percentileComputation: Option[Boolean] = scala.None, enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, highlightPreTag: Option[String] = scala.None, highlightPostTag: Option[String] = scala.None, snippetEllipsisText: Option[String] = scala.None, restrictHighlightAndSnippetArrays: Option[Boolean] = scala.None, hitsPerPage: Option[Int] = scala.None, minWordSizefor1Typo: Option[Int] = scala.None, minWordSizefor2Typos: Option[Int] = scala.None, typoTolerance: Option[TypoTolerance] = scala.None, allowTyposOnNumericTokens: Option[Boolean] = scala.None, disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, enablePersonalization: Option[Boolean] = scala.None, queryType: Option[QueryType] = scala.None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = scala.None, mode: Option[Mode] = scala.None, semanticSearch: Option[SemanticSearch] = scala.None, advancedSyntax: Option[Boolean] = scala.None, optionalWords: Option[Seq[String]] = scala.None, disableExactOnAttributes: Option[Seq[String]] = scala.None, exactOnSingleWordQuery: Option[ExactOnSingleWordQuery] = scala.None, alternativesAsExact: Option[Seq[AlternativesAsExact]] = scala.None, advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]] = scala.None, distinct: Option[Distinct] = scala.None, replaceSynonymsInHighlight: Option[Boolean] = scala.None, minProximity: Option[Int] = scala.None, responseFields: Option[Seq[String]] = scala.None, maxFacetHits: Option[Int] = scala.None, maxValuesPerFacet: Option[Int] = scala.None, sortFacetValuesBy: Option[String] = scala.None, attributeCriteriaComputedByMinProximity: Option[Boolean] = scala.None, renderingContent: Option[RenderingContent] = scala.None, enableReRanking: Option[Boolean] = scala.None, reRankingApplyFilter: Option[ReRankingApplyFilter] = scala.None) extends Product with Serializable
FallbackParams
FallbackParams
query
Search query.
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.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
restrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
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.
page
Page of search results to retrieve.
offset
Position of the first hit to retrieve.
length
Number of hits to retrieve (used in combination with offset).
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.
minimumAroundRadius
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify insideBoundingBox.
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.
ruleContexts
Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
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](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
userToken
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
getRankingInfo
Whether the search response should include detailed ranking information.
synonyms
Whether to take into account an index's synonyms for this search.
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](https://www.algolia.com/guides/sending-events/getting-started/).
analytics
Whether this search will be included in Analytics.
analyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
percentileComputation
Whether to include this search when calculating processing-time percentiles.
enableABTest
Whether to enable A/B testing for this search.
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.
ranking
Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/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](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-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](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
customRanking
Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/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](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
relevancyStrictness
Relevancy threshold below which less relevant results aren't included in the results. You can only set relevancyStrictness on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
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.
highlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
highlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
snippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.
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.
hitsPerPage
Number of hits per page.
minWordSizefor1Typo
Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
minWordSizefor2Typos
Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
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.
disableTypoToleranceOnAttributes
Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-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.
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.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
decompoundQuery
Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
enableRules
Whether to enable rules.
enablePersonalization
Whether to enable Personalization.
advancedSyntax
Whether to support phrase matching and excluding words from search queries. Use the advancedSyntaxFeatures parameter to control which feature is supported.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
disableExactOnAttributes
Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). 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.
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.
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.
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.
minProximity
Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) 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.
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.
maxFacetHits
Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
maxValuesPerFacet
Maximum number of facet values to return for each facet.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
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.
enableReRanking
Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
sealed trait FbtModel extends AnyRef
class FbtModelSerializer extends CustomSerializer[FbtModel]
case class FrequentlyBoughtTogether(model: FbtModel, objectID: String) extends Product with Serializable
FrequentlyBoughtTogether
FrequentlyBoughtTogether
objectID
Unique record identifier.
case class GetRecommendTaskResponse(status: TaskStatus) extends Product with Serializable
GetRecommendTaskResponse
case class GetRecommendationsParams(requests: Seq[RecommendationsRequest]) extends Product with Serializable
Recommend request body.
Recommend request body.
requests
Recommendation request with parameters depending on the requested model.
case class GetRecommendationsResponse(results: Seq[RecommendationsResults]) extends Product with Serializable
GetRecommendationsResponse
case class HideConsequenceObject(objectID: Option[String] = scala.None) extends Product with Serializable
Object ID of the recommendation you want to exclude.
Object ID of the recommendation you want to exclude.
objectID
Unique record identifier.
sealed trait HighlightResult extends AnyRef
HighlightResult
trait HighlightResultEvidence extends AnyRef
case class HighlightResultOption(value: String, matchLevel: MatchLevel, matchedWords: Seq[String], fullyHighlighted: Option[Boolean] = scala.None) extends HighlightResultTrait with Product with Serializable
Surround words that match the query with HTML tags for highlighting.
Surround words that match the query with HTML tags for highlighting.
value
Highlighted attribute value, including HTML tags.
matchedWords
List of matched words from the search query.
fullyHighlighted
Whether the entire attribute value is highlighted.
trait HighlightResultTrait extends HighlightResult
sealed trait IgnorePlurals extends AnyRef
Treat singular, plurals, and other forms of declensions as equivalent.
Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
case class IndexSettingsAsSearchParams(attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, highlightPreTag: Option[String] = scala.None, highlightPostTag: Option[String] = scala.None, snippetEllipsisText: Option[String] = scala.None, restrictHighlightAndSnippetArrays: Option[Boolean] = scala.None, hitsPerPage: Option[Int] = scala.None, minWordSizefor1Typo: Option[Int] = scala.None, minWordSizefor2Typos: Option[Int] = scala.None, typoTolerance: Option[TypoTolerance] = scala.None, allowTyposOnNumericTokens: Option[Boolean] = scala.None, disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, enablePersonalization: Option[Boolean] = scala.None, queryType: Option[QueryType] = scala.None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = scala.None, mode: Option[Mode] = scala.None, semanticSearch: Option[SemanticSearch] = scala.None, advancedSyntax: Option[Boolean] = scala.None, optionalWords: Option[Seq[String]] = scala.None, disableExactOnAttributes: Option[Seq[String]] = scala.None, exactOnSingleWordQuery: Option[ExactOnSingleWordQuery] = scala.None, alternativesAsExact: Option[Seq[AlternativesAsExact]] = scala.None, advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]] = scala.None, distinct: Option[Distinct] = scala.None, replaceSynonymsInHighlight: Option[Boolean] = scala.None, minProximity: Option[Int] = scala.None, responseFields: Option[Seq[String]] = scala.None, maxFacetHits: Option[Int] = scala.None, maxValuesPerFacet: Option[Int] = scala.None, sortFacetValuesBy: Option[String] = scala.None, attributeCriteriaComputedByMinProximity: Option[Boolean] = scala.None, renderingContent: Option[RenderingContent] = scala.None, enableReRanking: Option[Boolean] = scala.None, reRankingApplyFilter: Option[ReRankingApplyFilter] = scala.None) extends Product with Serializable
IndexSettingsAsSearchParams
IndexSettingsAsSearchParams
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.
ranking
Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/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](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-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](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
customRanking
Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/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](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
relevancyStrictness
Relevancy threshold below which less relevant results aren't included in the results. You can only set relevancyStrictness on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
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.
highlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
highlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
snippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.
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.
hitsPerPage
Number of hits per page.
minWordSizefor1Typo
Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
minWordSizefor2Typos
Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
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.
disableTypoToleranceOnAttributes
Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-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.
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.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
decompoundQuery
Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
enableRules
Whether to enable rules.
enablePersonalization
Whether to enable Personalization.
advancedSyntax
Whether to support phrase matching and excluding words from search queries. Use the advancedSyntaxFeatures parameter to control which feature is supported.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
disableExactOnAttributes
Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). 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.
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.
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.
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.
minProximity
Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) 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.
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.
maxFacetHits
Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
maxValuesPerFacet
Maximum number of facet values to return for each facet.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
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.
enableReRanking
Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
case class LookingSimilar(model: LookingSimilarModel, objectID: String, fallbackParameters: Option[FallbackParams] = scala.None) extends Product with Serializable
LookingSimilar
LookingSimilar
objectID
Unique record identifier.
sealed trait LookingSimilarModel extends AnyRef
class LookingSimilarModelSerializer extends CustomSerializer[LookingSimilarModel]
case class LookingSimilarQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, model: LookingSimilarModel, objectID: String, fallbackParameters: Option[FallbackParams] = scala.None) extends RecommendationsRequestTrait with Product with Serializable
LookingSimilarQuery
LookingSimilarQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
sealed trait MatchLevel extends AnyRef
class MatchLevelSerializer extends CustomSerializer[MatchLevel]
case class MatchedGeoLocation(lat: Option[Double] = scala.None, lng: Option[Double] = scala.None, distance: Option[Int] = scala.None) extends Product with Serializable
MatchedGeoLocation
MatchedGeoLocation
lat
Latitude of the matched location.
lng
Longitude of the matched location.
distance
Distance between the matched location and the search location (in meters).
sealed trait Mode extends AnyRef
class ModeSerializer extends CustomSerializer[Mode]
sealed trait NumericFilters extends AnyRef
Filter by numeric facets.
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.
sealed trait OptionalFilters extends AnyRef
Filters to promote or demote records in the search results.
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.
case class ParamsConsequence(automaticFacetFilters: Option[Seq[AutoFacetFilter]] = scala.None, filters: Option[String] = scala.None, optionalFilters: Option[Seq[String]] = scala.None) extends Product with Serializable
Filter or boost recommendations matching a facet filter.
Filter or boost recommendations matching a facet filter.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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.
case class Personalization(filtersScore: Option[Int] = scala.None, rankingScore: Option[Int] = scala.None, score: Option[Int] = scala.None) extends Product with Serializable
Personalization
Personalization
filtersScore
The score of the filters.
rankingScore
The score of the ranking.
score
The score of the event.
case class PromoteConsequenceObject(objectID: Option[String] = scala.None, position: Option[Int] = scala.None) extends Product with Serializable
Object ID and position of the recommendation you want to pin.
Object ID and position of the recommendation you want to pin.
objectID
Unique record identifier.
position
Index in the list of recommendations where to place this item.
sealed trait QueryType extends AnyRef
class QueryTypeSerializer extends CustomSerializer[QueryType]
case class Range(from: Option[Int] = scala.None, value: Option[Int] = scala.None) extends Product with Serializable
Range object with lower and upper values in meters to define custom ranges.
Range object with lower and upper values in meters to define custom ranges.
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.
case class RankingInfo(filters: Option[Int] = scala.None, firstMatchedWord: Int, geoDistance: Int, geoPrecision: Option[Int] = scala.None, matchedGeoLocation: Option[MatchedGeoLocation] = scala.None, personalization: Option[Personalization] = scala.None, nbExactWords: Int, nbTypos: Int, promoted: Option[Boolean] = scala.None, proximityDistance: Option[Int] = scala.None, userScore: Int, words: Option[Int] = scala.None, promotedByReRanking: Option[Boolean] = scala.None) extends Product with Serializable
Object with detailed information about the record's ranking.
Object with detailed information about the record's ranking.
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.
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.
promotedByReRanking
Whether the record is re-ranked.
sealed trait ReRankingApplyFilter extends AnyRef
Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
case class RecommendHit(objectID: String, highlightResult: Option[Map[String, HighlightResult]] = scala.None, snippetResult: Option[Map[String, SnippetResult]] = scala.None, rankingInfo: Option[RankingInfo] = scala.None, distinctSeqID: Option[Int] = scala.None, score: Double, additionalProperties: Option[List[JField]] = None) extends RecommendationsHitTrait with Product with Serializable
Recommend hit.
Recommend hit.
objectID
Unique record identifier.
highlightResult
Surround words that match the query with HTML tags for highlighting.
snippetResult
Snippets that show the context around a matching search query.
score
Recommendation score.
class RecommendHitSerializer extends Serializer[RecommendHit]
sealed trait RecommendModels extends AnyRef
class RecommendModelsSerializer extends CustomSerializer[RecommendModels]
case class RecommendRule(metadata: Option[RuleMetadata] = scala.None, objectID: Option[String] = scala.None, condition: Option[Condition] = scala.None, consequence: Option[Consequence] = scala.None, description: Option[String] = scala.None, enabled: Option[Boolean] = scala.None) extends Product with Serializable
Recommend rule.
Recommend rule.
objectID
Unique identifier of a rule object.
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.
sealed trait RecommendationsHit extends AnyRef
RecommendationsHit
trait RecommendationsHitTrait extends RecommendationsHit
case class RecommendationsHits(hits: Seq[RecommendationsHit]) extends Product with Serializable
RecommendationsHits
sealed trait RecommendationsRequest extends AnyRef
RecommendationsRequest
trait RecommendationsRequestTrait extends RecommendationsRequest
case class RecommendationsResults(abTestID: Option[Int] = scala.None, abTestVariantID: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, automaticRadius: Option[String] = scala.None, exhaustive: Option[Exhaustive] = scala.None, exhaustiveFacetsCount: Option[Boolean] = scala.None, exhaustiveNbHits: Option[Boolean] = scala.None, exhaustiveTypo: Option[Boolean] = scala.None, facets: Option[Map[String, Map[String, Int]]] = scala.None, facetsStats: Option[Map[String, FacetsStats]] = scala.None, index: Option[String] = scala.None, indexUsed: Option[String] = scala.None, message: Option[String] = scala.None, nbSortedHits: Option[Int] = scala.None, parsedQuery: Option[String] = scala.None, processingTimeMS: Int, processingTimingsMS: Option[Any] = scala.None, queryAfterRemoval: Option[String] = scala.None, redirect: Option[Redirect] = scala.None, renderingContent: Option[RenderingContent] = scala.None, serverTimeMS: Option[Int] = scala.None, serverUsed: Option[String] = scala.None, userData: Option[Any] = scala.None, queryID: Option[String] = scala.None, page: Int, nbHits: Int, nbPages: Int, hitsPerPage: Int, hits: Seq[RecommendationsHit]) extends Product with Serializable
RecommendationsResults
RecommendationsResults
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.
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.
nbSortedHits
Number of hits selected and sorted by the relevant sort algorithm.
parsedQuery
Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) 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.
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 32kB as custom data.
queryID
Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
page
Page of search results to retrieve.
nbHits
Number of results (hits).
nbPages
Number of pages of results.
hitsPerPage
Number of hits per page.
case class RecommendedForYou(model: RecommendedForYouModel, fallbackParameters: Option[FallbackParams] = scala.None) extends Product with Serializable
RecommendedForYou
sealed trait RecommendedForYouModel extends AnyRef
class RecommendedForYouModelSerializer extends CustomSerializer[RecommendedForYouModel]
case class RecommendedForYouQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, model: RecommendedForYouModel, fallbackParameters: Option[FallbackParams] = scala.None) extends RecommendationsRequestTrait with Product with Serializable
RecommendedForYouQuery
RecommendedForYouQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
case class Redirect(index: Option[Seq[RedirectRuleIndexMetadata]] = scala.None) extends Product with Serializable
[Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
case class RedirectRuleIndexData(ruleObjectID: String) extends Product with Serializable
Redirect rule data.
case class RedirectRuleIndexMetadata(source: String, dest: String, reason: String, succeed: Boolean, data: RedirectRuleIndexData) extends Product with Serializable
RedirectRuleIndexMetadata
RedirectRuleIndexMetadata
source
Source index for the redirect rule.
dest
Destination index for the redirect rule.
reason
Reason for the redirect rule.
succeed
Redirect rule status.
case class RedirectURL(url: Option[String] = scala.None) extends Product with Serializable
The redirect rule container.
sealed trait RelatedModel extends AnyRef
class RelatedModelSerializer extends CustomSerializer[RelatedModel]
case class RelatedProducts(model: RelatedModel, objectID: String, fallbackParameters: Option[FallbackParams] = scala.None) extends Product with Serializable
RelatedProducts
RelatedProducts
objectID
Unique record identifier.
case class RelatedQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, model: RelatedModel, objectID: String, fallbackParameters: Option[FallbackParams] = scala.None) extends RecommendationsRequestTrait with Product with Serializable
RelatedQuery
RelatedQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
sealed trait RemoveStopWords extends AnyRef
Removes stop words from the search query.
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.
sealed trait RemoveWordsIfNoResults extends AnyRef
class RemoveWordsIfNoResultsSerializer extends CustomSerializer[RemoveWordsIfNoResults]
case class RenderingContent(facetOrdering: Option[FacetOrdering] = scala.None, redirect: Option[RedirectURL] = scala.None) extends Product with Serializable
Extra data that can be used in the search UI.
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.
case class RuleMetadata(lastUpdate: Option[String] = scala.None) extends Product with Serializable
Rule metadata.
Rule metadata.
lastUpdate
Date and time when the object was updated, in RFC 3339 format.
case class SearchPagination(page: Int, nbHits: Int, nbPages: Int, hitsPerPage: Int) extends Product with Serializable
SearchPagination
SearchPagination
page
Page of search results to retrieve.
nbHits
Number of results (hits).
nbPages
Number of pages of results.
hitsPerPage
Number of hits per page.
case class SearchParams(query: Option[String] = scala.None, similarQuery: Option[String] = scala.None, filters: Option[String] = scala.None, facetFilters: Option[FacetFilters] = scala.None, optionalFilters: Option[OptionalFilters] = scala.None, numericFilters: Option[NumericFilters] = scala.None, tagFilters: Option[TagFilters] = scala.None, sumOrFiltersScores: Option[Boolean] = scala.None, restrictSearchableAttributes: Option[Seq[String]] = scala.None, facets: Option[Seq[String]] = scala.None, facetingAfterDistinct: Option[Boolean] = scala.None, page: Option[Int] = scala.None, offset: Option[Int] = scala.None, length: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, aroundLatLngViaIP: Option[Boolean] = scala.None, aroundRadius: Option[AroundRadius] = scala.None, aroundPrecision: Option[AroundPrecision] = scala.None, minimumAroundRadius: Option[Int] = scala.None, insideBoundingBox: Option[Seq[Seq[Double]]] = scala.None, insidePolygon: Option[Seq[Seq[Double]]] = scala.None, naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None, ruleContexts: Option[Seq[String]] = scala.None, personalizationImpact: Option[Int] = scala.None, userToken: Option[String] = scala.None, getRankingInfo: Option[Boolean] = scala.None, synonyms: Option[Boolean] = scala.None, clickAnalytics: Option[Boolean] = scala.None, analytics: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, percentileComputation: Option[Boolean] = scala.None, enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, highlightPreTag: Option[String] = scala.None, highlightPostTag: Option[String] = scala.None, snippetEllipsisText: Option[String] = scala.None, restrictHighlightAndSnippetArrays: Option[Boolean] = scala.None, hitsPerPage: Option[Int] = scala.None, minWordSizefor1Typo: Option[Int] = scala.None, minWordSizefor2Typos: Option[Int] = scala.None, typoTolerance: Option[TypoTolerance] = scala.None, allowTyposOnNumericTokens: Option[Boolean] = scala.None, disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, enablePersonalization: Option[Boolean] = scala.None, queryType: Option[QueryType] = scala.None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = scala.None, mode: Option[Mode] = scala.None, semanticSearch: Option[SemanticSearch] = scala.None, advancedSyntax: Option[Boolean] = scala.None, optionalWords: Option[Seq[String]] = scala.None, disableExactOnAttributes: Option[Seq[String]] = scala.None, exactOnSingleWordQuery: Option[ExactOnSingleWordQuery] = scala.None, alternativesAsExact: Option[Seq[AlternativesAsExact]] = scala.None, advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]] = scala.None, distinct: Option[Distinct] = scala.None, replaceSynonymsInHighlight: Option[Boolean] = scala.None, minProximity: Option[Int] = scala.None, responseFields: Option[Seq[String]] = scala.None, maxFacetHits: Option[Int] = scala.None, maxValuesPerFacet: Option[Int] = scala.None, sortFacetValuesBy: Option[String] = scala.None, attributeCriteriaComputedByMinProximity: Option[Boolean] = scala.None, renderingContent: Option[RenderingContent] = scala.None, enableReRanking: Option[Boolean] = scala.None, reRankingApplyFilter: Option[ReRankingApplyFilter] = scala.None) extends Product with Serializable
SearchParams
SearchParams
query
Search query.
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.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
restrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
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.
page
Page of search results to retrieve.
offset
Position of the first hit to retrieve.
length
Number of hits to retrieve (used in combination with offset).
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.
minimumAroundRadius
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify insideBoundingBox.
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.
ruleContexts
Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
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](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
userToken
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
getRankingInfo
Whether the search response should include detailed ranking information.
synonyms
Whether to take into account an index's synonyms for this search.
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](https://www.algolia.com/guides/sending-events/getting-started/).
analytics
Whether this search will be included in Analytics.
analyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
percentileComputation
Whether to include this search when calculating processing-time percentiles.
enableABTest
Whether to enable A/B testing for this search.
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.
ranking
Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/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](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-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](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
customRanking
Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/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](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
relevancyStrictness
Relevancy threshold below which less relevant results aren't included in the results. You can only set relevancyStrictness on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
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.
highlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
highlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
snippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.
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.
hitsPerPage
Number of hits per page.
minWordSizefor1Typo
Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
minWordSizefor2Typos
Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
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.
disableTypoToleranceOnAttributes
Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-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.
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.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
decompoundQuery
Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
enableRules
Whether to enable rules.
enablePersonalization
Whether to enable Personalization.
advancedSyntax
Whether to support phrase matching and excluding words from search queries. Use the advancedSyntaxFeatures parameter to control which feature is supported.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
disableExactOnAttributes
Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). 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.
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.
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.
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.
minProximity
Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) 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.
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.
maxFacetHits
Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
maxValuesPerFacet
Maximum number of facet values to return for each facet.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
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.
enableReRanking
Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
case class SearchParamsObject(query: Option[String] = scala.None, similarQuery: Option[String] = scala.None, filters: Option[String] = scala.None, facetFilters: Option[FacetFilters] = scala.None, optionalFilters: Option[OptionalFilters] = scala.None, numericFilters: Option[NumericFilters] = scala.None, tagFilters: Option[TagFilters] = scala.None, sumOrFiltersScores: Option[Boolean] = scala.None, restrictSearchableAttributes: Option[Seq[String]] = scala.None, facets: Option[Seq[String]] = scala.None, facetingAfterDistinct: Option[Boolean] = scala.None, page: Option[Int] = scala.None, offset: Option[Int] = scala.None, length: Option[Int] = scala.None, aroundLatLng: Option[String] = scala.None, aroundLatLngViaIP: Option[Boolean] = scala.None, aroundRadius: Option[AroundRadius] = scala.None, aroundPrecision: Option[AroundPrecision] = scala.None, minimumAroundRadius: Option[Int] = scala.None, insideBoundingBox: Option[Seq[Seq[Double]]] = scala.None, insidePolygon: Option[Seq[Seq[Double]]] = scala.None, naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None, ruleContexts: Option[Seq[String]] = scala.None, personalizationImpact: Option[Int] = scala.None, userToken: Option[String] = scala.None, getRankingInfo: Option[Boolean] = scala.None, synonyms: Option[Boolean] = scala.None, clickAnalytics: Option[Boolean] = scala.None, analytics: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, percentileComputation: Option[Boolean] = scala.None, enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, highlightPreTag: Option[String] = scala.None, highlightPostTag: Option[String] = scala.None, snippetEllipsisText: Option[String] = scala.None, restrictHighlightAndSnippetArrays: Option[Boolean] = scala.None, hitsPerPage: Option[Int] = scala.None, minWordSizefor1Typo: Option[Int] = scala.None, minWordSizefor2Typos: Option[Int] = scala.None, typoTolerance: Option[TypoTolerance] = scala.None, allowTyposOnNumericTokens: Option[Boolean] = scala.None, disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, enablePersonalization: Option[Boolean] = scala.None, queryType: Option[QueryType] = scala.None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = scala.None, mode: Option[Mode] = scala.None, semanticSearch: Option[SemanticSearch] = scala.None, advancedSyntax: Option[Boolean] = scala.None, optionalWords: Option[Seq[String]] = scala.None, disableExactOnAttributes: Option[Seq[String]] = scala.None, exactOnSingleWordQuery: Option[ExactOnSingleWordQuery] = scala.None, alternativesAsExact: Option[Seq[AlternativesAsExact]] = scala.None, advancedSyntaxFeatures: Option[Seq[AdvancedSyntaxFeatures]] = scala.None, distinct: Option[Distinct] = scala.None, replaceSynonymsInHighlight: Option[Boolean] = scala.None, minProximity: Option[Int] = scala.None, responseFields: Option[Seq[String]] = scala.None, maxFacetHits: Option[Int] = scala.None, maxValuesPerFacet: Option[Int] = scala.None, sortFacetValuesBy: Option[String] = scala.None, attributeCriteriaComputedByMinProximity: Option[Boolean] = scala.None, renderingContent: Option[RenderingContent] = scala.None, enableReRanking: Option[Boolean] = scala.None, reRankingApplyFilter: Option[ReRankingApplyFilter] = scala.None) extends Product with Serializable
Each parameter value, including the query must not be larger than 512 bytes.
Each parameter value, including the query must not be larger than 512 bytes.
query
Search query.
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.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
restrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
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.
page
Page of search results to retrieve.
offset
Position of the first hit to retrieve.
length
Number of hits to retrieve (used in combination with offset).
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.
minimumAroundRadius
Minimum radius (in meters) for a search around a location when aroundRadius isn't set.
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify insideBoundingBox.
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.
ruleContexts
Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
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](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
userToken
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
getRankingInfo
Whether the search response should include detailed ranking information.
synonyms
Whether to take into account an index's synonyms for this search.
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](https://www.algolia.com/guides/sending-events/getting-started/).
analytics
Whether this search will be included in Analytics.
analyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
percentileComputation
Whether to include this search when calculating processing-time percentiles.
enableABTest
Whether to enable A/B testing for this search.
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.
ranking
Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/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](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-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](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
customRanking
Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/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](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
relevancyStrictness
Relevancy threshold below which less relevant results aren't included in the results. You can only set relevancyStrictness on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
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.
highlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
highlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
snippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.
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.
hitsPerPage
Number of hits per page.
minWordSizefor1Typo
Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
minWordSizefor2Typos
Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
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.
disableTypoToleranceOnAttributes
Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-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.
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.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
decompoundQuery
Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
enableRules
Whether to enable rules.
enablePersonalization
Whether to enable Personalization.
advancedSyntax
Whether to support phrase matching and excluding words from search queries. Use the advancedSyntaxFeatures parameter to control which feature is supported.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
disableExactOnAttributes
Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). 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.
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.
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.
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.
minProximity
Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) 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.
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.
maxFacetHits
Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
maxValuesPerFacet
Maximum number of facet values to return for each facet.
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](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
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.
enableReRanking
Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
case class SearchParamsQuery(query: Option[String] = scala.None) extends Product with Serializable
SearchParamsQuery
SearchParamsQuery
query
Search query.
case class SearchRecommendRulesParams(query: Option[String] = scala.None, context: Option[String] = scala.None, page: Option[Int] = scala.None, hitsPerPage: Option[Int] = scala.None, enabled: Option[Boolean] = scala.None, filters: Option[String] = scala.None, facets: Option[Seq[String]] = scala.None, maxValuesPerFacet: Option[Int] = scala.None) extends Product with Serializable
Recommend rules parameters.
Recommend rules parameters.
query
Search query.
context
Only search for rules with matching context.
page
Requested page of the API response.
hitsPerPage
Maximum number of hits per page.
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.
filters
Filter expression. This only searches for rules matching the filter expression.
facets
Include facets and facet values in the response. Use ['*'] to include all facets.
maxValuesPerFacet
Maximum number of values to return for each facet.
case class SearchRecommendRulesResponse(hits: Seq[RecommendRule], nbHits: Int, page: Int, nbPages: Int) extends Product with Serializable
SearchRecommendRulesResponse
SearchRecommendRulesResponse
hits
Recommend rules that match the search criteria.
nbHits
Number of results (hits).
page
Page of search results to retrieve.
nbPages
Number of pages of results.
case class SemanticSearch(eventSources: Option[Seq[String]] = scala.None) extends Product with Serializable
Settings for the semantic search part of NeuralSearch.
Settings for the semantic search part of NeuralSearch. Only used when mode is neuralSearch.
eventSources
Indices from which to collect click and conversion events. If null, the current index and all its replicas are used.
sealed trait SnippetResult extends AnyRef
SnippetResult
trait SnippetResultEvidence extends AnyRef
case class SnippetResultOption(value: String, matchLevel: MatchLevel) extends SnippetResultTrait with Product with Serializable
Snippets that show the context around a matching search query.
Snippets that show the context around a matching search query.
value
Highlighted attribute value, including HTML tags.
trait SnippetResultTrait extends SnippetResult
sealed trait SortRemainingBy extends AnyRef
class SortRemainingBySerializer extends CustomSerializer[SortRemainingBy]
sealed trait SupportedLanguage extends AnyRef
class SupportedLanguageSerializer extends CustomSerializer[SupportedLanguage]
sealed trait TagFilters extends AnyRef
Filter the search by values of the special _tags attribute.
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.
sealed trait TaskStatus extends AnyRef
class TaskStatusSerializer extends CustomSerializer[TaskStatus]
case class TrendingFacetHit(score: Double, facetName: String, facetValue: String) extends RecommendationsHitTrait with Product with Serializable
Trending facet hit.
Trending facet hit.
score
Recommendation score.
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.
case class TrendingFacets(facetName: Option[Any] = scala.None, model: TrendingFacetsModel, fallbackParameters: Option[FallbackParams] = scala.None) extends Product with Serializable
TrendingFacets
TrendingFacets
facetName
Facet attribute for which to retrieve trending facet values.
sealed trait TrendingFacetsModel extends AnyRef
class TrendingFacetsModelSerializer extends CustomSerializer[TrendingFacetsModel]
case class TrendingFacetsQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, facetName: Option[Any] = scala.None, model: TrendingFacetsModel, fallbackParameters: Option[FallbackParams] = scala.None) extends RecommendationsRequestTrait with Product with Serializable
TrendingFacetsQuery
TrendingFacetsQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
facetName
Facet attribute for which to retrieve trending facet values.
case class TrendingItems(facetName: Option[String] = scala.None, facetValue: Option[String] = scala.None, model: TrendingItemsModel, fallbackParameters: Option[SearchParamsObject] = scala.None) extends Product with Serializable
TrendingItems
TrendingItems
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.
sealed trait TrendingItemsModel extends AnyRef
class TrendingItemsModelSerializer extends CustomSerializer[TrendingItemsModel]
case class TrendingItemsQuery(indexName: String, threshold: Double, maxRecommendations: Option[Int] = scala.None, queryParameters: Option[SearchParams] = scala.None, facetName: Option[String] = scala.None, facetValue: Option[String] = scala.None, model: TrendingItemsModel, fallbackParameters: Option[SearchParamsObject] = scala.None) extends RecommendationsRequestTrait with Product with Serializable
TrendingItemsQuery
TrendingItemsQuery
indexName
Index name (case-sensitive).
threshold
Minimum score a recommendation must have to be included in the response.
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.
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.
sealed trait TypoTolerance extends AnyRef
Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, min, or strict, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
sealed trait TypoToleranceEnum extends TypoToleranceTrait
class TypoToleranceEnumSerializer extends CustomSerializer[TypoToleranceEnum]
trait TypoToleranceTrait extends TypoTolerance
case class Value(order: Option[Seq[String]] = scala.None, sortRemainingBy: Option[SortRemainingBy] = scala.None, hide: Option[Seq[String]] = scala.None) extends Product with Serializable
Value
Value
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.
hide
Hide facet values.

Value Members

object AdvancedSyntaxFeatures
AdvancedSyntaxFeatures enumeration
object AlternativesAsExact
AlternativesAsExact enumeration
object AroundPrecision
object AroundPrecisionSerializer extends Serializer[AroundPrecision]
object AroundRadius
object AroundRadiusAll
Return all records with a valid _geoloc attribute.
Return all records with a valid _geoloc attribute. Don't filter by distance.
object AroundRadiusSerializer extends Serializer[AroundRadius]
object Distinct
object DistinctSerializer extends Serializer[Distinct]
object ExactOnSingleWordQuery
Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.
Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) 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.
object FacetFilters
object FacetFiltersSerializer extends Serializer[FacetFilters]
object FbtModel
Frequently bought together model.
Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID objectID.
object HighlightResult
object HighlightResultEvidence
object HighlightResultSerializer extends Serializer[HighlightResult]
object IgnorePlurals
object IgnorePluralsSerializer extends Serializer[IgnorePlurals]
object JsonSupport
object LookingSimilarModel
Looking similar model.
Looking similar model. This model recommends items that look similar to the item with the ID objectID based on image attributes in your index.
object MatchLevel
Whether the whole query string matches or only a part.
object Mode
Search mode the index will use to query for results.
Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
object NumericFilters
object NumericFiltersSerializer extends Serializer[NumericFilters]
object OptionalFilters
object OptionalFiltersSerializer extends Serializer[OptionalFilters]
object QueryType
Determines if and how query words are interpreted as prefixes.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
object ReRankingApplyFilter
object ReRankingApplyFilterSerializer extends Serializer[ReRankingApplyFilter]
object RecommendModels
RecommendModels enumeration
object RecommendationsHit
object RecommendationsHitSerializer extends Serializer[RecommendationsHit]
object RecommendationsRequest
object RecommendationsRequestSerializer extends Serializer[RecommendationsRequest]
object RecommendedForYouModel
\"Recommened for you\" model.
object RelatedModel
Related products or similar content model.
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.
object RemoveStopWords
object RemoveStopWordsSerializer extends Serializer[RemoveStopWords]
object RemoveWordsIfNoResults
Strategy for removing words from the query when it doesn't return any results.
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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
object SnippetResult
object SnippetResultEvidence
object SnippetResultSerializer extends Serializer[SnippetResult]
object SortRemainingBy
Order of facet values that aren't explicitly positioned with the order setting.
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.
object SupportedLanguage
ISO code for a supported language.
object TagFilters
object TagFiltersSerializer extends Serializer[TagFilters]
object TaskStatus
Task status, published if the task is completed, notPublished otherwise.
object TrendingFacetsModel
Trending facet values model.
Trending facet values model. This model recommends trending facet values for the specified facet attribute.
object TrendingItemsModel
Trending items model.
Trending items model. Trending items are determined from the number of conversion events collected on them.
object TypoTolerance
object TypoToleranceEnum
- 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.
object TypoToleranceSerializer extends Serializer[TypoTolerance]

Packages

recommend

package recommend

Type Members

Value Members

Ungrouped

Packages

recommend

package recommend

Type Members

Value Members

Ungrouped

recommend