Skip to content
LlamaIndex API Docs
Framework Docs
API Reference
Classifier

Jobs

Create Classify Job
Deprecated
ClassifyJob classifier().jobs().create(JobCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/classifier/jobs
List Classify Jobs
Deprecated
JobListPage classifier().jobs().list(JobListParamsparams = JobListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/classifier/jobs
Get Classify Job
Deprecated
ClassifyJob classifier().jobs().get(JobGetParamsparams = JobGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/classifier/jobs/{classify_job_id}
Get Classification Job Results
Deprecated
JobGetResultsResponse classifier().jobs().getResults(JobGetResultsParamsparams = JobGetResultsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
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.

String description

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

maxLength500
minLength10
String type

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

maxLength50
minLength1
class ClassifyJob:

A classify job.

String id

Unique identifier

formatuuid
String projectId

The ID of the project

formatuuid
List<ClassifierRule> rules

The rules to classify the files

String description

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

maxLength500
minLength10
String type

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

maxLength50
minLength1
StatusEnum status

The status of the classify job

One of the following:
PENDING("PENDING")
SUCCESS("SUCCESS")
ERROR("ERROR")
PARTIAL_SUCCESS("PARTIAL_SUCCESS")
CANCELLED("CANCELLED")
String userId

The ID of the user

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time
Optional<LocalDateTime> effectiveAt
Optional<String> errorMessage

Error message for the latest job attempt, if any.

Optional<String> jobRecordId

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

Optional<Mode> mode

The classification mode to use

One of the following:
FAST("FAST")
MULTIMODAL("MULTIMODAL")
Optional<ClassifyParsingConfiguration> parsingConfiguration

The configuration for the parsing job

Optional<ParsingLanguages> lang

The language to parse the files in

One of the following:
AF("af")
AZ("az")
BS("bs")
CS("cs")
CY("cy")
DA("da")
DE("de")
EN("en")
ES("es")
ET("et")
FR("fr")
GA("ga")
HR("hr")
HU("hu")
ID("id")
IS("is")
IT("it")
KU("ku")
LA("la")
LT("lt")
LV("lv")
MI("mi")
MS("ms")
MT("mt")
NL("nl")
NO("no")
OC("oc")
PI("pi")
PL("pl")
PT("pt")
RO("ro")
RS_LATIN("rs_latin")
SK("sk")
SL("sl")
SQ("sq")
SV("sv")
SW("sw")
TL("tl")
TR("tr")
UZ("uz")
VI("vi")
AR("ar")
FA("fa")
UG("ug")
UR("ur")
BN("bn")
AS("as")
MNI("mni")
RU("ru")
RS_CYRILLIC("rs_cyrillic")
BE("be")
BG("bg")
UK("uk")
MN("mn")
ABQ("abq")
ADY("ady")
KBD("kbd")
AVA("ava")
DAR("dar")
INH("inh")
CHE("che")
LBE("lbe")
LEZ("lez")
TAB("tab")
TJK("tjk")
HI("hi")
MR("mr")
NE("ne")
BH("bh")
MAI("mai")
ANG("ang")
BHO("bho")
MAH("mah")
SCK("sck")
NEW("new")
GOM("gom")
SA("sa")
BGC("bgc")
TH("th")
CH_SIM("ch_sim")
CH_TRA("ch_tra")
JA("ja")
KO("ko")
TA("ta")
TE("te")
KN("kn")
Optional<Long> maxPages

The maximum number of pages to parse

Optional<List<Long>> targetPages

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

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time
class ClassifyParsingConfiguration:

Parsing configuration for a classify job.

Optional<ParsingLanguages> lang

The language to parse the files in

One of the following:
AF("af")
AZ("az")
BS("bs")
CS("cs")
CY("cy")
DA("da")
DE("de")
EN("en")
ES("es")
ET("et")
FR("fr")
GA("ga")
HR("hr")
HU("hu")
ID("id")
IS("is")
IT("it")
KU("ku")
LA("la")
LT("lt")
LV("lv")
MI("mi")
MS("ms")
MT("mt")
NL("nl")
NO("no")
OC("oc")
PI("pi")
PL("pl")
PT("pt")
RO("ro")
RS_LATIN("rs_latin")
SK("sk")
SL("sl")
SQ("sq")
SV("sv")
SW("sw")
TL("tl")
TR("tr")
UZ("uz")
VI("vi")
AR("ar")
FA("fa")
UG("ug")
UR("ur")
BN("bn")
AS("as")
MNI("mni")
RU("ru")
RS_CYRILLIC("rs_cyrillic")
BE("be")
BG("bg")
UK("uk")
MN("mn")
ABQ("abq")
ADY("ady")
KBD("kbd")
AVA("ava")
DAR("dar")
INH("inh")
CHE("che")
LBE("lbe")
LEZ("lez")
TAB("tab")
TJK("tjk")
HI("hi")
MR("mr")
NE("ne")
BH("bh")
MAI("mai")
ANG("ang")
BHO("bho")
MAH("mah")
SCK("sck")
NEW("new")
GOM("gom")
SA("sa")
BGC("bgc")
TH("th")
CH_SIM("ch_sim")
CH_TRA("ch_tra")
JA("ja")
KO("ko")
TA("ta")
TE("te")
KN("kn")
Optional<Long> maxPages

The maximum number of pages to parse

Optional<List<Long>> targetPages

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