Class PutTrainedModelAliasRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.PutTrainedModelAliasRequest
Creates or updates a trained model alias. A trained model alias is a logical
name used to reference a single trained model. You can use aliases instead of
trained model identifiers to make it easier to reference your models. For
example, you can use aliases in inference aggregations and processors. An
alias must be unique and refer to only a single trained model. However, you
can have multiple aliases for each trained model. If you use this API to
update an alias such that it references a different trained model ID and the
model uses a different type of data frame analytics, an error occurs. For
example, this situation occurs if you have a trained model for regression
analysis and a trained model for classification analysis; you cannot reassign
an alias from one type of trained model to another. If you use this API to
update an alias and there are very few input fields in common between the old
and new trained models for the model alias, the API returns a warning.
- 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 TypeFieldDescriptionEndpoint "ml.put_trained_model_alias
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Required - The alias to create or update.final String
modelId()
Required - The identifier for the trained model that the alias refers to.static PutTrainedModelAliasRequest
final Boolean
reassign()
Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<PutTrainedModelAliasRequest,PutTrainedModelAliasResponse, _ENDPOINTErrorResponse> Endpoint "ml.put_trained_model_alias
".
-
-
Method Details
-
of
-
modelAlias
Required - The alias to create or update. This value cannot end in numbers.API name:
model_alias
-
modelId
Required - The identifier for the trained model that the alias refers to.API name:
model_id
-
reassign
Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error.API name:
reassign
-