Skip to content
LlamaIndex API Docs
Framework Docs
API Reference

Classifier

ClassifierJobs

Create Classify Job
Deprecated
$ llp classifier:jobs create
POST/api/v1/classifier/jobs
List Classify Jobs
Deprecated
$ llp classifier:jobs list
GET/api/v1/classifier/jobs
Get Classify Job
Deprecated
$ llp classifier:jobs get
GET/api/v1/classifier/jobs/{classify_job_id}
Get Classification Job Results
Deprecated
$ llp classifier:jobs get-results
GET/api/v1/classifier/jobs/{classify_job_id}/results
ModelsExpand Collapse
classifier_rule: 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’)

classify_job: object { id, project_id, rules, 9 more }

A classify job.

id: string

Unique identifier

project_id: string

The ID of the project

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.

type: string

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

status: "CANCELLED" or "ERROR" or "PARTIAL_SUCCESS" or 2 more

The status of the classify job

"CANCELLED"
"ERROR"
"PARTIAL_SUCCESS"
"PENDING"
"SUCCESS"
user_id: string

The ID of the user

created_at: optional string

Creation datetime

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

"FAST"
"MULTIMODAL"
parsing_configuration: optional object { lang, max_pages, target_pages }

The configuration for the parsing job

lang: optional "abq" or "ady" or "af" or 83 more

The language to parse the files in

"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

classify_parsing_configuration: object { lang, max_pages, target_pages }

Parsing configuration for a classify job.

lang: optional "abq" or "ady" or "af" or 83 more

The language to parse the files in

"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)