Package co.elastic.clients.elasticsearch.ml

Class PutTrainedModelRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.PutTrainedModelRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutTrainedModelRequest
extends RequestBase
implements JsonpSerializable
Enables you to supply a trained model that is not created by data frame analytics.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static PutTrainedModelRequest of​(java.util.function.Function<PutTrainedModelRequest.Builder,​ObjectBuilder<PutTrainedModelRequest>> fn)

    • compressedDefinition

      @Nullable public final java.lang.String compressedDefinition()
      The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.

      API name: compressed_definition

    • deferDefinitionDecompression

      @Nullable public final java.lang.Boolean deferDefinitionDecompression()
      If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations.

      API name: defer_definition_decompression

    • definition

      @Nullable public final Definition definition()
      The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.

      API name: definition

    • description

      @Nullable public final java.lang.String description()
      A human-readable description of the inference trained model.

      API name: description

    • inferenceConfig

      public final InferenceConfig inferenceConfig()
      Required - The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type.

      API name: inference_config

    • input

      public final Input input()
      Required - The input field names for the model definition.

      API name: input

    • metadata

      @Nullable public final JsonData metadata()
      An object map that contains metadata about the model.

      API name: metadata

    • modelId

      public final java.lang.String modelId()
      Required - The unique identifier of the trained model.

      API name: model_id

    • modelSizeBytes

      @Nullable public final java.lang.Long modelSizeBytes()
      The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.

      API name: model_size_bytes

    • modelType

      @Nullable public final TrainedModelType modelType()
      The model type.

      API name: model_type

    • tags

      public final java.util.List<java.lang.String> tags()
      An array of tags to organize the model.

      API name: tags

    • 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)

    • setupPutTrainedModelRequestDeserializer

      protected static void setupPutTrainedModelRequestDeserializer​(ObjectDeserializer<PutTrainedModelRequest.Builder> op)