This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› › ›

Delete inference API

edit

Delete inference API

edit

Deletes an inference endpoint.

The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the Machine learning trained model APIs.

Request

edit

DELETE /_inference/<inference_id>

DELETE /_inference/<task_type>/<inference_id>

Prerequisites

edit

Requires the manage_inference cluster privilege (the built-in inference_admin role grants this privilege)

Path parameters

edit

<inference_id>: (Required, string) The unique identifier of the inference endpoint to delete.
<task_type>: (Optional, string) The type of inference task that the model performs.

Query parameters

edit

dry_run: (Optional, Boolean) When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint. Defaults to false.
force: (Optional, Boolean) Deletes the endpoint regardless if it’s used in a semantic_text field or in an inference pipeline.

Examples

edit

The following API call deletes the my-elser-model inference model that can perform sparse_embedding tasks.

resp = client.inference.delete(
    task_type="sparse_embedding",
    inference_id="my-elser-model",
)
print(resp)

response = client.inference.delete_model(
  task_type: 'sparse_embedding',
  inference_id: 'my-elser-model'
)
puts response

const response = await client.inference.delete({
  task_type: "sparse_embedding",
  inference_id: "my-elser-model",
});
console.log(response);

DELETE /_inference/sparse_embedding/my-elser-model

The API returns the following response:

{
  "acknowledged": true
}

« Inference APIs Get inference API »