Package ai.extend.types

Class SplitRun.Builder

    • Method Detail

      • id

        public SplitRun.StatusStage id​(@NotNull
                               java.lang.String id)

        The unique identifier for this split run.

        Example: "splr_Xj8mK2pL9nR4vT7qY5wZ"

        The unique identifier for this split run.

        Example: "splr_Xj8mK2pL9nR4vT7qY5wZ"

        Specified by:
        id in interface SplitRun.IdStage
        Returns:
        Reference to this so that method calls can be chained together.

      • reviewed

        public SplitRun.EditedStage reviewed​(boolean reviewed)

        Indicates whether the run has been reviewed by a human.

        Indicates whether the run has been reviewed by a human.

        Specified by:
        reviewed in interface SplitRun.ReviewedStage
        Returns:
        Reference to this so that method calls can be chained together.

      • edited

        public SplitRun.ConfigStage edited​(boolean edited)

        Indicates whether the run results have been edited during review.

        Indicates whether the run results have been edited during review.

        Specified by:
        edited in interface SplitRun.EditedStage
        Returns:
        Reference to this so that method calls can be chained together.

      • config

        public SplitRun.FileStage config​(@NotNull
                                 SplitConfig config)

        The configuration used for this split run.

        The configuration used for this split run.

        Specified by:
        config in interface SplitRun.ConfigStage
        Returns:
        Reference to this so that method calls can be chained together.

      • dashboardUrl

        public SplitRun.CreatedAtStage dashboardUrl​(@NotNull
                                            java.lang.String dashboardUrl)

        The URL to view the split run in the Extend dashboard.

        The URL to view the split run in the Extend dashboard.

        Specified by:
        dashboardUrl in interface SplitRun.DashboardUrlStage
        Returns:
        Reference to this so that method calls can be chained together.

      • usage

        public SplitRun._FinalStage usage​(Nullable<RunUsage> usage)

        Usage credits consumed by this split run.

        Availability: Present when status is "PROCESSED". Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

        Specified by:
        usage in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • usage

        public SplitRun._FinalStage usage​(RunUsage usage)

        Usage credits consumed by this split run.

        Availability: Present when status is "PROCESSED". Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

        Specified by:
        usage in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • usage

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

        Usage credits consumed by this split run.

        Availability: Present when status is "PROCESSED". Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

        Specified by:
        usage in interface SplitRun._FinalStage

      • parseRunId

        public SplitRun._FinalStage parseRunId​(Nullable<java.lang.String> parseRunId)

        The ID of the parse run that was used for this split run.

        Availability: Present when a parse run was created.

        Specified by:
        parseRunId in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • parseRunId

        public SplitRun._FinalStage parseRunId​(java.lang.String parseRunId)

        The ID of the parse run that was used for this split run.

        Availability: Present when a parse run was created.

        Specified by:
        parseRunId in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • parseRunId

        public SplitRun._FinalStage parseRunId​(java.util.Optional<java.lang.String> parseRunId)

        The ID of the parse run that was used for this split run.

        Availability: Present when a parse run was created.

        Specified by:
        parseRunId in interface SplitRun._FinalStage

      • metadata

        public SplitRun._FinalStage metadata​(Nullable<java.util.Map<java.lang.String,​java.lang.Object>> metadata)

        Any metadata that was provided when creating the split run.

        Availability: Present when metadata was provided during creation.

        Specified by:
        metadata in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • metadata

        public SplitRun._FinalStage metadata​(java.util.Map<java.lang.String,​java.lang.Object> metadata)

        Any metadata that was provided when creating the split run.

        Availability: Present when metadata was provided during creation.

        Specified by:
        metadata in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • metadata

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

        Any metadata that was provided when creating the split run.

        Availability: Present when metadata was provided during creation.

        Specified by:
        metadata in interface SplitRun._FinalStage

      • failureMessage

        public SplitRun._FinalStage failureMessage​(Nullable<java.lang.String> failureMessage)

        A detailed message about the failure.

        Availability: Present when status is "FAILED".

        Specified by:
        failureMessage in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • failureMessage

        public SplitRun._FinalStage failureMessage​(java.lang.String failureMessage)

        A detailed message about the failure.

        Availability: Present when status is "FAILED".

        Specified by:
        failureMessage in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • failureReason

        public SplitRun._FinalStage failureReason​(Nullable<java.lang.String> failureReason)

        The reason for failure.

        Availability: Present when status is "FAILED".

        Possible values include:

        • ABORTED - The run was aborted by the user
        • INTERNAL_ERROR - An unexpected internal error occurred
        • FAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)
        • INVALID_PROCESSOR - The processor configuration is invalid
        • INVALID_CONFIGURATION - The provided configuration is incompatible with the selected model
        • PARSING_ERROR - Failed to parse the splitting output
        • PRE_PROCESSING_FAILURE - An error occurred during preprocessing
        • POST_PROCESSING_FAILURE - An error occurred during postprocessing
        • OUT_OF_CREDITS - Insufficient credits to run the splitter

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

        Specified by:
        failureReason in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • failureReason

        public SplitRun._FinalStage failureReason​(java.lang.String failureReason)

        The reason for failure.

        Availability: Present when status is "FAILED".

        Possible values include:

        • ABORTED - The run was aborted by the user
        • INTERNAL_ERROR - An unexpected internal error occurred
        • FAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)
        • INVALID_PROCESSOR - The processor configuration is invalid
        • INVALID_CONFIGURATION - The provided configuration is incompatible with the selected model
        • PARSING_ERROR - Failed to parse the splitting output
        • PRE_PROCESSING_FAILURE - An error occurred during preprocessing
        • POST_PROCESSING_FAILURE - An error occurred during postprocessing
        • OUT_OF_CREDITS - Insufficient credits to run the splitter

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

        Specified by:
        failureReason in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • failureReason

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

        The reason for failure.

        Availability: Present when status is "FAILED".

        Possible values include:

        • ABORTED - The run was aborted by the user
        • INTERNAL_ERROR - An unexpected internal error occurred
        • FAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)
        • INVALID_PROCESSOR - The processor configuration is invalid
        • INVALID_CONFIGURATION - The provided configuration is incompatible with the selected model
        • PARSING_ERROR - Failed to parse the splitting output
        • PRE_PROCESSING_FAILURE - An error occurred during preprocessing
        • POST_PROCESSING_FAILURE - An error occurred during postprocessing
        • OUT_OF_CREDITS - Insufficient credits to run the splitter

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

        Specified by:
        failureReason in interface SplitRun._FinalStage

      • initialOutput

        public SplitRun._FinalStage initialOutput​(SplitOutput initialOutput)

        The initial output from the split run, before any review edits.

        Availability: Present when reviewed is true.

        Specified by:
        initialOutput in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • splitterVersion

        public SplitRun._FinalStage splitterVersion​(SplitterVersionSummary splitterVersion)

        The version of the splitter that was used for this run.

        Availability: Present when a splitter reference was provided. Not present when using inline config.

        Specified by:
        splitterVersion in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • splitter

        public SplitRun._FinalStage splitter​(Nullable<SplitterSummary> splitter)

        The splitter that was used for this run.

        Availability: Present when a splitter reference was provided. Not present when using inline config.

        Specified by:
        splitter in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • splitter

        public SplitRun._FinalStage splitter​(SplitterSummary splitter)

        The splitter that was used for this run.

        Availability: Present when a splitter reference was provided. Not present when using inline config.

        Specified by:
        splitter in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.

      • output

        public SplitRun._FinalStage output​(SplitOutput output)

        The final output, either reviewed or initial.

        Availability: Present when status is "PROCESSED".

        Specified by:
        output in interface SplitRun._FinalStage
        Returns:
        Reference to this so that method calls can be chained together.