Package ai.extend.types

Class ExtractRun.Builder

java.lang.Object

ai.extend.types.ExtractRun.Builder

All Implemented Interfaces:

ExtractRun._FinalStage, ExtractRun.ConfigStage, ExtractRun.CreatedAtStage, ExtractRun.DashboardUrlStage, ExtractRun.EditedStage, ExtractRun.FileStage, ExtractRun.IdStage, ExtractRun.ReviewedStage, ExtractRun.StatusStage, ExtractRun.UpdatedAtStage

Enclosing class:

ExtractRun

public static final class ExtractRun.Builder
extends java.lang.Object
implements ExtractRun.IdStage, ExtractRun.StatusStage, ExtractRun.ReviewedStage, ExtractRun.EditedStage, ExtractRun.ConfigStage, ExtractRun.FileStage, ExtractRun.DashboardUrlStage, ExtractRun.CreatedAtStage, ExtractRun.UpdatedAtStage, ExtractRun._FinalStage

Method Summary

Modifier and Type	Method	Description
ExtractRun	build()
ExtractRun.FileStage	config(ExtractConfig config)	The configuration used for this extract run.
ExtractRun.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)
ExtractRun.CreatedAtStage	dashboardUrl(java.lang.String dashboardUrl)	The URL to view the extract run in the Extend dashboard.
ExtractRun.ConfigStage	edited(boolean edited)	Indicates whether the run results have been edited during review.
ExtractRun._FinalStage	edits(Nullable<java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>>> edits)	Details of edits made during review.
ExtractRun._FinalStage	edits(java.util.Map<java.lang.String,java.util.Optional<ExtractOutputEdits>> edits)	Details of edits made during review.
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)	The extractor that was used for this run.
ExtractRun._FinalStage	extractor(ExtractorSummary extractor)	The extractor that was used for this run.
ExtractRun._FinalStage	extractor(java.util.Optional<ExtractorSummary> extractor)	The extractor that was used for this run.
ExtractRun._FinalStage	extractorVersion(Nullable<ExtractorVersionSummary> extractorVersion)	The version of the extractor that was used for this run.
ExtractRun._FinalStage	extractorVersion(ExtractorVersionSummary extractorVersion)	The version of the extractor that was used for this run.
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)	A detailed message about the failure.
ExtractRun._FinalStage	failureMessage(java.lang.String failureMessage)	A detailed message about the failure.
ExtractRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
ExtractRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)	The reason for failure.
ExtractRun._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
ExtractRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
ExtractRun.DashboardUrlStage	file(FileSummary file)	The file that was processed.
ExtractRun.Builder	from(ExtractRun other)
ExtractRun.StatusStage	id(java.lang.String id)	The unique identifier for this extract run.
ExtractRun._FinalStage	initialOutput(Nullable<ExtractOutput> initialOutput)	The initial output from the extract run, before any review edits.
ExtractRun._FinalStage	initialOutput(ExtractOutput initialOutput)	The initial output from the extract run, before any review edits.
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)	Any metadata that was provided when creating the extract run.
ExtractRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	Any metadata that was provided when creating the extract run.
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)	The final output, either reviewed or initial.
ExtractRun._FinalStage	output(ExtractOutput output)	The final output, either reviewed or initial.
ExtractRun._FinalStage	output(java.util.Optional<ExtractOutput> output)	The final output, either reviewed or initial.
ExtractRun._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRun._FinalStage	parseRunId(java.lang.String parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRun._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRun.EditedStage	reviewed(boolean reviewed)	Indicates whether the run has been reviewed by a human.
ExtractRun._FinalStage	reviewedOutput(Nullable<ExtractOutput> reviewedOutput)	The output after human review.
ExtractRun._FinalStage	reviewedOutput(ExtractOutput reviewedOutput)	The output after human review.
ExtractRun._FinalStage	reviewedOutput(java.util.Optional<ExtractOutput> reviewedOutput)	The output after human review.
ExtractRun.ReviewedStage	status(ProcessorRunStatus status)
ExtractRun._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)
ExtractRun._FinalStage	usage(Nullable<RunUsage> usage)	Usage credits consumed by this run.
ExtractRun._FinalStage	usage(RunUsage usage)	Usage credits consumed by this run.
ExtractRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public ExtractRun.Builder from(ExtractRun other)

Specified by:

from in interface ExtractRun.IdStage

id

public ExtractRun.StatusStage id(@NotNull
                                 java.lang.String id)

The unique identifier for this extract run.

Example: "exr_Xj8mK2pL9nR4vT7qY5wZ"

The unique identifier for this extract run.

Example: "exr_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

id in interface ExtractRun.IdStage

Returns:

Reference to this so that method calls can be chained together.

status

