Perform text embedding inference on the service

POST /_inference/text_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/text_embedding/my-cohere-endpoint to perform text embedding on the example sentence using the Cohere integration,

Console Kibana Dev Tools

POST _inference/text_embedding/my-cohere-endpoint
{
  "input": "The sky above the port was the color of television tuned to a dead channel.",
  "input_type": "ingest"
}

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.inference.text_embedding(
    inference_id="my-cohere-endpoint",
    input="The sky above the port was the color of television tuned to a dead channel.",
    input_type="ingest",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_inference/text_embedding/my-cohere-endpoint" \
  -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.",
    "input_type": "ingest"
  }'

Java Elasticsearch Java Client

client.inference().textEmbedding(t -> t
    .inferenceId("my-cohere-endpoint")
    .input("The sky above the port was the color of television tuned to a dead channel.")
    .inputType("ingest")
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.inference.text_embedding(
  inference_id: "my-cohere-endpoint",
  body: {
    "input": "The sky above the port was the color of television tuned to a dead channel.",
    "input_type": "ingest"
  }
)

Response

An abbreviated response from POST _inference/text_embedding/my-text-embedding-endpoint.

{
  "text_embedding": [
    {
      "embedding": [
        0.018569946,
        -0.036895752,
        0.01486969,
        -0.0045204163,
        -0.04385376,
        0.0075950623,
        0.04260254,
        -0.004005432,
        0.007865906,
        0.030792236,
        -0.050476074,
        0.011795044,
        -0.011642456,
        -0.010070801
      ]
    }
  ]
}

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body