Package ai.extend.types

Class LegacyProcessorVersion.Builder

java.lang.Object

ai.extend.types.LegacyProcessorVersion.Builder

All Implemented Interfaces:

LegacyProcessorVersion._FinalStage, LegacyProcessorVersion.ConfigStage, LegacyProcessorVersion.CreatedAtStage, LegacyProcessorVersion.IdStage, LegacyProcessorVersion.ObjectStage, LegacyProcessorVersion.ProcessorIdStage, LegacyProcessorVersion.ProcessorTypeStage, LegacyProcessorVersion.UpdatedAtStage, LegacyProcessorVersion.VersionStage

Enclosing class:

LegacyProcessorVersion

public static final class LegacyProcessorVersion.Builder
extends java.lang.Object
implements LegacyProcessorVersion.ObjectStage, LegacyProcessorVersion.IdStage, LegacyProcessorVersion.ProcessorIdStage, LegacyProcessorVersion.ProcessorTypeStage, LegacyProcessorVersion.VersionStage, LegacyProcessorVersion.ConfigStage, LegacyProcessorVersion.CreatedAtStage, LegacyProcessorVersion.UpdatedAtStage, LegacyProcessorVersion._FinalStage

Method Summary

Modifier and Type	Method	Description
LegacyProcessorVersion	build()
LegacyProcessorVersion.CreatedAtStage	config(LegacyProcessorVersionConfig config)	The configuration settings for this version of the document processor.
LegacyProcessorVersion.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)	The time (in UTC) at which this version of the document processor was created.
LegacyProcessorVersion._FinalStage	description(java.lang.String description)	An optional description of this version of the document processor.
LegacyProcessorVersion._FinalStage	description(java.util.Optional<java.lang.String> description)	An optional description of this version of the document processor.
LegacyProcessorVersion.Builder	from(LegacyProcessorVersion other)
LegacyProcessorVersion.ProcessorIdStage	id(java.lang.String id)	The unique identifier for this version of the document processor.
LegacyProcessorVersion.IdStage	object(java.lang.String object)	The type of the object.
LegacyProcessorVersion.ProcessorTypeStage	processorId(java.lang.String processorId)	The ID of the parent document processor.
LegacyProcessorVersion._FinalStage	processorName(java.lang.String processorName)	The name of the parent document processor.
LegacyProcessorVersion._FinalStage	processorName(java.util.Optional<java.lang.String> processorName)	The name of the parent document processor.
LegacyProcessorVersion.VersionStage	processorType(LegacyProcessorType processorType)
LegacyProcessorVersion._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)	The time (in UTC) at which this version of the document processor was last updated.
LegacyProcessorVersion.ConfigStage	version(java.lang.String version)	The version number or identifier for this specific version of the document processor.

Methods inherited from class java.lang.Object

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

Method Detail

from

public LegacyProcessorVersion.Builder from(LegacyProcessorVersion other)

Specified by:

from in interface LegacyProcessorVersion.ObjectStage

object

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

The type of the object. In this case, it will always be "document_processor_version".

The type of the object. In this case, it will always be "document_processor_version".

Specified by:

object in interface LegacyProcessorVersion.ObjectStage

Returns:

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

id

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

The unique identifier for this version of the document processor.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

The unique identifier for this version of the document processor.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface LegacyProcessorVersion.IdStage

Returns:

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

processorId

public LegacyProcessorVersion.ProcessorTypeStage processorId(@NotNull
                                                             java.lang.String processorId)

The ID of the parent document processor.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

The ID of the parent document processor.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

processorId in interface LegacyProcessorVersion.ProcessorIdStage

Returns:

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

processorType

public LegacyProcessorVersion.VersionStage processorType(@NotNull
                                                         LegacyProcessorType processorType)

Specified by:

processorType in interface LegacyProcessorVersion.ProcessorTypeStage

version

public LegacyProcessorVersion.ConfigStage version(@NotNull
                                                  java.lang.String version)

The version number or identifier for this specific version of the document processor. The draft version will have version="draft".

Examples: "1.0", "2.1", "draft"

The version number or identifier for this specific version of the document processor. The draft version will have version="draft".

Examples: "1.0", "2.1", "draft"

Specified by:

version in interface LegacyProcessorVersion.VersionStage

Returns:

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

config

public LegacyProcessorVersion.CreatedAtStage config(@NotNull
                                                    LegacyProcessorVersionConfig config)

The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.

See the configuration section in the "Guides" tab, for yout specific processor type, for more details on the configuration settings.

The configuration settings for this version of the document processor. The structure of this object will vary depending on the processor type.

See the configuration section in the "Guides" tab, for yout specific processor type, for more details on the configuration settings.

Specified by:

config in interface LegacyProcessorVersion.ConfigStage

Returns:

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

createdAt

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

The time (in UTC) at which this version of the document processor was created. Will follow the RFC 3339 format.

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

The time (in UTC) at which this version of the document processor was created. Will follow the RFC 3339 format.

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

Specified by:

createdAt in interface LegacyProcessorVersion.CreatedAtStage

Returns:

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

updatedAt

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

The time (in UTC) at which this version of the document processor was last updated. Will follow the RFC 3339 format.

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

The time (in UTC) at which this version of the document processor was last updated. Will follow the RFC 3339 format.

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

Specified by:

updatedAt in interface LegacyProcessorVersion.UpdatedAtStage

Returns:

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

description

public LegacyProcessorVersion._FinalStage description(java.lang.String description)

An optional description of this version of the document processor.

Example: "Updated extraction fields for new invoice format"

Specified by:

description in interface LegacyProcessorVersion._FinalStage

Returns:

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

description

public LegacyProcessorVersion._FinalStage description(java.util.Optional<java.lang.String> description)

An optional description of this version of the document processor.

Example: "Updated extraction fields for new invoice format"

Specified by:

description in interface LegacyProcessorVersion._FinalStage

processorName

public LegacyProcessorVersion._FinalStage processorName(java.lang.String processorName)

The name of the parent document processor.

Example: "Invoice Processor"

Specified by:

processorName in interface LegacyProcessorVersion._FinalStage

Returns:

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

processorName

public LegacyProcessorVersion._FinalStage processorName(java.util.Optional<java.lang.String> processorName)

The name of the parent document processor.

Example: "Invoice Processor"

Specified by:

processorName in interface LegacyProcessorVersion._FinalStage

build

public LegacyProcessorVersion build()

Specified by:

build in interface LegacyProcessorVersion._FinalStage