elasticsearch/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc
David Roberts 6fa3d73fd5
[ML] Make native inference generally available (#92213)
Previously this functionality was beta. This PR changes it to GA.
2022-12-12 15:43:30 +00:00

55 lines
1.6 KiB
Text

[role="xpack"]
[[clear-trained-model-deployment-cache]]
= Clear trained model deployment cache API
[subs="attributes"]
++++
<titleabbrev>Clear trained model deployment cache</titleabbrev>
++++
Clears a trained model deployment cache on all nodes where the trained model is assigned.
[[clear-trained-model-deployment-cache-request]]
== {api-request-title}
`POST _ml/trained_models/<model_id>/deployment/cache/_clear`
[[clear-trained-model-deployment-cache-prereq]]
== {api-prereq-title}
Requires the `manage_ml` cluster privilege. This privilege is included in the
`machine_learning_admin` built-in role.
[[clear-trained-model-deployment-cache-desc]]
== {api-description-title}
A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node,
their responses may be cached on that individual node. Calling this API clears the caches without restarting the
deployment.
[[clear-trained-model-deployment-cache-path-params]]
== {api-path-parms-title}
`<model_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
[[clear-trained-model-deployment-cache-example]]
== {api-examples-title}
The following example clears the cache for the new deployment for the
`elastic__distilbert-base-uncased-finetuned-conll03-english` trained model:
[source,console]
--------------------------------------------------
POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear
--------------------------------------------------
// TEST[skip:TBD]
The API returns the following results:
[source,console-result]
----
{
"cleared": true
}
----