44 lines
1.4 KiB
Plaintext
44 lines
1.4 KiB
Plaintext
|
--
|
||
|
|
:api: get-trained-models
|
||
|
|
:request: GetTrainedModelsRequest
|
||
|
|
:response: GetTrainedModelsResponse
|
||
|
|
--
|
||
|
|
[role="xpack"]
|
||
|
|
[id="{upid}-{api}"]
|
||
|
|
=== Get Trained Models API
|
||
|
|
|
||
|
|
experimental[]
|
||
|
|
|
||
|
|
Retrieves one or more Trained Models.
|
||
|
|
The API accepts a +{request}+ object and returns a +{response}+.
|
||
|
|
|
||
|
|
[id="{upid}-{api}-request"]
|
||
|
|
==== Get Trained Models request
|
||
|
|
|
||
|
|
A +{request}+ requires either a Trained Model ID, a comma-separated list of
|
||
|
|
IDs, or the special wildcard `_all` to get all Trained Models.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Constructing a new GET request referencing an existing Trained Model
|
||
|
|
<2> Set the paging parameters
|
||
|
|
<3> Indicate if the complete model definition should be included
|
||
|
|
<4> Should the definition be fully decompressed on GET
|
||
|
|
<5> Allow empty response if no Trained Models match the provided ID patterns.
|
||
|
|
If false, an error will be thrown if no Trained Models match the
|
||
|
|
ID patterns.
|
||
|
|
|
||
|
|
include::../execution.asciidoc[]
|
||
|
|
|
||
|
|
[id="{upid}-{api}-response"]
|
||
|
|
==== Response
|
||
|
|
|
||
|
|
The returned +{response}+ contains the requested Trained Model.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
||
|
|
--------------------------------------------------
|