get-info.asciidoc 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. --
  2. :api: get-ml-info
  3. :request: MlInfoRequest
  4. :response: MlInfoResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === ML get info API
  8. Provides defaults and limits used internally by {ml}.
  9. These may be useful to a user interface that needs to interpret machine learning
  10. configurations where certain fields are missing because the end user was happy
  11. with the default value.
  12. It accepts a +{request}+ object and responds with a +{response}+ object.
  13. [id="{upid}-{api}-request"]
  14. ==== Get info request
  15. ["source","java",subs="attributes,callouts,macros"]
  16. --------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. --------------------------------------------------
  19. <1> Constructing a new request.
  20. [id="{upid}-{api}-response"]
  21. ==== ML get info response
  22. ["source","java",subs="attributes,callouts,macros"]
  23. --------------------------------------------------
  24. include-tagged::{doc-tests-file}[{api}-response]
  25. --------------------------------------------------
  26. <1> `info` from the +{response}+ contains {ml} info details.
  27. include::../execution.asciidoc[]