Sign in

v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB
Split content into chunks

Chunk text using the specified chunker

This is an all-purpose chunking endpoint you can use by specifying the chunker and modelId to use.

The POST request submits text to be split into chunks based on the CHUNKER (chunking strategy) and MODEL_ID sent in the request.

The API responds with the following information:

  • chunkingId that is a unique UUID for the submitted chunking task, and can be used later to retrieve the results.

  • status that indicates the current state of the chunking task.

IMPORTANT: The available use cases by chunker are detailed in their own section in this specification.

post/ai/async-chunking/{CHUNKER}/{MODEL_ID}

Headers

Authorizationstring required

Bearer token used for authentication. Format: Authorization: Bearer ACCESS_TOKEN.

Content-Typestring
Example:application/json

The content type of the request body.

Request body

chunkerConfigobject

This parameter contains fields that determine how the text is split and the size of text chunks created.

IMPORTANT: Specific information is detailed in each use case.

Example request

{
  "batch": [
    {
      "text": "The content to be split into chunks. "
    }
  ],
  "modelConfig": {
    "vectorQuantizationMethod": "min-max",
    "dimReductionSize": 256
  },
  "useCaseConfig": {
    "dataType": "query"
  }
}

Response

OK

chunkingIdstring uuid

The universal unique identifier (UUID) returned in the POST request. This UUID is required in the GET request to retrieve results.

statusstring

The current status of the request. Allowed values are:

  • SUBMITTED - The POST request was successful and the response has returned the chunkingId and status that is used by the GET request.

  • ERROR - An error was generated when the GET request was sent.

  • READY - The results associated with the chunkingId are available and ready to be retrieved.

  • RETRIEVED - The results associated with the chunkingId are returned successfully when the GET request was sent.

Example response

{
  "chunkingId": "441eb3be-7de6-470a-8141-e416a15c7db1",
  "status": "SUBMITTED"
}