Package ai.extend.types

Class LegacyBatchProcessorRun.Builder

java.lang.Object

ai.extend.types.LegacyBatchProcessorRun.Builder

All Implemented Interfaces:

LegacyBatchProcessorRun._FinalStage, LegacyBatchProcessorRun.CreatedAtStage, LegacyBatchProcessorRun.IdStage, LegacyBatchProcessorRun.MetricsStage, LegacyBatchProcessorRun.ObjectStage, LegacyBatchProcessorRun.OptionsStage, LegacyBatchProcessorRun.ProcessorIdStage, LegacyBatchProcessorRun.ProcessorNameStage, LegacyBatchProcessorRun.ProcessorVersionIdStage, LegacyBatchProcessorRun.RunCountStage, LegacyBatchProcessorRun.SourceStage, LegacyBatchProcessorRun.StatusStage, LegacyBatchProcessorRun.UpdatedAtStage

Enclosing class:

LegacyBatchProcessorRun

public static final class LegacyBatchProcessorRun.Builder
extends java.lang.Object
implements LegacyBatchProcessorRun.ObjectStage, LegacyBatchProcessorRun.IdStage, LegacyBatchProcessorRun.ProcessorIdStage, LegacyBatchProcessorRun.ProcessorVersionIdStage, LegacyBatchProcessorRun.ProcessorNameStage, LegacyBatchProcessorRun.MetricsStage, LegacyBatchProcessorRun.StatusStage, LegacyBatchProcessorRun.SourceStage, LegacyBatchProcessorRun.RunCountStage, LegacyBatchProcessorRun.OptionsStage, LegacyBatchProcessorRun.CreatedAtStage, LegacyBatchProcessorRun.UpdatedAtStage, LegacyBatchProcessorRun._FinalStage

Method Summary

Modifier and Type	Method	Description
LegacyBatchProcessorRun	build()
LegacyBatchProcessorRun.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)	The time (in UTC) at which the batch processor run was created.
LegacyBatchProcessorRun.Builder	from(LegacyBatchProcessorRun other)
LegacyBatchProcessorRun.ProcessorIdStage	id(java.lang.String id)	The unique identifier for this batch processor run.
LegacyBatchProcessorRun.StatusStage	metrics(LegacyBatchProcessorRunMetrics metrics)
LegacyBatchProcessorRun.IdStage	object(java.lang.String object)	The type of response.
LegacyBatchProcessorRun.CreatedAtStage	options(LegacyBatchProcessorRunOptions options)	The options for the batch processor run.
LegacyBatchProcessorRun.ProcessorVersionIdStage	processorId(java.lang.String processorId)	The ID of the processor used for this run.
LegacyBatchProcessorRun.MetricsStage	processorName(java.lang.String processorName)	The name of the processor.
LegacyBatchProcessorRun.ProcessorNameStage	processorVersionId(java.lang.String processorVersionId)	The ID of the specific processor version used.
LegacyBatchProcessorRun.OptionsStage	runCount(int runCount)	The number of runs that were made.
LegacyBatchProcessorRun.RunCountStage	source(LegacyBatchProcessorRunSource source)	The source of the batch processor run:
LegacyBatchProcessorRun._FinalStage	sourceId(java.lang.String sourceId)	The ID of the source of the batch processor run.
LegacyBatchProcessorRun._FinalStage	sourceId(java.util.Optional<java.lang.String> sourceId)	The ID of the source of the batch processor run.
LegacyBatchProcessorRun.SourceStage	status(LegacyBatchProcessorRunStatus status)	The current status of the batch processor run:
LegacyBatchProcessorRun._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)	The time (in UTC) at which the batch processor run was last updated.

Methods inherited from class java.lang.Object

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

Method Detail

from

public LegacyBatchProcessorRun.Builder from(LegacyBatchProcessorRun other)

Specified by:

from in interface LegacyBatchProcessorRun.ObjectStage

object

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

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

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

Specified by:

object in interface LegacyBatchProcessorRun.ObjectStage

Returns:

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

id

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

The unique identifier for this batch processor run.

Example: "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"

The unique identifier for this batch processor run.

Example: "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

id in interface LegacyBatchProcessorRun.IdStage

Returns:

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

processorId

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

