Package ai.extend.types

Interface ExtractRun._FinalStage

All Known Implementing Classes:

ExtractRun.Builder

Enclosing class:

ExtractRun

public static interface ExtractRun._FinalStage

Method Summary

Modifier and Type	Method	Description
ExtractRun	build()
ExtractRun._FinalStage	edits(Nullable<java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>>> edits)
ExtractRun._FinalStage	edits(java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>> edits)
ExtractRun._FinalStage	edits(java.util.Optional<java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>>> edits)	Details of edits made during review.
ExtractRun._FinalStage	extractor(Nullable<ExtractorSummary> extractor)
ExtractRun._FinalStage	extractor(ExtractorSummary extractor)
ExtractRun._FinalStage	extractor(java.util.Optional<ExtractorSummary> extractor)	The extractor that was used for this run.
ExtractRun._FinalStage	extractorVersion(Nullable<ExtractorVersionSummary> extractorVersion)
ExtractRun._FinalStage	extractorVersion(ExtractorVersionSummary extractorVersion)
ExtractRun._FinalStage	extractorVersion(java.util.Optional<ExtractorVersionSummary> extractorVersion)	The version of the extractor that was used for this run.
ExtractRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)
ExtractRun._FinalStage	failureMessage(java.lang.String failureMessage)
ExtractRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
ExtractRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)
ExtractRun._FinalStage	failureReason(java.lang.String failureReason)
ExtractRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
ExtractRun._FinalStage	file(Nullable<FileSummary> file)
ExtractRun._FinalStage	file(FileSummary file)
ExtractRun._FinalStage	file(java.util.Optional<FileSummary> file)	The file that was processed.
ExtractRun._FinalStage	initialOutput(Nullable<ExtractOutput> initialOutput)
ExtractRun._FinalStage	initialOutput(ExtractOutput initialOutput)
ExtractRun._FinalStage	initialOutput(java.util.Optional<ExtractOutput> initialOutput)	The initial output from the extract run, before any review edits.
ExtractRun._FinalStage	metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)
ExtractRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
ExtractRun._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the extract run.
ExtractRun._FinalStage	output(Nullable<ExtractOutput> output)
ExtractRun._FinalStage	output(ExtractOutput output)
ExtractRun._FinalStage	output(java.util.Optional<ExtractOutput> output)	The final output, either reviewed or initial.
ExtractRun._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)
ExtractRun._FinalStage	parseRunId(java.lang.String parseRunId)
ExtractRun._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRun._FinalStage	reviewedOutput(Nullable<ExtractOutput> reviewedOutput)
ExtractRun._FinalStage	reviewedOutput(ExtractOutput reviewedOutput)
ExtractRun._FinalStage	reviewedOutput(java.util.Optional<ExtractOutput> reviewedOutput)	The output after human review.
ExtractRun._FinalStage	usage(Nullable<RunUsage> usage)
ExtractRun._FinalStage	usage(RunUsage usage)
ExtractRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this extract run.

Method Detail

build

ExtractRun build()

output

ExtractRun._FinalStage output(java.util.Optional<ExtractOutput> output)

The final output, either reviewed or initial. This is a union of two possible shapes:

• JSON Schema output: The current output format, returned for runs created with a JSON Schema config.
• Legacy output: A legacy output format from a previous API version. This shape is only returned for runs that were originally created with a legacy config.

Availability: Present when status is "PROCESSED".

output

ExtractRun._FinalStage output(ExtractOutput output)

output

ExtractRun._FinalStage output(Nullable<ExtractOutput> output)

initialOutput

ExtractRun._FinalStage initialOutput(java.util.Optional<ExtractOutput> initialOutput)

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

Availability: Present when reviewed is true.

initialOutput

ExtractRun._FinalStage initialOutput(ExtractOutput initialOutput)

initialOutput

ExtractRun._FinalStage initialOutput(Nullable<ExtractOutput> initialOutput)

reviewedOutput

ExtractRun._FinalStage reviewedOutput(java.util.Optional<ExtractOutput> reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

reviewedOutput

ExtractRun._FinalStage reviewedOutput(ExtractOutput reviewedOutput)

reviewedOutput

ExtractRun._FinalStage reviewedOutput(Nullable<ExtractOutput> reviewedOutput)

failureReason

ExtractRun._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 extraction output
• PRE_PROCESSING_FAILURE - An error occurred during preprocessing (e.g., chunking)
• POST_PROCESSING_FAILURE - An error occurred during postprocessing
• OUT_OF_CREDITS - Insufficient credits to run the extraction

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

failureReason

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

failureReason

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

failureMessage

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

failureMessage

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

metadata

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

Any metadata that was provided when creating the extract run.

Availability: Present when metadata was provided during creation.

metadata

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

metadata

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

edits

ExtractRun._FinalStage edits(java.util.Optional<java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>>> edits)

Details of edits made during review.

Availability: Present when edited is true.

edits

ExtractRun._FinalStage edits(java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>> edits)

edits

ExtractRun._FinalStage edits(Nullable<java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>>> edits)

extractor

ExtractRun._FinalStage extractor(java.util.Optional<ExtractorSummary> extractor)

The extractor that was used for this run.

Availability: Present when an extractor reference was provided. Not present when using inline config.

extractor

ExtractRun._FinalStage extractor(ExtractorSummary extractor)

extractor

ExtractRun._FinalStage extractor(Nullable<ExtractorSummary> extractor)

extractorVersion

ExtractRun._FinalStage extractorVersion(java.util.Optional<ExtractorVersionSummary> extractorVersion)

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

Availability: Present when an extractor reference was provided. Not present when using inline config.

extractorVersion

ExtractRun._FinalStage extractorVersion(ExtractorVersionSummary extractorVersion)

extractorVersion

ExtractRun._FinalStage extractorVersion(Nullable<ExtractorVersionSummary> extractorVersion)

file

ExtractRun._FinalStage file(java.util.Optional<FileSummary> file)

The file that was processed. null when the file could not be accessed or processed (for example a run that failed during file ingestion, or a multi-file batch run).

file

ExtractRun._FinalStage file(FileSummary file)

file

ExtractRun._FinalStage file(Nullable<FileSummary> file)

parseRunId

ExtractRun._FinalStage parseRunId(java.util.Optional<java.lang.String> parseRunId)

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

Availability: Present when a parse run was created.

parseRunId

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

parseRunId

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

usage

ExtractRun._FinalStage usage(java.util.Optional<RunUsage> usage)

Usage credits consumed by this extract 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

ExtractRun._FinalStage usage(RunUsage usage)

usage

ExtractRun._FinalStage usage(Nullable<RunUsage> usage)