Package ai.extend.types

Class ProcessorVersion

java.lang.Object

ai.extend.types.ProcessorVersion

public final class ProcessorVersion
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProcessorVersion._FinalStage
static class	ProcessorVersion.Builder
static interface	ProcessorVersion.ConfigStage
static interface	ProcessorVersion.CreatedAtStage
static interface	ProcessorVersion.IdStage
static interface	ProcessorVersion.ObjectStage
static interface	ProcessorVersion.ProcessorIdStage
static interface	ProcessorVersion.ProcessorTypeStage
static interface	ProcessorVersion.UpdatedAtStage
static interface	ProcessorVersion.VersionStage

Method Summary

Modifier and Type	Method	Description
static ProcessorVersion.ObjectStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
ProcessorVersionConfig	getConfig()
java.time.OffsetDateTime	getCreatedAt()
java.util.Optional<java.lang.String>	getDescription()
java.lang.String	getId()
java.lang.String	getObject()
java.lang.String	getProcessorId()
java.util.Optional<java.lang.String>	getProcessorName()
ProcessorType	getProcessorType()
java.time.OffsetDateTime	getUpdatedAt()
java.lang.String	getVersion()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getObject

public java.lang.String getObject()

Returns:

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

getId

public java.lang.String getId()

Returns:

The unique identifier for this version of the document processor.

Example: "dpv_xK9mLPqRtN3vS8wF5hB2cQ"

getProcessorId

public java.lang.String getProcessorId()

Returns:

The ID of the parent document processor.

Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"

getProcessorName

public java.util.Optional<java.lang.String> getProcessorName()

Returns:

The name of the parent document processor.

Example: "Invoice Processor"

getProcessorType

public ProcessorType getProcessorType()

getDescription

public java.util.Optional<java.lang.String> getDescription()

Returns:

An optional description of this version of the document processor.

Example: "Updated extraction fields for new invoice format"

getVersion

public java.lang.String getVersion()

Returns:

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"

getConfig

public ProcessorVersionConfig getConfig()

Returns:

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.

getCreatedAt

public java.time.OffsetDateTime getCreatedAt()

Returns:

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"

getUpdatedAt

public java.time.OffsetDateTime getUpdatedAt()

Returns:

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"

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ProcessorVersion.ObjectStage builder()