com.box.sdkgen.schemas.aiextractsubfield

Class AiExtractSubField

Object

NullableFieldTracker

SerializableObject

AiExtractSubField

All Implemented Interfaces:

Serializable

public class AiExtractSubField
extends SerializableObject

A nested field definition for structured and table field types used in AI extraction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AiExtractSubField.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description A description of the nested field.
protected String	displayName The display name of the nested field.
protected String	key A unique identifier for the nested field.
protected List<AiExtractFieldOption>	options A list of options for this nested field.
protected String	prompt Context about the nested field that may include how to find and how to format it.
protected String	type The type of the nested field.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AiExtractSubField(AiExtractSubField.Builder builder)
	AiExtractSubField(String key)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getDisplayName()
String	getKey()
List<AiExtractFieldOption>	getOptions()
String	getPrompt()
String	getType()
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

key

protected final String key

A unique identifier for the nested field.

description

protected String description

A description of the nested field.

displayName

protected String displayName

The display name of the nested field.

prompt

protected String prompt

Context about the nested field that may include how to find and how to format it.

type

protected String type

The type of the nested field. Allowed types include `string`, `float`, `date`, `number`, `text`, `boolean`, `enum` and `multiSelect`.

options

protected List<AiExtractFieldOption> options

A list of options for this nested field. Used with `enum` and `multiSelect` types.

Constructor Detail

AiExtractSubField

public AiExtractSubField(String key)

AiExtractSubField

protected AiExtractSubField(AiExtractSubField.Builder builder)

Method Detail

getKey

public String getKey()

getDescription

public String getDescription()

getDisplayName

public String getDisplayName()

getPrompt

public String getPrompt()

getType

public String getType()

getOptions

public List<AiExtractFieldOption> getOptions()

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