delete-trained-models-aliases.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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. beta::[]
  11. [[ml-delete-trained-models-aliases-request]]
  12. == {api-request-title}
  13. `DELETE _ml/trained_models/<model_id>/model_aliases/<model_alias>`
  14. [[ml-delete-trained-models-aliases-prereq]]
  15. == {api-prereq-title}
  16. If the {es} {security-features} are enabled, you must have the following
  17. built-in roles and privileges:
  18. * `machine_learning_admin`
  19. For more information, see <<built-in-roles>>, <<security-privileges>>, and
  20. {ml-docs-setup-privileges}.
  21. [[ml-delete-trained-models-aliases-desc]]
  22. == {api-description-title}
  23. This API deletes an existing model alias that refers to a trained model.
  24. If the model alias is missing or refers to a model other than the one identified
  25. by the `model_id`, this API returns an error.
  26. [[ml-delete-trained-models-aliases-path-params]]
  27. == {api-path-parms-title}
  28. `model_alias`::
  29. (Required, string)
  30. The model alias to delete.
  31. `model_id`::
  32. (Required, string)
  33. The trained model ID to which the model alias refers.
  34. [[ml-delete-trained-models-aliases-example]]
  35. == {api-examples-title}
  36. The following example shows how to delete a model alias (`flight_delay_model`)
  37. for a trained model ID (`flight-delay-prediction-1574775339910`):
  38. [source,console]
  39. --------------------------------------------------
  40. DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model
  41. --------------------------------------------------
  42. // TEST[skip:setup kibana sample data]