mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-26 08:07:27 -04:00
c2072fc4d3
* [DOCS] Creates documentation structure. * [DOCS] Adds PUT inference API docs and part of GET inference API docs. * [DOCS] Fixes complaining CI. * [DOCS] Adds GET and DELETE API docs for inference API. * [DOCS] Adds POST inference API docs. * Apply suggestions from code review
57 lines
No EOL
1.2 KiB
Text
57 lines
No EOL
1.2 KiB
Text
[role="xpack"]
|
|
[[delete-inference-api]]
|
|
=== Delete {infer} API
|
|
|
|
Deletes an {infer} model deployment.
|
|
|
|
|
|
[discrete]
|
|
[[delete-inference-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE /_inference/<task_type>/<model_id>`
|
|
|
|
[discrete]
|
|
[[delete-inference-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* Requires the `manage` <<privileges-list-cluster,cluster 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>::
|
|
(Required, 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 |