Create a Watsonx inference endpoint
- PUT /_inference/{task_type}/{watsonx_inference_id}
Create an inference endpoint to perform an inference task with the watsonxai service.
You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service.
You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.
- Cluster privileges:
manage_inference
Path Parameters
-
task_typeWatsonxTaskTyperequired -
The task type. The only valid task type for the model to perform is
text_embedding. -
Values:
text_embeddingrerank -
watsonx_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
-
serviceWatsonxServiceTyperequired -
The type of service supported for the specified task type. In this case,
watsonxai. -
Values:
watsonxai -
service_settingsWatsonxServiceSettingsrequired -
Settings used to install the inference model. These settings are specific to the
watsonxaiservice. -
api_keystringrequired -
A valid API key of your Watsonx account. You can find your Watsonx API keys or you can create a new one on the API keys page.
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
-
api_versionstringrequired -
A version parameter that takes a version date in the format of
YYYY-MM-DD. For the active version data parameters, refer to the Wastonx documentation. - External docs
-
model_idstringrequired -
The name of the model to use for the inference task. Refer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models.
- External docs
-
project_idstringrequired -
The identifier of the IBM Cloud project to use for the inference task.
-
rate_limitRateLimitSetting -
This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the
watsonxaiservice sets the number of requests allowed per minute to 120. -
requests_per_minutenumber -
The number of requests allowed per minute.
-
urlstringrequired -
The URL of the inference endpoint that you created on Watsonx.
Response
-
chunking_settingsInferenceChunkingSettings -
Chunking configuration object
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
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. -
strategystring · default: sentence -
The chunking strategy:
sentenceorword. -
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