Skip to content
Developer Documentation
API Reference

Classifier

ClassifierJobs

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.

maxLength2000
minLength10
type: string

The document type to assign when this rule matches (e.g., ‘invoice’, ‘receipt’, ‘contract’)

maxLength50
minLength1
ClassifyJob object { id, project_id, rules, 9 more }

A classify job.

id: string

Unique identifier

formatuuid
project_id: string

The ID of the project

formatuuid
rules: array of ClassifierRule { description, type }

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.

maxLength2000
minLength10
type: string

The document type to assign when this rule matches (e.g., ‘invoice’, ‘receipt’, ‘contract’)

maxLength50
minLength1
status: StatusEnum

The status of the classify job

One of the following:
"CANCELLED"
"ERROR"
"PARTIAL_SUCCESS"
"PENDING"
"SUCCESS"
user_id: string

The ID of the user

created_at: optional string

Creation datetime

formatdate-time
effective_at: optional string
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

One of the following:
"FAST"
"MULTIMODAL"
parsing_configuration: optional ClassifyParsingConfiguration { lang, max_pages, target_pages }

The configuration for the parsing job

lang: optional ParsingLanguages

The language to parse the files in

One of the following:
"abq"
"ady"
"af"
"ang"
"ar"
"as"
"ava"
"az"
"be"
"bg"
"bgc"
"bh"
"bho"
"bn"
"bs"
"ch_sim"
"ch_tra"
"che"
"cs"
"cy"
"da"
"dar"
"de"
"en"
"es"
"et"
"fa"
"fr"
"ga"
"gom"
"hi"
"hr"
"hu"
"id"
"inh"
"is"
"it"
"ja"
"kbd"
"kn"
"ko"
"ku"
"la"
"lbe"
"lez"
"lt"
"lv"
"mah"
"mai"
"mi"
"mn"
"mni"
"mr"
"ms"
"mt"
"ne"
"new"
"nl"
"no"
"oc"
"pi"
"pl"
"pt"
"ro"
"rs_cyrillic"
"rs_latin"
"ru"
"sa"
"sck"
"sk"
"sl"
"sq"
"sv"
"sw"
"ta"
"tab"
"te"
"th"
"tjk"
"tl"
"tr"
"ug"
"uk"
"ur"
"uz"
"vi"
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

formatdate-time
ClassifyParsingConfiguration object { lang, max_pages, target_pages }

Parsing configuration for a classify job.

lang: optional ParsingLanguages

The language to parse the files in

One of the following:
"abq"
"ady"
"af"
"ang"
"ar"
"as"
"ava"
"az"
"be"
"bg"
"bgc"
"bh"
"bho"
"bn"
"bs"
"ch_sim"
"ch_tra"
"che"
"cs"
"cy"
"da"
"dar"
"de"
"en"
"es"
"et"
"fa"
"fr"
"ga"
"gom"
"hi"
"hr"
"hu"
"id"
"inh"
"is"
"it"
"ja"
"kbd"
"kn"
"ko"
"ku"
"la"
"lbe"
"lez"
"lt"
"lv"
"mah"
"mai"
"mi"
"mn"
"mni"
"mr"
"ms"
"mt"
"ne"
"new"
"nl"
"no"
"oc"
"pi"
"pl"
"pt"
"ro"
"rs_cyrillic"
"rs_latin"
"ru"
"sa"
"sck"
"sk"
"sl"
"sq"
"sv"
"sw"
"ta"
"tab"
"te"
"th"
"tjk"
"tl"
"tr"
"ug"
"uk"
"ur"
"uz"
"vi"
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)

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/for-agents/mcp/ - Other LlamaIndex tooling for agents — the LlamaParse Platform MCP server, agent skills and plugins, and the n8n node — is mapped at https://developers.llamaindex.ai/for-agents/