Create a Llama inference endpoint

PUT /_inference/{task_type}/{llama_inference_id}

Create an inference endpoint to perform an inference task with the llama service.

Required authorization

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

chunking_settings object: The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the completion or chat_completion task types.; Reference
service enum required: The type of service supported for the specified task type. In this case, llama.; Values: llama
service_settings object required: Settings used to install the inference model. These settings are specific to the llama service.

Response

application/json

chunking_settings object: The chunking configuration object. Applies only to the embedding, sparse_embedding and text_embedding task types. Not applicable to the rerank, completion, or chat_completion task types.
service string required: The service type
service_settings object required: Settings specific to the service
task_settings object: Task settings specific to the service and task type
inference_id string required: The inference Id
task_type enum required: The task type; Values: text_embedding chat_completion completion

Examples

Request Console 1 / 8 languages

Run PUT _inference/text_embedding/llama-text-embedding to create a Llama inference endpoint that performs a text_embedding task.

Console Kibana Dev Tools

PUT _inference/text_embedding/llama-text-embedding
{
  "service": "llama",
  "service_settings": {
    "url": "http://localhost:8321/v1/inference/embeddings",
    "dimensions": 384,
    "model_id": "all-MiniLM-L6-v2" 
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.inference.put({
  task_type: "text_embedding",
  inference_id: "llama-text-embedding",
  inference_config: {
    service: "llama",
    service_settings: {
      url: "http://localhost:8321/v1/inference/embeddings",
      dimensions: 384,
      model_id: "all-MiniLM-L6-v2",
    },
  },
});

Python Elasticsearch Python Client

resp = client.inference.put(
    task_type="text_embedding",
    inference_id="llama-text-embedding",
    inference_config={
        "service": "llama",
        "service_settings": {
            "url": "http://localhost:8321/v1/inference/embeddings",
            "dimensions": 384,
            "model_id": "all-MiniLM-L6-v2"
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/text_embedding/llama-text-embedding" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "llama",
    "service_settings": {
      "url": "http://localhost:8321/v1/inference/embeddings",
      "dimensions": 384,
      "model_id": "all-MiniLM-L6-v2"
    }
  }'

Java Elasticsearch Java Client

client.inference().put(p -> p
    .inferenceId("llama-text-embedding")
    .taskType(TaskType.TextEmbedding)
    .inferenceConfig(i -> i
        .service("llama")
        .serviceSettings(JsonData.fromJson("""
{"url":"http://localhost:8321/v1/inference/embeddings","dimensions":384,"model_id":"all-MiniLM-L6-v2"}
"""))
    )
);

C# Elasticsearch .NET Client

var response = await client.Inference
    .PutAsync(new PutInferenceRequest()
    {
        InferenceId = "llama-text-embedding",
        TaskType = TaskType.TextEmbedding,
        InferenceConfig = new()
        {
            Service = "llama",
            ServiceSettings = JsonSerializer.Deserialize<JsonElement>("""
            {
              "url": "http://localhost:8321/v1/inference/embeddings",
              "dimensions": 384,
              "model_id": "all-MiniLM-L6-v2"
            }
            """)
        }
    });

PHP Elasticsearch PHP Client

$resp = $client->inference()->put([
    "task_type" => "text_embedding",
    "inference_id" => "llama-text-embedding",
    "body" => [
        "service" => "llama",
        "service_settings" => [
            "url" => "http://localhost:8321/v1/inference/embeddings",
            "dimensions" => 384,
            "model_id" => "all-MiniLM-L6-v2",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.inference.put(
  task_type: "text_embedding",
  inference_id: "llama-text-embedding",
  body: {
    "service": "llama",
    "service_settings": {
      "url": "http://localhost:8321/v1/inference/embeddings",
      "dimensions": 384,
      "model_id": "all-MiniLM-L6-v2"
    }
  }
)

Response

No example

Request Console 1 / 2 languages

Run PUT _inference/completion/llama-completion to create a Llama inference endpoint that performs a completion task.

Console Kibana Dev Tools

PUT _inference/completion/llama-completion
{
  "service": "llama",
  "service_settings": {
    "url": "http://localhost:8321/v1/openai/v1/chat/completions",
    "model_id": "llama3.2:3b" 
  }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/completion/llama-completion" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "llama",
    "service_settings": {
      "url": "http://localhost:8321/v1/openai/v1/chat/completions",
      "model_id": "llama3.2:3b" 
    }
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Run PUT _inference/chat_completion/llama-chat-completion to create a Llama inference endpoint that performs a chat_completion task.

Console Kibana Dev Tools

PUT _inference/chat_completion/llama-chat-completion
{
  "service": "llama",
  "service_settings": {
    "url": "http://localhost:8321/v1/openai/v1/chat/completions",
    "model_id": "llama3.2:3b" 
  }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_inference/chat_completion/llama-chat-completion" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "llama",
    "service_settings": {
      "url": "http://localhost:8321/v1/openai/v1/chat/completions",
      "model_id": "llama3.2:3b" 
    }
  }'

Generated from the API spec

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body