Package co.elastic.clients.elasticsearch.core.search

Class TermSuggester

java.lang.Object
co.elastic.clients.elasticsearch.core.search.SuggesterBase
co.elastic.clients.elasticsearch.core.search.TermSuggester
All Implemented Interfaces:
FieldSuggesterVariant, JsonpSerializable
@JsonpDeserializable public class TermSuggester extends SuggesterBase implements FieldSuggesterVariant
See Also:

  • Field Details

  • Method Details

    • of

      public static TermSuggester of(Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)

    • _fieldSuggesterKind

      public FieldSuggester.Kind _fieldSuggesterKind()
      FieldSuggester variant kind.
      Specified by:
      _fieldSuggesterKind in interface FieldSuggesterVariant

    • lowercaseTerms

      @Nullable public final Boolean lowercaseTerms()
      API name: lowercase_terms

    • maxEdits

      @Nullable public final Integer maxEdits()
      The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. Can only be 1 or 2.

      API name: max_edits

    • maxInspections

      @Nullable public final Integer maxInspections()
      A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. Can improve accuracy at the cost of performance.

      API name: max_inspections

    • maxTermFreq

      @Nullable public final Float maxTermFreq()
      The maximum threshold in number of documents in which a suggest text token can exist in order to be included. Can be a relative percentage number (for example 0.4) or an absolute number to represent document frequencies. If a value higher than 1 is specified, then fractional can not be specified.

      API name: max_term_freq

    • minDocFreq

      @Nullable public final Float minDocFreq()
      The minimal threshold in number of documents a suggestion should appear in. This can improve quality by only suggesting high frequency terms. Can be specified as an absolute number or as a relative percentage of number of documents. If a value higher than 1 is specified, then the number cannot be fractional.

      API name: min_doc_freq

    • minWordLength

      @Nullable public final Integer minWordLength()
      The minimum length a suggest text term must have in order to be included.

      API name: min_word_length

    • prefixLength

      @Nullable public final Integer prefixLength()
      The number of minimal prefix characters that must match in order be a candidate for suggestions. Increasing this number improves spellcheck performance.

      API name: prefix_length

    • shardSize

      @Nullable public final Integer shardSize()
      Sets the maximum number of suggestions to be retrieved from each individual shard.

      API name: shard_size

    • sort

      @Nullable public final SuggestSort sort()
      Defines how suggestions should be sorted per suggest text term.

      API name: sort

    • stringDistance

      @Nullable public final StringDistance stringDistance()
      The string distance implementation to use for comparing how similar suggested terms are.

      API name: string_distance

    • suggestMode

      @Nullable public final SuggestMode suggestMode()
      Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested.

      API name: suggest_mode

    • text

      @Nullable public final String text()
      The suggest text. Needs to be set globally or per suggestion.

      API name: text

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class SuggesterBase

    • setupTermSuggesterDeserializer

      protected static void setupTermSuggesterDeserializer(ObjectDeserializer<TermSuggester.Builder> op)