Package ai.extend.types

Class ParseRun

  • public final class ParseRun
extends java.lang.Object

    • Method Detail

      • getObject

        public java.lang.String getObject()
        Returns:
        The type of object. Will always be "parse_run".

      • getId

        public java.lang.String getId()
        Returns:
        A unique identifier for the parse run.

        Example: "pr_xK9mLPqRtN3vS8wF5hB2cQ"

      • getBatchId

        public java.util.Optional<java.lang.String> getBatchId()
        Returns:
        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"

      • getFile

        public FileSummary getFile()
        Returns:
        The file that was parsed. This file can be used as a parameter for other Extend endpoints, such as POST /workflow_runs. May be null for batch parse runs where file ingestion failed.

      • getStatus

        public ParseRunStatusEnum getStatus()
        Returns:
        The status of the parse run:
        • "PENDING" - The run has been created and is waiting to be processed. Only applies to runs created via POST /parse_runs/batch.
        • "PROCESSING" - The file is still being processed
        • "PROCESSED" - The file was successfully processed
        • "FAILED" - The processing failed (see failureReason for details)

      • getFailureReason

        public java.util.Optional<java.lang.String> getFailureReason()
        Returns:
        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.

      • getFailureMessage

        public java.util.Optional<java.lang.String> getFailureMessage()
        Returns:
        A human-readable description of the failure.

        Availability: Present when status is "FAILED".

      • getOutput

        public java.util.Optional<ParseRunOutput> getOutput()
        Returns:
        The parse run output.

        Availability: Present when status is "PROCESSED" and the request was made without the responseType=url query parameter. Contains the parsed chunks.

      • getOutputUrl

        public java.util.Optional<java.lang.String> getOutputUrl()
        Returns:
        A presigned URL to download the parse run output as a JSON file. The object shape is the same as the output field. Expires after 15 minutes.

        Availability: Present when status is "PROCESSED" and the request was made with responseType=url query parameter.

      • getMetrics

        public java.util.Optional<ParseRunMetrics> getMetrics()
        Returns:
        Metrics about the parsing process.

        Availability: Present when status is "PROCESSED".

      • getConfig

        public ParseConfig getConfig()
        Returns:
        The configuration used for the parsing process, including any default values that were applied.

      • getUsage

        public java.util.Optional<RunUsage> getUsage()
        Returns:
        Usage credits consumed by this run.

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

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object