---
type: api
title: Create an OpenShift AI inference endpoint
description: Create an inference endpoint to perform an inference task with the `openshift_ai` service.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-inference-put-openshift-ai
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-inference-put-openshift-ai
products:
  - Elasticsearch
---

# Create an OpenShift AI inference endpoint

Availability: 9.3+

## Paths

- `PUT` `/_inference/{task_type}/{openshiftai_inference_id}`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#basicauth)
- [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#bearerauth)

#### Path Parameters

- `task_type` (enum OpenShiftAiTaskType)
  The type of the inference task that the model will perform.
NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.
  Values: `text_embedding`, `completion`, `chat_completion`, `rerank`
- `openshiftai_inference_id` (string Id)
  The unique identifier of the inference endpoint.

## Description

Create an inference endpoint to perform an inference task with the `openshift_ai` service.

## Required authorization

* Cluster privileges: `manage_inference`

## Query String Parameters

- `timeout` (string Duration · default: 30s)
  Specifies the amount of time to wait for the inference endpoint to be created.

## Request Body

`application/json`

- `chunking_settings` ({} InferenceChunkingSettings) — optional
  The chunking configuration object.
Applies only to the `text_embedding` task type.
Not applicable to the `rerank`, `completion`, or `chat_completion` task types.
  - `max_chunk_size` (number · default: 250) — optional
    The maximum size of a chunk in words.
This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).
This value should not exceed the window size for the associated model.
  - `overlap` (number · default: 100) — optional
    The number of overlapping words for chunks.
It is applicable only to a `word` chunking strategy.
This value cannot be higher than half the `max_chunk_size` value.
  - `sentence_overlap` (number · default: 1) — optional
    The number of overlapping sentences for chunks.
It is applicable only for a `sentence` chunking strategy.
It can be either `1` or `0`.
  - `separator_group` (string) — optional
    Only applicable to the `recursive` strategy and required when using it.

Sets a predefined list of separators in the saved chunking settings based on the selected text type.
Values can be `markdown` or `plaintext`.

Using this parameter is an alternative to manually specifying a custom `separators` list.
  - `separators` ([] string) — optional
    Only applicable to the `recursive` strategy and required when using it.

A list of strings used as possible split points when chunking text.

Each string can be a plain string or a regular expression (regex) pattern.
The system tries each separator in order to split the text, starting from the first item in the list.

After splitting, it attempts to recombine smaller pieces into larger chunks that stay within
the `max_chunk_size` limit, to reduce the total number of chunks generated.
  - `strategy` (string · default: sentence) — optional
    The chunking strategy: `sentence`, `word`, `none` or `recursive`.

 * If `strategy` is set to `recursive`, you must also specify:

- `max_chunk_size`
- either `separators` or`separator_group`

Learn more about different chunking strategies in the linked documentation.
- `service` (enum OpenShiftAiServiceType) — required
  The type of service supported for the specified task type. In this case, `openshift_ai`.
  Values: `openshift_ai`
- `service_settings` ({} OpenShiftAiServiceSettings) — required
  Settings used to install the inference model. These settings are specific to the `openshift_ai` service.
  - `api_key` (string) — required
    A valid API key for your OpenShift AI endpoint.
Can be found in `Token authentication` section of model related information.
  - `url` (string) — required
    The URL of the OpenShift AI hosted model endpoint.
  - `model_id` (string) — optional
    The name of the model to use for the inference task.
Refer to the hosted model's documentation for the name if needed.
Service has been tested and confirmed to be working with the following models:
* For `text_embedding` task - `gritlm-7b`.
* For `completion` and `chat_completion` tasks - `llama-31-8b-instruct`.
* For `rerank` task - `bge-reranker-v2-m3`.
  - `max_input_tokens` (number) — optional
    For a `text_embedding` task, the maximum number of tokens per input before chunking occurs.
  - `similarity` (enum OpenShiftAiSimilarityType) — optional
    For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm.
If not specified, the default dot_product value is used.
    Values: `cosine`, `dot_product`, `l2_norm`
  - `rate_limit` ({} RateLimitSetting) — optional
    This setting helps to minimize the number of rate limit errors returned from the OpenShift AI API.
By default, the `openshift_ai` service sets the number of requests allowed per minute to 3000.
    - `requests_per_minute` (number) — optional
      The number of requests allowed per minute.
By default, the number of requests allowed per minute is set by each service as follows:

