delete-trained-models.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-trained-models]]
  4. = Delete trained models API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete trained models</titleabbrev>
  8. ++++
  9. Deletes an existing trained {infer} model that is currently not referenced by an
  10. ingest pipeline.
  11. [[ml-delete-trained-models-request]]
  12. == {api-request-title}
  13. `DELETE _ml/trained_models/<model_id>`
  14. [[ml-delete-trained-models-prereq]]
  15. == {api-prereq-title}
  16. If the {es} {security-features} are enabled, you must have the following
  17. built-in roles or equivalent privileges:
  18. * `machine_learning_admin`
  19. For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
  20. [[ml-delete-trained-models-path-params]]
  21. == {api-path-parms-title}
  22. `<model_id>`::
  23. (Optional, string)
  24. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
  25. [[ml-delete-trained-models-response-codes]]
  26. == {api-response-codes-title}
  27. `409`::
  28. The code indicates that the trained model is referenced by an ingest pipeline
  29. and cannot be deleted.
  30. [[ml-delete-trained-models-example]]
  31. == {api-examples-title}
  32. The following example deletes the `regression-job-one-1574775307356` trained
  33. model:
  34. [source,console]
  35. --------------------------------------------------
  36. DELETE _ml/trained_models/regression-job-one-1574775307356
  37. --------------------------------------------------
  38. // TEST[skip:TBD]
  39. The API returns the following result:
  40. [source,console-result]
  41. ----
  42. {
  43. "acknowledged" : true
  44. }
  45. ----