Convert Types

Python SDK - Convert type definitions

Types for document conversion operations.

ConversionResult

Result of a synchronous document conversion.

Fields:

  • data: dict[str, Any] - Extracted data according to the document type JSON schema.

  • model_config: Any

ConversionStatus

Status of an asynchronous document conversion.

Fields:

  • conversion_id: str - Unique conversion ID.

  • data: dict[str, Any] | None - Extracted data (only present when status is SUCCESS).

  • document_type_code: str | None - Document type code used for conversion.

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

  • model_config: Any

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

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

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

  • status: ConversionStatusType - Current conversion status.

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

On this page