objects

Type Members

1. sealed trait AbstractSynonym extends AnyRef

   

2. sealed trait Acl extends AnyRef

   

3. trait Alternatives extends AnyRef

   

4. case class ApiKey(validity: Option[Int] = None, maxQueriesPerIPPerHour: Option[Int] = None, maxHitsPerQuery: Option[Int] = None, acl: Option[Seq[Acl]] = None, indexes: Option[Seq[String]] = None, referers: Option[Seq[String]] = None, queryParameters: Option[String] = None, description: Option[String] = None, restrictSources: Option[String] = None) extends Product with Serializable

   

5. case class AroundLatLng(lat: String, lng: String) extends Product with Serializable

   

6. sealed trait AroundRadius extends AnyRef

   

7. sealed trait AttributesToIndex extends AnyRef

   

   Use SearchableAttributes

   Use SearchableAttributes

   Annotations

   @Deprecated

8. case class AutomaticFacetFilters(facet: String, disjunctive: Option[Boolean] = None, score: Option[Int] = None) extends Product with Serializable

   

9. case class CompoundEntry(objectID: String, language: String, word: String, decomposition: Seq[String]) extends DictionaryEntry with Product with Serializable

   

10. case class Condition(pattern: String, anchoring: String, context: Option[String] = None, alternatives: Option[Alternatives] = None, filters: Option[String] = None) extends Product with Serializable

    

11. case class Consequence(params: Option[Map[String, Any]] = None, filterPromotes: Option[Boolean] = None, promote: Option[Iterable[ConsequencePromote]] = None, hide: Option[Iterable[ConsequenceHide]] = None, userData: Option[Map[String, Any]] = None, renderingContent: Option[RenderingContent] = None) extends Product with Serializable

    

12. case class ConsequenceHide(objectID: String) extends Product with Serializable

    

13. case class ConsequencePromote(objectID: String, position: Int) extends Product with Serializable

    

14. sealed trait CustomRanking extends AnyRef

    

15. case class CustomRequest(verb: HttpVerb, path: Seq[String], endpoint: RequestEndpoint, queryParameters: Option[Map[String, String]] = None, body: Option[String] = None, requestOptions: Option[RequestOptions] = None) extends Product with Serializable

    

16. sealed trait Dictionary[+T <: DictionaryEntry] extends AnyRef

    

17. sealed trait DictionaryEntry extends AnyRef

    

18. case class DictionarySettings(disableStandardEntries: Option[DisableStandardEntries] = None) extends Product with Serializable

    

    Represents Dictionary settings.

19. case class DisableStandardEntries(stopwords: Option[Map[String, Boolean]] = None) extends Product with Serializable

    

    Map of language ISO code supported by the dictionary (e.g., “en” for English) to a boolean value.

    Map of language ISO code supported by the dictionary (e.g., “en” for English) to a boolean value. When set to true, the standard entries for the language are disabled. Changes are set for the given languages only. To re-enable standard entries, set the language to false. To reset settings to default values, set dictionary to null.

20. sealed trait Distinct extends AnyRef

    

21. case class Edit(type: String, delete: String, insert: Option[String] = None) extends Product with Serializable

    

22. case class EventsScoring(eventName: String, eventType: String, score: Int) extends Product with Serializable

    

23. case class FacetOrdering(facets: FacetsOrder, values: Map[String, FacetValuesOrder]) extends Product with Serializable

    

    Facets and facets values ordering rules container.

24. case class FacetValuesOrder(order: Seq[String], sortRemainingBy: Option[SortRule] = None) extends Product with Serializable

    

    Facet values ordering rule container.

25. case class FacetsOrder(order: Seq[String]) extends Product with Serializable

    

    Define or override the way facet attributes are displayed.

26. case class FacetsScoring(facetName: String, score: Int) extends Product with Serializable

    

27. case class FrequentlyBoughtTogetherQuery(indexName: String, objectID: String, threshold: Int = 0, maxRecommendations: Option[Int] = None, queryParameters: Option[Query] = None, fallbackParameters: Option[Query] = None) extends RecommendationsOptions with Product with Serializable

    

28. sealed trait IgnorePlurals extends AnyRef

    

