Package co.elastic.clients.elasticsearch.ml

Class FillMaskInferenceOptions

java.lang.Object
co.elastic.clients.elasticsearch.ml.FillMaskInferenceOptions
All Implemented Interfaces:
InferenceConfigCreateVariant, JsonpSerializable
@JsonpDeserializable public class FillMaskInferenceOptions extends Object implements InferenceConfigCreateVariant, JsonpSerializable
Fill mask inference options
See Also:

  • Field Details

  • Method Details

    • of

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

    • _inferenceConfigCreateKind

      public InferenceConfigCreate.Kind _inferenceConfigCreateKind()
      InferenceConfigCreate variant kind.
      Specified by:
      _inferenceConfigCreateKind in interface InferenceConfigCreateVariant

    • maskToken

      @Nullable public final String maskToken()
      The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.

      API name: mask_token

    • numTopClasses

      @Nullable public final Integer numTopClasses()
      Specifies the number of top class predictions to return. Defaults to 0.

      API name: num_top_classes

    • tokenization

      @Nullable public final TokenizationConfig tokenization()
      The tokenization options to update when inferring

      API name: tokenization

    • resultsField

      @Nullable public final String resultsField()
      The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

      API name: results_field

    • vocabulary

      @Nullable public final Vocabulary vocabulary()
      API name: vocabulary

    • 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

    • setupFillMaskInferenceOptionsDeserializer

      protected static void setupFillMaskInferenceOptionsDeserializer(ObjectDeserializer<FillMaskInferenceOptions.Builder> op)