Classify

Create Classify Job

$ llamacloud-prod classify create

POST/api/v2/classify

List Classify Jobs

$ llamacloud-prod classify list

GET/api/v2/classify

Get Classify Job

$ llamacloud-prod classify get

GET/api/v2/classify/{job_id}

ModelsExpand Collapse

classify_configuration: object { rules, mode, parsing_configuration }

Configuration for a classify job.

rules: array of object { description, type }

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

description: string

Natural language criteria for matching this rule

type: string

Document type to assign when rule matches

mode: optional "FAST"

Classify execution mode

"FAST"

parsing_configuration: optional object { lang, max_pages, target_pages }

Parsing configuration for classify jobs.

lang: optional string

ISO 639-1 language code for the document

max_pages: optional number

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

target_pages: optional string

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

classify_create_request: object { configuration, configuration_id, file_id, 4 more }

Request to create a classify job.

configuration: optional object { rules, mode, parsing_configuration }

Configuration for a classify job.

rules: array of object { description, type }

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

description: string

Natural language criteria for matching this rule

type: string

Document type to assign when rule matches

mode: optional "FAST"

Classify execution mode

"FAST"

parsing_configuration: optional object { lang, max_pages, target_pages }

Parsing configuration for classify jobs.

lang: optional string

ISO 639-1 language code for the document

max_pages: optional number

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

target_pages: optional string

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

configuration_id: optional string

Saved configuration ID

Deprecatedfile_id: optional string

Deprecated: use file_input instead

file_input: optional string

File ID or parse job ID to classify

Deprecatedparse_job_id: optional string

Deprecated: use file_input instead

transaction_id: optional string

Idempotency key scoped to the project

webhook_configurations: optional array of object { webhook_events, webhook_headers, webhook_output_format, webhook_url }

Outbound webhook endpoints to notify on job status changes

webhook_events: optional array of "extract.pending" or "extract.success" or "extract.error" or 20 more

Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.

"extract.pending"

"extract.success"

"extract.error"

"extract.partial_success"

"extract.cancelled"

"parse.pending"

"parse.running"

"parse.success"

"parse.error"

"parse.partial_success"

"parse.cancelled"

"classify.pending"

"classify.running"

"classify.success"

"classify.error"

"classify.partial_success"

"classify.cancelled"

"sheets.pending"

"sheets.success"

"sheets.error"

"sheets.partial_success"

"sheets.cancelled"

"unmapped_event"

webhook_headers: optional map[string]

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

webhook_output_format: optional string

Response format sent to the webhook: ‘string’ (default) or ‘json’

webhook_url: optional string

URL to receive webhook POST notifications

classify_result: object { confidence, reasoning, type }

Result of classifying a document.

confidence: number

Confidence score between 0.0 and 1.0

reasoning: string

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

type: string

Matched rule type, or null if no rule matched