public ExtractRun.ReviewedStage status(@NotNull
                                       ProcessorRunStatus status)

Specified by:

status in interface ExtractRun.StatusStage

reviewed

public ExtractRun.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 ExtractRun.ReviewedStage

Returns:

Reference to this so that method calls can be chained together.

edited

public ExtractRun.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 ExtractRun.EditedStage

Returns:

Reference to this so that method calls can be chained together.

config

public ExtractRun.FileStage config(@NotNull
                                   ExtractConfig config)

The configuration used for this extract run.

The configuration used for this extract run.

Specified by:

config in interface ExtractRun.ConfigStage

Returns:

Reference to this so that method calls can be chained together.

file

public ExtractRun.DashboardUrlStage file(@NotNull
                                         FileSummary file)

The file that was processed.

The file that was processed.

Specified by:

file in interface ExtractRun.FileStage

Returns:

Reference to this so that method calls can be chained together.

dashboardUrl

public ExtractRun.CreatedAtStage dashboardUrl(@NotNull
                                              java.lang.String dashboardUrl)

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

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

Specified by:

dashboardUrl in interface ExtractRun.DashboardUrlStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public ExtractRun.UpdatedAtStage createdAt(@NotNull
                                           java.time.OffsetDateTime createdAt)

Specified by:

createdAt in interface ExtractRun.CreatedAtStage

updatedAt

public ExtractRun._FinalStage updatedAt(@NotNull
                                        java.time.OffsetDateTime updatedAt)

Specified by:

updatedAt in interface ExtractRun.UpdatedAtStage

usage

public ExtractRun._FinalStage usage(Nullable<RunUsage> usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

usage

public ExtractRun._FinalStage usage(RunUsage usage)

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

usage

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

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

Specified by:

usage in interface ExtractRun._FinalStage

parseRunId

public ExtractRun._FinalStage parseRunId(Nullable<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.

Specified by:

parseRunId in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parseRunId

public ExtractRun._FinalStage parseRunId(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.

Specified by:

parseRunId in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parseRunId

public 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.

Specified by:

parseRunId in interface ExtractRun._FinalStage

edits

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

Details of edits made during review.

Availability: Present when edited is true.

Specified by:

edits in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

edits

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

Details of edits made during review.

Availability: Present when edited is true.

Specified by:

edits in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

edits

public 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.

Specified by:

edits in interface ExtractRun._FinalStage

metadata

public ExtractRun._FinalStage metadata(Nullable<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.

Specified by:

metadata in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

metadata

public ExtractRun._FinalStage metadata(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.

Specified by:

metadata in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

metadata

public 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.

Specified by:

metadata in interface ExtractRun._FinalStage

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ExtractRun._FinalStage

failureReason

public ExtractRun._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 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.

Specified by:

failureReason in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public ExtractRun._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 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.

Specified by:

failureReason in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public 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.

Specified by:

failureReason in interface ExtractRun._FinalStage

reviewedOutput

public ExtractRun._FinalStage reviewedOutput(Nullable<ExtractOutput> reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

reviewedOutput

public ExtractRun._FinalStage reviewedOutput(ExtractOutput reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

reviewedOutput

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

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ExtractRun._FinalStage

initialOutput

public ExtractRun._FinalStage initialOutput(Nullable<ExtractOutput> initialOutput)

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

Availability: Present when reviewed is true.

Specified by:

initialOutput in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

initialOutput

public ExtractRun._FinalStage initialOutput(ExtractOutput initialOutput)

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

Availability: Present when reviewed is true.

Specified by:

initialOutput in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

initialOutput

public 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.

Specified by:

initialOutput in interface ExtractRun._FinalStage

output

public ExtractRun._FinalStage output(Nullable<ExtractOutput> output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

output

public ExtractRun._FinalStage output(ExtractOutput output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

output

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

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ExtractRun._FinalStage

extractorVersion

public ExtractRun._FinalStage extractorVersion(Nullable<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.

Specified by:

extractorVersion in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

extractorVersion

public ExtractRun._FinalStage extractorVersion(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.

Specified by:

extractorVersion in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

extractorVersion

public 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.

Specified by:

extractorVersion in interface ExtractRun._FinalStage

extractor

public ExtractRun._FinalStage extractor(Nullable<ExtractorSummary> extractor)

The extractor that was used for this run.

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

Specified by:

extractor in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

extractor

public ExtractRun._FinalStage extractor(ExtractorSummary extractor)

The extractor that was used for this run.

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

Specified by:

extractor in interface ExtractRun._FinalStage

Returns:

Reference to this so that method calls can be chained together.

extractor

public 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.

Specified by:

extractor in interface ExtractRun._FinalStage

build

public ExtractRun build()

Specified by:

build in interface ExtractRun._FinalStage