Package ai.extend.types

Class ProvidedExtractionFieldResult.Builder

java.lang.Object

ai.extend.types.ProvidedExtractionFieldResult.Builder

All Implemented Interfaces:

ProvidedExtractionFieldResult._FinalStage, ProvidedExtractionFieldResult.IdStage, ProvidedExtractionFieldResult.ValueStage

Enclosing class:

ProvidedExtractionFieldResult

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

Method Summary

Modifier and Type	Method	Description
ProvidedExtractionFieldResult	build()
ProvidedExtractionFieldResult._FinalStage	confidence(java.lang.Double confidence)	A value between 0 and 1 indicating confidence in the extraction.
ProvidedExtractionFieldResult._FinalStage	confidence(java.util.Optional<java.lang.Double> confidence)	A value between 0 and 1 indicating confidence in the extraction.
ProvidedExtractionFieldResult.Builder	from(ProvidedExtractionFieldResult other)
ProvidedExtractionFieldResult.ValueStage	id(java.lang.String id)	The unique identifier for this field
ProvidedExtractionFieldResult._FinalStage	page(java.lang.Double page)	The page number where this field was extracted from
ProvidedExtractionFieldResult._FinalStage	page(java.util.Optional<java.lang.Double> page)	The page number where this field was extracted from
ProvidedExtractionFieldResult._FinalStage	type(ProvidedExtractionFieldResultType type)	The type of the extraction field result
ProvidedExtractionFieldResult._FinalStage	type(java.util.Optional<ProvidedExtractionFieldResultType> type)	The type of the extraction field result
ProvidedExtractionFieldResult._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 ProvidedExtractionFieldResult.Builder from(ProvidedExtractionFieldResult other)

Specified by:

from in interface ProvidedExtractionFieldResult.IdStage

id

public ProvidedExtractionFieldResult.ValueStage id(@NotNull
                                                   java.lang.String id)

The unique identifier for this field

The unique identifier for this field

Specified by:

id in interface ProvidedExtractionFieldResult.IdStage

Returns:

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

value

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

Specified by:

value in interface ProvidedExtractionFieldResult.ValueStage

page

public ProvidedExtractionFieldResult._FinalStage page(java.lang.Double page)

The page number where this field was extracted from

Specified by:

page in interface ProvidedExtractionFieldResult._FinalStage

Returns:

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

page

public ProvidedExtractionFieldResult._FinalStage page(java.util.Optional<java.lang.Double> page)

The page number where this field was extracted from

Specified by:

page in interface ProvidedExtractionFieldResult._FinalStage

confidence

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

A value between 0 and 1 indicating confidence in the extraction. Will be set to 1 if not provided.

Specified by:

confidence in interface ProvidedExtractionFieldResult._FinalStage

Returns:

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

confidence

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

A value between 0 and 1 indicating confidence in the extraction. Will be set to 1 if not provided.

Specified by:

confidence in interface ProvidedExtractionFieldResult._FinalStage

type

public ProvidedExtractionFieldResult._FinalStage type(ProvidedExtractionFieldResultType type)

The type of the extraction field result

Specified by:

type in interface ProvidedExtractionFieldResult._FinalStage

Returns:

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

type

public ProvidedExtractionFieldResult._FinalStage type(java.util.Optional<ProvidedExtractionFieldResultType> type)

The type of the extraction field result

Specified by:

type in interface ProvidedExtractionFieldResult._FinalStage

build

public ProvidedExtractionFieldResult build()

Specified by:

build in interface ProvidedExtractionFieldResult._FinalStage