Package ai.extend.types

Interface ClassifyRun._FinalStage

All Known Implementing Classes:

ClassifyRun.Builder

Enclosing class:

ClassifyRun

public static interface ClassifyRun._FinalStage

Method Summary

Modifier and Type	Method	Description
ClassifyRun	build()
ClassifyRun._FinalStage	classifier(Nullable<ClassifierSummary> classifier)
ClassifyRun._FinalStage	classifier(ClassifierSummary classifier)
ClassifyRun._FinalStage	classifier(java.util.Optional<ClassifierSummary> classifier)	The classifier that was used for this run.
ClassifyRun._FinalStage	classifierVersion(Nullable<ClassifierVersionSummary> classifierVersion)
ClassifyRun._FinalStage	classifierVersion(ClassifierVersionSummary classifierVersion)
ClassifyRun._FinalStage	classifierVersion(java.util.Optional<ClassifierVersionSummary> classifierVersion)	The version of the classifier that was used for this run.
ClassifyRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)
ClassifyRun._FinalStage	failureMessage(java.lang.String failureMessage)
ClassifyRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A detailed message about the failure.
ClassifyRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)
ClassifyRun._FinalStage	failureReason(java.lang.String failureReason)
ClassifyRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
ClassifyRun._FinalStage	initialOutput(Nullable<ClassifyOutput> initialOutput)
ClassifyRun._FinalStage	initialOutput(ClassifyOutput initialOutput)
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)
ClassifyRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
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)
ClassifyRun._FinalStage	output(ClassifyOutput output)
ClassifyRun._FinalStage	output(java.util.Optional<ClassifyOutput> output)	The final output, either reviewed or initial.
ClassifyRun._FinalStage	parseRunId(Nullable<java.lang.String> parseRunId)
ClassifyRun._FinalStage	parseRunId(java.lang.String parseRunId)
ClassifyRun._FinalStage	parseRunId(java.util.Optional<java.lang.String> parseRunId)	The ID of the parse run that was used for this classify run.
ClassifyRun._FinalStage	reviewedOutput(Nullable<ClassifyOutput> reviewedOutput)
ClassifyRun._FinalStage	reviewedOutput(ClassifyOutput reviewedOutput)
ClassifyRun._FinalStage	reviewedOutput(java.util.Optional<ClassifyOutput> reviewedOutput)	The output after human review.
ClassifyRun._FinalStage	usage(Nullable<RunUsage> usage)
ClassifyRun._FinalStage	usage(RunUsage usage)
ClassifyRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this classify run.

Method Detail

build

ClassifyRun build()

classifier

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.

classifier

ClassifyRun._FinalStage classifier(ClassifierSummary classifier)

classifier

ClassifyRun._FinalStage classifier(Nullable<ClassifierSummary> classifier)

classifierVersion

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.

classifierVersion

ClassifyRun._FinalStage classifierVersion(ClassifierVersionSummary classifierVersion)

classifierVersion

ClassifyRun._FinalStage classifierVersion(Nullable<ClassifierVersionSummary> classifierVersion)

output

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

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

output

ClassifyRun._FinalStage output(ClassifyOutput output)

output

ClassifyRun._FinalStage output(Nullable<ClassifyOutput> output)

initialOutput

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.

initialOutput

ClassifyRun._FinalStage initialOutput(ClassifyOutput initialOutput)

initialOutput

ClassifyRun._FinalStage initialOutput(Nullable<ClassifyOutput> initialOutput)

reviewedOutput

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

The output after human review.

Availability: Present when reviewed is true.

reviewedOutput

ClassifyRun._FinalStage reviewedOutput(ClassifyOutput reviewedOutput)

reviewedOutput

ClassifyRun._FinalStage reviewedOutput(Nullable<ClassifyOutput> reviewedOutput)

failureReason

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.

failureReason

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

failureReason

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

failureMessage

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

A detailed message about the failure.

Availability: Present when status is "FAILED".

failureMessage

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

failureMessage

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

metadata

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.

metadata

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

metadata

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

parseRunId

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.

parseRunId

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

parseRunId

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

usage

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.

usage

ClassifyRun._FinalStage usage(RunUsage usage)

usage

ClassifyRun._FinalStage usage(Nullable<RunUsage> usage)