delete-trained-model-alias.asciidoc 1.1 KB

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