Classifier
ClassifierJobs
Create Classify Job
List Classify Jobs
Get Classify Job
Get Classification Job Results
ModelsExpand Collapse
ClassifierRule = object { description, type }
A rule for classifying documents - v0 simplified version.
This represents a single classification rule that will be applied to documents. All rules are content-based and use natural language descriptions.
description: string
Natural language description of what to classify. Be specific about the content characteristics that identify this document type.
type: string
The document type to assign when this rule matches (e.g., 'invoice', 'receipt', 'contract')
ClassifyJob = object { id, project_id, rules, 9 more }
A classify job.
id: string
Unique identifier
project_id: string
The ID of the project
The rules to classify the files
description: string
Natural language description of what to classify. Be specific about the content characteristics that identify this document type.
type: string
The document type to assign when this rule matches (e.g., 'invoice', 'receipt', 'contract')
The status of the classify job
user_id: string
The ID of the user
created_at: optional string
Creation datetime
error_message: optional string
Error message for the latest job attempt, if any.
job_record_id: optional string
The job record ID associated with this status, if any.
mode: optional "FAST" or "MULTIMODAL"
The classification mode to use
The configuration for the parsing job
The language to parse the files in
max_pages: optional number
The maximum number of pages to parse
target_pages: optional array of number
The pages to target for parsing (0-indexed, so first page is at 0)
updated_at: optional string
Update datetime
ClassifyParsingConfiguration = object { lang, max_pages, target_pages }
Parsing configuration for a classify job.
The language to parse the files in
max_pages: optional number
The maximum number of pages to parse
target_pages: optional array of number
The pages to target for parsing (0-indexed, so first page is at 0)