Package ai.extend.types

Class ProcessorRun.Builder

java.lang.Object

ai.extend.types.ProcessorRun.Builder

All Implemented Interfaces:

ProcessorRun._FinalStage, ProcessorRun.ConfigStage, ProcessorRun.EditedStage, ProcessorRun.IdStage, ProcessorRun.ObjectStage, ProcessorRun.OutputStage, ProcessorRun.ProcessorIdStage, ProcessorRun.ProcessorNameStage, ProcessorRun.ProcessorVersionIdStage, ProcessorRun.ReviewedStage, ProcessorRun.StatusStage, ProcessorRun.TypeStage, ProcessorRun.UrlStage

Enclosing class:

ProcessorRun

public static final class ProcessorRun.Builder
extends java.lang.Object
implements ProcessorRun.ObjectStage, ProcessorRun.IdStage, ProcessorRun.ProcessorIdStage, ProcessorRun.ProcessorVersionIdStage, ProcessorRun.ProcessorNameStage, ProcessorRun.StatusStage, ProcessorRun.OutputStage, ProcessorRun.ReviewedStage, ProcessorRun.EditedStage, ProcessorRun.TypeStage, ProcessorRun.ConfigStage, ProcessorRun.UrlStage, ProcessorRun._FinalStage

Method Summary

Modifier and Type	Method	Description
ProcessorRun._FinalStage	addAllFiles(java.util.List<File> files)	Details of the processed files.
ProcessorRun._FinalStage	addAllMergedProcessors(java.util.List<ProcessorRunMergedProcessorsItem> mergedProcessors)	An array of processors that were merged to create this output.
ProcessorRun._FinalStage	addFiles(File files)	Details of the processed files.
ProcessorRun._FinalStage	addMergedProcessors(ProcessorRunMergedProcessorsItem mergedProcessors)	An array of processors that were merged to create this output.
ProcessorRun	build()
ProcessorRun.UrlStage	config(ProcessorRunConfig config)	The configuration used for this processor run.
ProcessorRun.TypeStage	edited(boolean edited)	Indicates whether the run results have been edited.
ProcessorRun._FinalStage	edits(java.lang.String key, ExtractionOutputEdits value)
ProcessorRun._FinalStage	edits(java.util.Map<java.lang.String,ExtractionOutputEdits> edits)
ProcessorRun._FinalStage	failureMessage(java.lang.String failureMessage)	If the run failed, provides a detailed message about the failure.
ProcessorRun._FinalStage	failureMessage(java.util.Optional<java.lang.String> failureMessage)	If the run failed, provides a detailed message about the failure.
ProcessorRun._FinalStage	failureReason(java.lang.String failureReason)	If the run failed, indicates the reason for failure.
ProcessorRun._FinalStage	failureReason(java.util.Optional<java.lang.String> failureReason)	If the run failed, indicates the reason for failure.
ProcessorRun._FinalStage	files(java.util.List<File> files)	Details of the processed files.
ProcessorRun.Builder	from(ProcessorRun other)
ProcessorRun.ProcessorIdStage	id(java.lang.String id)	The unique identifier for this processor run.
ProcessorRun._FinalStage	initialOutput(ProcessorOutput initialOutput)	The initial output from the processor run.
ProcessorRun._FinalStage	initialOutput(java.util.Optional<ProcessorOutput> initialOutput)	The initial output from the processor run.
ProcessorRun._FinalStage	mergedProcessors(java.util.List<ProcessorRunMergedProcessorsItem> mergedProcessors)	An array of processors that were merged to create this output.
ProcessorRun._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)	Any metadata that was provided when creating the processor run.
ProcessorRun._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> metadata)	Any metadata that was provided when creating the processor run.
ProcessorRun.IdStage	object(java.lang.String object)	The type of response.
ProcessorRun.ReviewedStage	output(ProcessorOutput output)	The final output, either reviewed or initial.
ProcessorRun.ProcessorVersionIdStage	processorId(java.lang.String processorId)	The ID of the processor used for this run.
ProcessorRun.StatusStage	processorName(java.lang.String processorName)	The name of the processor.
ProcessorRun.ProcessorNameStage	processorVersionId(java.lang.String processorVersionId)	The ID of the specific processor version used.
ProcessorRun._FinalStage	putAllEdits(java.util.Map<java.lang.String,ExtractionOutputEdits> edits)
ProcessorRun.EditedStage	reviewed(boolean reviewed)	Indicates whether the run has been reviewed.
ProcessorRun._FinalStage	reviewedOutput(ProcessorOutput reviewedOutput)	The output after review, if any.
ProcessorRun._FinalStage	reviewedOutput(java.util.Optional<ProcessorOutput> reviewedOutput)	The output after review, if any.
ProcessorRun.OutputStage	status(ProcessorRunStatus status)	The current status of the processor run:
ProcessorRun.ConfigStage	type(ProcessorRunType type)	The type of processor:
ProcessorRun._FinalStage	url(java.lang.String url)	The URL to view the processor run.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ProcessorRun.Builder from(ProcessorRun other)

