Get an inference endpoint

GET /_inference/{task_type}/{inference_id}
GET /_inference/{task_type}/_all
GET /_inference/{inference_id}
GET /_inference

This API requires the monitor_inference cluster privilege (the built-in inference_admin and inference_user roles grant this privilege).

Path Parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _inference/sparse_embedding/my-elser-model

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_inference/sparse_embedding/my-elser-model" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.inference().get(g -> g
    .inferenceId("my-elser-model")
    .taskType(TaskType.SparseEmbedding)
);

C# Elasticsearch .NET Client

var response = await client.Inference
    .GetAsync(d1 => d1
        .InferenceId("my-elser-model")
        .TaskType(TaskType.SparseEmbedding)
    );

PHP Elasticsearch PHP Client

$resp = $client->inference()->get([
    "task_type" => "sparse_embedding",
    "inference_id" => "my-elser-model",
]);

Ruby Elasticsearch Ruby Client

response = client.inference.get(
  task_type: "sparse_embedding",
  inference_id: "my-elser-model"
)

Response

No example

Path Parameters { task_type , inference_id , }

Response

Path Parameters