Package ai.extend.types

Class ClassifyRun.Builder

java.lang.Object

ai.extend.types.ClassifyRun.Builder

All Implemented Interfaces:

ClassifyRun._FinalStage, ClassifyRun.ConfigStage, ClassifyRun.CreatedAtStage, ClassifyRun.DashboardUrlStage, ClassifyRun.EditedStage, ClassifyRun.IdStage, ClassifyRun.ReviewedStage, ClassifyRun.StatusStage, ClassifyRun.UpdatedAtStage

Enclosing class:

ClassifyRun

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

from

public ClassifyRun.Builder from(ClassifyRun other)

Specified by:

from in interface ClassifyRun.IdStage

id

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

The unique identifier for this classify run.

Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"

The unique identifier for this classify run.

Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

id in interface ClassifyRun.IdStage

Returns:

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

status

public ClassifyRun.ReviewedStage status(@NotNull
                                        ProcessorRunStatus status)

Specified by:

status in interface ClassifyRun.StatusStage

reviewed

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

Returns:

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

edited

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

Returns:

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

config

public ClassifyRun.DashboardUrlStage config(@NotNull
                                            ClassifyConfig config)

The configuration used for this classify run.

The configuration used for this classify run.

Specified by:

config in interface ClassifyRun.ConfigStage

Returns:

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

dashboardUrl

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

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

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

Specified by:

dashboardUrl in interface ClassifyRun.DashboardUrlStage

Returns:

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

createdAt

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

Specified by:

createdAt in interface ClassifyRun.CreatedAtStage

updatedAt

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

Specified by:

updatedAt in interface ClassifyRun.UpdatedAtStage

usage

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

Usage credits consumed by this classify 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 ClassifyRun._FinalStage

Returns:

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

usage

public ClassifyRun._FinalStage usage(RunUsage usage)

Usage credits consumed by this classify 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 ClassifyRun._FinalStage

Returns:

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

usage

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

Usage credits consumed by this classify 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 ClassifyRun._FinalStage

parseRunId

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

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

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface ClassifyRun._FinalStage

Returns:

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

parseRunId

public ClassifyRun._FinalStage parseRunId(java.lang.String parseRunId)

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

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface ClassifyRun._FinalStage

Returns:

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

parseRunId

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

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

Availability: Present when a parse run was created.

Specified by:

parseRunId in interface ClassifyRun._FinalStage

file

public ClassifyRun._FinalStage file(Nullable<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).

Specified by:

file in interface ClassifyRun._FinalStage

Returns:

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

file

public ClassifyRun._FinalStage file(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).

Specified by:

file in interface ClassifyRun._FinalStage

Returns:

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

file

public ClassifyRun._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).

Specified by:

file in interface ClassifyRun._FinalStage

metadata

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

Any metadata that was provided when creating the classify run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ClassifyRun._FinalStage

Returns:

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

metadata

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

Any metadata that was provided when creating the classify run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ClassifyRun._FinalStage

Returns:

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

metadata

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

Any metadata that was provided when creating the classify run.

Availability: Present when metadata was provided during creation.

Specified by:

metadata in interface ClassifyRun._FinalStage

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ClassifyRun._FinalStage

Returns:

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface ClassifyRun._FinalStage

Returns:

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

failureMessage

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

failureReason

public ClassifyRun._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 classification 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 classification

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

Specified by:

failureReason in interface ClassifyRun._FinalStage

Returns:

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

failureReason

public ClassifyRun._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 classification 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 classification

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

Specified by:

failureReason in interface ClassifyRun._FinalStage

Returns:

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

failureReason

public ClassifyRun._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 classification 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 classification

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

Specified by:

failureReason in interface ClassifyRun._FinalStage

reviewedOutput

public ClassifyRun._FinalStage reviewedOutput(Nullable<ClassifyOutput> reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ClassifyRun._FinalStage

Returns:

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

reviewedOutput

public ClassifyRun._FinalStage reviewedOutput(ClassifyOutput reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ClassifyRun._FinalStage

Returns:

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

reviewedOutput

public ClassifyRun._FinalStage reviewedOutput(java.util.Optional<ClassifyOutput> reviewedOutput)

The output after human review.

Availability: Present when reviewed is true.

Specified by:

reviewedOutput in interface ClassifyRun._FinalStage

initialOutput

public ClassifyRun._FinalStage initialOutput(Nullable<ClassifyOutput> initialOutput)

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

Availability: Present when reviewed is true.

Specified by:

initialOutput in interface ClassifyRun._FinalStage

Returns:

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

initialOutput

public ClassifyRun._FinalStage initialOutput(ClassifyOutput initialOutput)

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

Availability: Present when reviewed is true.

Specified by:

initialOutput in interface ClassifyRun._FinalStage

Returns:

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

initialOutput

public ClassifyRun._FinalStage initialOutput(java.util.Optional<ClassifyOutput> initialOutput)

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

Availability: Present when reviewed is true.

Specified by:

initialOutput in interface ClassifyRun._FinalStage

classifierVersion

public ClassifyRun._FinalStage classifierVersion(Nullable<ClassifierVersionSummary> classifierVersion)

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

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

Specified by:

classifierVersion in interface ClassifyRun._FinalStage

Returns:

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

classifierVersion

public ClassifyRun._FinalStage classifierVersion(ClassifierVersionSummary classifierVersion)

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

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

Specified by:

classifierVersion in interface ClassifyRun._FinalStage

Returns:

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

classifierVersion

public ClassifyRun._FinalStage classifierVersion(java.util.Optional<ClassifierVersionSummary> classifierVersion)

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

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

Specified by:

classifierVersion in interface ClassifyRun._FinalStage

classifier

public ClassifyRun._FinalStage classifier(Nullable<ClassifierSummary> classifier)

The classifier that was used for this run.

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

Specified by:

classifier in interface ClassifyRun._FinalStage

Returns:

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

classifier

public ClassifyRun._FinalStage classifier(ClassifierSummary classifier)

The classifier that was used for this run.

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

Specified by:

classifier in interface ClassifyRun._FinalStage

Returns:

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

classifier

public ClassifyRun._FinalStage classifier(java.util.Optional<ClassifierSummary> classifier)

The classifier that was used for this run.

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

Specified by:

classifier in interface ClassifyRun._FinalStage

output

public ClassifyRun._FinalStage output(Nullable<ClassifyOutput> output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ClassifyRun._FinalStage

Returns:

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

output

public ClassifyRun._FinalStage output(ClassifyOutput output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ClassifyRun._FinalStage

Returns:

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

output

public ClassifyRun._FinalStage output(java.util.Optional<ClassifyOutput> output)

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface ClassifyRun._FinalStage

build

public ClassifyRun build()

Specified by:

build in interface ClassifyRun._FinalStage