Type Members

1.  case class AppID(appID: Option[String] = scala.None) extends Product with Serializable

   AppID

   AppID

   appID

   Algolia application ID to which this Query Suggestions configuration belongs.

2.  case class BaseResponse(status: Option[Int] = scala.None, message: Option[String] = scala.None) extends Product with Serializable

   BaseResponse

   BaseResponse

   status

   HTTP status code.

   message

   Details about the response, such as error messages.

3.  case class ConfigStatus(indexName: Option[String] = scala.None, isRunning: Option[Boolean] = scala.None, lastBuiltAt: Option[String] = scala.None, lastSuccessfulBuiltAt: Option[String] = scala.None, lastSuccessfulBuildDuration: Option[String] = scala.None) extends Product with Serializable

   ConfigStatus

   ConfigStatus

   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.

   lastSuccessfulBuiltAt

   Date and time when the Query Suggestions index was last updated successfully.

   lastSuccessfulBuildDuration

   Duration of the last successful build in seconds.

4.  case class Configuration(sourceIndices: Seq[SourceIndex], languages: Option[Languages] = scala.None, exclude: Option[Seq[String]] = scala.None, enablePersonalization: Option[Boolean] = scala.None, allowSpecialCharacters: Option[Boolean] = scala.None) extends Product with Serializable

   Query Suggestions configuration.

   Query Suggestions configuration.

   sourceIndices

   Algolia indices from which to get the popular searches for query suggestions.

   enablePersonalization

   Whether to turn on personalized query suggestions.

   allowSpecialCharacters

   Whether to include suggestions with special characters.

5.  case class ConfigurationResponse(appID: String, indexName: String, sourceIndices: Seq[SourceIndex], languages: Languages, exclude: Option[Seq[String]] = scala.None, enablePersonalization: Boolean, allowSpecialCharacters: Boolean) extends Product with Serializable

   API response for retrieving Query Suggestions configurations.

   API response for retrieving Query Suggestions configurations.

   appID

   Algolia application ID to which this Query Suggestions configuration belongs.

   indexName

   Name of the Query Suggestions index (case-sensitive).

   sourceIndices

   Algolia indices from which to get the popular searches for query suggestions.

   enablePersonalization

   Whether to turn on personalized query suggestions.

   allowSpecialCharacters

   Whether to include suggestions with special characters.

6.  case class ConfigurationWithIndex(sourceIndices: Seq[SourceIndex], languages: Option[Languages] = scala.None, exclude: Option[Seq[String]] = scala.None, enablePersonalization: Option[Boolean] = scala.None, allowSpecialCharacters: Option[Boolean] = scala.None, indexName: String) extends Product with Serializable

   Query Suggestions configuration.

   Query Suggestions configuration.

   sourceIndices

   Algolia indices from which to get the popular searches for query suggestions.

   enablePersonalization

   Whether to turn on personalized query suggestions.

   allowSpecialCharacters

   Whether to include suggestions with special characters.

   indexName

   Name of the Query Suggestions index (case-sensitive).

7.  case class ErrorBase(message: Option[String] = scala.None, additionalProperties: Option[List[JField]] = None) extends Product with Serializable

   Error.

8.  class ErrorBaseSerializer extends Serializer[ErrorBase]
9.  case class Facet(attribute: Option[String] = scala.None, amount: Option[Int] = scala.None) extends Product with Serializable

   Facet to use as category.

   Facet to use as category.

   attribute

   Facet name.

   amount

   Number of suggestions.

10.  sealed trait Languages extends AnyRef

    Languages for deduplicating singular and plural suggestions.

    Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.

11.  case class LogFile(timestamp: Option[String] = scala.None, level: Option[LogLevel] = scala.None, message: Option[String] = scala.None, contextLevel: Option[Int] = scala.None) extends Product with Serializable

    LogFile

    LogFile

    timestamp

    Date and time of the log entry, in RFC 3339 format.

    message

    Details about this log entry.

    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 with contextLevel 0.

12.  sealed trait LogLevel extends AnyRef
13.  class LogLevelSerializer extends CustomSerializer[LogLevel]
14.  case class SourceIndex(indexName: String, replicas: Option[Boolean] = scala.None, analyticsTags: Option[Seq[String]] = scala.None, facets: Option[Seq[Facet]] = scala.None, minHits: Option[Int] = scala.None, minLetters: Option[Int] = scala.None, generate: Option[Seq[Seq[String]]] = scala.None, external: Option[Seq[String]] = scala.None) extends Product with Serializable

    Configuration of an Algolia index for Query Suggestions.

    Configuration of an Algolia index for Query Suggestions.

    indexName

    Name of the Algolia index (case-sensitive) to use as source for query suggestions.

    replicas

    If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.

    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.