Get Classify Job

GET/api/v2/classify/{job_id}

Retrieve classify job by ID.

Path ParametersExpand Collapse

job_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

id: string

Unique identifier

configuration: ClassifyConfiguration { rules, mode }

Classification configuration

rules: array of object { description, type }

Classification rules to apply (at least one required)

description: string

Natural language description of what to classify

maxLength500

minLength10

type: string

Document type to assign when rule matches

maxLength50

minLength1

mode: optional "FAST"

Classification execution mode

document_input_type: "url" or "file_id" or "parse_job_id"

Type of document input

Accepts one of the following:

"url"

"file_id"

"parse_job_id"

document_input_value: string

Document identifier

project_id: string

Project ID

status: "PENDING" or "RUNNING" or "COMPLETED" or "FAILED"

Job status

Accepts one of the following:

"PENDING"

"RUNNING"

"COMPLETED"

"FAILED"

user_id: string

User ID

configuration_id: optional string

Product configuration ID

created_at: optional string

Creation datetime

formatdate-time

error_message: optional string

Error message if job failed

parse_job_id: optional string

Associated parse job ID

result: optional ClassifyResult { confidence, reasoning, type }

Result of classifying a document.

confidence: number

Confidence score (0.0-1.0)

maximum1

minimum0

reasoning: string

Explanation of classification decision

type: string

Document type that matches, or None

transaction_id: optional string

Idempotency key

updated_at: optional string

Update datetime

formatdate-time

Get Classify Job

curl https://api.cloud.llamaindex.ai/api/v2/classify/$JOB_ID \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

{
  "id": "id",
  "configuration": {
    "rules": [
      {
        "description": "contains invoice number, line items, and total amount",
        "type": "invoice"
      }
    ],
    "mode": "FAST"
  },
  "document_input_type": "url",
  "document_input_value": "document_input_value",
  "project_id": "project_id",
  "status": "PENDING",
  "user_id": "user_id",
  "configuration_id": "configuration_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "parse_job_id": "parse_job_id",
  "result": {
    "confidence": 0,
    "reasoning": "reasoning",
    "type": "type"
  },
  "transaction_id": "transaction_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "configuration": {
    "rules": [
      {
        "description": "contains invoice number, line items, and total amount",
        "type": "invoice"
      }
    ],
    "mode": "FAST"
  },
  "document_input_type": "url",
  "document_input_value": "document_input_value",
  "project_id": "project_id",
  "status": "PENDING",
  "user_id": "user_id",
  "configuration_id": "configuration_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "parse_job_id": "parse_job_id",
  "result": {
    "confidence": 0,
    "reasoning": "reasoning",
    "type": "type"
  },
  "transaction_id": "transaction_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}