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	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	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	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.

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.

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.

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.