API Reference

Classifier

Jobs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Classify Jobs

Deprecated: Please use `client.classify.list()`

client.Classifier.Jobs.List(ctx, query) (*PaginatedCursor[ClassifyJob], error)

GET/api/v1/classifier/jobs

List classify jobs. Experimental: not production-ready and subject to change.

ParametersExpand Collapse

query ClassifierJobListParams

OrganizationID param.Field[string]Optional

PageSize param.Field[int64]Optional

PageToken param.Field[string]Optional

ProjectID param.Field[string]Optional

ReturnsExpand Collapse

type ClassifyJob struct{…}

A classify job.

ID string

Unique identifier

formatuuid

ProjectID string

The ID of the project

formatuuid

Rules []ClassifierRule

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:

const StatusEnumCancelled StatusEnum = "CANCELLED"

const StatusEnumError StatusEnum = "ERROR"

const StatusEnumPartialSuccess StatusEnum = "PARTIAL_SUCCESS"

const StatusEnumPending StatusEnum = "PENDING"

const StatusEnumSuccess StatusEnum = "SUCCESS"

UserID string

The ID of the user

CreatedAt TimeOptional

Creation datetime

formatdate-time

EffectiveAt TimeOptional

ErrorMessage stringOptional

Error message for the latest job attempt, if any.

JobRecordID stringOptional

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

Mode ClassifyJobModeOptional

The classification mode to use

One of the following:

const ClassifyJobModeFast ClassifyJobMode = "FAST"

const ClassifyJobModeMultimodal ClassifyJobMode = "MULTIMODAL"

ParsingConfiguration ClassifyParsingConfigurationOptional

The configuration for the parsing job

Lang ParsingLanguagesOptional

The language to parse the files in

One of the following:

const ParsingLanguagesAbq ParsingLanguages = "abq"

const ParsingLanguagesAdy ParsingLanguages = "ady"

const ParsingLanguagesAf ParsingLanguages = "af"

const ParsingLanguagesAng ParsingLanguages = "ang"

const ParsingLanguagesAr ParsingLanguages = "ar"

const ParsingLanguagesAs ParsingLanguages = "as"

const ParsingLanguagesAva ParsingLanguages = "ava"

const ParsingLanguagesAz ParsingLanguages = "az"

const ParsingLanguagesBe ParsingLanguages = "be"

const ParsingLanguagesBg ParsingLanguages = "bg"

const ParsingLanguagesBgc ParsingLanguages = "bgc"

const ParsingLanguagesBh ParsingLanguages = "bh"

const ParsingLanguagesBho ParsingLanguages = "bho"

const ParsingLanguagesBn ParsingLanguages = "bn"

const ParsingLanguagesBs ParsingLanguages = "bs"

const ParsingLanguagesChSim ParsingLanguages = "ch_sim"

const ParsingLanguagesChTra ParsingLanguages = "ch_tra"

const ParsingLanguagesChe ParsingLanguages = "che"

const ParsingLanguagesCs ParsingLanguages = "cs"

const ParsingLanguagesCy ParsingLanguages = "cy"

const ParsingLanguagesDa ParsingLanguages = "da"

const ParsingLanguagesDar ParsingLanguages = "dar"

const ParsingLanguagesDe ParsingLanguages = "de"

const ParsingLanguagesEn ParsingLanguages = "en"

const ParsingLanguagesEs ParsingLanguages = "es"

const ParsingLanguagesEt ParsingLanguages = "et"

const ParsingLanguagesFa ParsingLanguages = "fa"

const ParsingLanguagesFr ParsingLanguages = "fr"

const ParsingLanguagesGa ParsingLanguages = "ga"

const ParsingLanguagesGom ParsingLanguages = "gom"

const ParsingLanguagesHi ParsingLanguages = "hi"

const ParsingLanguagesHr ParsingLanguages = "hr"

const ParsingLanguagesHu ParsingLanguages = "hu"

const ParsingLanguagesID ParsingLanguages = "id"

const ParsingLanguagesInh ParsingLanguages = "inh"

const ParsingLanguagesIs ParsingLanguages = "is"

const ParsingLanguagesIt ParsingLanguages = "it"

const ParsingLanguagesJa ParsingLanguages = "ja"

