Package ai.extend.types

Class ExtractionField.Builder

java.lang.Object

ai.extend.types.ExtractionField.Builder

All Implemented Interfaces:

ExtractionField._FinalStage, ExtractionField.DescriptionStage, ExtractionField.IdStage, ExtractionField.NameStage, ExtractionField.TypeStage

Enclosing class:

ExtractionField

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

Method Summary

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

Specified by:

from in interface ExtractionField.IdStage

id

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

Unique identifier for the field.

Unique identifier for the field.

Specified by:

id in interface ExtractionField.IdStage

Returns:

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

name

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

Human-readable name for the field.

Human-readable name for the field.

Specified by:

name in interface ExtractionField.NameStage

Returns:

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

type

public ExtractionField.DescriptionStage type(@NotNull
                                             ExtractionFieldType type)

The type of the field.

The type of the field.

Specified by:

type in interface ExtractionField.TypeStage

Returns:

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

description

public ExtractionField._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 ExtractionField.DescriptionStage

Returns:

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

enum_

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

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

Specified by:

enum_ in interface ExtractionField._FinalStage

Returns:

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

enum_

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

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

Specified by:

enum_ in interface ExtractionField._FinalStage

schema

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

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

Specified by:

schema in interface ExtractionField._FinalStage

Returns:

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

schema

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

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

Specified by:

schema in interface ExtractionField._FinalStage

build

public ExtractionField build()

Specified by:

build in interface ExtractionField._FinalStage