mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
5c75d004fa
Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
41 lines
1.2 KiB
Text
41 lines
1.2 KiB
Text
--
|
|
:api: put-trained-model-alias
|
|
:request: PutTrainedModelAliasRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Create or update trained model alias API
|
|
|
|
beta::[]
|
|
|
|
Creates or reassigns a trained model alias.
|
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
|
The created trained model alias can then be used for other APIs in the stack
|
|
instead of the referenced model id.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
A +{request}+ requires the following arguments:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The trained model alias to create or reassign
|
|
<2> The trained model id to which to assign the alias
|
|
<3> (Optional) whether or not to reassign the model alias if it
|
|
is already pointing to a model. Defaults to false.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|