mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 09:28:55 -04:00
[ML][HLRC] adds put and delete trained model alias APIs to rest high-level client (#69214)
adds put (and reassign) and delete trained model alias APIs to the rest high-level client. This adds some serialization objects and request wrappers.
This commit is contained in:
parent
b13f77c35e
commit
2ee6dc37b6
10 changed files with 557 additions and 0 deletions
|
@ -0,0 +1,39 @@
|
|||
--
|
||||
:api: delete-trained-model-alias
|
||||
:request: DeleteTrainedModelAliasRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete trained model alias API
|
||||
|
||||
beta::[]
|
||||
|
||||
Deletes a trained model alias.
|
||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||
If the model alias is not assigned to the provided model id, or if the model
|
||||
alias does not exist, this API will result in an error.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Delete trained model alias 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 delete
|
||||
<2> The trained model id to which model alias is assigned
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Response
|
||||
|
||||
The returned +{response}+
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
|
@ -0,0 +1,41 @@
|
|||
--
|
||||
:api: put-trained-model-alias
|
||||
:request: PutTrainedModelAliasRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
[role="xpack"]
|
||||
[id="{upid}-{api}"]
|
||||
=== Put 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"]
|
||||
==== Put trained model alias 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]
|
||||
--------------------------------------------------
|
|
@ -298,6 +298,7 @@ The Java High Level REST Client supports the following {ml} APIs:
|
|||
* <<{upid}-delete-forecast>>
|
||||
* <<{upid}-delete-model-snapshot>>
|
||||
* <<{upid}-delete-trained-models>>
|
||||
* <<{upid}-delete-trained-model-alias>>
|
||||
* <<{upid}-estimate-model-memory>>
|
||||
* <<{upid}-evaluate-data-frame>>
|
||||
* <<{upid}-explain-data-frame-analytics>>
|
||||
|
@ -332,6 +333,7 @@ The Java High Level REST Client supports the following {ml} APIs:
|
|||
* <<{upid}-put-datafeed>>
|
||||
* <<{upid}-put-filter>>
|
||||
* <<{upid}-put-trained-model>>
|
||||
* <<{upid}-put-trained-model-alias>>
|
||||
* <<{upid}-revert-model-snapshot>>
|
||||
* <<{upid}-set-upgrade-mode>>
|
||||
* <<{upid}-start-data-frame-analytics>>
|
||||
|
@ -359,6 +361,7 @@ include::ml/delete-filter.asciidoc[]
|
|||
include::ml/delete-forecast.asciidoc[]
|
||||
include::ml/delete-model-snapshot.asciidoc[]
|
||||
include::ml/delete-trained-models.asciidoc[]
|
||||
include::ml/delete-trained-model-alias.asciidoc[]
|
||||
// ESTIMATE
|
||||
include::ml/estimate-model-memory.asciidoc[]
|
||||
// EVALUATE
|
||||
|
@ -403,6 +406,7 @@ include::ml/put-data-frame-analytics.asciidoc[]
|
|||
include::ml/put-datafeed.asciidoc[]
|
||||
include::ml/put-filter.asciidoc[]
|
||||
include::ml/put-trained-model.asciidoc[]
|
||||
include::ml/put-trained-model-alias.asciidoc[]
|
||||
// REVERT
|
||||
include::ml/revert-model-snapshot.asciidoc[]
|
||||
// SET
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue