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

Class TermSuggester.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.core.search.SuggesterBase.AbstractBuilder<TermSuggester.Builder>
co.elastic.clients.elasticsearch.core.search.TermSuggester.Builder
All Implemented Interfaces:
WithJson<TermSuggester.Builder>, ObjectBuilder<TermSuggester>
Enclosing class:
TermSuggester
public static class TermSuggester.Builder extends SuggesterBase.AbstractBuilder<TermSuggester.Builder> implements ObjectBuilder<TermSuggester>
Builder for TermSuggester.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • lowercaseTerms

      public final TermSuggester.Builder lowercaseTerms(@Nullable Boolean value)
      API name: lowercase_terms

    • maxEdits

      public final TermSuggester.Builder maxEdits(@Nullable Integer value)
      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

      public final TermSuggester.Builder maxInspections(@Nullable Integer value)
      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

      public final TermSuggester.Builder maxTermFreq(@Nullable Float value)
      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

      public final TermSuggester.Builder minDocFreq(@Nullable Float value)
      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

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

      API name: min_word_length

    • prefixLength

      public final TermSuggester.Builder prefixLength(@Nullable Integer value)
      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

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

      API name: shard_size

    • sort

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

      API name: sort

    • stringDistance

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

      API name: string_distance

    • suggestMode

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

      API name: suggest_mode

    • text

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

      API name: text

    • self

      protected TermSuggester.Builder self()
      Specified by:
      self in class SuggesterBase.AbstractBuilder<TermSuggester.Builder>

    • build

      public TermSuggester build()
      Builds a TermSuggester.
      Specified by:
      build in interface ObjectBuilder<TermSuggester>
      Throws:
      NullPointerException - if some of the required fields are null.