Skip to content
Developer Documentation
API Reference

Classifier

ClassifierJobs

Create Classify Job
Deprecated
classifier.jobs.create(JobCreateParams**kwargs) -> ClassifyJob
POST/api/v1/classifier/jobs
List Classify Jobs
Deprecated
classifier.jobs.list(JobListParams**kwargs) -> SyncPaginatedCursor[ClassifyJob]
GET/api/v1/classifier/jobs
Get Classify Job
Deprecated
classifier.jobs.get(strclassify_job_id, JobGetParams**kwargs) -> ClassifyJob
GET/api/v1/classifier/jobs/{classify_job_id}
Get Classification Job Results
Deprecated
classifier.jobs.get_results(strclassify_job_id, JobGetResultsParams**kwargs) -> JobGetResultsResponse
GET/api/v1/classifier/jobs/{classify_job_id}/results
ModelsExpand Collapse
class ClassifierRule: …

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: str

Natural language description of what to classify. Be specific about the content characteristics that identify this document type.

maxLength2000
minLength10
type: str

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

maxLength50
minLength1
class ClassifyJob: …

A classify job.

id: str

Unique identifier

formatuuid
project_id: str

The ID of the project

formatuuid
rules: List[ClassifierRule]

The rules to classify the files

description: str

Natural language description of what to classify. Be specific about the content characteristics that identify this document type.

maxLength2000
minLength10
type: str

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:
"PENDING"
"SUCCESS"
"ERROR"
"PARTIAL_SUCCESS"
"CANCELLED"
user_id: str

The ID of the user

created_at: Optional[datetime]

Creation datetime

formatdate-time
effective_at: Optional[datetime]
error_message: Optional[str]

Error message for the latest job attempt, if any.

job_record_id: Optional[str]

The job record ID associated with this status, if any.

mode: Optional[Literal["FAST", "MULTIMODAL"]]

The classification mode to use

One of the following:
"FAST"
"MULTIMODAL"
parsing_configuration: Optional[ClassifyParsingConfiguration]

The configuration for the parsing job

lang: Optional[ParsingLanguages]

The language to parse the files in

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

The maximum number of pages to parse

target_pages: Optional[List[int]]

The pages to target for parsing (0-indexed, so first page is at 0)

updated_at: Optional[datetime]

Update datetime

formatdate-time
class ClassifyParsingConfiguration: …

Parsing configuration for a classify job.

lang: Optional[ParsingLanguages]

The language to parse the files in

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

The maximum number of pages to parse

target_pages: Optional[List[int]]

The pages to target for parsing (0-indexed, so first page is at 0)

class JobGetResultsResponse: …

Response model for the classify endpoint following AIP-132 pagination standard.

items: List[Item]

The list of items.

id: str

Unique identifier

formatuuid
classify_job_id: str

The ID of the classify job

formatuuid
created_at: Optional[datetime]

Creation datetime

formatdate-time
file_id: Optional[str]

The ID of the classified file

formatuuid
result: Optional[ItemResult]

Result of classifying a single file.

confidence: float

Confidence score of the classification (0.0-1.0)

maximum1
minimum0
reasoning: str

Step-by-step explanation of why this classification was chosen and the confidence score assigned

type: Optional[str]

The document type that best matches, or null if no match.

updated_at: Optional[datetime]

Update datetime

formatdate-time
next_page_token: Optional[str]

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: Optional[int]

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

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/python/shared/mcp/