Skip to main content
POST
/
ai
/
async-chunking
/
regex-splitter
/
{MODEL_ID}
Split text on a regex
import requests

url = "https://application_id.applications.lucidworks.com/ai/async-chunking/regex-splitter/{MODEL_ID}"

payload = {
    "batch": [{ "text": "The itsy bitsy spider climbed up the waterspout.
Down came the rain.
And washed the spider out.
Out came the sun.
And dried up all the rain.
And the itsy bitsy spider climbed up the spout again." }],
    "useCaseConfig": { "dataType": "query" },
    "modelConfig": { "vectorQuantizationMethod": "max-scale" },
    "chunkerConfig": { "regex": "\n" }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "chunkingId": "e10b4412-be0c-4ef0-a8a6-ee9afcbc2c3e",
  "status": "SUBMITTED"
}

Headers

​
Authorization
string
required

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

​
Content-Type
string

application/json

Example:

"application/json"

Path Parameters

​
MODEL_ID
string
required

Unique identifier for the model.

Example:

"gte-small"

Body

application/json
​
batch
object[]

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

​
modelConfig
ModelConfig · object

Provides fields and values that specify ranges for tokens.

​
useCaseConfig
UseCaseConfigChunking · object
​
chunkerConfig
RegexSplitterChunkerConfig · object

The regex-splitter chunker (chunking strategy) splits the submitted text based on the specified regex (regular expression), according to the conventions employed by the re python package. This is the default chunker configuration if nothing is passed. For more information about the re operations, see https://docs.python.org/3/library/re.html.

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"