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.
Required authorization
- Cluster privileges manage_inference
Request body
-
servicerequired -
The type of service supported for the specified task type. In this case,
watsonxai. -
Values:
watsonxai -
service_settingsobjectrequired -
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.
ImportantYou 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
Response
-
chunking_settingsobject -
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.