Delete trained model aliases API

Delete trained model aliases API

New API reference

For the most up-to-date API details, refer to Machine learning trained model APIs.

Deletes a trained model alias.

Request

DELETE _ml/trained_models/<model_id>/model_aliases/<model_alias>

Prerequisites

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Description

This API deletes an existing model alias that refers to a trained model.

If the model alias is missing or refers to a model other than the one identified by the model_id, this API returns an error.

Path parameters

model_alias

(Required, string) The model alias to delete.

model_id

(Required, string) The trained model ID to which the model alias refers.

Examples

The following example shows how to delete a model alias (flight_delay_model) for a trained model ID (flight-delay-prediction-1574775339910):

  1. resp = client.ml.delete_trained_model_alias(
  2.     model_id="flight-delay-prediction-1574775339910",
  3.     model_alias="flight_delay_model",
  4. )
  5. print(resp)
  1. response = client.ml.delete_trained_model_alias(
  2.   model_id: 'flight-delay-prediction-1574775339910',
  3.   model_alias: 'flight_delay_model'
  4. )
  5. puts response
  1. const response = await client.ml.deleteTrainedModelAlias({
  2.   model_id: "flight-delay-prediction-1574775339910",
  3.   model_alias: "flight_delay_model",
  4. });
  5. console.log(response);
  1. DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model