Create Split Job

POST/api/v1/beta/split/jobs

Create a document split job. Experimental: This endpoint is not yet ready for production use and is subject to change at any time.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersExpand Collapse

categories: array of SplitCategory { name, description }

Categories to split the document into.

name: string

Name of the category.

maxLength200

minLength1

description: optional string

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document to be split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

splitting_strategy: optional object { allow_uncategorized }

Strategy for splitting the document.

allow_uncategorized: optional boolean

Whether to allow pages that don't match any category to be grouped as 'uncategorized'. If False, all pages must be assigned to a defined category.

ReturnsExpand Collapse

id: string

Unique identifier for the split job.

categories: array of SplitCategory { name, description }

Categories used for splitting.

name: string

Name of the category.

maxLength200

minLength1

description: optional string

Optional description of what content belongs in this category.

maxLength2000

minLength1

document_input: SplitDocumentInput { type, value }

Document that was split.

type: string

Type of document input. Valid values are: file_id

value: string

Document identifier.

project_id: string

Project ID this job belongs to.

status: string

Current status of the job. Valid values are: pending, processing, completed, failed.

user_id: string

User ID who created this job.

created_at: optional string

Creation datetime

formatdate-time

error_message: optional string

Error message if the job failed.

result: optional SplitResultResponse { segments }

Result of a completed split job.

segments: array of SplitSegmentResponse { category, confidence_category, pages }

List of document segments.

category: string

Category name this split belongs to.

confidence_category: string

Categorical confidence level. Valid values are: high, medium, low.

pages: array of number

1-indexed page numbers in this split.

updated_at: optional string

Update datetime

formatdate-time

Create Split Job

curl https://api.cloud.llamaindex.ai/api/v1/beta/split/jobs \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "categories": [
            {
              "name": "x"
            }
          ],
          "document_input": {
            "type": "type",
            "value": "value"
          }
        }'

{
  "id": "id",
  "categories": [
    {
      "name": "x",
      "description": "x"
    }
  ],
  "document_input": {
    "type": "type",
    "value": "value"
  },
  "project_id": "project_id",
  "status": "status",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "result": {
    "segments": [
      {
        "category": "category",
        "confidence_category": "confidence_category",
        "pages": [
          0
        ]
      }
    ]
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "categories": [
    {
      "name": "x",
      "description": "x"
    }
  ],
  "document_input": {
    "type": "type",
    "value": "value"
  },
  "project_id": "project_id",
  "status": "status",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "result": {
    "segments": [
      {
        "category": "category",
        "confidence_category": "confidence_category",
        "pages": [
          0
        ]
      }
    ]
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}