com.box.sdk

Class BoxAIAgentLLMEndpointParamsOpenAI

Object

BoxJSONObject

BoxAIAgentLLMEndpointParams

BoxAIAgentLLMEndpointParamsOpenAI

public class BoxAIAgentLLMEndpointParamsOpenAI
extends BoxAIAgentLLMEndpointParams

Represents the AI LLM endpoint params OpenAI object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type of the LLM endpoint parameters.

Constructor Summary

Constructors

Constructor and Description
BoxAIAgentLLMEndpointParamsOpenAI(Double frequencyPenalty, Double presencePenalty, String stop, Double temperature, Double topP) Constructs an AI agent with default settings.
BoxAIAgentLLMEndpointParamsOpenAI(JsonObject jsonObject) Constructs an AI agent with default settings.

Method Summary

Modifier and Type	Method and Description
Double	getFrequencyPenalty() Gets the frequency penalty.
JsonObject	getJSONObject()
Double	getPresencePenalty() Gets the presence penalty.
String	getStop() Gets the stop.
Double	getTemperature() Gets the temperature.
Double	getTopP() Gets the top-P.
void	setFrequencyPenalty(Double frequencyPenalty) Sets the frequency penalty.
void	setPresencePenalty(Double presencePenalty) Sets the presence penalty.
void	setStop(String stop) Sets the stop.
void	setTemperature(Double temperature) Sets the temperature.
void	setTopP(Double topP) Sets the top-P.

Methods inherited from class BoxAIAgentLLMEndpointParams

getType, parse, setType

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

Field Detail

TYPE

public static final String TYPE

The type of the LLM endpoint parameters.

See Also:

Constant Field Values

Constructor Detail

BoxAIAgentLLMEndpointParamsOpenAI

public BoxAIAgentLLMEndpointParamsOpenAI(Double frequencyPenalty,
                                         Double presencePenalty,
                                         String stop,
                                         Double temperature,
                                         Double topP)

Constructs an AI agent with default settings.

Parameters:

frequencyPenalty - Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

presencePenalty - Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

stop - Up to 4 sequences where the API will stop generating further tokens.

temperature - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

topP - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

BoxAIAgentLLMEndpointParamsOpenAI

public BoxAIAgentLLMEndpointParamsOpenAI(JsonObject jsonObject)

Constructs an AI agent with default settings.

Parameters:

jsonObject - JSON object representing the AI agent.

Method Detail

getFrequencyPenalty

public Double getFrequencyPenalty()

Gets the frequency penalty.

Returns:

The frequency penalty.

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

Sets the frequency penalty.

Parameters:

frequencyPenalty - The frequency penalty.

getPresencePenalty

public Double getPresencePenalty()

Gets the presence penalty.

Returns:

The presence penalty.

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

Sets the presence penalty.

Parameters:

presencePenalty - The presence penalty.

getStop

public String getStop()

Gets the stop.

Returns:

The stop.

setStop

public void setStop(String stop)

Sets the stop.

Parameters:

stop - The stop.

getTemperature

public Double getTemperature()

Gets the temperature.

Returns:

The temperature.

setTemperature

public void setTemperature(Double temperature)

Sets the temperature.

Parameters:

temperature - The temperature.

getTopP

public Double getTopP()

Gets the top-P.

Returns:

The top-P.

setTopP

public void setTopP(Double topP)

Sets the top-P.

Parameters:

topP - The top-P.

getJSONObject

public JsonObject getJSONObject()

Overrides:

getJSONObject in class BoxAIAgentLLMEndpointParams