Create Classify Job

client.Classify.New(ctx, params) (*ClassifyNewResponse, error)

POST/api/v2/classify

Create a classify job.

Classifies a document against a set of rules. Set file_input to a file ID (dfl-...) or parse job ID (pjb-...), and provide either inline configuration with rules or a configuration_id referencing a saved preset.

Each rule has a type (the label to assign) and a description (natural language criteria). The classifier returns the best matching rule with a confidence score.

The job runs asynchronously. Poll GET /classify/{job_id} to check status and retrieve results.

ParametersExpand Collapse

params ClassifyNewParams

ClassifyCreateRequest param.Field[ClassifyCreateRequest]

Body param: Request to create a classify job.

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

ReturnsExpand Collapse

type ClassifyNewResponse struct{…}

Response for a classify job.

ID string

Unique identifier

Configuration ClassifyConfiguration

Classify configuration used for this job

Rules []ClassifyConfigurationRule

Classify rules to evaluate against the document (at least one required)

Description string

Natural language criteria for matching this rule

maxLength500

minLength10

Type string

Document type to assign when rule matches

maxLength50

minLength1

Mode ClassifyConfigurationModeoptional

Classify execution mode

ParsingConfiguration ClassifyConfigurationParsingConfigurationoptional

Parsing configuration for classify jobs.

Lang stringoptional

ISO 639-1 language code for the document

MaxPages int64optional

Maximum number of pages to process. Omit for no limit.

minimum1

TargetPages stringoptional

Comma-separated page numbers or ranges to process (1-based). Omit to process all pages.

DocumentInputType ClassifyNewResponseDocumentInputType

Whether the input was a file or parse job (FILE or PARSE_JOB)

One of the following:

const ClassifyNewResponseDocumentInputTypeURL ClassifyNewResponseDocumentInputType = "url"

const ClassifyNewResponseDocumentInputTypeFileID ClassifyNewResponseDocumentInputType = "file_id"

const ClassifyNewResponseDocumentInputTypeParseJobID ClassifyNewResponseDocumentInputType = "parse_job_id"

FileInput string

ID of the input file or parse job

ProjectID string

Project this job belongs to

Status ClassifyNewResponseStatus

Current job status: PENDING, RUNNING, COMPLETED, or FAILED

One of the following:

const ClassifyNewResponseStatusPending ClassifyNewResponseStatus = "PENDING"

const ClassifyNewResponseStatusRunning ClassifyNewResponseStatus = "RUNNING"

const ClassifyNewResponseStatusCompleted ClassifyNewResponseStatus = "COMPLETED"

const ClassifyNewResponseStatusFailed ClassifyNewResponseStatus = "FAILED"

UserID string

User who created this job

ConfigurationID stringoptional

Product configuration ID

CreatedAt Timeoptional

Creation datetime

formatdate-time

ErrorMessage stringoptional

Error message if job failed

ParseJobID stringoptional

Associated parse job ID

Result ClassifyResultoptional

Result of classifying a document.

Confidence float64

Confidence score between 0.0 and 1.0

maximum1

minimum0

Reasoning string

Why the document matched (or didn’t match) the returned rule

Type string

Matched rule type, or null if no rule matched

TransactionID stringoptional

Idempotency key

UpdatedAt Timeoptional

Update datetime

formatdate-time

Create Classify Job

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  classify, err := client.Classify.New(context.TODO(), llamacloudprod.ClassifyNewParams{
    ClassifyCreateRequest: llamacloudprod.ClassifyCreateRequestParam{

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

{
  "id": "id",
  "configuration": {
    "rules": [
      {
        "description": "contains invoice number, line items, and total amount",
        "type": "invoice"
      }
    ],
    "mode": "FAST",
    "parsing_configuration": {
      "lang": "en",
      "max_pages": 10,
      "target_pages": "1,3,5-7"
    }
  },
  "document_input_type": "url",
  "file_input": "file_input",
  "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",
    "parsing_configuration": {
      "lang": "en",
      "max_pages": 10,
      "target_pages": "1,3,5-7"
    }
  },
  "document_input_type": "url",
  "file_input": "file_input",
  "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"
}