Package ai.extend.types

Interface SplitRun._FinalStage

All Known Implementing Classes:

SplitRun.Builder

Enclosing class:

SplitRun

public static interface SplitRun._FinalStage

Method Summary

Modifier and Type	Method	Description
SplitRun	build()
SplitRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)
SplitRun._FinalStage	failureMessage(java.lang.String failureMessage)
SplitRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
SplitRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)
SplitRun._FinalStage	failureReason(java.lang.String failureReason)
SplitRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
SplitRun._FinalStage	initialOutput(Nullable<SplitOutput> initialOutput)
SplitRun._FinalStage	initialOutput(SplitOutput initialOutput)
SplitRun._FinalStage	initialOutput(java.util.Optional<SplitOutput> initialOutput)	The initial output from the split run, before any review edits.
SplitRun._FinalStage	metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)
SplitRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
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.
SplitRun._FinalStage	output(Nullable<SplitOutput> output)
SplitRun._FinalStage	output(SplitOutput output)
SplitRun._FinalStage	output(java.util.Optional<SplitOutput> output)	The final output, either reviewed or initial.
SplitRun._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)
SplitRun._FinalStage	parseRunId(java.lang.String parseRunId)
SplitRun._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this split run.
SplitRun._FinalStage	reviewedOutput(Nullable<SplitOutput> reviewedOutput)
SplitRun._FinalStage	reviewedOutput(SplitOutput reviewedOutput)
SplitRun._FinalStage	reviewedOutput(java.util.Optional<SplitOutput> reviewedOutput)	The output after human review.
SplitRun._FinalStage	splitter(Nullable<SplitterSummary> splitter)
SplitRun._FinalStage	splitter(SplitterSummary splitter)
SplitRun._FinalStage	splitter(java.util.Optional<SplitterSummary> splitter)	The splitter that was used for this run.
SplitRun._FinalStage	splitterVersion(Nullable<SplitterVersionSummary> splitterVersion)
SplitRun._FinalStage	splitterVersion(SplitterVersionSummary splitterVersion)
SplitRun._FinalStage	splitterVersion(java.util.Optional<SplitterVersionSummary> splitterVersion)	The version of the splitter that was used for this run.
SplitRun._FinalStage	usage(Nullable<RunUsage> usage)
SplitRun._FinalStage	usage(RunUsage usage)
SplitRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this split run.

Method Detail

build

SplitRun build()

splitter

SplitRun._FinalStage splitter(java.util.Optional<SplitterSummary> splitter)

The splitter that was used for this run.

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

splitter

SplitRun._FinalStage splitter(SplitterSummary splitter)

splitter

SplitRun._FinalStage splitter(Nullable<SplitterSummary> splitter)

splitterVersion

SplitRun._FinalStage splitterVersion(java.util.Optional<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.

splitterVersion

SplitRun._FinalStage splitterVersion(SplitterVersionSummary splitterVersion)

splitterVersion

SplitRun._FinalStage splitterVersion(Nullable<SplitterVersionSummary> splitterVersion)

output

SplitRun._FinalStage output(java.util.Optional<SplitOutput> output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

output

SplitRun._FinalStage output(SplitOutput output)

output

SplitRun._FinalStage output(Nullable<SplitOutput> output)

initialOutput

SplitRun._FinalStage initialOutput(java.util.Optional<SplitOutput> initialOutput)

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

Availability: Present when reviewed is true.

initialOutput

SplitRun._FinalStage initialOutput(SplitOutput initialOutput)

initialOutput

SplitRun._FinalStage initialOutput(Nullable<SplitOutput> initialOutput)

reviewedOutput

SplitRun._FinalStage reviewedOutput(java.util.Optional<SplitOutput> reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

reviewedOutput

SplitRun._FinalStage reviewedOutput(SplitOutput reviewedOutput)

reviewedOutput

SplitRun._FinalStage reviewedOutput(Nullable<SplitOutput> reviewedOutput)

failureReason

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.

failureReason

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

failureReason

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

failureMessage

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

failureMessage

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

metadata

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.

metadata

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

metadata

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

parseRunId

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.

parseRunId

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

parseRunId

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

usage

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.

usage

SplitRun._FinalStage usage(RunUsage usage)

usage

SplitRun._FinalStage usage(Nullable<RunUsage> usage)