Package co.elastic.clients.elasticsearch.ml

Class TrainedModelConfig.AbstractBuilder<BuilderT extends TrainedModelConfig.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.ml.TrainedModelConfig.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
PutTrainedModelResponse.Builder, TrainedModelConfig.Builder
Enclosing class:
TrainedModelConfig
public abstract static class TrainedModelConfig.AbstractBuilder<BuilderT extends TrainedModelConfig.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • modelId

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

      API name: model_id

    • modelType

      public final BuilderT modelType(@Nullable TrainedModelType value)
      The model type

      API name: model_type

    • tags

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

      API name: tags

      Adds all elements of list to tags.

    • tags

      public final BuilderT tags(String value, String... values)
      Required - A comma delimited string of tags. A trained model can have many tags, or none.

      API name: tags

      Adds one or more values to tags.

    • version

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

      API name: version

    • compressedDefinition

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

    • createdBy

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

      API name: created_by

    • createTime

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

      API name: create_time

    • defaultFieldMap

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

      API name: default_field_map

      Adds all entries of map to defaultFieldMap.

    • defaultFieldMap

      public final BuilderT defaultFieldMap(String key, String value)
      Any field map described in the inference configuration takes precedence.

      API name: default_field_map

      Adds an entry to defaultFieldMap.

    • description

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

      API name: description

    • estimatedHeapMemoryUsageBytes

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

      API name: estimated_heap_memory_usage_bytes

    • estimatedOperations

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

      API name: estimated_operations

    • fullyDefined

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

      API name: fully_defined

    • inferenceConfig

      public final BuilderT inferenceConfig(@Nullable InferenceConfigCreate value)
      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

    • inferenceConfig

      public final BuilderT inferenceConfig(Function<InferenceConfigCreate.Builder,ObjectBuilder<InferenceConfigCreate>> fn)
      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

    • inferenceConfig

      public final BuilderT inferenceConfig(InferenceConfigCreateVariant value)
      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 BuilderT input(TrainedModelConfigInput value)
      Required - The input field names for the model definition.

      API name: input

    • input

      public final BuilderT input(Function<TrainedModelConfigInput.Builder,ObjectBuilder<TrainedModelConfigInput>> fn)
      Required - The input field names for the model definition.

      API name: input

    • licenseLevel

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

      API name: license_level

    • metadata

      public final BuilderT metadata(@Nullable TrainedModelConfigMetadata value)
      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

    • metadata

      public final BuilderT metadata(Function<TrainedModelConfigMetadata.Builder,ObjectBuilder<TrainedModelConfigMetadata>> fn)
      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

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

    • modelPackage

      public final BuilderT modelPackage(@Nullable ModelPackageConfig value)
      API name: model_package

    • modelPackage

      public final BuilderT modelPackage(Function<ModelPackageConfig.Builder,ObjectBuilder<ModelPackageConfig>> fn)
      API name: model_package

    • location

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

    • location

      public final BuilderT location(Function<TrainedModelLocation.Builder,ObjectBuilder<TrainedModelLocation>> fn)
      API name: location

    • platformArchitecture

      public final BuilderT platformArchitecture(@Nullable String value)
      API name: platform_architecture

    • prefixStrings

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

    • prefixStrings

      public final BuilderT prefixStrings(Function<TrainedModelPrefixStrings.Builder,ObjectBuilder<TrainedModelPrefixStrings>> fn)
      API name: prefix_strings

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends TrainedModelConfig.AbstractBuilder<BuilderT>>