Package co.elastic.clients.elasticsearch._types.analysis

Class ShingleTokenFilter

java.lang.Object
co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase
co.elastic.clients.elasticsearch._types.analysis.ShingleTokenFilter
All Implemented Interfaces:
TokenFilterDefinitionVariant, JsonpSerializable
@JsonpDeserializable public class ShingleTokenFilter extends TokenFilterBase implements TokenFilterDefinitionVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _tokenFilterDefinitionKind

      public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()
      TokenFilterDefinition variant kind.
      Specified by:
      _tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

    • fillerToken

      @Nullable public final String fillerToken()
      String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore (_).

      API name: filler_token

    • maxShingleSize

      @Nullable public final Integer maxShingleSize()
      Maximum number of tokens to concatenate when creating shingles. Defaults to 2.

      API name: max_shingle_size

    • minShingleSize

      @Nullable public final Integer minShingleSize()
      Minimum number of tokens to concatenate when creating shingles. Defaults to 2.

      API name: min_shingle_size

    • outputUnigrams

      @Nullable public final Boolean outputUnigrams()
      If true, the output includes the original input tokens. If false, the output only includes shingles; the original input tokens are removed. Defaults to true.

      API name: output_unigrams

    • outputUnigramsIfNoShingles

      @Nullable public final Boolean outputUnigramsIfNoShingles()
      If true, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to false.

      API name: output_unigrams_if_no_shingles

    • tokenSeparator

      @Nullable public final String tokenSeparator()
      Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space (" ").

      API name: token_separator

    • serializeInternal

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

    • setupShingleTokenFilterDeserializer

      protected static void setupShingleTokenFilterDeserializer(ObjectDeserializer<ShingleTokenFilter.Builder> op)