API Reference

Classifier

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Jobs

Create Classify Job

Deprecated

client.classifier.jobs.create(JobCreateParams { file_ids, rules, organization_id, 4 more } params, RequestOptionsoptions?): ClassifyJob { id, project_id, rules, 9 more }

POST/api/v1/classifier/jobs

List Classify Jobs

Deprecated

client.classifier.jobs.list(JobListParams { organization_id, page_size, page_token, project_id } query?, RequestOptionsoptions?): PaginatedCursor<ClassifyJob { id, project_id, rules, 9 more } >

GET/api/v1/classifier/jobs

Get Classify Job

Deprecated

client.classifier.jobs.get(stringclassifyJobID, JobGetParams { organization_id, project_id } query?, RequestOptionsoptions?): ClassifyJob { id, project_id, rules, 9 more }

GET/api/v1/classifier/jobs/{classify_job_id}

Get Classification Job Results

Deprecated

client.classifier.jobs.getResults(stringclassifyJobID, JobGetResultsParams { organization_id, project_id } query?, RequestOptionsoptions?): JobGetResultsResponse { items, next_page_token, total_size }

GET/api/v1/classifier/jobs/{classify_job_id}/results

ModelsExpand Collapse

ClassifierRule { 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 { 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<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:

"PENDING"

"SUCCESS"

"ERROR"

"PARTIAL_SUCCESS"

"CANCELLED"

user_id: string

The ID of the user

created_at?: string | null

Creation datetime

formatdate-time

effective_at?: string

error_message?: string | null

Error message for the latest job attempt, if any.

job_record_id?: string | null

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

mode?: "FAST" | "MULTIMODAL"

The classification mode to use

One of the following:

"FAST"

"MULTIMODAL"

parsing_configuration?: ClassifyParsingConfiguration { lang, max_pages, target_pages }

The configuration for the parsing job

lang?: 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?: number | null

The maximum number of pages to parse

target_pages?: Array<number> | null

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

updated_at?: string | null

Update datetime

formatdate-time

ClassifyParsingConfiguration { lang, max_pages, target_pages }

Parsing configuration for a classify job.

lang?: 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?: number | null

The maximum number of pages to parse

target_pages?: Array<number> | null

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

JobGetResultsResponse { items, next_page_token, total_size }

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

items: Array<Item>

The list of items.

id: string

Unique identifier

formatuuid

classify_job_id: string

The ID of the classify job

formatuuid

created_at?: string | null

Creation datetime

formatdate-time

file_id?: string | null

The ID of the classified file

formatuuid

result?: Result | null

Result of classifying a single file.

confidence: number

Confidence score of the classification (0.0-1.0)

maximum1

minimum0

reasoning: string

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

type: string | null

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

updated_at?: string | null

Update datetime

formatdate-time

next_page_token?: string | null

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?: number | null

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.