* `alibabacloud-ai-search` service: `1000`
* `amazonbedrock` service: `240`
* `anthropic` service: `50`
* `azureaistudio` service: `240`
* `azureopenai` service and task type `text_embedding`: `1440`
* `azureopenai` service and task types `completion` or `chat_completion`: `120`
* `cohere` service: `10000`
* `contextualai` service: `1000`
* `elastic` service and task type `chat_completion`: `240`
* `fireworksai` service: `6000`
* `googleaistudio` service: `360`
* `googlevertexai` service: `30000`
* `hugging_face` service: `3000`
* `jinaai` service: `2000`
* `llama` service: `3000`
* `mistral` service: `240`
* `openai` service and task type `text_embedding`: `3000`
* `openai` service and task type `completion`: `500`
* `openshift_ai` service: `3000`
* `voyageai` service: `2000`
* `watsonxai` service: `120`
- `task_settings` ({} OpenShiftAiTaskSettings) — optional
  Settings to configure the inference task.
Applies only to the `rerank` task type.
Not applicable to the `text_embedding`, `completion`, or `chat_completion` task types.
These settings are specific to the task type you specified.
  - `return_documents` (boolean) — optional
    For a `rerank` task, whether to return the source documents in the response.
  - `top_n` (number) — optional
    For a `rerank` task, the number of most relevant documents to return.

## Response

`application/json`

- `chunking_settings` ({} InferenceChunkingSettings)
  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.
  - `max_chunk_size` (number · default: 250)
    The maximum size of a chunk in words.
This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).
This value should not exceed the window size for the associated model.
  - `overlap` (number · default: 100)
    The number of overlapping words for chunks.
It is applicable only to a `word` chunking strategy.
This value cannot be higher than half the `max_chunk_size` value.
  - `sentence_overlap` (number · default: 1)
    The number of overlapping sentences for chunks.
It is applicable only for a `sentence` chunking strategy.
It can be either `1` or `0`.
  - `separator_group` (string)
    Only applicable to the `recursive` strategy and required when using it.

Sets a predefined list of separators in the saved chunking settings based on the selected text type.
Values can be `markdown` or `plaintext`.

Using this parameter is an alternative to manually specifying a custom `separators` list.
  - `separators` ([] string)
    Only applicable to the `recursive` strategy and required when using it.

A list of strings used as possible split points when chunking text.

Each string can be a plain string or a regular expression (regex) pattern.
The system tries each separator in order to split the text, starting from the first item in the list.

After splitting, it attempts to recombine smaller pieces into larger chunks that stay within
the `max_chunk_size` limit, to reduce the total number of chunks generated.
  - `strategy` (string · default: sentence)
    The chunking strategy: `sentence`, `word`, `none` or `recursive`.

 * If `strategy` is set to `recursive`, you must also specify:

- `max_chunk_size`
- either `separators` or`separator_group`

Learn more about different chunking strategies in the linked documentation.
- `service` (string)
  The service type
- `service_settings` (ServiceSettings)
  Settings specific to the service
- `task_settings` (TaskSettings)
  Task settings specific to the service and task type
- `inference_id` (string)
  The inference Id
- `task_type` (enum TaskTypeOpenShiftAi)
  The task type
  Values: `text_embedding`, `chat_completion`, `completion`, `rerank`
## Code Examples

#### Console

```console
PUT _inference/text_embedding/openshift-ai-text-embedding
{
    "service": "openshift_ai",
    "service_settings": {
        "url": "openshift-ai-embeddings-url",
        "api_key": "openshift-ai-embeddings-token",
        "model_id": "gritlm-7b"
    }
}
```

#### JavaScript

```javascript
const response = await client.inference.put({
  task_type: "text_embedding",
  inference_id: "openshift-ai-text-embedding",
  inference_config: {
    service: "openshift_ai",
    service_settings: {
      url: "openshift-ai-embeddings-url",
      api_key: "openshift-ai-embeddings-token",
      model_id: "gritlm-7b",
    },
  },
});
```

#### Python

```python
resp = client.inference.put(
    task_type="text_embedding",
    inference_id="openshift-ai-text-embedding",
    inference_config={
        "service": "openshift_ai",
        "service_settings": {
            "url": "openshift-ai-embeddings-url",
            "api_key": "openshift-ai-embeddings-token",
            "model_id": "gritlm-7b"
        }
    },
)
```

#### curl

