Package ai.extend.types

Class LegacyExtractionField.Builder

java.lang.Object

ai.extend.types.LegacyExtractionField.Builder

All Implemented Interfaces:

LegacyExtractionField._FinalStage, LegacyExtractionField.DescriptionStage, LegacyExtractionField.IdStage, LegacyExtractionField.NameStage, LegacyExtractionField.TypeStage

Enclosing class:

LegacyExtractionField

public static final class LegacyExtractionField.Builder
extends java.lang.Object
implements LegacyExtractionField.IdStage, LegacyExtractionField.NameStage, LegacyExtractionField.TypeStage, LegacyExtractionField.DescriptionStage, LegacyExtractionField._FinalStage

Method Summary

Modifier and Type	Method	Description
LegacyExtractionField	build()
LegacyExtractionField._FinalStage	description(java.lang.String description)	Detailed description of the field, including expected content and format.
LegacyExtractionField._FinalStage	enum_(java.util.List<Enum> enum_)	Required when type is "enum".
LegacyExtractionField._FinalStage	enum_(java.util.Optional<java.util.List<Enum>> enum_)	Required when type is "enum".
LegacyExtractionField.Builder	from(LegacyExtractionField other)
LegacyExtractionField.NameStage	id(java.lang.String id)	Unique identifier for the field.
LegacyExtractionField.TypeStage	name(java.lang.String name)	Human-readable name for the field.
LegacyExtractionField._FinalStage	schema(java.util.List<LegacyExtractionField> schema)	Required when type is "array" or "object".
LegacyExtractionField._FinalStage	schema(java.util.Optional<java.util.List<LegacyExtractionField>> schema)	Required when type is "array" or "object".
LegacyExtractionField.DescriptionStage	type(LegacyExtractionFieldType type)	The type of the field.

Methods inherited from class java.lang.Object

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

Method Detail

from

public LegacyExtractionField.Builder from(LegacyExtractionField other)

Specified by:

from in interface LegacyExtractionField.IdStage

id

public LegacyExtractionField.NameStage id(@NotNull
                                          java.lang.String id)

Unique identifier for the field.

Unique identifier for the field.

Specified by:

id in interface LegacyExtractionField.IdStage

Returns:

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

name

public LegacyExtractionField.TypeStage name(@NotNull
                                            java.lang.String name)

Human-readable name for the field.

Human-readable name for the field.

Specified by:

name in interface LegacyExtractionField.NameStage

Returns:

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

type

public LegacyExtractionField.DescriptionStage type(@NotNull
                                                   LegacyExtractionFieldType type)

The type of the field.

The type of the field.

Specified by:

type in interface LegacyExtractionField.TypeStage

Returns:

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

description

public LegacyExtractionField._FinalStage description(@NotNull
                                                     java.lang.String description)

Detailed description of the field, including expected content and format.

Detailed description of the field, including expected content and format.

Specified by:

description in interface LegacyExtractionField.DescriptionStage

Returns:

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

enum_

public LegacyExtractionField._FinalStage enum_(java.util.List<Enum> enum_)

Required when type is "enum". List of allowed values.

Specified by:

enum_ in interface LegacyExtractionField._FinalStage

Returns:

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

enum_

public LegacyExtractionField._FinalStage enum_(java.util.Optional<java.util.List<Enum>> enum_)

Required when type is "enum". List of allowed values.

Specified by:

enum_ in interface LegacyExtractionField._FinalStage

schema

public LegacyExtractionField._FinalStage schema(java.util.List<LegacyExtractionField> schema)

Required when type is "array" or "object". Contains nested field definitions.

Specified by:

schema in interface LegacyExtractionField._FinalStage

Returns:

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

schema

public LegacyExtractionField._FinalStage schema(java.util.Optional<java.util.List<LegacyExtractionField>> schema)

Required when type is "array" or "object". Contains nested field definitions.

Specified by:

schema in interface LegacyExtractionField._FinalStage

build

public LegacyExtractionField build()

Specified by:

build in interface LegacyExtractionField._FinalStage