Create a AI21 inference endpoint | Elasticsearch API documentation

Create a AI21 inference endpoint Generally available; Added in 9.2.0

PUT /_inference/{task_type}/{ai21_inference_id}

Create an inference endpoint to perform an inference task with the ai21 service.

Required authorization

Cluster privileges: manage_inference

Path parameters

task_type string

The type of the inference task that the model will perform.

Values are completion or chat_completion.
ai21_inference_id string Required

The unique identifier of the inference endpoint.

Query parameters

timeout string

Specifies the amount of time to wait for the inference endpoint to be created.

Values are -1 or 0.

External documentation

application/json

Body Required

service string Required

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

Value is ai21.
service_settings object Required

Settings used to install the inference model. These settings are specific to the ai21 service.
Hide service_settings attributes Show service_settings attributes object
- model_id string Required
  The name of the model to use for the inference task. Refer to the AI21 models documentation for the list of supported models and versions. Service has been tested and confirmed to be working for completion and chat_completion tasks with the following models:
  
  jamba-mini
  
  jamba-large
  External documentation
- api_key string
  
  A valid API key for accessing AI21 API.
  
  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.
- rate_limit object
  
  This setting helps to minimize the number of rate limit errors returned from the AI21 API. By default, the ai21 service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.
  
  External documentation
  Hide rate_limit attribute Show rate_limit attribute object
  
  requests_per_minute number
  
  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

Responses

200 application/json
Hide response attributes Show response attributes object
- chunking_settings object
  
  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.
  
  Hide chunking_settings attributes Show chunking_settings attributes object
  
  max_chunk_size number
  
  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.
  
  Default value is 250.0.
  
  overlap number
  
  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.
  
  Default value is 100.0.
  
  sentence_overlap number
  
  The number of overlapping sentences for chunks. It is applicable only for a sentence chunking strategy. It can be either 1 or 0.
  
  Default value is 1.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 array[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
  
  The chunking strategy: sentence, word, none or recursive.
  
  If strategy is set to recursive, you must also specify:
  
  max_chunk_size
  
  either separators orseparator_group
  
  Learn more about different chunking strategies in the linked documentation.
  
  Default value is sentence.
  
  External documentation
- 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 string Required
  
  The task type
  
  Values are completion or chat_completion.

PUT /_inference/{task_type}/{ai21_inference_id}

curl \
 --request PUT 'http://api.example.com/_inference/{task_type}/{ai21_inference_id}' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"service\": \"ai21\",\n  \"service_settings\": {\n    \"api_key\": \"ai21-api-key\",\n    \"model_id\": \"jamba-large\" \n  }\n}"'

Request examples

Run `PUT _inference/completion/ai21-completion` to create an AI21 inference endpoint that performs a `completion` task.

{
  "service": "ai21",
  "service_settings": {
    "api_key": "ai21-api-key",
    "model_id": "jamba-large" 
  }
}

Run `PUT _inference/chat-completion/ai21-chat-completion` to create a AI21 inference endpoint that performs a `chat_completion` task.

{
  "service": "ai21",
  "service_settings": {
    "api_key": "ai21-api-key",
    "model_id": "jamba-mini" 
  }
}