# Classify ## Create Classify Job `classify.create(ClassifyCreateParams**kwargs) -> ClassifyCreateResponse` **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 - `organization_id: Optional[str]` - `project_id: Optional[str]` - `configuration: Optional[ClassifyConfigurationParam]` Configuration for a classify job. - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `configuration_id: Optional[str]` Saved configuration ID - `file_id: Optional[str]` Deprecated: use file_input instead - `file_input: Optional[str]` File ID or parse job ID to classify - `parse_job_id: Optional[str]` Deprecated: use file_input instead - `transaction_id: Optional[str]` Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored. - `webhook_configurations: Optional[Iterable[WebhookConfiguration]]` Outbound webhook endpoints to notify on job status changes - `webhook_events: Optional[List[Literal["classify.cancelled", "classify.error", "classify.partial_success", 25 more]]]` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers: Optional[Dict[str, str]]` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format: Optional[str]` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret: Optional[str]` Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the 'LC-Signature' header (value 'sha256='). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic. - `webhook_url: Optional[str]` URL to receive webhook POST notifications ### Returns - `class ClassifyCreateResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime ### Example ```python import os from llama_cloud import LlamaCloud client = LlamaCloud( api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted ) classify = client.classify.create() print(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": "file_id", "file_input": "file_input", "project_id": "project_id", "status": "COMPLETED", "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 `classify.list(ClassifyListParams**kwargs) -> SyncPaginatedCursor[ClassifyListResponse]` **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 - `configuration_id: Optional[str]` Filter by configuration ID - `created_at_on_or_after: Optional[Union[str, datetime, null]]` Include items created at or after this timestamp (inclusive) - `created_at_on_or_before: Optional[Union[str, datetime, null]]` Include items created at or before this timestamp (inclusive) - `job_ids: Optional[Sequence[str]]` Filter by specific job IDs - `organization_id: Optional[str]` - `page_size: Optional[int]` Number of items per page - `page_token: Optional[str]` Token for pagination - `project_id: Optional[str]` - `status: Optional[Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]]` Filter by job status - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` ### Returns - `class ClassifyListResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime ### Example ```python import os from llama_cloud import LlamaCloud client = LlamaCloud( api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted ) page = client.classify.list() page = page.items[0] print(page.id) ``` #### 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": "file_id", "file_input": "file_input", "project_id": "project_id", "status": "COMPLETED", "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 `classify.get(strjob_id, ClassifyGetParams**kwargs) -> ClassifyGetResponse` **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 - `job_id: str` - `organization_id: Optional[str]` - `project_id: Optional[str]` ### Returns - `class ClassifyGetResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime ### Example ```python import os from llama_cloud import LlamaCloud client = LlamaCloud( api_key=os.environ.get("LLAMA_CLOUD_API_KEY"), # This is the default and can be omitted ) classify = client.classify.get( job_id="job_id", ) print(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": "file_id", "file_input": "file_input", "project_id": "project_id", "status": "COMPLETED", "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 - `class ClassifyConfiguration: …` Configuration for a classify job. - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. ### Classify Create Request - `class ClassifyCreateRequest: …` Request to create a classify job. - `configuration: Optional[ClassifyConfiguration]` Configuration for a classify job. - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `configuration_id: Optional[str]` Saved configuration ID - `file_id: Optional[str]` Deprecated: use file_input instead - `file_input: Optional[str]` File ID or parse job ID to classify - `parse_job_id: Optional[str]` Deprecated: use file_input instead - `transaction_id: Optional[str]` Idempotency key scoped to the project. Reusing a key returns the original job; the new request body is ignored. - `webhook_configurations: Optional[List[WebhookConfiguration]]` Outbound webhook endpoints to notify on job status changes - `webhook_events: Optional[List[Literal["classify.cancelled", "classify.error", "classify.partial_success", 25 more]]]` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `"classify.cancelled"` - `"classify.error"` - `"classify.partial_success"` - `"classify.pending"` - `"classify.running"` - `"classify.success"` - `"extract.cancelled"` - `"extract.error"` - `"extract.partial_success"` - `"extract.pending"` - `"extract.success"` - `"parse.cancelled"` - `"parse.error"` - `"parse.partial_success"` - `"parse.pending"` - `"parse.running"` - `"parse.success"` - `"sheets.cancelled"` - `"sheets.error"` - `"sheets.partial_success"` - `"sheets.pending"` - `"sheets.success"` - `"split.cancelled"` - `"split.error"` - `"split.pending"` - `"split.processing"` - `"split.success"` - `"unmapped_event"` - `webhook_headers: Optional[Dict[str, str]]` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `webhook_output_format: Optional[str]` Response format sent to the webhook: 'string' (default) or 'json' - `webhook_signing_secret: Optional[str]` Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the 'LC-Signature' header (value 'sha256='). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic. - `webhook_url: Optional[str]` URL to receive webhook POST notifications ### Classify Result - `class ClassifyResult: …` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched ### Classify Create Response - `class ClassifyCreateResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime ### Classify List Response - `class ClassifyListResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime ### Classify Get Response - `class ClassifyGetResponse: …` Response for a classify job. - `id: str` Unique identifier - `configuration: ClassifyConfiguration` Classify configuration used for this job - `rules: List[Rule]` Classify rules to evaluate against the document (at least one required) - `description: str` Natural language criteria for matching this rule - `type: str` Document type to assign when rule matches - `mode: Optional[Literal["FAST"]]` Classify execution mode - `"FAST"` - `parsing_configuration: Optional[ParsingConfiguration]` Parsing configuration for classify jobs. - `lang: Optional[str]` ISO 639-1 language code for the document - `max_pages: Optional[int]` Maximum number of pages to process. Omit for no limit. - `target_pages: Optional[str]` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `document_input_type: Literal["file_id", "parse_job_id", "url"]` Whether the input was a file or parse job (FILE or PARSE_JOB) - `"file_id"` - `"parse_job_id"` - `"url"` - `file_input: str` ID of the input file or parse job - `project_id: str` Project this job belongs to - `status: Literal["COMPLETED", "FAILED", "PENDING", "RUNNING"]` Current job status: PENDING, RUNNING, COMPLETED, or FAILED - `"COMPLETED"` - `"FAILED"` - `"PENDING"` - `"RUNNING"` - `user_id: str` User who created this job - `configuration_id: Optional[str]` Product configuration ID - `created_at: Optional[datetime]` Creation datetime - `error_message: Optional[str]` Error message if job failed - `parse_job_id: Optional[str]` Associated parse job ID - `result: Optional[ClassifyResult]` Result of classifying a document. - `confidence: float` Confidence score between 0.0 and 1.0 - `reasoning: str` Why the document matched (or didn't match) the returned rule - `type: Optional[str]` Matched rule type, or null if no rule matched - `transaction_id: Optional[str]` Idempotency key - `updated_at: Optional[datetime]` Update datetime