Package ai.extend.types

Class EditRun.Builder

java.lang.Object

ai.extend.types.EditRun.Builder

All Implemented Interfaces:

EditRun._FinalStage, EditRun.ConfigStage, EditRun.FileIdStage, EditRun.IdStage, EditRun.MetricsStage, EditRun.StatusStage

Enclosing class:

EditRun

public static final class EditRun.Builder
extends java.lang.Object
implements EditRun.IdStage, EditRun.FileIdStage, EditRun.StatusStage, EditRun.ConfigStage, EditRun.MetricsStage, EditRun._FinalStage

Method Summary

Modifier and Type	Method	Description
EditRun	build()
EditRun.MetricsStage	config(EditRunConfig config)	The configuration used for this edit run.
EditRun._FinalStage	editedFile(EditRunEditedFile editedFile)	Information about the edited output file.
EditRun._FinalStage	editedFile(java.util.Optional<EditRunEditedFile> editedFile)	Information about the edited output file.
EditRun._FinalStage	failureReason(java.lang.String failureReason)	The reason for failure if status is "FAILED".
EditRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	The reason for failure if status is "FAILED".
EditRun.StatusStage	fileId(java.lang.String fileId)	The identifier of the input file that was edited.
EditRun.Builder	from(EditRun other)
EditRun.FileIdStage	id(java.lang.String id)	A unique identifier for the edit run.
EditRun._FinalStage	metrics(EditRunMetrics metrics)	Metrics about the editing process.
EditRun._FinalStage	output(java.util.Map<java.lang.String,java.lang.Object> output)	The extracted/detected field values from the edited document.
EditRun._FinalStage	output(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> output)	The extracted/detected field values from the edited document.
EditRun.ConfigStage	status(EditRunStatus status)
EditRun._FinalStage	usage(EditRunUsage usage)	Usage credits consumed by this edit run.
EditRun._FinalStage	usage(java.util.Optional<EditRunUsage> usage)	Usage credits consumed by this edit run.

Methods inherited from class java.lang.Object

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

Method Detail

from

public EditRun.Builder from(EditRun other)

Specified by:

from in interface EditRun.IdStage

id

public EditRun.FileIdStage id(@NotNull
                              java.lang.String id)

A unique identifier for the edit run. Will always start with "edit_run_"

Example: "edit_run_xK9mLPqRtN3vS8wF5hB2cQ"

A unique identifier for the edit run. Will always start with "edit_run_"

Example: "edit_run_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface EditRun.IdStage

Returns:

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

fileId

public EditRun.StatusStage fileId(@NotNull
                                  java.lang.String fileId)

The identifier of the input file that was edited.

The identifier of the input file that was edited.

Specified by:

fileId in interface EditRun.FileIdStage

Returns:

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

status

public EditRun.ConfigStage status(@NotNull
                                  EditRunStatus status)

Specified by:

status in interface EditRun.StatusStage

config

public EditRun.MetricsStage config(@NotNull
                                   EditRunConfig config)

The configuration used for this edit run.

The configuration used for this edit run.

Specified by:

config in interface EditRun.ConfigStage

Returns:

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

metrics

public EditRun._FinalStage metrics(@NotNull
                                   EditRunMetrics metrics)

Metrics about the editing process.

Metrics about the editing process.

Specified by:

metrics in interface EditRun.MetricsStage

Returns:

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

usage

public EditRun._FinalStage usage(EditRunUsage usage)

Usage credits consumed by this edit run.

Specified by:

usage in interface EditRun._FinalStage

Returns:

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

usage

public EditRun._FinalStage usage(java.util.Optional<EditRunUsage> usage)

Usage credits consumed by this edit run.

Specified by:

usage in interface EditRun._FinalStage

output

public EditRun._FinalStage output(java.util.Map<java.lang.String,java.lang.Object> output)

The extracted/detected field values from the edited document.

Specified by:

output in interface EditRun._FinalStage

Returns:

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

output

public EditRun._FinalStage output(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> output)

The extracted/detected field values from the edited document.

Specified by:

output in interface EditRun._FinalStage

failureReason

public EditRun._FinalStage failureReason(java.lang.String failureReason)

The reason for failure if status is "FAILED".

Specified by:

failureReason in interface EditRun._FinalStage

Returns:

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

failureReason

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

The reason for failure if status is "FAILED".

Specified by:

failureReason in interface EditRun._FinalStage

editedFile

public EditRun._FinalStage editedFile(EditRunEditedFile editedFile)

Information about the edited output file. Only present when status is "PROCESSED".

Specified by:

editedFile in interface EditRun._FinalStage

Returns:

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

editedFile

public EditRun._FinalStage editedFile(java.util.Optional<EditRunEditedFile> editedFile)

Information about the edited output file. Only present when status is "PROCESSED".

Specified by:

editedFile in interface EditRun._FinalStage

build

public EditRun build()

Specified by:

build in interface EditRun._FinalStage