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
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PutTrainedModelRequest.Builder
Builder forPutTrainedModelRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<PutTrainedModelRequest>
_DESERIALIZER
Json deserializer forPutTrainedModelRequest
static Endpoint<PutTrainedModelRequest,PutTrainedModelResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.put_trained_model
". -
Method Summary
Modifier and Type Method Description java.lang.String
compressedDefinition()
The compressed (GZipped and Base64 encoded) inference definition of the model.Definition
definition()
The inference definition for the model.java.lang.String
description()
A human-readable description of the inference trained model.InferenceConfig
inferenceConfig()
Required - The default configuration for inference.Input
input()
Required - The input field names for the model definition.JsonData
metadata()
An object map that contains metadata about the model.java.lang.String
modelId()
Required - The unique identifier of the trained model.static PutTrainedModelRequest
of(java.util.function.Function<PutTrainedModelRequest.Builder,ObjectBuilder<PutTrainedModelRequest>> fn)
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
setupPutTrainedModelRequestDeserializer(ObjectDeserializer<PutTrainedModelRequest.Builder> op)
java.util.List<java.lang.String>
tags()
An array of tags to organize the model.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forPutTrainedModelRequest
-
_ENDPOINT
public static final Endpoint<PutTrainedModelRequest,PutTrainedModelResponse,ErrorResponse> _ENDPOINTEndpoint "ml.put_trained_model
".
-
-
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
-
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
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
public final java.lang.String modelId()Required - The unique identifier of the trained model.API name:
model_id
-
tags
public final java.util.List<java.lang.String> 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)
-