1
0

delete-inference-trained-model.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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. For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
  21. [[ml-delete-inference-path-params]]
  22. == {api-path-parms-title}
  23. `<model_id>`::
  24. (Optional, string)
  25. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
  26. [[ml-delete-inference-response-codes]]
  27. == {api-response-codes-title}
  28. `409`::
  29. The code indicates that the trained {infer} model is referenced by an ingest
  30. pipeline and cannot be deleted.
  31. [[ml-delete-inference-example]]
  32. == {api-examples-title}
  33. The following example deletes the `regression-job-one-1574775307356` trained
  34. model:
  35. [source,console]
  36. --------------------------------------------------
  37. DELETE _ml/inference/regression-job-one-1574775307356
  38. --------------------------------------------------
  39. // TEST[skip:TBD]
  40. The API returns the following result:
  41. [source,console-result]
  42. ----
  43. {
  44. "acknowledged" : true
  45. }
  46. ----