com.box.sdkgen.schemas.aiextractstructured

Class AiExtractStructured

Object

NullableFieldTracker

SerializableObject

AiExtractStructured

All Implemented Interfaces:

Serializable

public class AiExtractStructured
extends SerializableObject

AI Extract Structured Request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AiExtractStructured.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected AiExtractStructuredAgent	aiAgent
protected List<AiExtractStructuredFieldsField>	fields The fields to be extracted from the provided items.
protected Boolean	includeConfidenceScore A flag to indicate whether confidence scores for every extracted field should be returned.
protected Boolean	includeReference A flag to indicate whether references for every extracted field should be returned.
protected List<AiItemBase>	items The items to be processed by the LLM.
protected AiExtractStructuredMetadataTemplateField	metadataTemplate The metadata template containing the fields to extract.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AiExtractStructured(AiExtractStructured.Builder builder)
	AiExtractStructured(List<AiItemBase> items)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
AiExtractStructuredAgent	getAiAgent()
List<AiExtractStructuredFieldsField>	getFields()
Boolean	getIncludeConfidenceScore()
Boolean	getIncludeReference()
List<AiItemBase>	getItems()
AiExtractStructuredMetadataTemplateField	getMetadataTemplate()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

items

protected final List<AiItemBase> items

The items to be processed by the LLM. Currently you can use files only.

metadataTemplate

protected AiExtractStructuredMetadataTemplateField metadataTemplate

The metadata template containing the fields to extract. For your request to work, you must provide either `metadata_template` or `fields`, but not both.

fields

protected List<AiExtractStructuredFieldsField> fields

The fields to be extracted from the provided items. For your request to work, you must provide either `metadata_template` or `fields`, but not both.

aiAgent

protected AiExtractStructuredAgent aiAgent

includeConfidenceScore

protected Boolean includeConfidenceScore

A flag to indicate whether confidence scores for every extracted field should be returned.

includeReference

protected Boolean includeReference

A flag to indicate whether references for every extracted field should be returned.

Constructor Detail

AiExtractStructured

public AiExtractStructured(List<AiItemBase> items)

AiExtractStructured

protected AiExtractStructured(AiExtractStructured.Builder builder)

Method Detail

getItems

public List<AiItemBase> getItems()

getMetadataTemplate

public AiExtractStructuredMetadataTemplateField getMetadataTemplate()

getFields

public List<AiExtractStructuredFieldsField> getFields()

getAiAgent

public AiExtractStructuredAgent getAiAgent()

getIncludeConfidenceScore

public Boolean getIncludeConfidenceScore()

getIncludeReference

public Boolean getIncludeReference()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object