Perform completion inference on the service

POST /_inference/completion/{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/completion/openai_chat_completions to perform a completion on the example question.

Console Kibana Dev Tools

POST _inference/completion/openai_chat_completions
{
  "input": "What is Elastic?"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.inference.completion({
  inference_id: "openai_chat_completions",
  input: "What is Elastic?",
});

Python Elasticsearch Python Client

resp = client.inference.completion(
    inference_id="openai_chat_completions",
    input="What is Elastic?",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_inference/completion/openai_chat_completions" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "What is Elastic?"
  }'

Java Elasticsearch Java Client

client.inference().completion(c -> c
    .inferenceId("openai_chat_completions")
    .input("What is Elastic?")
);

C# Elasticsearch .NET Client

var response = await client.Inference
    .CompletionAsync(inferenceId: "openai_chat_completions", d1 => d1
        .Input("What is Elastic?")
    );

PHP Elasticsearch PHP Client

$resp = $client->inference()->completion([
    "inference_id" => "openai_chat_completions",
    "body" => [
        "input" => "What is Elastic?",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.inference.completion(
  inference_id: "openai_chat_completions",
  body: {
    "input": "What is Elastic?"
  }
)

Response

A successful response from POST _inference/completion/openai_chat_completions.

{
  "completion": [
    {
      "result": "Elastic is a company that provides a range of software solutions for search, logging, security, and analytics. Their flagship product is Elasticsearch, an open-source, distributed search engine that allows users to search, analyze, and visualize large volumes of data in real-time. Elastic also offers products such as Kibana, a data visualization tool, and Logstash, a log management and pipeline tool, as well as various other tools and solutions for data analysis and management."
    }
  ]
}

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body