Package ai.extend.types

Interface ParseRunSummary._FinalStage

    • Method Detail

      • batchId

        ParseRunSummary._FinalStage batchId​(java.util.Optional<java.lang.String> batchId)

        The ID of the batch this run belongs to, if created via POST /parse_runs/batch.

        Availability: Present when the run was submitted as part of a batch.

        Example: "bpar_Xj8mK2pL9nR4vT7qY5wZ"

      • failureReason

        ParseRunSummary._FinalStage failureReason​(java.util.Optional<java.lang.String> failureReason)

        The reason for failure.

        Availability: Present when status is "FAILED".

        Possible values include:

        • UNABLE_TO_DOWNLOAD_FILE - The file could not be downloaded from the provided URL
        • FILE_TYPE_NOT_SUPPORTED - The file type is not supported for parsing
        • FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
        • CORRUPT_FILE - The file appears to be corrupted or malformed
        • OCR_ERROR - An error occurred during optical character recognition
        • PASSWORD_PROTECTED_FILE - The file is password protected and cannot be processed
        • FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
        • FAILED_TO_CONVERT_TO_JPEG - The file could not be converted to JPEG for processing
        • FAILED_TO_GENERATE_TARGET_FORMAT - The output could not be generated in the requested format
        • CHUNKING_ERROR - An error occurred while chunking the document
        • INTERNAL_ERROR - An unexpected internal error occurred
        • INVALID_CONFIG_OPTIONS - The provided configuration options are invalid
        • OUT_OF_CREDITS - Insufficient credits to process the file

        Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

      • failureMessage

        ParseRunSummary._FinalStage failureMessage​(java.util.Optional<java.lang.String> failureMessage)

        A human-readable description of the failure.

        Availability: Present when status is "FAILED".

      • metadata

        ParseRunSummary._FinalStage metadata​(java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> metadata)

        Any metadata that was provided when creating the parse run.

        Availability: Present when metadata was provided during creation.

      • usage

        ParseRunSummary._FinalStage usage​(java.util.Optional<RunUsageSummary> usage)

        Usage credits consumed by this parse run. Omits breakdown — fetch the full parse run by id to see the per-line items.

        Availability: Present when status is "PROCESSED", the run was created after October 7, 2025, and the customer is on the current billing system.