IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete trained models APIedit
Deletes an existing trained inference model.
Requestedit
DELETE _ml/trained_models/<model_id>
Prerequisitesedit
Requires the manage_ml cluster privilege. This privilege is included in the
machine_learning_admin built-in role.
Path parametersedit
-
<model_id> - (Optional, string) The unique identifier of the trained model.
Query parametersedit
-
force - (Optional, Boolean) Use to forcefully delete a trained model that is referenced by ingest pipelines or has a started deployment.
Response codesedit
-
409 - The code indicates that the trained model is referenced by an ingest pipeline and cannot be deleted.
Examplesedit
The following example deletes the regression-job-one-1574775307356 trained
model:
response = client.ml.delete_trained_model( model_id: 'regression-job-one-1574775307356' ) puts response
DELETE _ml/trained_models/regression-job-one-1574775307356
The API returns the following result:
{
"acknowledged" : true
}