29. case class IndexSettings(attributeForDistinct: Option[String] = None, distinct: Option[Distinct] = None, replaceSynonymsInHighlight: Option[Boolean] = None, placeholders: Option[Map[String, Seq[String]]] = None, minProximity: Option[Int] = None, keepDiacriticsOnCharacters: Option[String] = None, queryLanguages: Option[Seq[String]] = None, indexLanguages: Option[Seq[String]] = None, attributeCriteriaComputedByMinProximity: Option[Boolean] = None, primary: Option[String] = None, userData: Option[Any] = None, customNormalization: Option[Map[String, Map[String, String]]] = None, enablePersonalization: Option[Boolean] = None, attributesToTransliterate: Option[Seq[String]] = None, decompoundQuery: Option[Boolean] = None, attributesToIndex: Option[Seq[AttributesToIndex]] = None, searchableAttributes: Option[Seq[SearchableAttributes]] = None, attributesForFaceting: Option[Seq[String]] = None, unretrievableAttributes: Option[Seq[String]] = None, attributesToRetrieve: Option[Seq[String]] = None, camelCaseAttributes: Option[Seq[String]] = None, decompoundedAttributes: Option[Map[String, Seq[String]]] = None, maxValuesPerFacet: Option[Int] = None, sortFacetValuesBy: Option[String] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, hitsPerPage: Option[Int] = None, paginationLimitedTo: Option[Int] = None, numericAttributesForFiltering: Option[Seq[String]] = None, allowCompressionOfIntegerArray: Option[Boolean] = None, enableRules: Option[Boolean] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[String] = None, advancedSyntax: Option[Boolean] = None, advancedSyntaxFeatures: Option[Seq[String]] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disablePrefixOnAttributes: Option[Seq[String]] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, ranking: Option[Seq[Ranking]] = None, customRanking: Option[Seq[CustomRanking]] = None, slaves: Option[Seq[String]] = None, replicas: Option[Seq[String]] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, disableTypoToleranceOnWords: Option[Seq[String]] = None, separatorsToIndex: Option[String] = None, renderingContent: Option[RenderingContent] = None, relevancyStrictness: Option[Int] = None) extends Product with Serializable

    

30. case class InsideBoundingBox(p1Lat: String, p1Lng: String, p2Lat: String, p2Lng: String) extends Product with Serializable

    

31. case class InsidePolygon(p1Lat: String, p1Lng: String, p2Lat: String, p2Lng: String, p3Lat: String, p3Lng: String) extends Product with Serializable

    

32. case class PluralEntry(objectID: String, language: String, words: Seq[String]) extends DictionaryEntry with Product with Serializable

    

33. case class Query(distinct: Option[Distinct] = None, getRankingInfo: Option[Boolean] = None, numericFilters: Option[Seq[String]] = None, tagFilters: Option[Seq[String]] = None, analytics: Option[Boolean] = None, analyticsTags: Option[Seq[String]] = None, synonyms: Option[Boolean] = None, replaceSynonymsInHighlight: Option[Boolean] = None, minProximity: Option[Int] = None, responseFields: Option[Seq[String]] = None, maxFacetHits: Option[Int] = None, percentileComputation: Option[Boolean] = None, queryLanguages: Option[Seq[String]] = None, enableABTest: Option[Boolean] = None, explain: Option[Seq[String]] = None, naturalLanguages: Option[Seq[String]] = None, decompoundQuery: Option[Boolean] = None, attributesToRetrieve: Option[Seq[String]] = None, restrictSearchableAttributes: Option[Seq[String]] = None, filters: Option[String] = None, facets: Option[Seq[String]] = None, maxValuesPerFacet: Option[Int] = None, facetFilters: Option[Seq[String]] = None, facetingAfterDistinct: Option[Boolean] = None, sortFacetValuesBy: Option[String] = None, aroundLatLng: Option[AroundLatLng] = None, aroundLatLngViaIP: Option[Boolean] = None, aroundRadius: Option[AroundRadius] = None, aroundPrecision: Option[Int] = None, minimumAroundRadius: Option[Int] = None, insideBoundingBox: Option[Seq[InsideBoundingBox]] = None, insidePolygon: Option[Seq[InsidePolygon]] = None, attributesToHighlight: Option[Seq[String]] = None, attributesToSnippet: Option[Seq[String]] = None, highlightPreTag: Option[String] = None, highlightPostTag: Option[String] = None, snippetEllipsisText: Option[String] = None, restrictHighlightAndSnippetArrays: Option[Boolean] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, offset: Option[Int] = None, length: Option[Int] = None, enableRules: Option[Boolean] = None, ruleContexts: Option[Seq[String]] = None, queryType: Option[QueryType] = None, removeWordsIfNoResults: Option[RemoveWordsIfNoResults] = None, advancedSyntax: Option[Boolean] = None, advancedSyntaxFeatures: Option[Seq[String]] = None, optionalWords: Option[Seq[String]] = None, removeStopWords: Option[RemoveStopWords] = None, disableExactOnAttributes: Option[Seq[String]] = None, exactOnSingleWordQuery: Option[Seq[String]] = None, alternativesAsExact: Option[Seq[String]] = None, query: Option[String] = None, facetQuery: Option[String] = None, similarQuery: Option[String] = None, minWordSizefor1Typo: Option[Int] = None, minWordSizefor2Typos: Option[Int] = None, typoTolerance: Option[TypoTolerance] = None, allowTyposOnNumericTokens: Option[Boolean] = None, ignorePlurals: Option[IgnorePlurals] = None, disableTypoToleranceOnAttributes: Option[Seq[String]] = None, userToken: Option[String] = None, validUntil: Option[Int] = None, restrictIndices: Option[Seq[String]] = None, restrictSources: Option[String] = None, cursor: Option[String] = None, enablePersonalization: Option[Boolean] = None, customParameters: Option[Map[String, String]] = None, relevancyStrictness: Option[Int] = None) extends Product with Serializable

    

