Package ai.extend.types

Class FormDetectionRun.Builder

java.lang.Object

ai.extend.types.FormDetectionRun.Builder

All Implemented Interfaces:

FormDetectionRun._FinalStage, FormDetectionRun.ConfigStage, FormDetectionRun.FileStage, FormDetectionRun.IdStage, FormDetectionRun.StatusStage

Enclosing class:

FormDetectionRun

public static final class FormDetectionRun.Builder
extends java.lang.Object
implements FormDetectionRun.IdStage, FormDetectionRun.FileStage, FormDetectionRun.StatusStage, FormDetectionRun.ConfigStage, FormDetectionRun._FinalStage

Method Summary

Modifier and Type	Method	Description
FormDetectionRun	build()
FormDetectionRun._FinalStage	config(EditSchemaGenerationConfig config)	The configuration used for this form detection run, including any default values that were applied.
FormDetectionRun._FinalStage	failureMessage(Nullable<java.lang.String> failureMessage)	A human-readable description of the failure.
FormDetectionRun._FinalStage	failureMessage(java.lang.String failureMessage)	A human-readable description of the failure.
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)	The reason for failure.
FormDetectionRun._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure.
FormDetectionRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure.
FormDetectionRun.StatusStage	file(FileSummary file)	The input PDF submitted for form detection.
FormDetectionRun.Builder	from(FormDetectionRun other)
FormDetectionRun.FileStage	id(java.lang.String id)	A unique identifier for the form detection run.
FormDetectionRun._FinalStage	metrics(Nullable<FormDetectionRunMetrics> metrics)	Metrics about the form detection process.
FormDetectionRun._FinalStage	metrics(FormDetectionRunMetrics metrics)	Metrics about the form detection process.
FormDetectionRun._FinalStage	metrics(java.util.Optional<FormDetectionRunMetrics> metrics)	Metrics about the form detection process.
FormDetectionRun._FinalStage	output(Nullable<EditSchemaGenerationResponse> output)	The detected schema and optional mapping metadata.
FormDetectionRun._FinalStage	output(EditSchemaGenerationResponse output)	The detected schema and optional mapping metadata.
FormDetectionRun._FinalStage	output(java.util.Optional<EditSchemaGenerationResponse> output)	The detected schema and optional mapping metadata.
FormDetectionRun.ConfigStage	status(FormDetectionRunStatus status)	The status of the form detection run:
FormDetectionRun._FinalStage	usage(Nullable<RunUsage> usage)	Usage credits consumed by this form detection run.
FormDetectionRun._FinalStage	usage(RunUsage usage)	Usage credits consumed by this form detection run.
FormDetectionRun._FinalStage	usage(java.util.Optional<RunUsage> usage)	Usage credits consumed by this form detection run.

Methods inherited from class java.lang.Object

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

Method Detail

from

public FormDetectionRun.Builder from(FormDetectionRun other)

Specified by:

from in interface FormDetectionRun.IdStage

id

public FormDetectionRun.FileStage id(@NotNull
                                     java.lang.String id)

A unique identifier for the form detection run.

Example: "sgr_xK9mLPqRtN3vS8wF5hB2cQ"

A unique identifier for the form detection run.

Example: "sgr_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface FormDetectionRun.IdStage

Returns:

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

file

public FormDetectionRun.StatusStage file(@NotNull
                                         FileSummary file)

The input PDF submitted for form detection.

The input PDF submitted for form detection.

Specified by:

file in interface FormDetectionRun.FileStage

Returns:

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

status

public FormDetectionRun.ConfigStage status(@NotNull
                                           FormDetectionRunStatus status)

The status of the form detection run:

• "PROCESSING" - The form is still being analyzed
• "PROCESSED" - Form detection completed successfully
• "FAILED" - Form detection failed (see failureReason for details)

The status of the form detection run:

• "PROCESSING" - The form is still being analyzed
• "PROCESSED" - Form detection completed successfully
• "FAILED" - Form detection failed (see failureReason for details)

Specified by:

status in interface FormDetectionRun.StatusStage

Returns:

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

config

public FormDetectionRun._FinalStage config(@NotNull
                                           EditSchemaGenerationConfig config)

The configuration used for this form detection run, including any default values that were applied.

The configuration used for this form detection run, including any default values that were applied.

Specified by:

config in interface FormDetectionRun.ConfigStage

Returns:

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

usage

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

Usage credits consumed by this form detection run.

Specified by:

usage in interface FormDetectionRun._FinalStage

Returns:

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

usage

public FormDetectionRun._FinalStage usage(RunUsage usage)

Usage credits consumed by this form detection run.

Specified by:

usage in interface FormDetectionRun._FinalStage

Returns:

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

usage

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

Usage credits consumed by this form detection run.

Specified by:

usage in interface FormDetectionRun._FinalStage

metrics

public FormDetectionRun._FinalStage metrics(Nullable<FormDetectionRunMetrics> metrics)

Metrics about the form detection process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface FormDetectionRun._FinalStage

Returns:

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

metrics

public FormDetectionRun._FinalStage metrics(FormDetectionRunMetrics metrics)

Metrics about the form detection process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface FormDetectionRun._FinalStage

Returns:

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

metrics

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

Metrics about the form detection process.

Availability: Present when status is "PROCESSED".

Specified by:

metrics in interface FormDetectionRun._FinalStage

output

public FormDetectionRun._FinalStage output(Nullable<EditSchemaGenerationResponse> output)

The detected schema and optional mapping metadata.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface FormDetectionRun._FinalStage

Returns:

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

output

public FormDetectionRun._FinalStage output(EditSchemaGenerationResponse output)

The detected schema and optional mapping metadata.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface FormDetectionRun._FinalStage

Returns:

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

output

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

The detected schema and optional mapping metadata.

Availability: Present when status is "PROCESSED".

Specified by:

output in interface FormDetectionRun._FinalStage

failureMessage

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

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface FormDetectionRun._FinalStage

Returns:

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

failureMessage

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

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface FormDetectionRun._FinalStage

Returns:

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

failureMessage

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

A human-readable description of the failure.

Availability: Present when status is "FAILED".

Specified by:

failureMessage in interface FormDetectionRun._FinalStage

failureReason

public FormDetectionRun._FinalStage failureReason(Nullable<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.

Specified by:

failureReason in interface FormDetectionRun._FinalStage

Returns:

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

failureReason

public FormDetectionRun._FinalStage failureReason(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.

Specified by:

failureReason in interface FormDetectionRun._FinalStage

Returns:

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

failureReason

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

Specified by:

failureReason in interface FormDetectionRun._FinalStage

build

public FormDetectionRun build()

Specified by:

build in interface FormDetectionRun._FinalStage