com.box.sdk

Class BoxAIAgentTextGenBasicGen

Object

BoxJSONObject

BoxAIAgentTextGenBasicGen

public class BoxAIAgentTextGenBasicGen
extends BoxJSONObject

Represents the AI agent basic tool used to generate text.

Constructor Summary

Constructors

Constructor and Description
BoxAIAgentTextGenBasicGen(JsonObject jsonObject) Constructs an AI agent with default settings.
BoxAIAgentTextGenBasicGen(String contentTemplate, BoxAIAgentEmbeddings embeddings, BoxAIAgentLLMEndpointParamsOpenAI llmEndpointParams, String model, int numTokensForCompletion, String promptTemplate, String systemMessage) Constructs an AI agent with default settings.

Method Summary

Modifier and Type	Method and Description
String	getContentTemplate() Gets how the content should be included in a request to the LLM.
BoxAIAgentEmbeddings	getEmbeddings() Gets the embeddings used by the AI agent.
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 generating 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	setContentTemplate(String contentTemplate) Sets how the content should be included in a request to the LLM.
void	setEmbeddings(BoxAIAgentEmbeddings embeddings) Sets the embeddings used by the AI agent.
void	setLlmEndpointParams(BoxAIAgentLLMEndpointParamsOpenAI 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 generating 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

BoxAIAgentTextGenBasicGen

public BoxAIAgentTextGenBasicGen(String contentTemplate,
                                 BoxAIAgentEmbeddings embeddings,
                                 BoxAIAgentLLMEndpointParamsOpenAI llmEndpointParams,
                                 String model,
                                 int numTokensForCompletion,
                                 String promptTemplate,
                                 String systemMessage)

Constructs an AI agent with default settings.

Parameters:

contentTemplate - How the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

embeddings - Embeddings used by the AI agent.

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

model - The model used for the AI Agent for generating 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.

BoxAIAgentTextGenBasicGen

public BoxAIAgentTextGenBasicGen(JsonObject jsonObject)

Constructs an AI agent with default settings.

Parameters:

jsonObject - JSON object representing the AI agent.

Method Detail

getContentTemplate

public String getContentTemplate()

Gets how the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

Returns:

How the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

setContentTemplate

public void setContentTemplate(String contentTemplate)

Sets how the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

Parameters:

contentTemplate - How the content should be included in a request to the LLM. Input for {content} is optional, depending on the use.

getEmbeddings

public BoxAIAgentEmbeddings getEmbeddings()

Gets the embeddings used by the AI agent.

Returns:

The embeddings used by the AI agent.

setEmbeddings

public void setEmbeddings(BoxAIAgentEmbeddings embeddings)

Sets the embeddings used by the AI agent.

Parameters:

embeddings - The embeddings used by the AI agent.

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(BoxAIAgentLLMEndpointParamsOpenAI 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 generating text.

Returns:

The model used for the AI Agent for generating text.

setModel

public void setModel(String model)

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

Parameters:

model - The model used for the AI Agent for generating 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()