Create an OpenAI inference endpoint

Auth

Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs.

Required authorization

Cluster privileges manage_inference

Path parameters

task_type enum required

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: chat_completion completion text_embedding
openai_inference_id string required

The unique identifier of the inference endpoint.

Query parameters

timeout string · default: 30s

Specifies the amount of time to wait for the inference endpoint to be created.

Request body

chunking_settings object

The chunking configuration object.

Reference
max_chunk_size number · default: 250

The maximum size of a chunk in words. This value cannot be higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).

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.

strategy string · default: sentence

The chunking strategy: sentence or word.

service enum required

The type of service supported for the specified task type. In this case, openai.

Values: openai
service_settings object required

Settings used to install the inference model. These settings are specific to the openai service.

api_key string required

A valid API key of your OpenAI account. You can find your OpenAI API keys in your OpenAI account under the API keys section.

Important

You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key.

External docs
dimensions number

The number of dimensions the resulting output embeddings should have. It is supported only in text-embedding-3 and later models. If it is not set, the OpenAI defined default for the model is used.

model_id string required

The name of the model to use for the inference task. Refer to the OpenAI documentation for the list of available text embedding models.

External docs
organization_id string

The unique identifier for your organization. You can find the Organization ID in your OpenAI account under Settings > Organizations.

rate_limit object

This setting helps to minimize the number of rate limit errors returned from OpenAI. The openai service sets a default number of requests allowed per minute depending on the task type. For text_embedding, it is set to 3000. For completion, it is set to 500.

requests_per_minute number

The number of requests allowed per minute.

similarity enum

For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm. Defaults to dot_product.

Values: cosine dot_product l2_norm
url string · default: https://api.openai.com/v1/embeddings.

The URL endpoint to use for the requests. It can be changed for testing purposes.

task_settings object

Settings to configure the inference task. These settings are specific to the task type you specified.

user string

For a completion or text_embedding task, specify the user issuing the request. This information can be used for abuse detection.

Response

application/json
chunking_settings object

Chunking configuration object

max_chunk_size number · default: 250

The maximum size of a chunk in words. This value cannot be higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).

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.

strategy string · default: sentence

The chunking strategy: sentence or word.

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