delete-trained-model-alias.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. --
  2. :api: delete-trained-model-alias
  3. :request: DeleteTrainedModelAliasRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete trained model alias API
  9. beta::[]
  10. Deletes a trained model alias.
  11. The API accepts a +{request}+ object as a request and returns a +{response}+.
  12. If the model alias is not assigned to the provided model id, or if the model
  13. alias does not exist, this API will result in an error.
  14. [id="{upid}-{api}-request"]
  15. ==== Delete trained model alias request
  16. A +{request}+ requires the following arguments:
  17. ["source","java",subs="attributes,callouts,macros"]
  18. --------------------------------------------------
  19. include-tagged::{doc-tests-file}[{api}-request]
  20. --------------------------------------------------
  21. <1> The trained model alias to delete
  22. <2> The trained model id to which model alias is assigned
  23. include::../execution.asciidoc[]
  24. [id="{upid}-{api}-response"]
  25. ==== Response
  26. The returned +{response}+
  27. ["source","java",subs="attributes,callouts,macros"]
  28. --------------------------------------------------
  29. include-tagged::{doc-tests-file}[{api}-response]
  30. --------------------------------------------------