delete-trained-models-aliases.asciidoc 1.6 KB

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