delete-inference-trained-model.asciidoc 1.4 KB

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