1
0

delete-trained-models-aliases.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[delete-trained-models-aliases]]
  4. = Delete trained model aliases API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete trained model aliases</titleabbrev>
  8. ++++
  9. Deletes a trained model alias.
  10. [[ml-delete-trained-models-aliases-request]]
  11. == {api-request-title}
  12. `DELETE _ml/trained_models/<model_id>/model_aliases/<model_alias>`
  13. [[ml-delete-trained-models-aliases-prereq]]
  14. == {api-prereq-title}
  15. Requires the `manage_ml` cluster privilege. This privilege is included in the
  16. `machine_learning_admin` built-in role.
  17. [[ml-delete-trained-models-aliases-desc]]
  18. == {api-description-title}
  19. This API deletes an existing model alias that refers to a trained model.
  20. If the model alias is missing or refers to a model other than the one identified
  21. by the `model_id`, this API returns an error.
  22. [[ml-delete-trained-models-aliases-path-params]]
  23. == {api-path-parms-title}
  24. `model_alias`::
  25. (Required, string)
  26. The model alias to delete.
  27. `model_id`::
  28. (Required, string)
  29. The trained model ID to which the model alias refers.
  30. [[ml-delete-trained-models-aliases-example]]
  31. == {api-examples-title}
  32. The following example shows how to delete a model alias (`flight_delay_model`)
  33. for a trained model ID (`flight-delay-prediction-1574775339910`):
  34. [source,console]
  35. --------------------------------------------------
  36. DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model
  37. --------------------------------------------------
  38. // TEST[skip:setup kibana sample data]