# Classify ## 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. ### Parameters - `params ClassifyNewParams` - `ClassifyCreateRequest param.Field[ClassifyCreateRequest]` Body param: Request to create a classify job. - `OrganizationID param.Field[string]` Query param - `ProjectID param.Field[string]` Query param ### Returns - `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 - `Type string` Document type to assign when rule matches - `Mode ClassifyConfigurationMode` Classify execution mode - `const ClassifyConfigurationModeFast ClassifyConfigurationMode = "FAST"` - `ParsingConfiguration ClassifyConfigurationParsingConfiguration` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` 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) - `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 - `const ClassifyNewResponseStatusPending ClassifyNewResponseStatus = "PENDING"` - `const ClassifyNewResponseStatusRunning ClassifyNewResponseStatus = "RUNNING"` - `const ClassifyNewResponseStatusCompleted ClassifyNewResponseStatus = "COMPLETED"` - `const ClassifyNewResponseStatusFailed ClassifyNewResponseStatus = "FAILED"` - `UserID string` User who created this job - `ConfigurationID string` Product configuration ID - `CreatedAt Time` Creation datetime - `ErrorMessage string` Error message if job failed - `ParseJobID string` Associated parse job ID - `Result ClassifyResult` Result of classifying a document. - `Confidence float64` Confidence score between 0.0 and 1.0 - `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 string` Idempotency key - `UpdatedAt Time` Update datetime ### Example ```go 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) } ``` #### Response ```json { "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" } ``` ## List Classify Jobs `client.Classify.List(ctx, query) (*PaginatedCursor[ClassifyListResponse], error)` **get** `/api/v2/classify` List classify jobs with optional filtering and pagination. Filter by `status`, `configuration_id`, specific `job_ids`, or creation date range. ### Parameters - `query ClassifyListParams` - `ConfigurationID param.Field[string]` Filter by configuration ID - `CreatedAtOnOrAfter param.Field[Time]` Include items created at or after this timestamp (inclusive) - `CreatedAtOnOrBefore param.Field[Time]` Include items created at or before this timestamp (inclusive) - `JobIDs param.Field[[]string]` Filter by specific job IDs - `OrganizationID param.Field[string]` - `PageSize param.Field[int64]` Number of items per page - `PageToken param.Field[string]` Token for pagination - `ProjectID param.Field[string]` - `Status param.Field[ClassifyListParamsStatus]` Filter by job status - `const ClassifyListParamsStatusPending ClassifyListParamsStatus = "PENDING"` - `const ClassifyListParamsStatusRunning ClassifyListParamsStatus = "RUNNING"` - `const ClassifyListParamsStatusCompleted ClassifyListParamsStatus = "COMPLETED"` - `const ClassifyListParamsStatusFailed ClassifyListParamsStatus = "FAILED"` ### Returns - `type ClassifyListResponse 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 - `Type string` Document type to assign when rule matches - `Mode ClassifyConfigurationMode` Classify execution mode - `const ClassifyConfigurationModeFast ClassifyConfigurationMode = "FAST"` - `ParsingConfiguration ClassifyConfigurationParsingConfiguration` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `DocumentInputType ClassifyListResponseDocumentInputType` Whether the input was a file or parse job (FILE or PARSE_JOB) - `const ClassifyListResponseDocumentInputTypeURL ClassifyListResponseDocumentInputType = "url"` - `const ClassifyListResponseDocumentInputTypeFileID ClassifyListResponseDocumentInputType = "file_id"` - `const ClassifyListResponseDocumentInputTypeParseJobID ClassifyListResponseDocumentInputType = "parse_job_id"` - `FileInput string` ID of the input file or parse job - `ProjectID string` Project this job belongs to - `Status ClassifyListResponseStatus` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `const ClassifyListResponseStatusPending ClassifyListResponseStatus = "PENDING"` - `const ClassifyListResponseStatusRunning ClassifyListResponseStatus = "RUNNING"` - `const ClassifyListResponseStatusCompleted ClassifyListResponseStatus = "COMPLETED"` - `const ClassifyListResponseStatusFailed ClassifyListResponseStatus = "FAILED"` - `UserID string` User who created this job - `ConfigurationID string` Product configuration ID - `CreatedAt Time` Creation datetime - `ErrorMessage string` Error message if job failed - `ParseJobID string` Associated parse job ID - `Result ClassifyResult` Result of classifying a document. - `Confidence float64` Confidence score between 0.0 and 1.0 - `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 string` Idempotency key - `UpdatedAt Time` Update datetime ### Example ```go 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"), ) page, err := client.Classify.List(context.TODO(), llamacloudprod.ClassifyListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "items": [ { "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" } ], "next_page_token": "next_page_token", "total_size": 0 } ``` ## Get Classify Job `client.Classify.Get(ctx, jobID, query) (*ClassifyGetResponse, error)` **get** `/api/v2/classify/{job_id}` Get a classify job by ID. Returns the job status, configuration, and classify result when complete. The result includes the matched document type, confidence score, and reasoning. ### Parameters - `jobID string` - `query ClassifyGetParams` - `OrganizationID param.Field[string]` - `ProjectID param.Field[string]` ### Returns - `type ClassifyGetResponse 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 - `Type string` Document type to assign when rule matches - `Mode ClassifyConfigurationMode` Classify execution mode - `const ClassifyConfigurationModeFast ClassifyConfigurationMode = "FAST"` - `ParsingConfiguration ClassifyConfigurationParsingConfiguration` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `DocumentInputType ClassifyGetResponseDocumentInputType` Whether the input was a file or parse job (FILE or PARSE_JOB) - `const ClassifyGetResponseDocumentInputTypeURL ClassifyGetResponseDocumentInputType = "url"` - `const ClassifyGetResponseDocumentInputTypeFileID ClassifyGetResponseDocumentInputType = "file_id"` - `const ClassifyGetResponseDocumentInputTypeParseJobID ClassifyGetResponseDocumentInputType = "parse_job_id"` - `FileInput string` ID of the input file or parse job - `ProjectID string` Project this job belongs to - `Status ClassifyGetResponseStatus` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `const ClassifyGetResponseStatusPending ClassifyGetResponseStatus = "PENDING"` - `const ClassifyGetResponseStatusRunning ClassifyGetResponseStatus = "RUNNING"` - `const ClassifyGetResponseStatusCompleted ClassifyGetResponseStatus = "COMPLETED"` - `const ClassifyGetResponseStatusFailed ClassifyGetResponseStatus = "FAILED"` - `UserID string` User who created this job - `ConfigurationID string` Product configuration ID - `CreatedAt Time` Creation datetime - `ErrorMessage string` Error message if job failed - `ParseJobID string` Associated parse job ID - `Result ClassifyResult` Result of classifying a document. - `Confidence float64` Confidence score between 0.0 and 1.0 - `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 string` Idempotency key - `UpdatedAt Time` Update datetime ### Example ```go 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.Get( context.TODO(), "job_id", llamacloudprod.ClassifyGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", classify.ID) } ``` #### Response ```json { "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" } ``` ## Domain Types ### Classify Configuration - `type ClassifyConfiguration struct{…}` Configuration for a classify job. - `Rules []ClassifyConfigurationRule` Classify rules to evaluate against the document (at least one required) - `Description string` Natural language criteria for matching this rule - `Type string` Document type to assign when rule matches - `Mode ClassifyConfigurationMode` Classify execution mode - `const ClassifyConfigurationModeFast ClassifyConfigurationMode = "FAST"` - `ParsingConfiguration ClassifyConfigurationParsingConfiguration` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. ### Classify Create Request - `type ClassifyCreateRequest struct{…}` Request to create a classify job. - `Configuration ClassifyConfiguration` Configuration for a classify job. - `Rules []ClassifyConfigurationRule` Classify rules to evaluate against the document (at least one required) - `Description string` Natural language criteria for matching this rule - `Type string` Document type to assign when rule matches - `Mode ClassifyConfigurationMode` Classify execution mode - `const ClassifyConfigurationModeFast ClassifyConfigurationMode = "FAST"` - `ParsingConfiguration ClassifyConfigurationParsingConfiguration` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `ConfigurationID string` Saved configuration ID - `FileID string` Deprecated: use file_input instead - `FileInput string` File ID or parse job ID to classify - `ParseJobID string` Deprecated: use file_input instead - `TransactionID string` Idempotency key scoped to the project ### Classify Result - `type ClassifyResult struct{…}` Result of classifying a document. - `Confidence float64` Confidence score between 0.0 and 1.0 - `Reasoning string` Why the document matched (or didn't match) the returned rule - `Type string` Matched rule type, or null if no rule matched