SourceIndex

algoliasearch.querysuggestions.SourceIndex
case class SourceIndex(indexName: String, replicas: Option[Boolean], analyticsTags: Option[Seq[String]], facets: Option[Seq[Facet]], minHits: Option[Int], minLetters: Option[Int], generate: Option[Seq[Seq[String]]], external: Option[Seq[String]])

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

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product