Class PutTrainedModelRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutTrainedModelRequest.Builder>
co.elastic.clients.elasticsearch.ml.PutTrainedModelRequest.Builder
- All Implemented Interfaces:
WithJson<PutTrainedModelRequest.Builder>
,ObjectBuilder<PutTrainedModelRequest>
- Enclosing class:
- PutTrainedModelRequest
public static class PutTrainedModelRequest.Builder
extends RequestBase.AbstractBuilder<PutTrainedModelRequest.Builder>
implements ObjectBuilder<PutTrainedModelRequest>
Builder for
PutTrainedModelRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPutTrainedModelRequest
.compressedDefinition
(String value) The compressed (GZipped and Base64 encoded) inference definition of the model.If set totrue
and acompressed_definition
is provided, the request defers definition decompression and skips relevant validations.definition
(Definition value) The inference definition for the model.The inference definition for the model.description
(String value) A human-readable description of the inference trained model.The default configuration for inference.The default configuration for inference.The input field names for the model definition.The input field names for the model definition.An object map that contains metadata about the model.Required - The unique identifier of the trained model.modelSizeBytes
(Long value) The estimated memory usage in bytes to keep the trained model in memory.modelType
(TrainedModelType value) The model type.protected PutTrainedModelRequest.Builder
self()
An array of tags to organize the model.An array of tags to organize the model.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
If set totrue
and acompressed_definition
is provided, the request defers definition decompression and skips relevant validations.API name:
defer_definition_decompression
-
definition
The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.API name:
definition
-
definition
public final PutTrainedModelRequest.Builder definition(Function<Definition.Builder, ObjectBuilder<Definition>> fn) The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.API name:
definition
-
description
A human-readable description of the inference trained model.API name:
description
-
inferenceConfig
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. For pre-packaged models such as ELSER the config is not required.API name:
inference_config
-
inferenceConfig
public final PutTrainedModelRequest.Builder inferenceConfig(Function<InferenceConfigCreate.Builder, ObjectBuilder<InferenceConfigCreate>> fn) 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. For pre-packaged models such as ELSER the config is not required.API name:
inference_config
-
input
The input field names for the model definition.API name:
input
-
input
The input field names for the model definition.API name:
input
-
metadata
An object map that contains metadata about the model.API name:
metadata
-
modelId
Required - The unique identifier of the trained model.API name:
model_id
-
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
The model type.API name:
model_type
-
tags
An array of tags to organize the model.API name:
tags
Adds all elements of
list
totags
. -
tags
An array of tags to organize the model.API name:
tags
Adds one or more values to
tags
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutTrainedModelRequest.Builder>
-
build
Builds aPutTrainedModelRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTrainedModelRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-