com.box.sdk

Class BoxAI

Object

BoxAI

public final class BoxAI
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxAI.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	AI_AGENT_DEFAULT_CONFIG_URL AI agent default config url.
static URLTemplate	EXTRACT_METADATA_FREEFORM_URL AI extract metadata freeform url.
static URLTemplate	EXTRACT_METADATA_STRUCTURED_URL AI extract metadata structured url.
static URLTemplate	SEND_AI_REQUEST_URL Ask AI url.
static URLTemplate	SEND_AI_TEXT_GEN_REQUEST_URL Text gen AI url.

Method Summary

Modifier and Type	Method and Description
static BoxAIResponse	extractMetadataFreeform(BoxAPIConnection api, String prompt, List<BoxAIItem> items) Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
static BoxAIResponse	extractMetadataFreeform(BoxAPIConnection api, String prompt, List<BoxAIItem> items, BoxAIAgentExtract agent) Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
static BoxAIExtractStructuredResponse	extractMetadataStructured(BoxAPIConnection api, List<BoxAIItem> items, BoxAIExtractMetadataTemplate template) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
static BoxAIExtractStructuredResponse	extractMetadataStructured(BoxAPIConnection api, List<BoxAIItem> items, BoxAIExtractMetadataTemplate template, BoxAIAgentExtractStructured agent) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
static BoxAIExtractStructuredResponse	extractMetadataStructured(BoxAPIConnection api, List<BoxAIItem> items, List<BoxAIExtractField> fields) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
static BoxAIExtractStructuredResponse	extractMetadataStructured(BoxAPIConnection api, List<BoxAIItem> items, List<BoxAIExtractField> fields, BoxAIAgentExtractStructured agent) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
static BoxAIAgent	getAiAgentDefaultConfig(BoxAPIConnection api, BoxAIAgent.Mode mode) Get the default AI Agent use for the given mode.
static BoxAIAgent	getAiAgentDefaultConfig(BoxAPIConnection api, BoxAIAgent.Mode mode, String language, String model) Get the default AI Agent use for the given mode.
static BoxAIResponse	sendAIRequest(BoxAPIConnection api, String prompt, List<BoxAIItem> items, BoxAI.Mode mode) Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided items.
static BoxAIResponse	sendAIRequest(BoxAPIConnection api, String prompt, List<BoxAIItem> items, BoxAI.Mode mode, List<BoxAIDialogueEntry> dialogueHistory, BoxAIAgentAsk agent, Boolean includeCitations) Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided items.
static BoxAIResponse	sendAITextGenRequest(BoxAPIConnection api, String prompt, List<BoxAIItem> items) Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
static BoxAIResponse	sendAITextGenRequest(BoxAPIConnection api, String prompt, List<BoxAIItem> items, List<BoxAIDialogueEntry> dialogueHistory) Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
static BoxAIResponse	sendAITextGenRequest(BoxAPIConnection api, String prompt, List<BoxAIItem> items, List<BoxAIDialogueEntry> dialogueHistory, BoxAIAgentTextGen agent) Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Methods inherited from class Object

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

Field Detail

SEND_AI_REQUEST_URL

public static final URLTemplate SEND_AI_REQUEST_URL

Ask AI url.

SEND_AI_TEXT_GEN_REQUEST_URL

public static final URLTemplate SEND_AI_TEXT_GEN_REQUEST_URL

Text gen AI url.

AI_AGENT_DEFAULT_CONFIG_URL

public static final URLTemplate AI_AGENT_DEFAULT_CONFIG_URL

AI agent default config url.

EXTRACT_METADATA_FREEFORM_URL

public static final URLTemplate EXTRACT_METADATA_FREEFORM_URL

AI extract metadata freeform url.

EXTRACT_METADATA_STRUCTURED_URL

public static final URLTemplate EXTRACT_METADATA_STRUCTURED_URL

AI extract metadata structured url.

Method Detail

sendAIRequest

public static BoxAIResponse sendAIRequest(BoxAPIConnection api,
                                          String prompt,
                                          List<BoxAIItem> items,
                                          BoxAI.Mode mode)

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided items.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

mode - The mode specifies if this request is for a single or multiple items.

Returns:

The response from the AI.

sendAIRequest

public static BoxAIResponse sendAIRequest(BoxAPIConnection api,
                                          String prompt,
                                          List<BoxAIItem> items,
                                          BoxAI.Mode mode,
                                          List<BoxAIDialogueEntry> dialogueHistory,
                                          BoxAIAgentAsk agent,
                                          Boolean includeCitations)

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided items.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

mode - The mode specifies if this request is for a single or multiple items.

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

agent - The AI agent configuration to be used for the request.

includeCitations - Whether to include citations in the response.

