Package ai.extend.types

Class ExtractRunSummary.Builder

java.lang.Object

ai.extend.types.ExtractRunSummary.Builder

All Implemented Interfaces:

ExtractRunSummary._FinalStage, ExtractRunSummary.CreatedAtStage, ExtractRunSummary.DashboardUrlStage, ExtractRunSummary.EditedStage, ExtractRunSummary.IdStage, ExtractRunSummary.ReviewedStage, ExtractRunSummary.StatusStage, ExtractRunSummary.UpdatedAtStage

Enclosing class:

ExtractRunSummary

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

Method Summary

Modifier and Type	Method	Description
ExtractRunSummary	build()
ExtractRunSummary.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)
ExtractRunSummary.CreatedAtStage	dashboardUrl(java.lang.String dashboardUrl)	The URL to view the extract run in the Extend dashboard.
ExtractRunSummary.DashboardUrlStage	edited(boolean edited)	Indicates whether the run results have been edited during review.
ExtractRunSummary._FinalStage	extractor(Nullable<ExtractorSummary> extractor)	The extractor that was used for this run.
ExtractRunSummary._FinalStage	extractor(ExtractorSummary extractor)	The extractor that was used for this run.
ExtractRunSummary._FinalStage	extractor(java.util.Optional<ExtractorSummary> extractor)	The extractor that was used for this run.
ExtractRunSummary._FinalStage	extractorVersion(Nullable<ExtractorVersionSummary> extractorVersion)	The version of the extractor that was used for this run.
ExtractRunSummary._FinalStage	extractorVersion(ExtractorVersionSummary extractorVersion)	The version of the extractor that was used for this run.
ExtractRunSummary._FinalStage	extractorVersion(java.util.Optional<ExtractorVersionSummary> extractorVersion)	The version of the extractor that was used for this run.
ExtractRunSummary._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)	A detailed message about the failure.
ExtractRunSummary._FinalStage	failureMessage(java.lang.String failureMessage)	A detailed message about the failure.
ExtractRunSummary._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
ExtractRunSummary._FinalStage	failureReason(Nullable<java.lang.String> failureReason)	The reason for failure.
ExtractRunSummary._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
ExtractRunSummary._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
ExtractRunSummary._FinalStage	file(Nullable<FileSummary> file)	The file that was processed.
ExtractRunSummary._FinalStage	file(FileSummary file)	The file that was processed.
ExtractRunSummary._FinalStage	file(java.util.Optional<FileSummary> file)	The file that was processed.
ExtractRunSummary._FinalStage	files(Nullable<java.util.List<FileSummary>> files)	The files that were processed, in the order they were submitted.
ExtractRunSummary._FinalStage	files(java.util.List<FileSummary> files)	The files that were processed, in the order they were submitted.
ExtractRunSummary._FinalStage	files(java.util.Optional<java.util.List<FileSummary>> files)	The files that were processed, in the order they were submitted.
ExtractRunSummary.Builder	from(ExtractRunSummary other)
ExtractRunSummary.StatusStage	id(java.lang.String id)	The unique identifier for this extract run.
ExtractRunSummary._FinalStage	metadata(Nullable<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the extract run.
ExtractRunSummary._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	Any metadata that was provided when creating the extract run.
ExtractRunSummary._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.
ExtractRunSummary._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRunSummary._FinalStage	parseRunId(java.lang.String parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRunSummary._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this extract run.
ExtractRunSummary.EditedStage	reviewed(boolean reviewed)	Indicates whether the run has been reviewed by a human.
ExtractRunSummary.ReviewedStage	status(ProcessorRunStatus status)
ExtractRunSummary._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)
ExtractRunSummary._FinalStage	usage(Nullable<RunUsageSummary> usage)	Usage credits consumed by this extract run.
ExtractRunSummary._FinalStage	usage(RunUsageSummary usage)	Usage credits consumed by this extract run.
ExtractRunSummary._FinalStage	usage(java.util.Optional<RunUsageSummary> usage)	Usage credits consumed by this extract run.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ExtractRunSummary.Builder from(ExtractRunSummary other)

Specified by:

from in interface ExtractRunSummary.IdStage

id

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

The unique identifier for this extract run.

The unique identifier for this extract run.

Specified by:

id in interface ExtractRunSummary.IdStage

Returns:

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

status

public ExtractRunSummary.ReviewedStage status(@NotNull
                                              ProcessorRunStatus status)

Specified by:

status in interface ExtractRunSummary.StatusStage

reviewed

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

Returns:

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

edited

public ExtractRunSummary.DashboardUrlStage 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 ExtractRunSummary.EditedStage

Returns:

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

dashboardUrl

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

Returns:

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

createdAt

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

Specified by:

createdAt in interface ExtractRunSummary.CreatedAtStage

updatedAt

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

Specified by:

updatedAt in interface ExtractRunSummary.UpdatedAtStage

usage

public ExtractRunSummary._FinalStage usage(Nullable<RunUsageSummary> usage)

Usage credits consumed by this extract run. Omits breakdown — fetch the full extract run by id to see the per-line items.

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 ExtractRunSummary._FinalStage

Returns:

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

usage

public ExtractRunSummary._FinalStage usage(RunUsageSummary usage)

Usage credits consumed by this extract run. Omits breakdown — fetch the full extract run by id to see the per-line items.

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 ExtractRunSummary._FinalStage

Returns:

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

usage

public ExtractRunSummary._FinalStage usage(java.util.Optional<RunUsageSummary> usage)

Usage credits consumed by this extract run. Omits breakdown — fetch the full extract run by id to see the per-line items.

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 ExtractRunSummary._FinalStage

parseRunId

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

parseRunId

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

parseRunId

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

files

public ExtractRunSummary._FinalStage files(Nullable<java.util.List<FileSummary>> files)

The files that were processed, in the order they were submitted. Only populated for multifile runs (created with package).

For single-file runs, this is null — use file instead.

Specified by:

files in interface ExtractRunSummary._FinalStage

Returns:

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

files

public ExtractRunSummary._FinalStage files(java.util.List<FileSummary> files)

The files that were processed, in the order they were submitted. Only populated for multifile runs (created with package).

For single-file runs, this is null — use file instead.

Specified by:

files in interface ExtractRunSummary._FinalStage

Returns:

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

files

public ExtractRunSummary._FinalStage files(java.util.Optional<java.util.List<FileSummary>> files)

The files that were processed, in the order they were submitted. Only populated for multifile runs (created with package).

For single-file runs, this is null — use file instead.

Specified by:

files in interface ExtractRunSummary._FinalStage

file

public ExtractRunSummary._FinalStage file(Nullable<FileSummary> file)

The file that was processed. null for multifile runs (use files instead), and null when the file could not be accessed or processed (for example, a run that failed during file ingestion).

Specified by:

file in interface ExtractRunSummary._FinalStage

Returns:

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

file

public ExtractRunSummary._FinalStage file(FileSummary file)

The file that was processed. null for multifile runs (use files instead), and null when the file could not be accessed or processed (for example, a run that failed during file ingestion).

Specified by:

file in interface ExtractRunSummary._FinalStage

Returns:

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

file

public ExtractRunSummary._FinalStage file(java.util.Optional<FileSummary> file)

The file that was processed. null for multifile runs (use files instead), and null when the file could not be accessed or processed (for example, a run that failed during file ingestion).

Specified by:

file in interface ExtractRunSummary._FinalStage

metadata

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

metadata

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

metadata

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ExtractRunSummary._FinalStage

Returns:

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ExtractRunSummary._FinalStage

Returns:

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

failureMessage

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

failureReason

public ExtractRunSummary._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
• SCHEMA_GENERATION_FAILED - Automatic schema inference failed (only applies when schema is omitted). The file could not be parsed or a schema could not be generated from it.

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

Specified by:

failureReason in interface ExtractRunSummary._FinalStage

Returns:

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

failureReason

public ExtractRunSummary._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
• SCHEMA_GENERATION_FAILED - Automatic schema inference failed (only applies when schema is omitted). The file could not be parsed or a schema could not be generated from it.

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

Specified by:

failureReason in interface ExtractRunSummary._FinalStage

Returns:

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

failureReason

public ExtractRunSummary._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
• SCHEMA_GENERATION_FAILED - Automatic schema inference failed (only applies when schema is omitted). The file could not be parsed or a schema could not be generated from it.

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

Specified by:

failureReason in interface ExtractRunSummary._FinalStage

extractorVersion

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

extractorVersion

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

extractorVersion

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

extractor

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

extractor

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

Returns:

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

extractor

public ExtractRunSummary._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 ExtractRunSummary._FinalStage

build

public ExtractRunSummary build()

Specified by:

build in interface ExtractRunSummary._FinalStage