68 lines
1.4 KiB
Plaintext
68 lines
1.4 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[testenv="basic"]
|
||
|
|
[[delete-inference]]
|
||
|
|
=== Delete {infer} trained model API
|
||
|
|
[subs="attributes"]
|
||
|
|
++++
|
||
|
|
<titleabbrev>Delete {infer} trained model</titleabbrev>
|
||
|
|
++++
|
||
|
|
|
||
|
|
Deletes an existing trained {infer} model that is currently not referenced by an
|
||
|
|
ingest pipeline.
|
||
|
|
|
||
|
|
experimental[]
|
||
|
|
|
||
|
|
|
||
|
|
[[ml-delete-inference-request]]
|
||
|
|
==== {api-request-title}
|
||
|
|
|
||
|
|
`DELETE _ml/inference/<model_id>`
|
||
|
|
|
||
|
|
|
||
|
|
[[ml-delete-inference-prereq]]
|
||
|
|
==== {api-prereq-title}
|
||
|
|
|
||
|
|
* You must have `machine_learning_admin` built-in role to use this API. For more
|
||
|
|
information, see <<security-privileges>> and <<built-in-roles>>.
|
||
|
|
|
||
|
|
|
||
|
|
[[ml-delete-inference-path-params]]
|
||
|
|
==== {api-path-parms-title}
|
||
|
|
|
||
|
|
`<model_id>`::
|
||
|
|
(Optional, string)
|
||
|
|
include::{docdir}/ml/ml-shared.asciidoc[tag=model-id]
|
||
|
|
|
||
|
|
|
||
|
|
[[ml-delete-inference-response-codes]]
|
||
|
|
==== {api-response-codes-title}
|
||
|
|
|
||
|
|
`409`::
|
||
|
|
The code indicates that the trained {infer} model is referenced by an ingest
|
||
|
|
pipeline and cannot be deleted.
|
||
|
|
|
||
|
|
|
||
|
|
[[ml-delete-inference-example]]
|
||
|
|
==== {api-examples-title}
|
||
|
|
|
||
|
|
The following example deletes the `regression-job-one-1574775307356` trained
|
||
|
|
model:
|
||
|
|
|
||
|
|
[source,console]
|
||
|
|
--------------------------------------------------
|
||
|
|
DELETE _ml/inference/regression-job-one-1574775307356
|
||
|
|
--------------------------------------------------
|
||
|
|
// TEST[skip:TBD]
|
||
|
|
|
||
|
|
The API returns the following result:
|
||
|
|
|
||
|
|
|
||
|
|
[source,console-result]
|
||
|
|
----
|
||
|
|
{
|
||
|
|
"acknowledged" : true
|
||
|
|
}
|
||
|
|
----
|
||
|
|
|
||
|
|
|