34. case class QueryDictionary(query: Option[String] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, language: Option[String] = None, customParameters: Option[Map[String, String]] = None) extends Product with Serializable

    

35. case class QueryRules(query: String, anchoring: Option[String] = None, context: Option[String] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None, nbPages: Option[Int] = None) extends Product with Serializable

    

36. case class QuerySynonyms(query: String, types: Option[Seq[SynonymType]] = None, page: Option[Int] = None, hitsPerPage: Option[Int] = None) extends Product with Serializable

    

37. sealed trait QueryType extends AnyRef

    

38. sealed trait Ranking extends AnyRef

    

39. sealed trait RecommendationsOptions extends AnyRef

    

    Recommendations query options.

    Recommendations query options.

    See also

    Documentation

40. case class RecommendationsQuery(indexName: String, model: String, objectID: String, threshold: Int = 0, maxRecommendations: Option[Int] = None, queryParameters: Option[Query] = None, fallbackParameters: Option[Query] = None) extends RecommendationsOptions with Product with Serializable

    

41. case class RelatedProductsQuery(indexName: String, objectID: String, threshold: Int = 0, maxRecommendations: Option[Int] = None, queryParameters: Option[Query] = None, fallbackParameters: Option[Query] = None) extends RecommendationsOptions with Product with Serializable

    

42. sealed trait RemoveStopWords extends AnyRef

    

43. sealed trait RemoveWordsIfNoResults extends AnyRef

    

44. case class RenderingContent(facetOrdering: Option[FacetOrdering] = None) extends Product with Serializable

    

    Content defining how the search interface should be rendered.

    Content defining how the search interface should be rendered. This is set via the settings for a default value and can be overridden via rules.

45. sealed trait RequestEndpoint extends AnyRef

    

46. case class RequestOptions(forwardedFor: Option[String] = None, extraHeaders: Option[Map[String, String]] = None, extraQueryParameters: Option[Map[String, String]] = None) extends Product with Serializable

    

47. case class Rule(objectID: String, enabled: Option[Boolean] = None, condition: Option[Condition] = None, conditions: Option[Iterable[Condition]] = None, consequence: Consequence, validity: Option[Iterable[TimeRange]] = None, description: Option[String] = None) extends Product with Serializable

    

48. case class Score(score: Int) extends Product with Serializable

    

49. case class ScoreType(score: Int, type: String) extends Product with Serializable

    

50. sealed trait SearchableAttributes extends AnyRef

    

51. case class SetStrategyRequest(eventsScoring: Seq[EventsScoring], facetsScoring: Seq[FacetsScoring], personalizationImpact: Int) extends Product with Serializable

    

52. sealed trait SortRule extends AnyRef

    

    Rule defining the sort order of facet values.

53. case class StopwordEntry(objectID: String, language: String, word: String, state: String) extends DictionaryEntry with Product with Serializable

    

54. case class Strategy(eventsScoring: Option[Map[String, ScoreType]] = None, facetsScoring: Option[Map[String, Score]] = None) extends Product with Serializable

    

55. sealed trait SynonymType extends AnyRef

    

56. case class TimeRange(from: ZonedDateTime, until: ZonedDateTime) extends Product with Serializable

    

57. sealed trait TypoTolerance extends AnyRef