Skip to content
LlamaIndex OSS Documentation
API Reference

Classify

Create Classify Job
client.classify.create(ClassifyCreateParams { organization_id, project_id, configuration, 4 more } params, RequestOptionsoptions?): ClassifyCreateResponse { id, configuration, document_input_type, 11 more }
POST/api/v2/classify
List Classify Jobs
client.classify.list(ClassifyListParams { configuration_id, created_at_on_or_after, created_at_on_or_before, 6 more } query?, RequestOptionsoptions?): PaginatedCursor<ClassifyListResponse { id, configuration, document_input_type, 11 more } >
GET/api/v2/classify
Get Classify Job
client.classify.get(stringjobID, ClassifyGetParams { organization_id, project_id } query?, RequestOptionsoptions?): ClassifyGetResponse { id, configuration, document_input_type, 11 more }
GET/api/v2/classify/{job_id}
ModelsExpand Collapse
ClassifyConfiguration { rules, mode, parsing_configuration }

Configuration for a classify job.

rules: Array<Rule>

Classify rules to evaluate against the document (at least one required)

description: string

Natural language criteria for matching this rule

maxLength500
minLength10
type: string

Document type to assign when rule matches

maxLength50
minLength1
mode?: "FAST"

Classify execution mode

parsing_configuration?: ParsingConfiguration | null

Parsing configuration for classify jobs.

lang?: string

ISO 639-1 language code for the document

max_pages?: number | null

Maximum number of pages to process. Omit for no limit.

minimum1
target_pages?: string | null

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

ClassifyCreateRequest { configuration, configuration_id, file_id, 2 more }

Request to create a classify job.

configuration?: ClassifyConfiguration { rules, mode, parsing_configuration } | null

Configuration for a classify job.

rules: Array<Rule>

Classify rules to evaluate against the document (at least one required)

description: string

Natural language criteria for matching this rule

maxLength500
minLength10
type: string

Document type to assign when rule matches

maxLength50
minLength1
mode?: "FAST"

Classify execution mode

parsing_configuration?: ParsingConfiguration | null

Parsing configuration for classify jobs.

lang?: string

ISO 639-1 language code for the document

max_pages?: number | null

Maximum number of pages to process. Omit for no limit.

minimum1
target_pages?: string | null

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

configuration_id?: string | null

Product configuration ID for reusable presets

file_id?: string | null

File ID to classify

parse_job_id?: string | null

Parse job ID to classify

transaction_id?: string | null

Idempotency key scoped to the project

ClassifyResult { confidence, reasoning, type }

Result of classifying a document.

confidence: number

Confidence score between 0.0 and 1.0

maximum1
minimum0
reasoning: string

Why the document matched (or didn't match) the returned rule

type: string | null

Matched rule type, or null if no rule matched