Package co.elastic.clients.elasticsearch.ml

Class TrainedModelConfig

java.lang.Object
co.elastic.clients.elasticsearch.ml.TrainedModelConfig
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
PutTrainedModelResponse
@JsonpDeserializable public class TrainedModelConfig extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trainedModelConfigOf

      public static TrainedModelConfig trainedModelConfigOf(Function<TrainedModelConfig.Builder,ObjectBuilder<TrainedModelConfig>> fn)

    • modelId

      public final String modelId()
      Required - Identifier for the trained model.

      API name: model_id

    • modelType

      @Nullable public final TrainedModelType modelType()
      The model type

      API name: model_type

    • tags

      public final List<String> tags()
      Required - A comma delimited string of tags. A trained model can have many tags, or none.

      API name: tags

    • version

      @Nullable public final String version()
      The Elasticsearch version number in which the trained model was created.

      API name: version

    • compressedDefinition

      @Nullable public final String compressedDefinition()
      API name: compressed_definition

    • createdBy

      @Nullable public final String createdBy()
      Information on the creator of the trained model.

      API name: created_by

    • createTime

      @Nullable public final DateTime createTime()
      The time when the trained model was created.

      API name: create_time

    • defaultFieldMap

      public final Map<String,String> defaultFieldMap()
      Any field map described in the inference configuration takes precedence.

      API name: default_field_map

    • description

      @Nullable public final String description()
      The free-text description of the trained model.

      API name: description

    • estimatedHeapMemoryUsageBytes

      @Nullable public final Integer estimatedHeapMemoryUsageBytes()
      The estimated heap usage in bytes to keep the trained model in memory.

      API name: estimated_heap_memory_usage_bytes

    • estimatedOperations

      @Nullable public final Integer estimatedOperations()
      The estimated number of operations to use the trained model.

      API name: estimated_operations

    • fullyDefined

      @Nullable public final Boolean fullyDefined()
      True if the full model definition is present.

      API name: fully_defined

    • inferenceConfig

      @Nullable public final InferenceConfigCreate inferenceConfig()
      The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.

      API name: inference_config

    • input

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

      API name: input

    • licenseLevel

      @Nullable public final String licenseLevel()
      The license level of the trained model.

      API name: license_level

    • metadata

      @Nullable public final TrainedModelConfigMetadata metadata()
      An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.

      API name: metadata

    • modelSizeBytes

      @Nullable public final String modelSizeBytes()
      API name: model_size_bytes

    • location

      @Nullable public final TrainedModelLocation location()
      API name: location

    • prefixStrings

      @Nullable public final TrainedModelPrefixStrings prefixStrings()
      API name: prefix_strings

    • 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

    • setupTrainedModelConfigDeserializer

      protected static <BuilderT extends TrainedModelConfig.AbstractBuilder<BuilderT>> void setupTrainedModelConfigDeserializer(ObjectDeserializer<BuilderT> op)