Create a AI21 inference endpoint Generally available

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.

application/json

Body

  • service string Required

    Value is ai21.

  • service_settings object Required
    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. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.

    • rate_limit object

      This setting helps to minimize the number of rate limit errors returned from the service.

      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
        • anthropic service: 50
        • azureaistudio service: 240
        • azureopenai service and task type text_embedding: 1440
        • azureopenai service and task type completion: 120
        • cohere service: 10000
        • elastic service and task type chat_completion: 240
        • 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
        • voyageai service: 2000
        • watsonxai service: 120

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • chunking_settings object

      Chunking configuration object

      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 higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).

        Default value is 250.

      • 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.

      • 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.

      • separator_group string Required

        This parameter is only applicable when using the recursive chunking strategy.

        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] Required

        A list of strings used as possible split points when chunking text with the recursive strategy.

        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
    • task_settings object
    • inference_id string Required

      The inference Id

    • task_type string Required

      Values are completion or chat_completion.

PUT /_inference/{task_type}/{ai21_inference_id}
PUT _inference/completion/ai21-completion
{
  "service": "ai21",
  "service_settings": {
    "api_key": "ai21-api-key",
    "model_id": "jamba-large" 
  }
}
resp = client.inference.put(
    task_type="completion",
    inference_id="ai21-completion",
    inference_config={
        "service": "ai21",
        "service_settings": {
            "api_key": "ai21-api-key",
            "model_id": "jamba-large"
        }
    },
)
const response = await client.inference.put({
  task_type: "completion",
  inference_id: "ai21-completion",
  inference_config: {
    service: "ai21",
    service_settings: {
      api_key: "ai21-api-key",
      model_id: "jamba-large",
    },
  },
});
response = client.inference.put(
  task_type: "completion",
  inference_id: "ai21-completion",
  body: {
    "service": "ai21",
    "service_settings": {
      "api_key": "ai21-api-key",
      "model_id": "jamba-large"
    }
  }
)
$resp = $client->inference()->put([
    "task_type" => "completion",
    "inference_id" => "ai21-completion",
    "body" => [
        "service" => "ai21",
        "service_settings" => [
            "api_key" => "ai21-api-key",
            "model_id" => "jamba-large",
        ],
    ],
]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"service":"ai21","service_settings":{"api_key":"ai21-api-key","model_id":"jamba-large"}}' "$ELASTICSEARCH_URL/_inference/completion/ai21-completion"
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" 
  }
}