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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutTrainedModelRequest>
Json deserializer forPutTrainedModelRequest
static final Endpoint<PutTrainedModelRequest,
PutTrainedModelResponse, ErrorResponse> Endpoint "ml.put_trained_model
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The compressed (GZipped and Base64 encoded) inference definition of the model.final Boolean
If set totrue
and acompressed_definition
is provided, the request defers definition decompression and skips relevant validations.final Definition
The inference definition for the model.final String
A human-readable description of the inference trained model.final InferenceConfigCreate
Required - The default configuration for inference.final Input
input()
Required - The input field names for the model definition.final JsonData
metadata()
An object map that contains metadata about the model.final String
modelId()
Required - The unique identifier of the trained model.final Long
The estimated memory usage in bytes to keep the trained model in memory.final TrainedModelType
The model type.static PutTrainedModelRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
tags()
An array of tags to organize the model.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutTrainedModelRequest
-
_ENDPOINT
public static final Endpoint<PutTrainedModelRequest,PutTrainedModelResponse, _ENDPOINTErrorResponse> Endpoint "ml.put_trained_model
".
-
-
Method Details
-
of
public static PutTrainedModelRequest of(Function<PutTrainedModelRequest.Builder, ObjectBuilder<PutTrainedModelRequest>> fn) -
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
-
description
A human-readable description of the inference trained model.API name:
description
-
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
Required - 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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutTrainedModelRequestDeserializer
protected static void setupPutTrainedModelRequestDeserializer(ObjectDeserializer<PutTrainedModelRequest.Builder> op)
-