The ID of the processor used for this run.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

The ID of the processor used for this run.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

processorId in interface LegacyBatchProcessorRun.ProcessorIdStage

Returns:

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

processorVersionId

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

The ID of the specific processor version used.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

The ID of the specific processor version used.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

processorVersionId in interface LegacyBatchProcessorRun.ProcessorVersionIdStage

Returns:

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

processorName

public LegacyBatchProcessorRun.MetricsStage 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 LegacyBatchProcessorRun.ProcessorNameStage

Returns:

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

metrics

public LegacyBatchProcessorRun.StatusStage metrics(@NotNull
                                                   LegacyBatchProcessorRunMetrics metrics)

Specified by:

metrics in interface LegacyBatchProcessorRun.MetricsStage

status

public LegacyBatchProcessorRun.SourceStage status(@NotNull
                                                  LegacyBatchProcessorRunStatus status)

The current status of the batch processor run:

• "PENDING" - The batch processor run is waiting to start
• "PROCESSING" - The batch processor run is in progress
• "PROCESSED" - The batch processor run completed successfully
• "FAILED" - The batch processor run encountered an error

The current status of the batch processor run:

• "PENDING" - The batch processor run is waiting to start
• "PROCESSING" - The batch processor run is in progress
• "PROCESSED" - The batch processor run completed successfully
• "FAILED" - The batch processor run encountered an error

Specified by:

status in interface LegacyBatchProcessorRun.StatusStage

Returns:

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

source

public LegacyBatchProcessorRun.RunCountStage source(@NotNull
                                                    LegacyBatchProcessorRunSource source)

The source of the batch processor run:

• "EVAL_SET" - The batch processor run was made from an evaluation set. The sourceId will be the ID of the evaluation set (e.g., "ev_1234")
• "PLAYGROUND" - The batch processor run was made from the playground. The sourceId will not be set
• "STUDIO" - The batch processor run was made for a processor in Studio. The sourceId will be the ID of the processor (e.g., "ex_1234")

The source of the batch processor run:

• "EVAL_SET" - The batch processor run was made from an evaluation set. The sourceId will be the ID of the evaluation set (e.g., "ev_1234")
• "PLAYGROUND" - The batch processor run was made from the playground. The sourceId will not be set
• "STUDIO" - The batch processor run was made for a processor in Studio. The sourceId will be the ID of the processor (e.g., "ex_1234")

Specified by:

source in interface LegacyBatchProcessorRun.SourceStage

Returns:

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

runCount

public LegacyBatchProcessorRun.OptionsStage runCount(int runCount)

The number of runs that were made.

The number of runs that were made.

Specified by:

runCount in interface LegacyBatchProcessorRun.RunCountStage

Returns:

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

options

public LegacyBatchProcessorRun.CreatedAtStage options(@NotNull
                                                      LegacyBatchProcessorRunOptions options)

The options for the batch processor run.

The options for the batch processor run.

Specified by:

options in interface LegacyBatchProcessorRun.OptionsStage

Returns:

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

createdAt

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

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

Example: "2024-03-21T15:30:00Z"

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

Example: "2024-03-21T15:30:00Z"

Specified by:

createdAt in interface LegacyBatchProcessorRun.CreatedAtStage

Returns:

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

updatedAt

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

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

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

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

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

Specified by:

updatedAt in interface LegacyBatchProcessorRun.UpdatedAtStage

Returns:

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

sourceId

public LegacyBatchProcessorRun._FinalStage sourceId(java.lang.String sourceId)

The ID of the source of the batch processor run. See the source field for more details. Example: "ev_1234" for EVAL_SET source, "ex_1234" for STUDIO source

Specified by:

sourceId in interface LegacyBatchProcessorRun._FinalStage

Returns:

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

sourceId

public LegacyBatchProcessorRun._FinalStage sourceId(java.util.Optional<java.lang.String> sourceId)

The ID of the source of the batch processor run. See the source field for more details. Example: "ev_1234" for EVAL_SET source, "ex_1234" for STUDIO source

Specified by:

sourceId in interface LegacyBatchProcessorRun._FinalStage

build

public LegacyBatchProcessorRun build()

Specified by:

build in interface LegacyBatchProcessorRun._FinalStage