Perform sparse embedding inference on the service

POST /_inference/sparse_embedding/{inference_id}

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Run POST _inference/sparse_embedding/my-elser-model to perform sparse embedding on the example sentence.

Console Kibana Dev Tools

POST _inference/sparse_embedding/my-elser-model
{
  "input": "The sky above the port was the color of television tuned to a dead channel."
}

JavaScript Elasticsearch JavaScript Client

const response = await client.inference.sparseEmbedding({
  inference_id: "my-elser-model",
  input:
    "The sky above the port was the color of television tuned to a dead channel.",
});

Python Elasticsearch Python Client

resp = client.inference.sparse_embedding(
    inference_id="my-elser-model",
    input="The sky above the port was the color of television tuned to a dead channel.",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_inference/sparse_embedding/my-elser-model" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "The sky above the port was the color of television tuned to a dead channel."
  }'

Java Elasticsearch Java Client

client.inference().sparseEmbedding(s -> s
    .inferenceId("my-elser-model")
    .input("The sky above the port was the color of television tuned to a dead channel.")
);

C# Elasticsearch .NET Client

var response = await client.Inference
    .SparseEmbeddingAsync(inferenceId: "my-elser-model", d1 => d1
        .Input("The sky above the port was the color of television tuned to a dead channel.")
    );

PHP Elasticsearch PHP Client

$resp = $client->inference()->sparseEmbedding([
    "inference_id" => "my-elser-model",
    "body" => [
        "input" => "The sky above the port was the color of television tuned to a dead channel.",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.inference.sparse_embedding(
  inference_id: "my-elser-model",
  body: {
    "input": "The sky above the port was the color of television tuned to a dead channel."
  }
)

Response

An abbreviated response from POST _inference/sparse_embedding/my-elser-model.

{
  "sparse_embedding": [
    {
      "is_truncated": false,
      "embedding": {
        "port": 2.1259406,
        "sky": 1.7073475,
        "color": 1.6922266,
        "dead": 1.6247464,
        "television": 1.3525393,
        "above": 1.2425821,
        "tuned": 1.1440028,
        "colors": 1.1218185,
        "tv": 1.0111054,
        "ports": 1.0067928,
        "poem": 1.0042328,
        "channel": 0.99471164,
        "tune": 0.96235967,
        "scene": 0.9020516
      }
    }
  ]
}

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body