algoliasearch.recommend
Members list
Type members
Classlikes
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object ExactPhrase.typeobject ExcludeWords.type
AdvancedSyntaxFeatures enumeration
AdvancedSyntaxFeatures enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[AdvancedSyntaxFeatures]trait Serializer[AdvancedSyntaxFeatures]class Objecttrait Matchableclass Any
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
AlternativesAsExact enumeration
AlternativesAsExact enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AlternativesAsExact.type
Attributes
- Supertypes
-
class CustomSerializer[AlternativesAsExact]trait Serializer[AlternativesAsExact]class Objecttrait Matchableclass Any
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Whether the pattern parameter matches the beginning (startsWith
) or end (endsWith
) of the query string, is an exact match (is
), or a partial match (contains
).
Precision of a geographical search (in meters), to group results that are more or less the same distance from a central point.
Precision of a geographical search (in meters), to group results that are more or less the same distance from a central point.
Attributes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AroundPrecision.type
AroundPrecisionFromValueInner
AroundPrecisionFromValueInner
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
- Self type
Maximum radius for a geographical search (in meters).
Maximum radius for a geographical search (in meters).
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
AroundRadius.type
Attributes
AroundRadiusAll enumeration
AroundRadiusAll enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AroundRadiusAll.type
Attributes
- Supertypes
-
class CustomSerializer[AroundRadiusAll]trait Serializer[AroundRadiusAll]class Objecttrait Matchableclass Any
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
trait AroundRadiusAllobject All.type
Automatic facet Filter.
Automatic facet Filter.
Value parameters
- disjunctive
-
Whether the filter is disjunctive (true) or conjunctive (false).
- facet
-
Attribute to filter on. This must match a facet placeholder in the Rule's pattern.
- score
-
Score for the filter. Typically used for optional or disjunctive filters.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfString
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object SeqOfAutomaticFacetFilterEvidence.typeobject SeqOfStringEvidence.type
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
- Self type
BaseRecommendRequest
BaseRecommendRequest
Value parameters
- indexName
-
Algolia index name.
- maxRecommendations
-
Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
- threshold
-
Recommendations with a confidence score lower than
threshold
won't appear in results. > Note: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseRecommendationsQuery
BaseRecommendationsQuery
Value parameters
- objectID
-
Unique object identifier.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseRecommendedForYouQuery
BaseRecommendedForYouQuery
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseRecommendedForYouQueryParameters
BaseRecommendedForYouQueryParameters
Value parameters
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseSearchParams
BaseSearchParams
Value parameters
- analytics
-
Indicates whether this query will be included in analytics.
- analyticsTags
-
Tags to apply to the query for segmenting analytics data.
- aroundLatLng
-
Search for entries around a central location, enabling a geographical search within a circular area.
- aroundLatLngViaIP
-
Search for entries around a location. The location is automatically computed from the requester's IP address.
- clickAnalytics
-
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.
- enableABTest
-
Incidates whether this search will be considered in A/B testing.
- explain
-
Enriches the API's response with information about how the query was processed.
- facetingAfterDistinct
-
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the
afterDistinct
modifier ofattributesForFaceting
allows for more granular control. - facets
-
Returns facets, their facet values, and the number of matching facet values.
- filters
-
Filter the query with numeric, facet, or tag filters.
- getRankingInfo
-
Incidates whether the search response includes detailed ranking information.
- insideBoundingBox
-
Search inside a rectangular area (in geographical coordinates).
- insidePolygon
-
Search inside a polygon (in geographical coordinates).
- length
-
Sets the number of hits to retrieve (for use with
offset
). > Note: Usingpage
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - minimumAroundRadius
-
Minimum radius (in meters) used for a geographical search when
aroundRadius
isn't set. - naturalLanguages
-
Changes the default values of parameters that work best for a natural language query, such as
ignorePlurals
,removeStopWords
,removeWordsIfNoResults
,analyticsTags
, andruleContexts
. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries. - offset
-
Specifies the offset of the first hit to return. > Note: Using
page
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - page
-
Page to retrieve (the first page is
0
, not1
). - percentileComputation
-
Whether to include or exclude a query from the processing-time percentile computation.
- personalizationImpact
-
Defines how much Personalization affects results.
- query
-
Text to search for in an index.
- restrictSearchableAttributes
-
Restricts a query to only look at a subset of your searchable attributes.
- ruleContexts
-
Assigns rule contexts to search queries.
- similarQuery
-
Overrides the query parameter and performs a more generic search.
- sumOrFiltersScores
-
Determines how to calculate filter scores. If
false
, maximum score is kept. Iftrue
, score is summed. - synonyms
-
Whether to take into account an index's synonyms for a particular search.
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
Value parameters
- analytics
-
Indicates whether this query will be included in analytics.
- analyticsTags
-
Tags to apply to the query for segmenting analytics data.
- aroundLatLng
-
Search for entries around a central location, enabling a geographical search within a circular area.
- aroundLatLngViaIP
-
Search for entries around a location. The location is automatically computed from the requester's IP address.
- clickAnalytics
-
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.
- enableABTest
-
Incidates whether this search will be considered in A/B testing.
- explain
-
Enriches the API's response with information about how the query was processed.
- facetingAfterDistinct
-
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the
afterDistinct
modifier ofattributesForFaceting
allows for more granular control. - facets
-
Returns facets, their facet values, and the number of matching facet values.
- filters
-
Filter the query with numeric, facet, or tag filters.
- getRankingInfo
-
Incidates whether the search response includes detailed ranking information.
- insideBoundingBox
-
Search inside a rectangular area (in geographical coordinates).
- insidePolygon
-
Search inside a polygon (in geographical coordinates).
- length
-
Sets the number of hits to retrieve (for use with
offset
). > Note: Usingpage
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - minimumAroundRadius
-
Minimum radius (in meters) used for a geographical search when
aroundRadius
isn't set. - naturalLanguages
-
Changes the default values of parameters that work best for a natural language query, such as
ignorePlurals
,removeStopWords
,removeWordsIfNoResults
,analyticsTags
, andruleContexts
. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries. - offset
-
Specifies the offset of the first hit to return. > Note: Using
page
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - page
-
Page to retrieve (the first page is
0
, not1
). - percentileComputation
-
Whether to include or exclude a query from the processing-time percentile computation.
- personalizationImpact
-
Defines how much Personalization affects results.
- restrictSearchableAttributes
-
Restricts a query to only look at a subset of your searchable attributes.
- ruleContexts
-
Assigns rule contexts to search queries.
- similarQuery
-
Overrides the query parameter and performs a more generic search.
- sumOrFiltersScores
-
Determines how to calculate filter scores. If
false
, maximum score is kept. Iftrue
, score is summed. - synonyms
-
Whether to take into account an index's synonyms for a particular search.
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseSearchResponse
BaseSearchResponse
Value parameters
- abTestID
-
A/B test ID. This is only included in the response for indices that are part of an A/B test.
- abTestVariantID
-
Variant ID. This is only included in the response for indices that are part of an A/B test.
- aroundLatLng
-
Computed geographical location.
- automaticRadius
-
Automatically-computed radius.
- exhaustiveFacetsCount
-
See the
facetsCount
field of theexhaustive
object in the response. - exhaustiveNbHits
-
See the
nbHits
field of theexhaustive
object in the response. - exhaustiveTypo
-
See the
typo
field of theexhaustive
object in the response. - facets
-
Mapping of each facet name to the corresponding facet counts.
- facetsStats
-
Statistics for numerical facets.
- hitsPerPage
-
Number of hits per page.
- index
-
Index name used for the query.
- indexUsed
-
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
- message
-
Warnings about the query.
- nbHits
-
Number of hits the search query matched.
- nbPages
-
Number of pages of results for the current query.
- nbSortedHits
-
Number of hits selected and sorted by the relevant sort algorithm.
- page
-
Page to retrieve (the first page is
0
, not1
). - parsedQuery
-
Post-normalization query string that will be searched.
- processingTimeMS
-
Time the server took to process the request, in milliseconds.
- processingTimingsMS
-
Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
- queryAfterRemoval
-
Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
- serverTimeMS
-
Time the server took to process the request, in milliseconds.
- serverUsed
-
Host name of the server that processed the request.
- userData
-
Lets you store custom data in your indices.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
BaseTrendingFacetsQuery
BaseTrendingFacetsQuery
Value parameters
- facetName
-
Facet name for trending models.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseTrendingItemsQuery
BaseTrendingItemsQuery
Value parameters
- facetName
-
Facet name for trending models.
- facetValue
-
Facet value for trending models.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Condition
Condition
Value parameters
- alternatives
-
Whether the pattern matches on plurals, synonyms, and typos.
- context
-
Rule context format: [A-Za-z0-9_-]+).
- pattern
-
Query pattern syntax.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Consequences of a rule.
Consequences of a rule.
Value parameters
- filterPromotes
-
Only use in combination with the
promote
consequence. Whentrue
, promoted results will be restricted to match the filters of the current search. Whenfalse
, the promoted results will show up regardless of the filters. - hide
-
Records to hide. By default, you can hide up to 50 records per rule.
- promote
-
Records to promote.
- userData
-
Custom JSON object that will be appended to the userData array in the response. This object isn't interpreted by the API. It's limited to 1kB of minified JSON.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Unique identifier of the record to hide.
Unique identifier of the record to hide.
Value parameters
- objectID
-
Unique object identifier.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
ConsequenceParams
ConsequenceParams
Value parameters
- advancedSyntax
-
Enables the advanced query syntax.
- advancedSyntaxFeatures
-
Allows you to specify which advanced syntax features are active when
advancedSyntax
is enabled. - allowTyposOnNumericTokens
-
Whether to allow typos on numbers ("numeric tokens") in the query string.
- alternativesAsExact
-
Alternatives that should be considered an exact match by the exact ranking criterion.
- analytics
-
Indicates whether this query will be included in analytics.
- analyticsTags
-
Tags to apply to the query for segmenting analytics data.
- aroundLatLng
-
Search for entries around a central location, enabling a geographical search within a circular area.
- aroundLatLngViaIP
-
Search for entries around a location. The location is automatically computed from the requester's IP address.
- attributeCriteriaComputedByMinProximity
-
When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
- attributesForFaceting
-
Attributes used for faceting and the modifiers that can be applied:
filterOnly
,searchable
, andafterDistinct
. - attributesToHighlight
-
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (
highlightPreTag
andhighlightPostTag
). - attributesToRetrieve
-
Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
- attributesToSnippet
-
Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example:
body:20
. - clickAnalytics
-
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.
- customRanking
-
Specifies the Custom ranking criterion. Use the
asc
anddesc
modifiers to specify the ranking order: ascending or descending. - decompoundQuery
-
Splits compound words into their component word parts in the query.
- disableExactOnAttributes
-
Attributes for which you want to turn off the exact ranking criterion.
- disableTypoToleranceOnAttributes
-
Attributes for which you want to turn off typo tolerance.
- enableABTest
-
Incidates whether this search will be considered in A/B testing.
- enablePersonalization
-
Incidates whether Personalization is enabled.
- enableReRanking
-
Indicates whether this search will use Dynamic Re-Ranking.
- enableRules
-
Incidates whether Rules are enabled.
- explain
-
Enriches the API's response with information about how the query was processed.
- facetingAfterDistinct
-
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the
afterDistinct
modifier ofattributesForFaceting
allows for more granular control. - facets
-
Returns facets, their facet values, and the number of matching facet values.
- filters
-
Filter the query with numeric, facet, or tag filters.
- getRankingInfo
-
Incidates whether the search response includes detailed ranking information.
- highlightPostTag
-
HTML string to insert after the highlighted parts in all highlight and snippet results.
- highlightPreTag
-
HTML string to insert before the highlighted parts in all highlight and snippet results.
- hitsPerPage
-
Number of hits per page.
- insideBoundingBox
-
Search inside a rectangular area (in geographical coordinates).
- insidePolygon
-
Search inside a polygon (in geographical coordinates).
- keepDiacriticsOnCharacters
-
Characters that the engine shouldn't automatically normalize.
- length
-
Sets the number of hits to retrieve (for use with
offset
). > Note: Usingpage
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - maxFacetHits
-
Maximum number of facet hits to return when searching for facet values.
- maxValuesPerFacet
-
Maximum number of facet values to return for each facet.
- minProximity
-
Precision of the proximity ranking criterion.
- minWordSizefor1Typo
-
Minimum number of characters a word in the query string must contain to accept matches with one typo.
- minWordSizefor2Typos
-
Minimum number of characters a word in the query string must contain to accept matches with two typos.
- minimumAroundRadius
-
Minimum radius (in meters) used for a geographical search when
aroundRadius
isn't set. - naturalLanguages
-
Changes the default values of parameters that work best for a natural language query, such as
ignorePlurals
,removeStopWords
,removeWordsIfNoResults
,analyticsTags
, andruleContexts
. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries. - offset
-
Specifies the offset of the first hit to return. > Note: Using
page
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - optionalWords
-
Words which should be considered optional when found in a query.
- page
-
Page to retrieve (the first page is
0
, not1
). - percentileComputation
-
Whether to include or exclude a query from the processing-time percentile computation.
- personalizationImpact
-
Defines how much Personalization affects results.
- queryLanguages
-
Sets your user's search language. This adjusts language-specific settings and features such as
ignorePlurals
,removeStopWords
, and CJK word detection. - ranking
-
Determines the order in which Algolia returns your results.
- relevancyStrictness
-
Relevancy threshold below which less relevant results aren't included in the results.
- replaceSynonymsInHighlight
-
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
- responseFields
-
Attributes to include in the API response for search and browse queries.
- restrictHighlightAndSnippetArrays
-
Restrict highlighting and snippeting to items that matched the query.
- restrictSearchableAttributes
-
Restricts a query to only look at a subset of your searchable attributes.
- ruleContexts
-
Assigns rule contexts to search queries.
- similarQuery
-
Overrides the query parameter and performs a more generic search.
- snippetEllipsisText
-
String used as an ellipsis indicator when a snippet is truncated.
- sortFacetValuesBy
-
Controls how facet values are fetched.
- sumOrFiltersScores
-
Determines how to calculate filter scores. If
false
, maximum score is kept. Iftrue
, score is summed. - synonyms
-
Whether to take into account an index's synonyms for a particular search.
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can't do both).
When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can't do both).
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ConsequenceQuery.type
ConsequenceQueryObject
ConsequenceQueryObject
Value parameters
- edits
-
Edits to apply.
- remove
-
Words to remove.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait ConsequenceQueryTraittrait ConsequenceQueryclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class ConsequenceQueryObject
Response, taskID, and deletion timestamp.
Response, taskID, and deletion timestamp.
Value parameters
- deletedAt
-
Timestamp of deletion in ISO 8601 format.
- taskID
-
Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the
task
operation and thistaskID
.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Enables deduplication or grouping of results (Algolia's distinct feature).
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class BooleanValueclass IntValue
Attributes
- Supertypes
- Self type
-
DistinctSerializer.type
Edit
Edit
Value parameters
- delete
-
Text or patterns to remove from the query string.
- insert
-
Text that should be inserted in place of the removed text inside the query string.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Error.
Error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
Determines how the Exact ranking criterion is computed when the query contains only one word.
Determines how the Exact ranking criterion is computed when the query contains only one word.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[ExactOnSingleWordQuery]trait Serializer[ExactOnSingleWordQuery]class Objecttrait Matchableclass Any
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.
Value parameters
- facetValues
-
The value is
false
if not all facet values are retrieved. - facetsCount
-
Whether the facet count is exhaustive (
true
) or approximate (false
). See the related discussion. - nbHits
-
Whether the
nbHits
is exhaustive (true
) or approximate (false
). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches).nbHits
is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query. - rulesMatch
-
Rules matching exhaustivity. The value is
false
if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large. - typo
-
Whether the typo search was exhaustive (
true
) or approximate (false
). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Filter hits by facet value.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfMixedSearchFiltersclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
FacetFilters.type
Attributes
- Supertypes
- Self type
Defines the ordering of facets (widgets).
Defines the ordering of facets (widgets).
Value parameters
- values
-
Ordering of facet values within an individual facet.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Ordering of facets (widgets).
Ordering of facets (widgets).
Value parameters
- order
-
Pinned order of facet lists.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
FacetsStats
FacetsStats
Value parameters
- avg
-
Average facet value in the results.
- max
-
Maximum value in the results.
- min
-
Minimum value in the results.
- sum
-
Sum of all values in the results.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
GetRecommendTaskResponse
GetRecommendTaskResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Recommend parameters.
Recommend parameters.
Value parameters
- requests
-
Request parameters depend on the model (recommendations or trending).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
GetRecommendationsResponse
GetRecommendationsResponse
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
HighlightResult
HighlightResult
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HighlightResult.type
Show highlighted section and words matched on a query.
Show highlighted section and words matched on a query.
Value parameters
- fullyHighlighted
-
Whether the entire attribute value is highlighted.
- matchedWords
-
List of words from the query that matched the object.
- value
-
Markup text with
facetQuery
matches highlighted.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait HighlightResultTraittrait HighlightResultclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class HighlightResultOption
Treats singular, plurals, and other forms of declensions as matching terms. ignorePlurals
is used in conjunction with the queryLanguages
setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages
. true: enables the ignore plurals feature, where singulars and plurals are considered equivalent ("foot" = "feet"). The languages supported here are either every language (this is the default) or those set by queryLanguages
. false: turns off the ignore plurals feature, so that singulars and plurals aren't considered to be the same ("foot" will not find "feet").
Treats singular, plurals, and other forms of declensions as matching terms. ignorePlurals
is used in conjunction with the queryLanguages
setting. list: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages
. true: enables the ignore plurals feature, where singulars and plurals are considered equivalent ("foot" = "feet"). The languages supported here are either every language (this is the default) or those set by queryLanguages
. false: turns off the ignore plurals feature, so that singulars and plurals aren't considered to be the same ("foot" will not find "feet").
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class BooleanValueclass SeqOfString
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
IgnorePlurals.type
Attributes
- Supertypes
- Self type
IndexSettingsAsSearchParams
IndexSettingsAsSearchParams
Value parameters
- advancedSyntax
-
Enables the advanced query syntax.
- advancedSyntaxFeatures
-
Allows you to specify which advanced syntax features are active when
advancedSyntax
is enabled. - allowTyposOnNumericTokens
-
Whether to allow typos on numbers ("numeric tokens") in the query string.
- alternativesAsExact
-
Alternatives that should be considered an exact match by the exact ranking criterion.
- attributeCriteriaComputedByMinProximity
-
When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
- attributesForFaceting
-
Attributes used for faceting and the modifiers that can be applied:
filterOnly
,searchable
, andafterDistinct
. - attributesToHighlight
-
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (
highlightPreTag
andhighlightPostTag
). - attributesToRetrieve
-
Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
- attributesToSnippet
-
Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example:
body:20
. - customRanking
-
Specifies the Custom ranking criterion. Use the
asc
anddesc
modifiers to specify the ranking order: ascending or descending. - decompoundQuery
-
Splits compound words into their component word parts in the query.
- disableExactOnAttributes
-
Attributes for which you want to turn off the exact ranking criterion.
- disableTypoToleranceOnAttributes
-
Attributes for which you want to turn off typo tolerance.
- enablePersonalization
-
Incidates whether Personalization is enabled.
- enableReRanking
-
Indicates whether this search will use Dynamic Re-Ranking.
- enableRules
-
Incidates whether Rules are enabled.
- highlightPostTag
-
HTML string to insert after the highlighted parts in all highlight and snippet results.
- highlightPreTag
-
HTML string to insert before the highlighted parts in all highlight and snippet results.
- hitsPerPage
-
Number of hits per page.
- keepDiacriticsOnCharacters
-
Characters that the engine shouldn't automatically normalize.
- maxFacetHits
-
Maximum number of facet hits to return when searching for facet values.
- maxValuesPerFacet
-
Maximum number of facet values to return for each facet.
- minProximity
-
Precision of the proximity ranking criterion.
- minWordSizefor1Typo
-
Minimum number of characters a word in the query string must contain to accept matches with one typo.
- minWordSizefor2Typos
-
Minimum number of characters a word in the query string must contain to accept matches with two typos.
- optionalWords
-
Words which should be considered optional when found in a query.
- queryLanguages
-
Sets your user's search language. This adjusts language-specific settings and features such as
ignorePlurals
,removeStopWords
, and CJK word detection. - ranking
-
Determines the order in which Algolia returns your results.
- relevancyStrictness
-
Relevancy threshold below which less relevant results aren't included in the results.
- replaceSynonymsInHighlight
-
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
- responseFields
-
Attributes to include in the API response for search and browse queries.
- restrictHighlightAndSnippetArrays
-
Restrict highlighting and snippeting to items that matched the query.
- snippetEllipsisText
-
String used as an ellipsis indicator when a snippet is truncated.
- sortFacetValuesBy
-
Controls how facet values are fetched.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
Indicates how well the attribute matched the search query.
Indicates how well the attribute matched the search query.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
MatchLevel.type
Attributes
- Supertypes
-
class CustomSerializer[MatchLevel]trait Serializer[MatchLevel]class Objecttrait Matchableclass Any
MatchedGeoLocation
MatchedGeoLocation
Value parameters
- distance
-
Distance between the matched location and the search location (in meters).
- lat
-
Latitude of the matched location.
- lng
-
Longitude of the matched location.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
MixedSearchFilters
MixedSearchFilters
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfStringclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
MixedSearchFilters.type
Attributes
- Supertypes
- Self type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object KeywordSearch.typeobject NeuralSearch.type
Filter on numeric attributes.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfMixedSearchFiltersclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
NumericFilters.type
Attributes
- Supertypes
- Self type
Create filters to boost or demote records. Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don't match the optional filter are still included in the results, only their ranking is affected.
Create filters to boost or demote records. Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don't match the optional filter are still included in the results, only their ranking is affected.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfMixedSearchFiltersclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
OptionalFilters.type
Attributes
- Supertypes
- Self type
Additional search parameters.
Additional search parameters.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Personalization
Personalization
Value parameters
- filtersScore
-
The score of the filters.
- rankingScore
-
The score of the ranking.
- score
-
The score of the event.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Promote
Promote
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Record to promote.
Record to promote.
Value parameters
- objectID
-
Unique identifier of the record to promote.
- position
-
The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait PromoteTraittrait Promoteclass Objecttrait Matchableclass AnyShow all
Records to promote.
Records to promote.
Value parameters
- objectIDs
-
Unique identifiers of the records to promote.
- position
-
The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait PromoteTraittrait Promoteclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
- Self type
-
PromoteSerializer.type
Attributes
- Supertypes
- Known subtypes
-
class PromoteObjectIDclass PromoteObjectIDs
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Determines how query words are interpreted as prefixes.
Determines how query words are interpreted as prefixes.
Attributes
RankingInfo
RankingInfo
Value parameters
- filters
-
This field is reserved for advanced usage.
- firstMatchedWord
-
Position of the most important matched attribute in the attributes to index list.
- 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
-
Present and set to true if a Rule promoted the hit.
- promotedByReRanking
-
Wether the record are promoted by the re-ranking strategy.
- proximityDistance
-
When the query contains more than one word, the sum of the distances between matched words (in meters).
- userScore
-
Custom ranking for the object, expressed as a single integer value.
- words
-
Number of matched words, including prefixes and typos.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
When Dynamic Re-Ranking is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
When Dynamic Re-Ranking is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfMixedSearchFiltersclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ReRankingApplyFilter.type
Attributes
- Supertypes
- Self type
Recommend hit.
Recommend hit.
Value parameters
- highlightResult
-
Show highlighted section and words matched on a query.
- objectID
-
Unique object identifier.
- score
-
Recommendation score.
- snippetResult
-
Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsHitTraittrait RecommendationsHitclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object BoughtTogether.typeobject RelatedProducts.typeobject TrendingFacets.typeobject TrendingItems.type
RecommendModels enumeration
RecommendModels enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RecommendModels.type
Attributes
- Supertypes
-
class CustomSerializer[RecommendModels]trait Serializer[RecommendModels]class Objecttrait Matchableclass Any
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object BoughtTogether.typeobject RelatedProducts.type
Recommendation model.
Recommendation model.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RecommendationModels.type
Attributes
- Supertypes
-
class CustomSerializer[RecommendationModels]trait Serializer[RecommendationModels]class Objecttrait Matchableclass Any
RecommendationsHit
RecommendationsHit
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
RecommendationsHit.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class RecommendHitclass TrendingFacetHit
RecommendationsHits
RecommendationsHits
Value parameters
- params
-
URL-encoded string of all search parameters.
- query
-
Text to search for in an index.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
RecommendationsQuery
RecommendationsQuery
Value parameters
- indexName
-
Algolia index name.
- maxRecommendations
-
Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
- objectID
-
Unique object identifier.
- threshold
-
Recommendations with a confidence score lower than
threshold
won't appear in results. > Note: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsRequestclass Objecttrait Matchableclass AnyShow all
RecommendationsRequest
RecommendationsRequest
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class RecommendationsQueryclass RecommendedForYouQueryclass TrendingFacetsQueryclass TrendingItemsQuery
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class RecommendationsQueryclass RecommendedForYouQueryclass TrendingFacetsQueryclass TrendingItemsQuery
RecommendationsResults
RecommendationsResults
Value parameters
- abTestID
-
A/B test ID. This is only included in the response for indices that are part of an A/B test.
- abTestVariantID
-
Variant ID. This is only included in the response for indices that are part of an A/B test.
- aroundLatLng
-
Computed geographical location.
- automaticRadius
-
Automatically-computed radius.
- exhaustiveFacetsCount
-
See the
facetsCount
field of theexhaustive
object in the response. - exhaustiveNbHits
-
See the
nbHits
field of theexhaustive
object in the response. - exhaustiveTypo
-
See the
typo
field of theexhaustive
object in the response. - facets
-
Mapping of each facet name to the corresponding facet counts.
- facetsStats
-
Statistics for numerical facets.
- hitsPerPage
-
Number of hits per page.
- index
-
Index name used for the query.
- indexUsed
-
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
- message
-
Warnings about the query.
- nbHits
-
Number of hits the search query matched.
- nbPages
-
Number of pages of results for the current query.
- nbSortedHits
-
Number of hits selected and sorted by the relevant sort algorithm.
- page
-
Page to retrieve (the first page is
0
, not1
). - params
-
URL-encoded string of all search parameters.
- parsedQuery
-
Post-normalization query string that will be searched.
- processingTimeMS
-
Time the server took to process the request, in milliseconds.
- processingTimingsMS
-
Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
- query
-
Text to search for in an index.
- 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
-
Lets you store custom data in your indices.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object RecommendedForYou.type
Recommended for you model.
Recommended for you model.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[RecommendedForYouModel]trait Serializer[RecommendedForYouModel]class Objecttrait Matchableclass Any
RecommendedForYouQuery
RecommendedForYouQuery
Value parameters
- indexName
-
Algolia index name.
- maxRecommendations
-
Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
- threshold
-
Recommendations with a confidence score lower than
threshold
won't appear in results. > Note: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsRequestclass Objecttrait Matchableclass AnyShow all
RecommendedForYouQueryParameters
RecommendedForYouQueryParameters
Value parameters
- advancedSyntax
-
Enables the advanced query syntax.
- advancedSyntaxFeatures
-
Allows you to specify which advanced syntax features are active when
advancedSyntax
is enabled. - allowTyposOnNumericTokens
-
Whether to allow typos on numbers ("numeric tokens") in the query string.
- alternativesAsExact
-
Alternatives that should be considered an exact match by the exact ranking criterion.
- analytics
-
Indicates whether this query will be included in analytics.
- analyticsTags
-
Tags to apply to the query for segmenting analytics data.
- aroundLatLng
-
Search for entries around a central location, enabling a geographical search within a circular area.
- aroundLatLngViaIP
-
Search for entries around a location. The location is automatically computed from the requester's IP address.
- attributeCriteriaComputedByMinProximity
-
When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
- attributesForFaceting
-
Attributes used for faceting and the modifiers that can be applied:
filterOnly
,searchable
, andafterDistinct
. - attributesToHighlight
-
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (
highlightPreTag
andhighlightPostTag
). - attributesToRetrieve
-
Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
- attributesToSnippet
-
Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example:
body:20
. - clickAnalytics
-
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.
- customRanking
-
Specifies the Custom ranking criterion. Use the
asc
anddesc
modifiers to specify the ranking order: ascending or descending. - decompoundQuery
-
Splits compound words into their component word parts in the query.
- disableExactOnAttributes
-
Attributes for which you want to turn off the exact ranking criterion.
- disableTypoToleranceOnAttributes
-
Attributes for which you want to turn off typo tolerance.
- enableABTest
-
Incidates whether this search will be considered in A/B testing.
- enablePersonalization
-
Incidates whether Personalization is enabled.
- enableReRanking
-
Indicates whether this search will use Dynamic Re-Ranking.
- enableRules
-
Incidates whether Rules are enabled.
- explain
-
Enriches the API's response with information about how the query was processed.
- facetingAfterDistinct
-
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the
afterDistinct
modifier ofattributesForFaceting
allows for more granular control. - facets
-
Returns facets, their facet values, and the number of matching facet values.
- filters
-
Filter the query with numeric, facet, or tag filters.
- getRankingInfo
-
Incidates whether the search response includes detailed ranking information.
- highlightPostTag
-
HTML string to insert after the highlighted parts in all highlight and snippet results.
- highlightPreTag
-
HTML string to insert before the highlighted parts in all highlight and snippet results.
- hitsPerPage
-
Number of hits per page.
- insideBoundingBox
-
Search inside a rectangular area (in geographical coordinates).
- insidePolygon
-
Search inside a polygon (in geographical coordinates).
- keepDiacriticsOnCharacters
-
Characters that the engine shouldn't automatically normalize.
- length
-
Sets the number of hits to retrieve (for use with
offset
). > Note: Usingpage
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - maxFacetHits
-
Maximum number of facet hits to return when searching for facet values.
- maxValuesPerFacet
-
Maximum number of facet values to return for each facet.
- minProximity
-
Precision of the proximity ranking criterion.
- minWordSizefor1Typo
-
Minimum number of characters a word in the query string must contain to accept matches with one typo.
- minWordSizefor2Typos
-
Minimum number of characters a word in the query string must contain to accept matches with two typos.
- minimumAroundRadius
-
Minimum radius (in meters) used for a geographical search when
aroundRadius
isn't set. - naturalLanguages
-
Changes the default values of parameters that work best for a natural language query, such as
ignorePlurals
,removeStopWords
,removeWordsIfNoResults
,analyticsTags
, andruleContexts
. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries. - offset
-
Specifies the offset of the first hit to return. > Note: Using
page
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - optionalWords
-
Words which should be considered optional when found in a query.
- page
-
Page to retrieve (the first page is
0
, not1
). - percentileComputation
-
Whether to include or exclude a query from the processing-time percentile computation.
- personalizationImpact
-
Defines how much Personalization affects results.
- query
-
Text to search for in an index.
- queryLanguages
-
Sets your user's search language. This adjusts language-specific settings and features such as
ignorePlurals
,removeStopWords
, and CJK word detection. - ranking
-
Determines the order in which Algolia returns your results.
- relevancyStrictness
-
Relevancy threshold below which less relevant results aren't included in the results.
- replaceSynonymsInHighlight
-
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
- responseFields
-
Attributes to include in the API response for search and browse queries.
- restrictHighlightAndSnippetArrays
-
Restrict highlighting and snippeting to items that matched the query.
- restrictSearchableAttributes
-
Restricts a query to only look at a subset of your searchable attributes.
- ruleContexts
-
Assigns rule contexts to search queries.
- similarQuery
-
Overrides the query parameter and performs a more generic search.
- snippetEllipsisText
-
String used as an ellipsis indicator when a snippet is truncated.
- sortFacetValuesBy
-
Controls how facet values are fetched.
- sumOrFiltersScores
-
Determines how to calculate filter scores. If
false
, maximum score is kept. Iftrue
, score is summed. - synonyms
-
Whether to take into account an index's synonyms for a particular search.
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Redirect results to a URL.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
RedirectRuleIndexMetadata
RedirectRuleIndexMetadata
Value parameters
- dest
-
Destination index for the redirect rule.
- reason
-
Reason for the redirect rule.
- source
-
Source index for the redirect rule.
- succeed
-
Redirect rule status.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Redirect rule data.
Redirect rule data.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Removes stop (common) words from the query before executing it. removeStopWords
is used in conjunction with the queryLanguages
setting. list: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in queryLanguages
. true: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language (this is the default) or those set by queryLanguages
. false: turns off the stop words feature, allowing stop words to be taken into account in a search.
Removes stop (common) words from the query before executing it. removeStopWords
is used in conjunction with the queryLanguages
setting. list: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in queryLanguages
. true: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language (this is the default) or those set by queryLanguages
. false: turns off the stop words feature, allowing stop words to be taken into account in a search.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class BooleanValueclass SeqOfString
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
RemoveStopWords.type
Attributes
- Supertypes
- Self type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Strategy to remove words from the query when it doesn't match any hits.
Strategy to remove words from the query when it doesn't match any hits.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class CustomSerializer[RemoveWordsIfNoResults]trait Serializer[RemoveWordsIfNoResults]class Objecttrait Matchableclass Any
Extra content for the search UI, for example, to control the ordering and display of facets. You can set a default value and dynamically override it with Rules.
Extra content for the search UI, for example, to control the ordering and display of facets. You can set a default value and dynamically override it with Rules.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Rule object.
Rule object.
Value parameters
- conditions
-
Conditions required to activate a rule. You can use up to 25 conditions per rule.
- description
-
Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
- enabled
-
Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
- objectID
-
Unique identifier for a rule object.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
RuleResponseMetadata
RuleResponseMetadata
Value parameters
- lastUpdate
-
Timestamp of the last update in ISO 8601 format.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SearchParamsObject
SearchParamsObject
Value parameters
- advancedSyntax
-
Enables the advanced query syntax.
- advancedSyntaxFeatures
-
Allows you to specify which advanced syntax features are active when
advancedSyntax
is enabled. - allowTyposOnNumericTokens
-
Whether to allow typos on numbers ("numeric tokens") in the query string.
- alternativesAsExact
-
Alternatives that should be considered an exact match by the exact ranking criterion.
- analytics
-
Indicates whether this query will be included in analytics.
- analyticsTags
-
Tags to apply to the query for segmenting analytics data.
- aroundLatLng
-
Search for entries around a central location, enabling a geographical search within a circular area.
- aroundLatLngViaIP
-
Search for entries around a location. The location is automatically computed from the requester's IP address.
- attributeCriteriaComputedByMinProximity
-
When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
- attributesForFaceting
-
Attributes used for faceting and the modifiers that can be applied:
filterOnly
,searchable
, andafterDistinct
. - attributesToHighlight
-
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (
highlightPreTag
andhighlightPostTag
). - attributesToRetrieve
-
Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
- attributesToSnippet
-
Attributes to snippet. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example:
body:20
. - clickAnalytics
-
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events.
- customRanking
-
Specifies the Custom ranking criterion. Use the
asc
anddesc
modifiers to specify the ranking order: ascending or descending. - decompoundQuery
-
Splits compound words into their component word parts in the query.
- disableExactOnAttributes
-
Attributes for which you want to turn off the exact ranking criterion.
- disableTypoToleranceOnAttributes
-
Attributes for which you want to turn off typo tolerance.
- enableABTest
-
Incidates whether this search will be considered in A/B testing.
- enablePersonalization
-
Incidates whether Personalization is enabled.
- enableReRanking
-
Indicates whether this search will use Dynamic Re-Ranking.
- enableRules
-
Incidates whether Rules are enabled.
- explain
-
Enriches the API's response with information about how the query was processed.
- facetingAfterDistinct
-
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the
afterDistinct
modifier ofattributesForFaceting
allows for more granular control. - facets
-
Returns facets, their facet values, and the number of matching facet values.
- filters
-
Filter the query with numeric, facet, or tag filters.
- getRankingInfo
-
Incidates whether the search response includes detailed ranking information.
- highlightPostTag
-
HTML string to insert after the highlighted parts in all highlight and snippet results.
- highlightPreTag
-
HTML string to insert before the highlighted parts in all highlight and snippet results.
- hitsPerPage
-
Number of hits per page.
- insideBoundingBox
-
Search inside a rectangular area (in geographical coordinates).
- insidePolygon
-
Search inside a polygon (in geographical coordinates).
- keepDiacriticsOnCharacters
-
Characters that the engine shouldn't automatically normalize.
- length
-
Sets the number of hits to retrieve (for use with
offset
). > Note: Usingpage
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - maxFacetHits
-
Maximum number of facet hits to return when searching for facet values.
- maxValuesPerFacet
-
Maximum number of facet values to return for each facet.
- minProximity
-
Precision of the proximity ranking criterion.
- minWordSizefor1Typo
-
Minimum number of characters a word in the query string must contain to accept matches with one typo.
- minWordSizefor2Typos
-
Minimum number of characters a word in the query string must contain to accept matches with two typos.
- minimumAroundRadius
-
Minimum radius (in meters) used for a geographical search when
aroundRadius
isn't set. - naturalLanguages
-
Changes the default values of parameters that work best for a natural language query, such as
ignorePlurals
,removeStopWords
,removeWordsIfNoResults
,analyticsTags
, andruleContexts
. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries. - offset
-
Specifies the offset of the first hit to return. > Note: Using
page
andhitsPerPage
is the recommended method for paging results. However, you can useoffset
andlength
to implement an alternative approach to paging. - optionalWords
-
Words which should be considered optional when found in a query.
- page
-
Page to retrieve (the first page is
0
, not1
). - percentileComputation
-
Whether to include or exclude a query from the processing-time percentile computation.
- personalizationImpact
-
Defines how much Personalization affects results.
- query
-
Text to search for in an index.
- queryLanguages
-
Sets your user's search language. This adjusts language-specific settings and features such as
ignorePlurals
,removeStopWords
, and CJK word detection. - ranking
-
Determines the order in which Algolia returns your results.
- relevancyStrictness
-
Relevancy threshold below which less relevant results aren't included in the results.
- replaceSynonymsInHighlight
-
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
- responseFields
-
Attributes to include in the API response for search and browse queries.
- restrictHighlightAndSnippetArrays
-
Restrict highlighting and snippeting to items that matched the query.
- restrictSearchableAttributes
-
Restricts a query to only look at a subset of your searchable attributes.
- ruleContexts
-
Assigns rule contexts to search queries.
- similarQuery
-
Overrides the query parameter and performs a more generic search.
- snippetEllipsisText
-
String used as an ellipsis indicator when a snippet is truncated.
- sortFacetValuesBy
-
Controls how facet values are fetched.
- sumOrFiltersScores
-
Determines how to calculate filter scores. If
false
, maximum score is kept. Iftrue
, score is summed. - synonyms
-
Whether to take into account an index's synonyms for a particular search.
- userToken
-
Associates a user token with the current search.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SearchParamsQuery
SearchParamsQuery
Value parameters
- query
-
Text to search for in an index.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Recommend rules search parameters.
Recommend rules search parameters.
Value parameters
- context
-
Restricts responses to the specified contextual rule.
- enabled
-
Restricts responses to enabled rules. When absent (default), all rules are retrieved.
- hitsPerPage
-
Maximum number of hits per page.
- page
-
Requested page (the first page is page 0).
- query
-
Full-text query.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SearchRecommendRulesResponse
SearchRecommendRulesResponse
Value parameters
- hits
-
Fetched rules.
- nbHits
-
Number of hits the search query matched.
- nbPages
-
Number of pages of results for the current query.
- page
-
Page to retrieve (the first page is
0
, not1
).
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Settings for the semantic search part of NeuralSearch. Only used when mode
is neuralSearch.
Settings for the semantic search part of NeuralSearch. Only used when mode
is neuralSearch.
Value parameters
- eventSources
-
Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
SnippetResult
SnippetResult
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
SnippetResult.type
Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
Value parameters
- value
-
Markup text with
facetQuery
matches highlighted.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SnippetResultTraittrait SnippetResultclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class SnippetResultOption
How to display the remaining items: - count
: facet count (descending). - alpha
: alphabetical (ascending). - hidden
: show only pinned values.
How to display the remaining items: - count
: facet count (descending). - alpha
: alphabetical (ascending). - hidden
: show only pinned values.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
SortRemainingBy.type
Attributes
- Supertypes
-
class CustomSerializer[SortRemainingBy]trait Serializer[SortRemainingBy]class Objecttrait Matchableclass Any
Filter hits by tags.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class SeqOfMixedSearchFiltersclass StringValue
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TagFilters.type
Attributes
- Supertypes
- Self type
-
TagFiltersSerializer.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object NotPublished.typeobject Published.type
published if the task has been processed, notPublished otherwise.
published if the task has been processed, notPublished otherwise.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TaskStatus.type
Attributes
- Supertypes
-
class CustomSerializer[TaskStatus]trait Serializer[TaskStatus]class Objecttrait Matchableclass Any
Trending facet hit.
Trending facet hit.
Value parameters
- facetName
-
Facet name for trending models.
- facetValue
-
Facet value for trending models.
- score
-
Recommendation score.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsHitTraittrait RecommendationsHitclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object TrendingFacets.type
Trending facets model.
Trending facets model.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TrendingFacetsModel.type
Attributes
- Supertypes
-
class CustomSerializer[TrendingFacetsModel]trait Serializer[TrendingFacetsModel]class Objecttrait Matchableclass Any
TrendingFacetsQuery
TrendingFacetsQuery
Value parameters
- facetName
-
Facet name for trending models.
- indexName
-
Algolia index name.
- maxRecommendations
-
Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
- threshold
-
Recommendations with a confidence score lower than
threshold
won't appear in results. > Note: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsRequestclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object TrendingItems.type
Trending items model.
Trending items model.
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TrendingItemsModel.type
Attributes
- Supertypes
-
class CustomSerializer[TrendingItemsModel]trait Serializer[TrendingItemsModel]class Objecttrait Matchableclass Any
TrendingItemsQuery
TrendingItemsQuery
Value parameters
- facetName
-
Facet name for trending models.
- facetValue
-
Facet value for trending models.
- indexName
-
Algolia index name.
- maxRecommendations
-
Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
- threshold
-
Recommendations with a confidence score lower than
threshold
won't appear in results. > Note: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait RecommendationsRequestclass Objecttrait Matchableclass AnyShow all
Controls whether typo tolerance is enabled and how it is applied.
Controls whether typo tolerance is enabled and how it is applied.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class BooleanValuetrait TypoToleranceTraittrait TypoToleranceEnumobject Min.typeobject Strict.type
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
TypoTolerance.type
Attributes
- Companion
- object
- Supertypes
- Known subtypes
TypoToleranceEnum enumeration
TypoToleranceEnum enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
TypoToleranceEnum.type
Attributes
- Supertypes
-
class CustomSerializer[TypoToleranceEnum]trait Serializer[TypoToleranceEnum]class Objecttrait Matchableclass Any
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
Value
Value
Value parameters
- order
-
Pinned order of facet lists.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all