const ParsingLanguagesKbd ParsingLanguages = "kbd"

const ParsingLanguagesKn ParsingLanguages = "kn"

const ParsingLanguagesKo ParsingLanguages = "ko"

const ParsingLanguagesKu ParsingLanguages = "ku"

const ParsingLanguagesLa ParsingLanguages = "la"

const ParsingLanguagesLbe ParsingLanguages = "lbe"

const ParsingLanguagesLez ParsingLanguages = "lez"

const ParsingLanguagesLt ParsingLanguages = "lt"

const ParsingLanguagesLv ParsingLanguages = "lv"

const ParsingLanguagesMah ParsingLanguages = "mah"

const ParsingLanguagesMai ParsingLanguages = "mai"

const ParsingLanguagesMi ParsingLanguages = "mi"

const ParsingLanguagesMn ParsingLanguages = "mn"

const ParsingLanguagesMni ParsingLanguages = "mni"

const ParsingLanguagesMr ParsingLanguages = "mr"

const ParsingLanguagesMs ParsingLanguages = "ms"

const ParsingLanguagesMt ParsingLanguages = "mt"

const ParsingLanguagesNe ParsingLanguages = "ne"

const ParsingLanguagesNew ParsingLanguages = "new"

const ParsingLanguagesNl ParsingLanguages = "nl"

const ParsingLanguagesNo ParsingLanguages = "no"

const ParsingLanguagesOc ParsingLanguages = "oc"

const ParsingLanguagesPi ParsingLanguages = "pi"

const ParsingLanguagesPl ParsingLanguages = "pl"

const ParsingLanguagesPt ParsingLanguages = "pt"

const ParsingLanguagesRo ParsingLanguages = "ro"

const ParsingLanguagesRsCyrillic ParsingLanguages = "rs_cyrillic"

const ParsingLanguagesRsLatin ParsingLanguages = "rs_latin"

const ParsingLanguagesRu ParsingLanguages = "ru"

const ParsingLanguagesSa ParsingLanguages = "sa"

const ParsingLanguagesSck ParsingLanguages = "sck"

const ParsingLanguagesSk ParsingLanguages = "sk"

const ParsingLanguagesSl ParsingLanguages = "sl"

const ParsingLanguagesSq ParsingLanguages = "sq"

const ParsingLanguagesSv ParsingLanguages = "sv"

const ParsingLanguagesSw ParsingLanguages = "sw"

const ParsingLanguagesTa ParsingLanguages = "ta"

const ParsingLanguagesTab ParsingLanguages = "tab"

const ParsingLanguagesTe ParsingLanguages = "te"

const ParsingLanguagesTh ParsingLanguages = "th"

const ParsingLanguagesTjk ParsingLanguages = "tjk"

const ParsingLanguagesTl ParsingLanguages = "tl"

const ParsingLanguagesTr ParsingLanguages = "tr"

const ParsingLanguagesUg ParsingLanguages = "ug"

const ParsingLanguagesUk ParsingLanguages = "uk"

const ParsingLanguagesUr ParsingLanguages = "ur"

const ParsingLanguagesUz ParsingLanguages = "uz"

const ParsingLanguagesVi ParsingLanguages = "vi"

MaxPages int64Optional

The maximum number of pages to parse

TargetPages []int64Optional

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

UpdatedAt TimeOptional

Update datetime

formatdate-time

List Classify Jobs

Go

HTTP

TypeScript

Python

Go

Java

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloud.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Classifier.Jobs.List(context.TODO(), llamacloud.ClassifierJobListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "rules": [
        {
          "description": "contains invoice number, line items, and total amount",
          "type": "invoice"
        }
      ],
      "status": "CANCELLED",
      "user_id": "user_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "effective_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "job_record_id": "job_record_id",
      "mode": "FAST",
      "parsing_configuration": {
        "lang": "abq",
        "max_pages": 0,
        "target_pages": [
          0
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "rules": [
        {
          "description": "contains invoice number, line items, and total amount",
          "type": "invoice"
        }
      ],
      "status": "CANCELLED",
      "user_id": "user_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "effective_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "job_record_id": "job_record_id",
      "mode": "FAST",
      "parsing_configuration": {
        "lang": "abq",
        "max_pages": 0,
        "target_pages": [
          0
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}