Specified by:

from in interface ProcessorRun.ObjectStage

object

public ProcessorRun.IdStage object(@NotNull
                                   java.lang.String object)

The type of response. In this case, it will always be "document_processor_run".

The type of response. In this case, it will always be "document_processor_run".

Specified by:

object in interface ProcessorRun.ObjectStage

Returns:

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

id

public ProcessorRun.ProcessorIdStage id(@NotNull
                                        java.lang.String id)

The unique identifier for this processor run.

Example: "dpr_Xj8mK2pL9nR4vT7qY5wZ"

The unique identifier for this processor run.

Example: "dpr_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

id in interface ProcessorRun.IdStage

Returns:

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

processorId

public ProcessorRun.ProcessorVersionIdStage processorId(@NotNull
                                                        java.lang.String processorId)

The ID of the processor used for this run.

Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"

The ID of the processor used for this run.

Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

processorId in interface ProcessorRun.ProcessorIdStage

Returns:

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

processorVersionId

public ProcessorRun.ProcessorNameStage processorVersionId(@NotNull
                                                          java.lang.String processorVersionId)

The ID of the specific processor version used.

The ID of the specific processor version used.

Specified by:

processorVersionId in interface ProcessorRun.ProcessorVersionIdStage

Returns:

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

processorName

public ProcessorRun.StatusStage processorName(@NotNull
                                              java.lang.String processorName)

The name of the processor.

Example: "Invoice Processor"

The name of the processor.

Example: "Invoice Processor"

Specified by:

processorName in interface ProcessorRun.ProcessorNameStage

Returns:

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

status

public ProcessorRun.OutputStage status(@NotNull
                                       ProcessorRunStatus status)

The current status of the processor run:

• "PROCESSING" - The processor is currently running
• "PROCESSED" - The processor has completed successfully
• "FAILED" - The processor encountered an error
• "CANCELLED" - The processor run was cancelled

The current status of the processor run:

• "PROCESSING" - The processor is currently running
• "PROCESSED" - The processor has completed successfully
• "FAILED" - The processor encountered an error
• "CANCELLED" - The processor run was cancelled

Specified by:

status in interface ProcessorRun.StatusStage

Returns:

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

output

public ProcessorRun.ReviewedStage output(@NotNull
                                         ProcessorOutput output)

The final output, either reviewed or initial.

Conforms to the shape of output types and depends on the processor type and configuration shape.

The final output, either reviewed or initial.

Conforms to the shape of output types and depends on the processor type and configuration shape.

Specified by:

output in interface ProcessorRun.OutputStage

Returns:

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

reviewed

public ProcessorRun.EditedStage reviewed(boolean reviewed)

Indicates whether the run has been reviewed.

Indicates whether the run has been reviewed.

Specified by:

reviewed in interface ProcessorRun.ReviewedStage

Returns:

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

edited

public ProcessorRun.TypeStage edited(boolean edited)

Indicates whether the run results have been edited.

Indicates whether the run results have been edited.

Specified by:

edited in interface ProcessorRun.EditedStage

Returns:

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

type

public ProcessorRun.ConfigStage type(@NotNull
                                     ProcessorRunType type)

The type of processor:

• "CLASSIFY" - Classifies documents into categories
• "EXTRACT" - Extracts structured data from documents
• "SPLITTER" - Splits documents into multiple parts

The type of processor:

• "CLASSIFY" - Classifies documents into categories
• "EXTRACT" - Extracts structured data from documents
• "SPLITTER" - Splits documents into multiple parts

Specified by:

type in interface ProcessorRun.TypeStage

Returns:

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

config

public ProcessorRun.UrlStage config(@NotNull
                                    ProcessorRunConfig config)

The configuration used for this processor run. The type of configuration will match the processor type.

The configuration used for this processor run. The type of configuration will match the processor type.

Specified by:

config in interface ProcessorRun.ConfigStage

Returns:

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

url

public ProcessorRun._FinalStage url(@NotNull
                                    java.lang.String url)

