Classify
Create Classify Job
List Classify Jobs
Get Classify Job
ModelsExpand Collapse
ClassifyConfiguration = 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
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.
ClassifyCreateRequest = object { configuration, configuration_id, file_id, 2 more }
Request to create a classify job.
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
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
Product configuration ID for reusable presets
file_id: optional string
File ID to classify
parse_job_id: optional string
Parse job ID to classify
transaction_id: optional string
Idempotency key scoped to the project
ClassifyResult = 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