2018-11-28 05:58:20 -05:00
|
|
|
--
|
|
|
|
|
:api: get-ml-info
|
|
|
|
|
:request: MlInfoRequest
|
|
|
|
|
:response: MlInfoResponse
|
|
|
|
|
--
|
2019-09-10 11:26:56 -04:00
|
|
|
[role="xpack"]
|
2018-11-28 05:58:20 -05:00
|
|
|
[id="{upid}-{api}"]
|
2019-07-30 13:52:23 -04:00
|
|
|
=== ML get info API
|
2018-11-28 05:58:20 -05:00
|
|
|
|
2019-07-30 13:52:23 -04:00
|
|
|
Provides defaults and limits used internally by {ml}.
|
2018-11-28 05:58:20 -05:00
|
|
|
These may be useful to a user interface that needs to interpret machine learning
|
2019-07-30 13:52:23 -04:00
|
|
|
configurations where certain fields are missing because the end user was happy
|
|
|
|
|
with the default value.
|
2018-11-28 05:58:20 -05:00
|
|
|
|
|
|
|
|
It accepts a +{request}+ object and responds with a +{response}+ object.
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-07-30 13:52:23 -04:00
|
|
|
==== Get info request
|
2018-11-28 05:58:20 -05:00
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
--------------------------------------------------
|
2019-07-30 13:52:23 -04:00
|
|
|
<1> Constructing a new request.
|
2018-11-28 05:58:20 -05:00
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
2019-07-30 13:52:23 -04:00
|
|
|
==== ML get info response
|
2018-11-28 05:58:20 -05:00
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
|
|
--------------------------------------------------
|
2019-07-30 13:52:23 -04:00
|
|
|
<1> `info` from the +{response}+ contains {ml} info details.
|
2018-11-28 05:58:20 -05:00
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
