Skip to content
Get started

Split

Create Split Job
beta.split.create(SplitCreateParams**kwargs) -> SplitCreateResponse
POST/api/v1/beta/split/jobs
List Split Jobs
beta.split.list(SplitListParams**kwargs) -> SyncPaginatedCursor[SplitListResponse]
GET/api/v1/beta/split/jobs
Get Split Job
beta.split.get(strsplit_job_id, SplitGetParams**kwargs) -> SplitGetResponse
GET/api/v1/beta/split/jobs/{split_job_id}
ModelsExpand Collapse
class SplitCategory:

Category definition for document splitting.

name: str

Name of the category.

maxLength200
minLength1
description: Optional[str]

Optional description of what content belongs in this category.

maxLength2000
minLength1
class SplitDocumentInput:

Document input specification.

type: str

Type of document input. Valid values are: file_id

value: str

Document identifier.

class SplitResultResponse:

Result of a completed split job.

segments: List[SplitSegmentResponse]

List of document segments.

category: str

Category name this split belongs to.

confidence_category: str

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

pages: List[int]

1-indexed page numbers in this split.

class SplitSegmentResponse:

A segment of the split document.

category: str

Category name this split belongs to.

confidence_category: str

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

pages: List[int]

1-indexed page numbers in this split.