com.box.sdk

Class BoxAIAgentAskBasicText

Object

BoxJSONObject

BoxAIAgentAskBasicText

public class BoxAIAgentAskBasicText
extends BoxJSONObject

AI agent tool used to handle basic text.

Constructor Summary

Constructors

Constructor and Description
BoxAIAgentAskBasicText(BoxAIAgentLLMEndpointParams llmEndpointParams, String model, int numTokensForCompletion, String promptTemplate, String systemMessage) Constructs an AI agent with default settings.
BoxAIAgentAskBasicText(JsonObject jsonObject) Constructs an AI agent with default settings.

Method Summary

Modifier and Type	Method and Description
JsonObject	getJSONObject()
BoxAIAgentLLMEndpointParams	getLlmEndpointParams() Gets the parameters for the LLM endpoint specific to OpenAI / Google models.
String	getModel() Gets the model used for the AI Agent for basic text.
int	getNumTokensForCompletion() Gets the number of tokens for completion.
String	getPromptTemplate() Gets the prompt template contains contextual information of the request and the user prompt.
String	getSystemMessage() Gets the system messages try to help the LLM "understand" its role and what it is supposed to do.
void	setLlmEndpointParams(BoxAIAgentLLMEndpointParams llmEndpointParams) Sets the parameters for the LLM endpoint specific to OpenAI / Google models.
void	setModel(String model) Sets the model used for the AI Agent for basic text.
void	setNumTokensForCompletion(int numTokensForCompletion) Sets the number of tokens for completion.
void	setPromptTemplate(String promptTemplate) Sets the prompt template contains contextual information of the request and the user prompt.
void	setSystemMessage(String systemMessage) Sets the system messages try to help the LLM "understand" its role and what it is supposed to do.

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

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

Constructor Detail

BoxAIAgentAskBasicText

public BoxAIAgentAskBasicText(BoxAIAgentLLMEndpointParams llmEndpointParams,
                              String model,
                              int numTokensForCompletion,
                              String promptTemplate,
                              String systemMessage)

Constructs an AI agent with default settings.

Parameters:

llmEndpointParams - The parameters for the LLM endpoint specific to OpenAI / Google models.

model - The model used for the AI Agent for basic text.

numTokensForCompletion - The number of tokens for completion.

promptTemplate - The prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. Input for {current_date} is optional, depending on the use.

systemMessage - System messages try to help the LLM "understand" its role and what it is supposed to do.

BoxAIAgentAskBasicText

public BoxAIAgentAskBasicText(JsonObject jsonObject)

Constructs an AI agent with default settings.

Parameters:

jsonObject - JSON object representing the AI agent.

Method Detail

getLlmEndpointParams

public BoxAIAgentLLMEndpointParams getLlmEndpointParams()

Gets the parameters for the LLM endpoint specific to OpenAI / Google models.

Returns:

The parameters for the LLM endpoint specific to OpenAI / Google models.

setLlmEndpointParams

public void setLlmEndpointParams(BoxAIAgentLLMEndpointParams llmEndpointParams)

Sets the parameters for the LLM endpoint specific to OpenAI / Google models.

Parameters:

llmEndpointParams - The parameters for the LLM endpoint specific to OpenAI / Google models.

getModel

public String getModel()

Gets the model used for the AI Agent for basic text.

Returns:

The model used for the AI Agent for basic text.

setModel

public void setModel(String model)

Sets the model used for the AI Agent for basic text.

Parameters:

model - The model used for the AI Agent for basic text.

getNumTokensForCompletion

public int getNumTokensForCompletion()

Gets the number of tokens for completion.

Returns:

The number of tokens for completion.

setNumTokensForCompletion

public void setNumTokensForCompletion(int numTokensForCompletion)

Sets the number of tokens for completion.

Parameters:

numTokensForCompletion - The number of tokens for completion.

getPromptTemplate

public String getPromptTemplate()

Gets the prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. Input for {current_date} is optional, depending on the use.

Returns:

The prompt template contains contextual information of the request and the user prompt.

setPromptTemplate

public void setPromptTemplate(String promptTemplate)

Sets the prompt template contains contextual information of the request and the user prompt. When passing prompt_template parameters, you must include inputs for {user_question} and {content}. Input for {current_date} is optional, depending on the use.

Parameters:

promptTemplate - The prompt template contains contextual information of the request and the user prompt.

getSystemMessage

public String getSystemMessage()

Gets the system messages try to help the LLM "understand" its role and what it is supposed to do.

Returns:

The system messages try to help the LLM "understand" its role and what it is supposed to do.

setSystemMessage

public void setSystemMessage(String systemMessage)

Sets the system messages try to help the LLM "understand" its role and what it is supposed to do.

Parameters:

systemMessage - The system messages try to help the LLM "understand" its role and what it is supposed to do.

getJSONObject

public JsonObject getJSONObject()