mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
2087b65523
Defines new inference_user and inference_admin roles with the related cluster privileges manage_inference and monitor_inference. inference_user can list the models and preform inference, inference_admin can do the same plus create and delete models
67 lines
1.6 KiB
Text
67 lines
1.6 KiB
Text
[role="xpack"]
|
|
[[delete-inference-api]]
|
|
=== Delete {infer} API
|
|
|
|
experimental[]
|
|
|
|
Deletes an {infer} model deployment.
|
|
|
|
IMPORTANT: The {infer} APIs enable you to use certain services, such as ELSER,
|
|
OpenAI, or Hugging Face, in your cluster. This is not the same feature that you
|
|
can use on an ML node with custom {ml} models. If you want to train and use your
|
|
own model, use the <<ml-df-trained-models-apis>>.
|
|
|
|
|
|
[discrete]
|
|
[[delete-inference-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE /_inference/<model_id>`
|
|
|
|
`DELETE /_inference/<task_type>/<model_id>`
|
|
|
|
[discrete]
|
|
[[delete-inference-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* Requires the `manage_inference` <<privileges-list-cluster,cluster privilege>>
|
|
(the built-in `inference_admin` role grants this privilege)
|
|
|
|
|
|
[discrete]
|
|
[[delete-inference-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
<model_id>::
|
|
(Required, string)
|
|
The unique identifier of the {infer} model to delete.
|
|
|
|
<task_type>::
|
|
(Optional, string)
|
|
The type of {infer} task that the model performs.
|
|
|
|
|
|
[discrete]
|
|
[[delete-inference-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following API call deletes the `my-elser-model` {infer} model that can
|
|
perform `sparse_embedding` tasks.
|
|
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
DELETE /_inference/sparse_embedding/my-elser-model
|
|
------------------------------------------------------------
|
|
// TEST[skip:TBD]
|
|
|
|
|
|
The API returns the following response:
|
|
|
|
[source,console-result]
|
|
------------------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
------------------------------------------------------------
|
|
// NOTCONSOLE
|