--- type: api title: Create a Watsonx inference endpoint description: Create an inference endpoint to perform an inference task with the `watsonxai` service. url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-inference-put-watsonx resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-inference-put-watsonx products: - Elasticsearch --- # Create a Watsonx inference endpoint Availability: Generally available since 8.16 ## Paths - `PUT` `/_inference/{task_type}/{watsonx_inference_id}` #### 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. ## Description 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` ## Authentication - Api key: `Authorization: ` Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example: ``` curl -X GET "${ES_URL}/_cat/indices?v=true" \ -H "Authorization: ApiKey ${API_KEY}" ``` To get API keys, use the `/_security/api_key` APIs. - Basic: `Authorization: Basic ` - Bearer: `Authorization: Bearer ` Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API. For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html) ## Query string parameters - `timeout` (string · default: 30s) — optional Specifies the amount of time to wait for the inference endpoint to be created. ## Request body `application/json` - `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. - `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. - `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. - `project_id` (string) — required The identifier of the IBM Cloud project to use for the inference task. - `rate_limit` (object) — optional 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) — optional 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) The service type - `service_settings` (object) Settings specific to the service - `task_settings` (object) Task settings specific to the service and task type - `inference_id` (string) The inference Id - `task_type` (enum) The task type Values: `text_embedding` ## Code examples #### Console ```console PUT _inference/text_embedding/watsonx-embeddings { "service": "watsonxai", "service_settings": { "api_key": "Watsonx-API-Key", "url": "Wastonx-URL", "model_id": "ibm/slate-30m-english-rtrvr", "project_id": "IBM-Cloud-ID", "api_version": "2024-03-14" } } ``` #### JavaScript ```javascript const response = await client.inference.put({ task_type: "text_embedding", inference_id: "watsonx-embeddings", inference_config: { service: "watsonxai", service_settings: { api_key: "Watsonx-API-Key", url: "Wastonx-URL", model_id: "ibm/slate-30m-english-rtrvr", project_id: "IBM-Cloud-ID", api_version: "2024-03-14", }, }, }); ``` #### Python ```python resp = client.inference.put( task_type="text_embedding", inference_id="watsonx-embeddings", inference_config={ "service": "watsonxai", "service_settings": { "api_key": "Watsonx-API-Key", "url": "Wastonx-URL", "model_id": "ibm/slate-30m-english-rtrvr", "project_id": "IBM-Cloud-ID", "api_version": "2024-03-14" } }, ) ``` #### curl ```curl curl -X PUT "$ELASTICSEARCH_URL/_inference/text_embedding/watsonx-embeddings" \ -H "Authorization: ApiKey $ELASTIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "service": "watsonxai", "service_settings": { "api_key": "Watsonx-API-Key", "url": "Wastonx-URL", "model_id": "ibm/slate-30m-english-rtrvr", "project_id": "IBM-Cloud-ID", "api_version": "2024-03-14" } }' ``` #### Java ```java client.inference().put(p -> p .inferenceId("watsonx-embeddings") .taskType(TaskType.TextEmbedding) .inferenceConfig(i -> i .service("watsonxai") .serviceSettings(JsonData.fromJson("{\"api_key\":\"Watsonx-API-Key\",\"url\":\"Wastonx-URL\",\"model_id\":\"ibm/slate-30m-english-rtrvr\",\"project_id\":\"IBM-Cloud-ID\",\"api_version\":\"2024-03-14\"}")) ) ); ``` #### C# ```c# var response = await client.Inference .PutAsync(new PutInferenceRequest() { InferenceId = "watsonx-embeddings", TaskType = TaskType.TextEmbedding, InferenceConfig = new() { Service = "watsonxai", ServiceSettings = JsonSerializer.Deserialize(""" { "api_key": "Watsonx-API-Key", "url": "Wastonx-URL", "model_id": "ibm/slate-30m-english-rtrvr", "project_id": "IBM-Cloud-ID", "api_version": "2024-03-14" } """) } }); ``` #### PHP ```php $resp = $client->inference()->put([ "task_type" => "text_embedding", "inference_id" => "watsonx-embeddings", "body" => [ "service" => "watsonxai", "service_settings" => [ "api_key" => "Watsonx-API-Key", "url" => "Wastonx-URL", "model_id" => "ibm/slate-30m-english-rtrvr", "project_id" => "IBM-Cloud-ID", "api_version" => "2024-03-14", ], ], ]); ``` #### Ruby ```ruby response = client.inference.put( task_type: "text_embedding", inference_id: "watsonx-embeddings", body: { "service": "watsonxai", "service_settings": { "api_key": "Watsonx-API-Key", "url": "Wastonx-URL", "model_id": "ibm/slate-30m-english-rtrvr", "project_id": "IBM-Cloud-ID", "api_version": "2024-03-14" } } ) ```