Package ai.extend.types

Interface EditRun._FinalStage

  • All Known Implementing Classes:
    EditRun.Builder
    Enclosing class:
    EditRun
    public static interface EditRun._FinalStage

    • Method Detail

      • failureReason

        EditRun._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 - Failed to load the requested file
        • FILE_TYPE_NOT_SUPPORTED - File type not supported. Edit runs currently require a PDF
        • FILE_SIZE_TOO_LARGE - The file exceeds the maximum allowed size
        • CORRUPT_FILE - The file appears to be corrupted and cannot be edited
        • FIELD_DETECTION_ERROR - An error occurred during field detection
        • PASSWORD_PROTECTED_FILE - The file is password protected and cannot be edited
        • FAILED_TO_CONVERT_TO_PDF - The file could not be converted to PDF for processing
        • INTERNAL_ERROR - An unexpected internal error occurred
        • INVALID_OPTIONS - The provided configuration options are invalid
        • EMPTY_SCHEMA - No schema was provided and no fields could be detected
        • OUT_OF_CREDITS - Insufficient credits to process the file
        • SCHEMA_VALIDATION_ERROR - The generated output value failed validation against the edit schema

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

      • failureMessage

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

        A human-readable description of the failure.

        Availability: Present when status is "FAILED".

      • output

        EditRun._FinalStage output​(java.util.Optional<EditRunOutput> output)

        The output of the edit run.

        Availability: Present when status is "PROCESSED".

      • metrics

        EditRun._FinalStage metrics​(java.util.Optional<EditRunMetrics> metrics)

        Metrics about the editing process.

        Availability: Present when status is "PROCESSED".

      • usage

        EditRun._FinalStage usage​(java.util.Optional<RunUsage> usage)

        Usage credits consumed by this edit run.

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