--- 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/4371/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx products: - Elasticsearch --- # Create a Watsonx inference endpoint Availability: 8.16+ ## Paths - `PUT` `/_inference/{task_type}/{watsonx_inference_id}` - [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#apikeyauth) - [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#basicauth) - [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#bearerauth) #### Path Parameters - `task_type` (enum WatsonxTaskType) The type of the inference task that the model will perform. Values: `text_embedding`, `rerank`, `chat_completion`, `completion` - `watsonx_inference_id` (string Id) 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` ## Query String Parameters - `timeout` (string Duration · default: 30s) Specifies the amount of time to wait for the inference endpoint to be created. ## Request Body `application/json` - `chunking_settings` ({} InferenceChunkingSettings) — optional The chunking configuration object. Applies only to the `text_embedding` task type. Not applicable to the `rerank`, `completion` or `chat_completion` task types. - `max_chunk_size` (number · default: 250) — optional The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model. - `overlap` (number · default: 100) — optional 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) — optional The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`. - `separator_group` (string) — optional Only applicable to the `recursive` strategy 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 `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list. - `separators` ([] string) — optional Only applicable to the `recursive` strategy 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_size` limit, to reduce the total number of chunks generated. - `strategy` (string · default: sentence) — optional The chunking strategy: `sentence`, `word`, `none` or `recursive`. * If `strategy` is set to `recursive`, you must also specify: - `max_chunk_size` - either `separators` or`separator_group` Learn more about different chunking strategies in the linked documentation. - `service` (enum WatsonxServiceType) — required The type of service supported for the specified task type. In this case, `watsonxai`. Values: `watsonxai` - `service_settings` ({} WatsonxServiceSettings) — 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. Refer to the IBM library - Foundation models in Watsonx.ai. - `project_id` (string) — required The identifier of the IBM Cloud project to use for the inference task. - `rate_limit` ({} RateLimitSetting) — 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. By default, the number of requests allowed per minute is set by each service as follows: * `alibabacloud-ai-search` service: `1000` * `amazonbedrock` service: `240` * `anthropic` service: `50` * `azureaistudio` service: `240` * `azureopenai` service and task type `text_embedding`: `1440` * `azureopenai` service and task types `completion` or `chat_completion`: `120` * `cohere` service: `10000` * `contextualai` service: `1000` * `elastic` service and task type `chat_completion`: `240` * `fireworksai` service: `6000` * `googleaistudio` service: `360` * `googlevertexai` service: `30000` * `hugging_face` service: `3000` * `jinaai` service: `2000` * `llama` service: `3000` * `mistral` service: `240` * `openai` service and task type `text_embedding`: `3000` * `openai` service and task type `completion`: `500` * `openshift_ai` service: `3000` * `voyageai` service: `2000` * `watsonxai` service: `120` - `url` (string) — required The URL of the inference endpoint that you created on Watsonx. ## Response `application/json` - `chunking_settings` ({} InferenceChunkingSettings) The chunking configuration object. Applies only to the `embedding`, `sparse_embedding` and `text_embedding` task types. Not applicable to the `rerank`, `completion`, or `chat_completion` task types. - `max_chunk_size` (number · default: 250) The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model. - `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`. - `separator_group` (string) Only applicable to the `recursive` strategy 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 `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list. - `separators` ([] string) Only applicable to the `recursive` strategy 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_size` limit, to reduce the total number of chunks generated. - `strategy` (string · default: sentence) The chunking strategy: `sentence`, `word`, `none` or `recursive`. * If `strategy` is set to `recursive`, you must also specify: - `max_chunk_size` - either `separators` or`separator_group` Learn more about different chunking strategies in the linked documentation. - `service` (string) The service type - `service_settings` (ServiceSettings) Settings specific to the service - `task_settings` (TaskSettings) Task settings specific to the service and task type - `inference_id` (string) The inference Id - `task_type` (enum TaskTypeWatsonx) The task type Values: `text_embedding`, `chat_completion`, `completion` ## 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" } } ) ```