The URL to view the processor run.

The URL to view the processor run.

Specified by:

url in interface ProcessorRun.UrlStage

Returns:

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

addAllMergedProcessors

public ProcessorRun._FinalStage addAllMergedProcessors(java.util.List<ProcessorRunMergedProcessorsItem> mergedProcessors)

An array of processors that were merged to create this output. Will be an empty array unless this output was the result of a MergeExtraction step in a workflow.

Specified by:

addAllMergedProcessors in interface ProcessorRun._FinalStage

Returns:

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

addMergedProcessors

public ProcessorRun._FinalStage addMergedProcessors(ProcessorRunMergedProcessorsItem mergedProcessors)

An array of processors that were merged to create this output. Will be an empty array unless this output was the result of a MergeExtraction step in a workflow.

Specified by:

addMergedProcessors in interface ProcessorRun._FinalStage

Returns:

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

mergedProcessors

public ProcessorRun._FinalStage mergedProcessors(java.util.List<ProcessorRunMergedProcessorsItem> mergedProcessors)

An array of processors that were merged to create this output. Will be an empty array unless this output was the result of a MergeExtraction step in a workflow.

Specified by:

mergedProcessors in interface ProcessorRun._FinalStage

addAllFiles

public ProcessorRun._FinalStage addAllFiles(java.util.List<File> files)

Details of the processed files.

If this was a file generated from a splitter processor, this will be the sub file.

See the File object for more details.

Specified by:

addAllFiles in interface ProcessorRun._FinalStage

Returns:

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

addFiles

public ProcessorRun._FinalStage addFiles(File files)

Details of the processed files.

If this was a file generated from a splitter processor, this will be the sub file.

See the File object for more details.

Specified by:

addFiles in interface ProcessorRun._FinalStage

Returns:

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

files

public ProcessorRun._FinalStage files(java.util.List<File> files)

Details of the processed files.

If this was a file generated from a splitter processor, this will be the sub file.

See the File object for more details.

Specified by:

files in interface ProcessorRun._FinalStage

reviewedOutput

public ProcessorRun._FinalStage reviewedOutput(ProcessorOutput reviewedOutput)

The output after review, if any.

Specified by:

reviewedOutput in interface ProcessorRun._FinalStage

Returns:

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

reviewedOutput

public ProcessorRun._FinalStage reviewedOutput(java.util.Optional<ProcessorOutput> reviewedOutput)

The output after review, if any.

Specified by:

reviewedOutput in interface ProcessorRun._FinalStage

initialOutput

public ProcessorRun._FinalStage initialOutput(ProcessorOutput initialOutput)

The initial output from the processor run. The type of output will match the processor type.

Specified by:

initialOutput in interface ProcessorRun._FinalStage

Returns:

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

initialOutput

public ProcessorRun._FinalStage initialOutput(java.util.Optional<ProcessorOutput> initialOutput)

The initial output from the processor run. The type of output will match the processor type.

Specified by:

initialOutput in interface ProcessorRun._FinalStage

edits

public ProcessorRun._FinalStage edits(java.lang.String key,
                                      ExtractionOutputEdits value)

Specified by:

edits in interface ProcessorRun._FinalStage

putAllEdits

public ProcessorRun._FinalStage putAllEdits(java.util.Map<java.lang.String,ExtractionOutputEdits> edits)

Specified by:

putAllEdits in interface ProcessorRun._FinalStage

edits

public ProcessorRun._FinalStage edits(java.util.Map<java.lang.String,ExtractionOutputEdits> edits)

Specified by:

edits in interface ProcessorRun._FinalStage

metadata

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

Any metadata that was provided when creating the processor run.

Specified by:

metadata in interface ProcessorRun._FinalStage

Returns:

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

metadata

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

Any metadata that was provided when creating the processor run.

Specified by:

metadata in interface ProcessorRun._FinalStage

failureMessage

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

If the run failed, provides a detailed message about the failure.

Specified by:

failureMessage in interface ProcessorRun._FinalStage

Returns:

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

failureMessage

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

If the run failed, provides a detailed message about the failure.

Specified by:

failureMessage in interface ProcessorRun._FinalStage

failureReason

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

If the run failed, indicates the reason for failure.

Specified by:

failureReason in interface ProcessorRun._FinalStage

Returns:

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

failureReason

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

If the run failed, indicates the reason for failure.

Specified by:

failureReason in interface ProcessorRun._FinalStage

build

public ProcessorRun build()

Specified by:

build in interface ProcessorRun._FinalStage