delete-trained-models-aliases.asciidoc 1.5 KB

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