mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-05 20:48:22 +00:00
35d5126cea
* [ML] adds new for_export flag to GET _ml/inference API (#57351) Adds a new boolean flag, `for_export` to the `GET _ml/inference/<model_id>` API. This flag is useful for moving models between clusters.
50 lines
1.8 KiB
Plaintext
50 lines
1.8 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.
|
|
<6> An optional list of tags used to narrow the model search. A Trained Model
|
|
can have many tags or none. The trained models in the response will
|
|
contain all the provided tags.
|
|
<7> Optional boolean value indicating if certain fields should be removed on
|
|
retrieval. This is useful for getting the trained model in a format that
|
|
can then be put into another cluster.
|
|
|
|
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]
|
|
--------------------------------------------------
|