algoliasearch.querysuggestions
Members list
Type members
Classlikes
BaseQuerySuggestionsConfigurationResponse
BaseQuerySuggestionsConfigurationResponse
Value parameters
- appId
-
Your Algolia application ID.
- externalIndicesAPIKey
-
API key used to read from external Algolia indices.
- sourceIndicesAPIKey
-
API key used to read from your source index.
- suggestionsIndicesAPIKey
-
API key used to write and configure your Query Suggestions index.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseQuerySuggestionsConfigurationWithIndex
BaseQuerySuggestionsConfigurationWithIndex
Value parameters
- indexName
-
Query Suggestions index name.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
BaseResponse
BaseResponse
Value parameters
- message
-
Details about the response, such as error messages.
- status
-
HTTP status code.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Error.
Error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
Facet to use as category.
Facet to use as category.
Value parameters
- amount
-
Number of suggestions.
- attribute
-
Facet name.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
GetConfigStatus200Response
GetConfigStatus200Response
Value parameters
- indexName
-
Query Suggestions index name.
- isRunning
-
Indicates whether the creation or update of the Query Suggestions is in progress.
- lastBuiltAt
-
Timestamp in ISO-8601 format when the Query Suggestions index was last built.
- lastSuccessfulBuildDuration
-
Duration of the last successful build in seconds.
- lastSuccessfulBuiltAt
-
Timestamp in ISO-8601 format when the Query Suggestions index was last updated successfully.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
GetLogFile200Response
GetLogFile200Response
Value parameters
- contextLevel
-
Level indicating the position of a suggestion in a hierarchy of records. For example, a
contextLevel
of 1 indicates that this suggestion belongs to a previous suggestion withcontextLevel
0. - message
-
Details about this log entry.
- timestamp
-
Timestamp in ISO-8601 format.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class BooleanValueclass SeqOfString
Attributes
- Supertypes
- Self type
-
LanguagesSerializer.type
The type of log entry. - SKIP
. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - INFO
. An informative log entry. - ERROR
. The Query Suggestions process encountered an error.
The type of log entry. - SKIP
. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - INFO
. An informative log entry. - ERROR
. The Query Suggestions process encountered an error.
Attributes
Query Suggestions configuration.
Query Suggestions configuration.
Value parameters
- allowSpecialCharacters
-
Allow suggestions with special characters.
- enablePersonalization
-
Turn on personalized query suggestions.
- exclude
-
Patterns to exclude from query suggestions.
- sourceIndices
-
Algolia indices from which to get the popular searches for query suggestions.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
QuerySuggestionsConfigurationResponse
QuerySuggestionsConfigurationResponse
Value parameters
- allowSpecialCharacters
-
Allow suggestions with special characters.
- appId
-
Your Algolia application ID.
- enablePersonalization
-
Turn on personalized query suggestions.
- exclude
-
Patterns to exclude from query suggestions.
- externalIndicesAPIKey
-
API key used to read from external Algolia indices.
- indexName
-
Query Suggestions index name.
- sourceIndices
-
Algolia indices from which to get the popular searches for query suggestions.
- sourceIndicesAPIKey
-
API key used to read from your source index.
- suggestionsIndicesAPIKey
-
API key used to write and configure your Query Suggestions index.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Query Suggestions configuration.
Query Suggestions configuration.
Value parameters
- allowSpecialCharacters
-
Allow suggestions with special characters.
- enablePersonalization
-
Turn on personalized query suggestions.
- exclude
-
Patterns to exclude from query suggestions.
- indexName
-
Query Suggestions index name.
- sourceIndices
-
Algolia indices from which to get the popular searches for query suggestions.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Configuration of an Algolia index for Query Suggestions.
Configuration of an Algolia index for Query Suggestions.
Value parameters
- analyticsTags
-
Analytics tags for filtering the popular searches.
- external
-
Algolia indices with popular searches to use as query suggestions. Records of these indices must have these attributes: -
query
: search query which will be added as a suggestion -count
: measure of popularity of that search query For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data. - facets
-
Facets to use as top categories with your suggestions. If provided, Query Suggestions adds the top facet values to each suggestion.
- indexName
-
Name of the Algolia index to use as source for query suggestions.
- minHits
-
Minimum number of hits required to be included as a suggestion. A search query must at least generate
minHits
hits to be included in the Query Suggestions index. - minLetters
-
Minimum letters required to be included as a suggestion. A search query must be at least
minLetters
long to be included in the Query Suggestions index. - replicas
-
If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all