Package ai.extend.types

Class ProcessorRunSummary.Builder

java.lang.Object

ai.extend.types.ProcessorRunSummary.Builder

All Implemented Interfaces:

ProcessorRunSummary._FinalStage, ProcessorRunSummary.CreatedAtStage, ProcessorRunSummary.IdStage, ProcessorRunSummary.ProcessorIdStage, ProcessorRunSummary.ProcessorNameStage, ProcessorRunSummary.ProcessorVersionIdStage, ProcessorRunSummary.StatusStage, ProcessorRunSummary.UpdatedAtStage

Enclosing class:

ProcessorRunSummary

public static final class ProcessorRunSummary.Builder
extends java.lang.Object
implements ProcessorRunSummary.IdStage, ProcessorRunSummary.StatusStage, ProcessorRunSummary.ProcessorIdStage, ProcessorRunSummary.ProcessorNameStage, ProcessorRunSummary.ProcessorVersionIdStage, ProcessorRunSummary.CreatedAtStage, ProcessorRunSummary.UpdatedAtStage, ProcessorRunSummary._FinalStage

Method Summary

Modifier and Type	Method	Description
ProcessorRunSummary	build()
ProcessorRunSummary.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)	The time (in UTC) at which the processor run was created.
ProcessorRunSummary.Builder	from(ProcessorRunSummary other)
ProcessorRunSummary.StatusStage	id(java.lang.String id)	The ID of the processor run.
ProcessorRunSummary.ProcessorNameStage	processorId(java.lang.String processorId)	The ID of the processor that was run.
ProcessorRunSummary.ProcessorVersionIdStage	processorName(java.lang.String processorName)	The name of the processor that was run.
ProcessorRunSummary.CreatedAtStage	processorVersionId(java.lang.String processorVersionId)	The ID of the processor version that was run.
ProcessorRunSummary.ProcessorIdStage	status(ProcessorStatus status)
ProcessorRunSummary._FinalStage	type(ProcessorRunSummaryType type)	The type of processor that was run:
ProcessorRunSummary._FinalStage	type(java.util.Optional<ProcessorRunSummaryType> type)	The type of processor that was run:
ProcessorRunSummary._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)	The time (in UTC) at which the processor run was last updated.
ProcessorRunSummary._FinalStage	usage(DocumentProcessorRunCredits usage)
ProcessorRunSummary._FinalStage	usage(java.util.Optional<DocumentProcessorRunCredits> usage)

Methods inherited from class java.lang.Object

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

Method Detail

from

public ProcessorRunSummary.Builder from(ProcessorRunSummary other)

Specified by:

from in interface ProcessorRunSummary.IdStage

id

public ProcessorRunSummary.StatusStage id(@NotNull
                                          java.lang.String id)

The ID of the processor run.

Example: "dpr_Zk9mNP12Qw4-yTv8BdR3H"

The ID of the processor run.

Example: "dpr_Zk9mNP12Qw4-yTv8BdR3H"

Specified by:

id in interface ProcessorRunSummary.IdStage

Returns:

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

status

public ProcessorRunSummary.ProcessorIdStage status(@NotNull
                                                   ProcessorStatus status)

Specified by:

status in interface ProcessorRunSummary.StatusStage

processorId

public ProcessorRunSummary.ProcessorNameStage processorId(@NotNull
                                                          java.lang.String processorId)

The ID of the processor that was run. Will always start with "dp_".

Example: "dp_BMdfq_yWM3sT-ZzvCnA3f"

The ID of the processor that was run. Will always start with "dp_".

Example: "dp_BMdfq_yWM3sT-ZzvCnA3f"

Specified by:

processorId in interface ProcessorRunSummary.ProcessorIdStage

Returns:

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

processorName

public ProcessorRunSummary.ProcessorVersionIdStage processorName(@NotNull
                                                                 java.lang.String processorName)

The name of the processor that was run.

Example: "Invoice Extractor"

The name of the processor that was run.

Example: "Invoice Extractor"

Specified by:

processorName in interface ProcessorRunSummary.ProcessorNameStage

Returns:

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

processorVersionId

public ProcessorRunSummary.CreatedAtStage processorVersionId(@NotNull
                                                             java.lang.String processorVersionId)

The ID of the processor version that was run. Will always start with "dpv_".

Example: "dpv_Zk9mNP12Qw4-yTv8BdR3H"

The ID of the processor version that was run. Will always start with "dpv_".

Example: "dpv_Zk9mNP12Qw4-yTv8BdR3H"

Specified by:

processorVersionId in interface ProcessorRunSummary.ProcessorVersionIdStage

Returns:

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

createdAt

public ProcessorRunSummary.UpdatedAtStage createdAt(@NotNull
                                                    java.time.OffsetDateTime createdAt)

The time (in UTC) at which the processor run was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:29:55Z"

The time (in UTC) at which the processor run was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:29:55Z"

Specified by:

createdAt in interface ProcessorRunSummary.CreatedAtStage

Returns:

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

updatedAt

public ProcessorRunSummary._FinalStage updatedAt(@NotNull
                                                 java.time.OffsetDateTime updatedAt)

The time (in UTC) at which the processor run was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

The time (in UTC) at which the processor run was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

Specified by:

updatedAt in interface ProcessorRunSummary.UpdatedAtStage

Returns:

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

usage

public ProcessorRunSummary._FinalStage usage(DocumentProcessorRunCredits usage)

Specified by:

usage in interface ProcessorRunSummary._FinalStage

usage

public ProcessorRunSummary._FinalStage usage(java.util.Optional<DocumentProcessorRunCredits> usage)

Specified by:

usage in interface ProcessorRunSummary._FinalStage

type

public ProcessorRunSummary._FinalStage type(ProcessorRunSummaryType type)

The type of processor that was run:

• "EXTRACT" - Extraction processor
• "SPLITTER" - Splitting processor
• "CLASSIFY" - Classification processor

Specified by:

type in interface ProcessorRunSummary._FinalStage

Returns:

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

type

public ProcessorRunSummary._FinalStage type(java.util.Optional<ProcessorRunSummaryType> type)

The type of processor that was run:

• "EXTRACT" - Extraction processor
• "SPLITTER" - Splitting processor
• "CLASSIFY" - Classification processor

Specified by:

type in interface ProcessorRunSummary._FinalStage

build

public ProcessorRunSummary build()

Specified by:

build in interface ProcessorRunSummary._FinalStage