Package ai.extend.types

Interface FormDetectionRun._FinalStage

All Known Implementing Classes:

FormDetectionRun.Builder

Enclosing class:

FormDetectionRun

public static interface FormDetectionRun._FinalStage

Method Summary

Modifier and Type	Method	Description
FormDetectionRun	build()
FormDetectionRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)
FormDetectionRun._FinalStage	failureMessage(java.lang.String failureMessage)
FormDetectionRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	A human-readable description of the failure.
FormDetectionRun._FinalStage	failureReason(Nullable<java.lang.String> failureReason)
FormDetectionRun._FinalStage	failureReason(java.lang.String failureReason)
FormDetectionRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
FormDetectionRun._FinalStage	metrics(Nullable<FormDetectionRunMetrics> metrics)
FormDetectionRun._FinalStage	metrics(FormDetectionRunMetrics metrics)
FormDetectionRun._FinalStage	metrics(java.util.Optional<FormDetectionRunMetrics> metrics)	Metrics about the form detection process.
FormDetectionRun._FinalStage	output(Nullable<EditSchemaGenerationResponse> output)
FormDetectionRun._FinalStage	output(EditSchemaGenerationResponse output)
FormDetectionRun._FinalStage	output(java.util.Optional<EditSchemaGenerationResponse> output)	The detected schema and optional mapping metadata.
FormDetectionRun._FinalStage	usage(Nullable<RunUsage> usage)
FormDetectionRun._FinalStage	usage(RunUsage usage)
FormDetectionRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this form detection run.

Method Detail

build

FormDetectionRun build()

failureReason

FormDetectionRun._FinalStage failureReason(java.util.Optional<java.lang.String> failureReason)

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

• UNABLE_TO_DOWNLOAD_FILE
• FILE_TYPE_NOT_SUPPORTED
• FILE_SIZE_TOO_LARGE
• CORRUPT_FILE
• FIELD_DETECTION_ERROR
• PASSWORD_PROTECTED_FILE
• FAILED_TO_CONVERT_TO_PDF
• EMPTY_SCHEMA
• INTERNAL_ERROR
• INVALID_OPTIONS
• OUT_OF_CREDITS

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

failureReason

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

failureReason

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

failureMessage

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

A human-readable description of the failure.

Availability: Present when status is "FAILED".

failureMessage

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

failureMessage

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

output

FormDetectionRun._FinalStage output(java.util.Optional<EditSchemaGenerationResponse> output)

The detected schema and optional mapping metadata.

Availability: Present when status is "PROCESSED".

output

FormDetectionRun._FinalStage output(EditSchemaGenerationResponse output)

output

FormDetectionRun._FinalStage output(Nullable<EditSchemaGenerationResponse> output)

metrics

FormDetectionRun._FinalStage metrics(java.util.Optional<FormDetectionRunMetrics> metrics)

Metrics about the form detection process.

Availability: Present when status is "PROCESSED".

metrics

FormDetectionRun._FinalStage metrics(FormDetectionRunMetrics metrics)

metrics

FormDetectionRun._FinalStage metrics(Nullable<FormDetectionRunMetrics> metrics)

usage

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

Usage credits consumed by this form detection run.

usage

FormDetectionRun._FinalStage usage(RunUsage usage)

usage

FormDetectionRun._FinalStage usage(Nullable<RunUsage> usage)