Skip to content

[DOCS] Edits delete trained model alias API #70119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 9, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[role="xpack"]
[testenv="platinum"]
[[delete-trained-models-aliases]]
= Delete Trained Model Aliases API
= Delete trained model aliases API
[subs="attributes"]
++++
<titleabbrev>Delete Trained Model Aliases</titleabbrev>
<titleabbrev>Delete trained model aliases</titleabbrev>
++++

Deletes a trained model alias.
Expand Down Expand Up @@ -33,27 +33,25 @@ For more information, see <<built-in-roles>>, <<security-privileges>>, and

This API deletes an existing model alias that refers to a trained model.

If the model alias is missing or refers to a model other than the one identified by
the `model_id`, this API will return an error.
If the model alias is missing or refers to a model other than the one identified
by the `model_id`, this API returns an error.

[[ml-delete-trained-models-aliases-path-params]]
== {api-path-parms-title}

`model_id`::
(Required, string)
The trained model ID to which the model alias refers.

`model_alias`::
(Required, string)
The model alias to delete.

`model_id`::
(Required, string)
The trained model ID to which the model alias refers.

[[ml-delete-trained-models-aliases-example]]
== {api-examples-title}

[[ml-delete-trained-models-aliases-example-delete]]
=== Deleting a model alias

The following example shows how to delete a model alias for a trained model ID.
The following example shows how to delete a model alias (`flight_delay_model`)
for a trained model ID (`flight-delay-prediction-1574775339910`):

[source,console]
--------------------------------------------------
Expand Down