Package ai.extend.types

Class ExtractorVersion.Builder

java.lang.Object

ai.extend.types.ExtractorVersion.Builder

All Implemented Interfaces:

ExtractorVersion._FinalStage, ExtractorVersion.ConfigStage, ExtractorVersion.CreatedAtStage, ExtractorVersion.ExtractorIdStage, ExtractorVersion.IdStage, ExtractorVersion.VersionStage

Enclosing class:

ExtractorVersion

public static final class ExtractorVersion.Builder
extends java.lang.Object
implements ExtractorVersion.IdStage, ExtractorVersion.VersionStage, ExtractorVersion.ConfigStage, ExtractorVersion.ExtractorIdStage, ExtractorVersion.CreatedAtStage, ExtractorVersion._FinalStage

Method Summary

Modifier and Type	Method	Description
ExtractorVersion	build()
ExtractorVersion.ExtractorIdStage	config(ExtractConfig config)	The configuration settings for this version of the extractor.
ExtractorVersion._FinalStage	createdAt(java.time.OffsetDateTime createdAt)
ExtractorVersion._FinalStage	description(Nullable<java.lang.String> description)	A description of this version of the extractor.
ExtractorVersion._FinalStage	description(java.lang.String description)	A description of this version of the extractor.
ExtractorVersion._FinalStage	description(java.util.Optional<java.lang.String> description)	A description of this version of the extractor.
ExtractorVersion.CreatedAtStage	extractorId(java.lang.String extractorId)	The ID of the extractor that this version belongs to.
ExtractorVersion.Builder	from(ExtractorVersion other)
ExtractorVersion.VersionStage	id(java.lang.String id)	The unique identifier for this version of the extractor.
ExtractorVersion.ConfigStage	version(java.lang.String version)	The version number or identifier for this specific version of the extractor.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ExtractorVersion.Builder from(ExtractorVersion other)

Specified by:

from in interface ExtractorVersion.IdStage

id

public ExtractorVersion.VersionStage id(@NotNull
                                        java.lang.String id)

The unique identifier for this version of the extractor.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

The unique identifier for this version of the extractor.

Example: "exv_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface ExtractorVersion.IdStage

Returns:

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

version

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

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"

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"

Specified by:

version in interface ExtractorVersion.VersionStage

Returns:

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

config

public ExtractorVersion.ExtractorIdStage config(@NotNull
                                                ExtractConfig config)

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.

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.

Specified by:

config in interface ExtractorVersion.ConfigStage

Returns:

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

extractorId

public ExtractorVersion.CreatedAtStage extractorId(@NotNull
                                                   java.lang.String extractorId)

The ID of the extractor that this version belongs to.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

The ID of the extractor that this version belongs to.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

Specified by:

extractorId in interface ExtractorVersion.ExtractorIdStage

Returns:

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

createdAt

public ExtractorVersion._FinalStage createdAt(@NotNull
                                              java.time.OffsetDateTime createdAt)

Specified by:

createdAt in interface ExtractorVersion.CreatedAtStage

description

public ExtractorVersion._FinalStage description(Nullable<java.lang.String> description)

A description of this version of the extractor.

Example: "Updated extraction fields for new invoice format"

Specified by:

description in interface ExtractorVersion._FinalStage

Returns:

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

description

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

A description of this version of the extractor.

Example: "Updated extraction fields for new invoice format"

Specified by:

description in interface ExtractorVersion._FinalStage

Returns:

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

description

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

A description of this version of the extractor.

Example: "Updated extraction fields for new invoice format"

Specified by:

description in interface ExtractorVersion._FinalStage

build

public ExtractorVersion build()

Specified by:

build in interface ExtractorVersion._FinalStage