Package ai.extend.types

Class ExtractorVersion

java.lang.Object

ai.extend.types.ExtractorVersion

public final class ExtractorVersion
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtractorVersion._FinalStage
static class	ExtractorVersion.Builder
static interface	ExtractorVersion.ConfigStage
static interface	ExtractorVersion.CreatedAtStage
static interface	ExtractorVersion.ExtractorIdStage
static interface	ExtractorVersion.IdStage
static interface	ExtractorVersion.VersionStage

Method Summary

Modifier and Type	Method	Description
static ExtractorVersion.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
ExtractConfig	getConfig()
java.time.OffsetDateTime	getCreatedAt()
java.util.Optional<java.lang.String>	getDescription()
java.lang.String	getExtractorId()
java.lang.String	getId()
java.lang.String	getObject()
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 object. Will always be "extractor_version".

getId

public java.lang.String getId()

Returns:

The unique identifier for this version of the extractor.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

getDescription

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

Returns:

A description of this version of the extractor.

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 extractor. The draft version will have version="draft".

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

getConfig

public ExtractConfig getConfig()

Returns:

The configuration settings for this version of the extractor. This is a union of two possible shapes:

• JSON Schema config: The current config format. All extractors created through this API version use this shape.
• Legacy config: A fields-array config from a previous API version. This shape is only returned for extractors that were originally configured with the legacy format. This API version does not support creating extractors with legacy configs.

getExtractorId

public java.lang.String getExtractorId()

Returns:

The ID of the extractor that this version belongs to.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

getCreatedAt

public java.time.OffsetDateTime getCreatedAt()

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 ExtractorVersion.IdStage builder()