POST
/
ai
/
async-chunking
/
{CHUNKER}
/
{MODEL_ID}
Chunking by chunker and modelId
curl --request POST \
  --url https://application_id.applications.lucidworks.com/ai/async-chunking/{CHUNKER}/{MODEL_ID} \
  --header 'Content-Type: application/json' \
  --data '{
  "batch": [
    {
      "text": "The content to be split into chunks. "
    }
  ],
  "modelConfig": {
    "vectorQuantizationMethod": "min-max or max-scale",
    "dimReductionSize": 256
  },
  "useCaseConfig": {
    "dataType": "query"
  },
  "chunkerConfig": {}
}'
{
  "chunkingId": "441eb3be-7de6-470a-8141-e416a15c7db1",
  "status": "SUBMITTED"
}

Headers

​
Authorization: Bearer ACCESS_TOKEN
string

The authentication and authorization access token.

​
Content-Type
string

application/json

Example:

"application/json"

Path Parameters

​
MODEL_ID
string
required

Unique identifier for the model.

Example:

"gte-small"

​
CHUNKER
enum<string>
required

Chunking strategy for the way text is split.

Available options:
dynamic-newline,
dynamic-sentence,
regex-splitter,
semantic,
sentence

Body

application/json
​
batch
object[]

The batch of key:value pairs used in the chunking request.

​
modelConfig
object

Provides fields and values that specify ranges for tokens.

​
useCaseConfig
object
​
chunkerConfig
object

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.

Response

OK

This is the response to the POST chunking request submitted for a specific chunker and modelId.

​
chunkingId
string<uuid>

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

Example:

"441eb3be-7de6-470a-8141-e416a15c7db1"

​
status
string

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:

"SUBMITTED"