delete-trained-model.asciidoc 1.0 KB

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: delete-trained-model
  3. :request: DeleteTrainedModelRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete Trained Model API
  9. experimental[]
  10. Deletes a previously saved Trained Model.
  11. The API accepts a +{request}+ object and returns a +{response}+.
  12. [id="{upid}-{api}-request"]
  13. ==== Delete Trained Model request
  14. A +{request}+ requires a valid Trained Model ID.
  15. ["source","java",subs="attributes,callouts,macros"]
  16. --------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. --------------------------------------------------
  19. <1> Constructing a new DELETE request referencing an existing Trained Model
  20. include::../execution.asciidoc[]
  21. [id="{upid}-{api}-response"]
  22. ==== Response
  23. The returned +{response}+ object acknowledges the Trained Model deletion.
  24. ["source","java",subs="attributes,callouts,macros"]
  25. --------------------------------------------------
  26. include-tagged::{doc-tests-file}[{api}-response]
  27. --------------------------------------------------