com.box.sdkgen.schemas.aiask

Class AiAsk

Object

NullableFieldTracker

SerializableObject

AiAsk

All Implemented Interfaces:

Serializable

public class AiAsk
extends SerializableObject

AI ask request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AiAsk.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected AiAskAgent	aiAgent
protected List<AiDialogueHistory>	dialogueHistory The history of prompts and answers previously passed to the LLM.
protected Boolean	includeCitations A flag to indicate whether citations should be returned.
protected List<AiItemAsk>	items The items to be processed by the LLM, often files.
protected EnumWrapper<AiAskModeField>	mode Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.
protected String	prompt The prompt provided by the client to be answered by the LLM.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AiAsk(AiAsk.Builder builder)
	AiAsk(AiAskModeField mode, String prompt, List<AiItemAsk> items)
	AiAsk(EnumWrapper<AiAskModeField> mode, String prompt, List<AiItemAsk> items)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
AiAskAgent	getAiAgent()
List<AiDialogueHistory>	getDialogueHistory()
Boolean	getIncludeCitations()
List<AiItemAsk>	getItems()
EnumWrapper<AiAskModeField>	getMode()
String	getPrompt()
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

mode

protected final EnumWrapper<AiAskModeField> mode

Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.

prompt

protected final String prompt

The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.

items

protected final List<AiItemAsk> items

The items to be processed by the LLM, often files.

dialogueHistory

protected List<AiDialogueHistory> dialogueHistory

The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.

includeCitations

protected Boolean includeCitations

A flag to indicate whether citations should be returned.

aiAgent

protected AiAskAgent aiAgent

Constructor Detail

AiAsk

public AiAsk(AiAskModeField mode,
             String prompt,
             List<AiItemAsk> items)

AiAsk

public AiAsk(EnumWrapper<AiAskModeField> mode,
             String prompt,
             List<AiItemAsk> items)

AiAsk

protected AiAsk(AiAsk.Builder builder)

Method Detail

getMode

public EnumWrapper<AiAskModeField> getMode()

getPrompt

public String getPrompt()

getItems

public List<AiItemAsk> getItems()

getDialogueHistory

public List<AiDialogueHistory> getDialogueHistory()

getIncludeCitations

public Boolean getIncludeCitations()

getAiAgent

public AiAskAgent getAiAgent()

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