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

Class DirectGenerator

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

  • Field Details

  • Method Details

    • of

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

    • field

      public final String field()
      Required - The field to fetch the candidate suggestions from. Needs to be set globally or per suggestion.

      API name: field

    • 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 Float 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. This can be used to exclude high frequency terms — which are usually spelled correctly — from being spellchecked. 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, 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

    • postFilter

      @Nullable public final String postFilter()
      A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer.

      API name: post_filter

    • preFilter

      @Nullable public final String preFilter()
      A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. This filter is applied to the original token before candidates are generated.

      API name: pre_filter

    • prefixLength

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

      API name: prefix_length

    • size

      @Nullable public final Integer size()
      The maximum corrections to be returned per suggest text token.

      API name: size

    • suggestMode

      @Nullable public final SuggestMode suggestMode()
      Controls what suggestions are included on the suggestions generated on each shard.

      API name: suggest_mode

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupDirectGeneratorDeserializer

      protected static void setupDirectGeneratorDeserializer(ObjectDeserializer<DirectGenerator.Builder> op)