Package ai.extend.types

Class ExtractionFieldResult.Builder

java.lang.Object

ai.extend.types.ExtractionFieldResult.Builder

All Implemented Interfaces:

ExtractionFieldResult._FinalStage, ExtractionFieldResult.IdStage, ExtractionFieldResult.TypeStage, ExtractionFieldResult.ValueStage

Enclosing class:

ExtractionFieldResult

public static final class ExtractionFieldResult.Builder
extends java.lang.Object
implements ExtractionFieldResult.IdStage, ExtractionFieldResult.TypeStage, ExtractionFieldResult.ValueStage, ExtractionFieldResult._FinalStage

Method Summary

Modifier and Type	Method	Description
ExtractionFieldResult._FinalStage	addAllReferences(java.util.List<ExtractionFieldResultReference> references)	References for the extracted field
ExtractionFieldResult._FinalStage	addReferences(ExtractionFieldResultReference references)	References for the extracted field
ExtractionFieldResult	build()
ExtractionFieldResult._FinalStage	confidence(java.lang.Double confidence)	A value between 0 and 1 indicating confidence in the extraction
ExtractionFieldResult._FinalStage	confidence(java.util.Optional<java.lang.Double> confidence)	A value between 0 and 1 indicating confidence in the extraction
ExtractionFieldResult._FinalStage	enum_(java.util.List<EnumOption> enum_)	The enum options for enum fields, only set when type=enum
ExtractionFieldResult._FinalStage	enum_(java.util.Optional<java.util.List<EnumOption>> enum_)	The enum options for enum fields, only set when type=enum
ExtractionFieldResult.Builder	from(ExtractionFieldResult other)
ExtractionFieldResult.TypeStage	id(java.lang.String id)	The unique identifier for this field
ExtractionFieldResult._FinalStage	insights(java.util.List<Insight> insights)	Reasoning and other insights from the model
ExtractionFieldResult._FinalStage	insights(java.util.Optional<java.util.List<Insight>> insights)	Reasoning and other insights from the model
ExtractionFieldResult._FinalStage	references(java.util.List<ExtractionFieldResultReference> references)	References for the extracted field
ExtractionFieldResult._FinalStage	schema(java.util.List<ExtractionField> schema)	The field schema of nested fields
ExtractionFieldResult._FinalStage	schema(java.util.Optional<java.util.List<ExtractionField>> schema)	The field schema of nested fields
ExtractionFieldResult.ValueStage	type(ExtractionFieldResultType type)	The type of the extracted field
ExtractionFieldResult._FinalStage	value(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Method Detail

from

public ExtractionFieldResult.Builder from(ExtractionFieldResult other)

Specified by:

from in interface ExtractionFieldResult.IdStage

id

public ExtractionFieldResult.TypeStage id(@NotNull
                                          java.lang.String id)

The unique identifier for this field

The unique identifier for this field

Specified by:

id in interface ExtractionFieldResult.IdStage

Returns:

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

type

public ExtractionFieldResult.ValueStage type(@NotNull
                                             ExtractionFieldResultType type)

The type of the extracted field

The type of the extracted field

Specified by:

type in interface ExtractionFieldResult.TypeStage

Returns:

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

value

public ExtractionFieldResult._FinalStage value(java.lang.Object value)

Specified by:

value in interface ExtractionFieldResult.ValueStage

enum_

public ExtractionFieldResult._FinalStage enum_(java.util.List<EnumOption> enum_)

The enum options for enum fields, only set when type=enum

Specified by:

enum_ in interface ExtractionFieldResult._FinalStage

Returns:

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

enum_

public ExtractionFieldResult._FinalStage enum_(java.util.Optional<java.util.List<EnumOption>> enum_)

The enum options for enum fields, only set when type=enum

Specified by:

enum_ in interface ExtractionFieldResult._FinalStage

addAllReferences

public ExtractionFieldResult._FinalStage addAllReferences(java.util.List<ExtractionFieldResultReference> references)

References for the extracted field

Specified by:

addAllReferences in interface ExtractionFieldResult._FinalStage

Returns:

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

addReferences

public ExtractionFieldResult._FinalStage addReferences(ExtractionFieldResultReference references)

References for the extracted field

Specified by:

addReferences in interface ExtractionFieldResult._FinalStage

Returns:

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

references

public ExtractionFieldResult._FinalStage references(java.util.List<ExtractionFieldResultReference> references)

References for the extracted field

Specified by:

references in interface ExtractionFieldResult._FinalStage

insights

public ExtractionFieldResult._FinalStage insights(java.util.List<Insight> insights)

Reasoning and other insights from the model

Specified by:

insights in interface ExtractionFieldResult._FinalStage

Returns:

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

insights

public ExtractionFieldResult._FinalStage insights(java.util.Optional<java.util.List<Insight>> insights)

Reasoning and other insights from the model

Specified by:

insights in interface ExtractionFieldResult._FinalStage

schema

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

The field schema of nested fields

Specified by:

schema in interface ExtractionFieldResult._FinalStage

Returns:

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

schema

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

The field schema of nested fields

Specified by:

schema in interface ExtractionFieldResult._FinalStage

confidence

public ExtractionFieldResult._FinalStage confidence(java.lang.Double confidence)

A value between 0 and 1 indicating confidence in the extraction

Specified by:

confidence in interface ExtractionFieldResult._FinalStage

Returns:

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

confidence

public ExtractionFieldResult._FinalStage confidence(java.util.Optional<java.lang.Double> confidence)

A value between 0 and 1 indicating confidence in the extraction

Specified by:

confidence in interface ExtractionFieldResult._FinalStage

build

public ExtractionFieldResult build()

Specified by:

build in interface ExtractionFieldResult._FinalStage