Returns:

The response from the AI.

sendAITextGenRequest

public static BoxAIResponse sendAITextGenRequest(BoxAPIConnection api,
                                                 String prompt,
                                                 List<BoxAIItem> items)

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

Returns:

The response from the AI.

sendAITextGenRequest

public static BoxAIResponse sendAITextGenRequest(BoxAPIConnection api,
                                                 String prompt,
                                                 List<BoxAIItem> items,
                                                 List<BoxAIDialogueEntry> dialogueHistory)

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

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

Returns:

The response from the AI.

sendAITextGenRequest

public static BoxAIResponse sendAITextGenRequest(BoxAPIConnection api,
                                                 String prompt,
                                                 List<BoxAIItem> items,
                                                 List<BoxAIDialogueEntry> dialogueHistory,
                                                 BoxAIAgentTextGen agent)

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

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

agent - The AI agent configuration to be used for the request.

Returns:

The response from the AI.

getAiAgentDefaultConfig

public static BoxAIAgent getAiAgentDefaultConfig(BoxAPIConnection api,
                                                 BoxAIAgent.Mode mode)

Get the default AI Agent use for the given mode.

Parameters:

api - The API connection to be used by the created user.

mode - The mode to filter the agent config to return.

Returns:

A successful response including the default agent configuration.

getAiAgentDefaultConfig

public static BoxAIAgent getAiAgentDefaultConfig(BoxAPIConnection api,
                                                 BoxAIAgent.Mode mode,
                                                 String language,
                                                 String model)

Get the default AI Agent use for the given mode.

Parameters:

api - The API connection to be used by the created user.

mode - The mode to filter the agent config to return.

language - The language to filter the agent config to return.

model - The model to filter the agent config to return.

Returns:

A successful response including the default agent configuration.

extractMetadataFreeform

public static BoxAIResponse extractMetadataFreeform(BoxAPIConnection api,
                                                    String prompt,
                                                    List<BoxAIItem> items)

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. Freeform metadata extraction does not require any metadata template setup before sending the request.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

Returns:

The response from the AI.

extractMetadataFreeform

public static BoxAIResponse extractMetadataFreeform(BoxAPIConnection api,
                                                    String prompt,
                                                    List<BoxAIItem> items,
                                                    BoxAIAgentExtract agent)

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. Freeform metadata extraction does not require any metadata template setup before sending the request.

Parameters:

api - the API connection to be used by the created user.

prompt - The prompt provided by the client to be answered by the LLM.

items - The items to be processed by the LLM, currently only files are supported.

agent - The AI agent configuration to be used for the request.

Returns:

The response from the AI.

extractMetadataStructured

public static BoxAIExtractStructuredResponse extractMetadataStructured(BoxAPIConnection api,
                                                                       List<BoxAIItem> items,
                                                                       BoxAIExtractMetadataTemplate template)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you need to use an already defined metadata template or a define a schema yourself.

Parameters:

api - The API connection to be used by the created user.

items - The items to be processed by the LLM, currently only files are supported.

template - The metadata template to be used for the request.

Returns:

The response from the AI.

extractMetadataStructured

public static BoxAIExtractStructuredResponse extractMetadataStructured(BoxAPIConnection api,
                                                                       List<BoxAIItem> items,
                                                                       BoxAIExtractMetadataTemplate template,
                                                                       BoxAIAgentExtractStructured agent)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you need to use an already defined metadata template or a define a schema yourself.

Parameters:

api - The API connection to be used by the created user.

items - The items to be processed by the LLM, currently only files are supported.

template - The metadata template to be used for the request.

agent - The AI agent configuration to be used for the request.

Returns:

The response from the AI.

extractMetadataStructured

public static BoxAIExtractStructuredResponse extractMetadataStructured(BoxAPIConnection api,
                                                                       List<BoxAIItem> items,
                                                                       List<BoxAIExtractField> fields)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you need to use an already defined metadata template or a define a schema yourself.

Parameters:

api - The API connection to be used by the created user.

items - The items to be processed by the LLM, currently only files are supported.

fields - The fields to be extracted from the items.

Returns:

The response from the AI.

extractMetadataStructured

public static BoxAIExtractStructuredResponse extractMetadataStructured(BoxAPIConnection api,
                                                                       List<BoxAIItem> items,
                                                                       List<BoxAIExtractField> fields,
                                                                       BoxAIAgentExtractStructured agent)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you need to use an already defined metadata template or a define a schema yourself.

Parameters:

api - The API connection to be used by the created user.

items - The items to be processed by the LLM, currently only files are supported.

fields - The fields to be extracted from the items.

agent - The AI agent configuration to be used for the request.

Returns:

The response from the AI.