Identify Types

Types for document identification operations.

DocumentTypeMatch

A matched document type with confidence score.

Fields:

• code: str - Document type code.

• confidence: float - Confidence score (0-1).

• model_config: Any

• name: str - Document type name.

IdentificationResult

Result of a synchronous document identification.

Fields:

• alternatives: list[DocumentTypeMatch] - Alternative document types with their confidence levels.

• document_type: DocumentTypeMatch - Primary identified document type.

• model_config: Any

IdentificationStatus

Status of an asynchronous document identification.

Fields:

• alternatives: list[DocumentTypeMatch] | None - Alternative document types (only present when status is SUCCESS).

• document_type: DocumentTypeMatch | None - Primary identified document type (only present when status is SUCCESS).

• error: str | None - Error message (only present when status is ERROR).

• identification_id: str - Unique identification ID.

• model_config: Any

• original_filename: str | None - Original filename of the processed file.

• request_timestamp: datetime | None - Timestamp when identification was started.

• response_timestamp: datetime | None - Timestamp when identification was completed (only for SUCCESS/ERROR).

• status: IdentificationStatusType - Current identification status.

• status_url: str | None - URL to check identification status.