Create an OpenShift AI inference endpoint
- PUT /_inference/{task_type}/{openshiftai_inference_id}
Create an inference endpoint to perform an inference task with the openshift_ai service.
- Cluster privileges:
manage_inference
Path Parameters
-
task_typeOpenShiftAiTaskTyperequired -
The type of the inference task that the model will perform. NOTE: The
chat_completiontask type only supports streaming and only through the _stream API. -
Values:
text_embeddingcompletionchat_completionrerank -
openshiftai_inference_idstring Idrequired -
The unique identifier of the inference endpoint.
Query Parameters
-
timeoutstring Duration · default: 30s Specifies the amount of time to wait for the inference endpoint to be created.
Request
-
chunking_settingsInferenceChunkingSettings -
The chunking configuration object. Applies only to the
text_embeddingtask type. Not applicable to thererank,completion, orchat_completiontask types. - Reference
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be lower than
20(forsentencestrategy) or10(forwordstrategy). This value should not exceed the window size for the associated model. -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
separator_groupstring -
Only applicable to the
recursivestrategy 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
markdownorplaintext.Using this parameter is an alternative to manually specifying a custom
separatorslist. -
separatorsstring -
Only applicable to the
recursivestrategy 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_sizelimit, to reduce the total number of chunks generated. -
serviceOpenShiftAiServiceTyperequired -
The type of service supported for the specified task type. In this case,
openshift_ai. -
Values:
openshift_ai -
service_settingsOpenShiftAiServiceSettingsrequired -
Settings used to install the inference model. These settings are specific to the
openshift_aiservice. -
api_keystringrequired -
A valid API key for your OpenShift AI endpoint. Can be found in
Token authenticationsection of model related information. -
urlstringrequired -
The URL of the OpenShift AI hosted model endpoint.
-
model_idstring -
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_embeddingtask -gritlm-7b. - For
completionandchat_completiontasks -llama-31-8b-instruct. - For
reranktask -bge-reranker-v2-m3.
- For
-
max_input_tokensnumber -
For a
text_embeddingtask, the maximum number of tokens per input before chunking occurs. -
similarityOpenShiftAiSimilarityType -
For a
text_embeddingtask, the similarity measure. One of cosine, dot_product, l2_norm. If not specified, the default dot_product value is used. -
Values:
cosinedot_productl2_norm -
rate_limitRateLimitSetting -
This setting helps to minimize the number of rate limit errors returned from the OpenShift AI API. By default, the
openshift_aiservice sets the number of requests allowed per minute to 3000. -
requests_per_minutenumber -
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-searchservice:1000amazonbedrockservice:240anthropicservice:50azureaistudioservice:240azureopenaiservice and task typetext_embedding:1440azureopenaiservice and task typescompletionorchat_completion:120cohereservice:10000contextualaiservice:1000elasticservice and task typechat_completion:240fireworksaiservice:6000googleaistudioservice:360googlevertexaiservice:30000hugging_faceservice:3000jinaaiservice:2000llamaservice:3000mistralservice:240openaiservice and task typetext_embedding:3000openaiservice and task typecompletion:500openshift_aiservice:3000voyageaiservice:2000watsonxaiservice:120
-
task_settingsOpenShiftAiTaskSettings -
Settings to configure the inference task. Applies only to the
reranktask type. Not applicable to thetext_embedding,completion, orchat_completiontask types. These settings are specific to the task type you specified. -
return_documentsboolean -
For a
reranktask, whether to return the source documents in the response. -
top_nnumber -
For a
reranktask, the number of most relevant documents to return.
Response
-
chunking_settingsInferenceChunkingSettings -
The chunking configuration object. Applies only to the
embedding,sparse_embeddingandtext_embeddingtask types. Not applicable to thererank,completion, orchat_completiontask types. -
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be lower than
20(forsentencestrategy) or10(forwordstrategy). This value should not exceed the window size for the associated model. -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
separator_groupstring -
Only applicable to the
recursivestrategy 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
markdownorplaintext.Using this parameter is an alternative to manually specifying a custom
separatorslist. -
separatorsstring -
Only applicable to the
recursivestrategy 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_sizelimit, to reduce the total number of chunks generated. -
servicestringrequired -
The service type
-
service_settingsServiceSettingsrequired -
Settings specific to the service
-
task_settingsTaskSettings -
Task settings specific to the service and task type
-
inference_idstringrequired -
The inference Id
-
task_typeTaskTypeOpenShiftAirequired -
The task type
-
Values:
text_embeddingchat_completioncompletionrerank