algoliasearch.querysuggestions
Members list
Type members
Classlikes
AppID
AppID
Value parameters
- appID
-
Algolia application ID to which this Query Suggestions configuration belongs.
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
-
Name of the Query Suggestions index (case-sensitive).
- isRunning
-
Whether the creation or update of the Query Suggestions index is in progress.
- lastBuiltAt
-
Date and time when the Query Suggestions index was last built, in RFC 3339 format.
- lastSuccessfulBuildDuration
-
Duration of the last successful build in seconds.
- lastSuccessfulBuiltAt
-
Date and time 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
-
Date and time of the log entry, in RFC 3339 format.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
Languages 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
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.
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
-
Whether to include suggestions with special characters.
- enablePersonalization
-
Whether to turn on personalized 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
API response for retrieving Query Suggestions configurations.
API response for retrieving Query Suggestions configurations.
Value parameters
- allowSpecialCharacters
-
Whether to include suggestions with special characters.
- appID
-
Algolia application ID to which this Query Suggestions configuration belongs.
- enablePersonalization
-
Whether to turn on personalized query suggestions.
- indexName
-
Name of the Query Suggestions index (case-sensitive).
- sourceIndices
-
Algolia indices from which to get the popular searches for query suggestions.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Query Suggestions configuration.
Query Suggestions configuration.
Value parameters
- allowSpecialCharacters
-
Whether to include suggestions with special characters.
- enablePersonalization
-
Whether to turn on personalized query suggestions.
- indexName
-
Name of the Query Suggestions index (case-sensitive).
- 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
- indexName
-
Name of the Algolia index (case-sensitive) 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
search results 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 replica indices to find popular searches. If false, only the primary index is used.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all