Create a Watsonx inference endpoint

Auth

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

Path parameters

task_type enum required

The task type. The only valid task type for the model to perform is text_embedding.

Values: text_embedding rerank
watsonx_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

service enum required

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

Values: watsonxai
service_settings object required

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

api_key string required

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_version string required

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_id string required

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_id string required

The identifier of the IBM Cloud project to use for the inference task.

rate_limit object

This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the watsonxai service sets the number of requests allowed per minute to 120.

requests_per_minute number

The number of requests allowed per minute.

url string required

The URL of the inference endpoint that you created on Watsonx.

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