```curl
curl -X PUT "$ELASTICSEARCH_URL/_inference/text_embedding/openshift-ai-text-embedding" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "openshift_ai",
    "service_settings": {
      "url": "openshift-ai-embeddings-url",
      "api_key": "openshift-ai-embeddings-token",
      "model_id": "gritlm-7b"
    }
  }'
```

#### Java

```java
client.inference().put(p -> p
    .inferenceId("openshift-ai-text-embedding")
    .taskType(TaskType.TextEmbedding)
    .inferenceConfig(i -> i
        .service("openshift_ai")
        .serviceSettings(JsonData.fromJson("""
{"url":"openshift-ai-embeddings-url","api_key":"openshift-ai-embeddings-token","model_id":"gritlm-7b"}
"""))
    )
);
```

#### C#

```c#
var response = await client.Inference
    .PutAsync(new PutInferenceRequest()
    {
        InferenceId = "openshift-ai-text-embedding",
        TaskType = TaskType.TextEmbedding,
        InferenceConfig = new()
        {
            Service = "openshift_ai",
            ServiceSettings = JsonSerializer.Deserialize<JsonElement>("""
            {
              "url": "openshift-ai-embeddings-url",
              "api_key": "openshift-ai-embeddings-token",
              "model_id": "gritlm-7b"
            }
            """)
        }
    });
```

#### PHP

```php
$resp = $client->inference()->put([
    "task_type" => "text_embedding",
    "inference_id" => "openshift-ai-text-embedding",
    "body" => [
        "service" => "openshift_ai",
        "service_settings" => [
            "url" => "openshift-ai-embeddings-url",
            "api_key" => "openshift-ai-embeddings-token",
            "model_id" => "gritlm-7b",
        ],
    ],
]);
```

#### Ruby

```ruby
response = client.inference.put(
  task_type: "text_embedding",
  inference_id: "openshift-ai-text-embedding",
  body: {
    "service": "openshift_ai",
    "service_settings": {
      "url": "openshift-ai-embeddings-url",
      "api_key": "openshift-ai-embeddings-token",
      "model_id": "gritlm-7b"
    }
  }
)
```

## Response Examples

#### A text embedding task

A successful response when creating an OpenShift AI `text_embedding` inference endpoint.

```json
{
  "inference_id": "openshift-ai-text-embedding",
  "task_type": "text_embedding",
  "service": "openshift_ai",
  "service_settings": {
    "model_id": "gritlm-7b",
    "url": "openshift-ai-embeddings-url",
    "rate_limit": {
      "requests_per_minute": 3000
    },
    "dimensions": 4096,
    "similarity": "dot_product",
    "dimensions_set_by_user": false
  },
  "chunking_settings": {
    "strategy": "sentence",
    "max_chunk_size": 250,
    "sentence_overlap": 1
  }
}
```

#### A completion task

A successful response when creating an OpenShift AI `completion` inference endpoint.

```json
{
  "inference_id": "openshift-ai-completion",
  "task_type": "completion",
  "service": "openshift_ai",
  "service_settings": {
    "model_id": "llama-31-8b-instruct",
    "url": "openshift-ai-completion-url",
    "rate_limit": {
      "requests_per_minute": 3000
    }
  }
}
```

#### A chat completion task

A successful response when creating an OpenShift AI `chat_completion` inference endpoint.

```json
{
  "inference_id": "openshift-ai-chat-completion",
  "task_type": "chat_completion",
  "service": "openshift_ai",
  "service_settings": {
    "model_id": "llama-31-8b-instruct",
    "url": "openshift-ai-chat-completion-url",
    "rate_limit": {
      "requests_per_minute": 3000
    }
  }
}
```

#### A rerank task

A successful response when creating an OpenShift AI `rerank` inference endpoint.

```json
{
  "inference_id": "openshift-ai-rerank",
  "task_type": "rerank",
  "service": "openshift_ai",
  "service_settings": {
    "model_id": "bge-reranker-v2-m3",
    "url": "openshift-ai-rerank-url",
    "rate_limit": {
      "requests_per_minute": 3000
    }
  }
}
```

#### A rerank task with custom `task_settings` and omitted `model_id`

A successful response when creating an OpenShift AI `rerank` inference endpoint with custom `task_settings` and omitted `model_id`

```json
{
  "inference_id": "openshift-ai-rerank",
  "task_type": "rerank",
  "service": "openshift_ai",
  "service_settings": {
    "url": "openshift-ai-rerank-url",
    "rate_limit": {
      "requests_per_minute": 3000
    }
  },
  "task_settings": {
    "return_documents": true,
    "top_n": 2
  }
}
```