Package org.springframework.ai.openai

Class OpenAiChatOptions

java.lang.Object

org.springframework.ai.openai.OpenAiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions, ToolCallingChatOptions

public class OpenAiChatOptions
extends Object
implements ToolCallingChatOptions

Options for the OpenAI Chat API.

Since:

0.8.0

Author:

Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiChatOptions.Builder

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
OpenAiChatOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
OpenAiChatOptions	copy()	Returns a copy of this ChatOptions.
boolean	equals(Object o)
static OpenAiChatOptions	fromOptions(OpenAiChatOptions fromOptions)
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
Map<String,String>	getHttpHeaders()
Map<String,Integer>	getLogitBias()
Boolean	getLogprobs()
Integer	getMaxCompletionTokens()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
Map<String,String>	getMetadata()
String	getModel()	Returns the model to use for the chat.
Integer	getN()
OpenAiApi.ChatCompletionRequest.AudioParameters	getOutputAudio()
List<String>	getOutputModalities()
Boolean	getParallelToolCalls()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Boolean	getProxyToolCalls()	Deprecated.
String	getReasoningEffort()
ResponseFormat	getResponseFormat()
Integer	getSeed()
List<String>	getStop()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Boolean	getStore()
OpenAiApi.ChatCompletionRequest.StreamOptions	getStreamOptions()
Boolean	getStreamUsage()
Double	getTemperature()	Returns the temperature to use for the chat.
List<FunctionCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Object	getToolChoice()
Map<String,Object>	getToolContext()
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
List<OpenAiApi.FunctionTool>	getTools()
Integer	getTopK()	Returns the top K to use for the chat.
Integer	getTopLogprobs()
Double	getTopP()	Returns the top P to use for the chat.
String	getUser()
int	hashCode()
Boolean	isInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
void	setFrequencyPenalty(Double frequencyPenalty)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated.
void	setFunctions(Set<String> functionNames)	Deprecated.
void	setHttpHeaders(Map<String,String> httpHeaders)
void	setInternalToolExecutionEnabled(Boolean internalToolExecutionEnabled)	Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
void	setLogitBias(Map<String,Integer> logitBias)
void	setLogprobs(Boolean logprobs)
void	setMaxCompletionTokens(Integer maxCompletionTokens)
void	setMaxTokens(Integer maxTokens)
void	setMetadata(Map<String,String> metadata)
void	setModel(String model)
void	setN(Integer n)
void	setOutputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)
void	setOutputModalities(List<String> modalities)
void	setParallelToolCalls(Boolean parallelToolCalls)
void	setPresencePenalty(Double presencePenalty)
void	setProxyToolCalls(Boolean proxyToolCalls)	Deprecated.
void	setReasoningEffort(String reasoningEffort)
void	setResponseFormat(ResponseFormat responseFormat)
void	setSeed(Integer seed)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setStore(Boolean store)
void	setStreamOptions(OpenAiApi.ChatCompletionRequest.StreamOptions streamOptions)
void	setStreamUsage(Boolean enableStreamUsage)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<FunctionCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolChoice(Object toolChoice)
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTools(List<OpenAiApi.FunctionTool> tools)
void	setTopLogprobs(Integer topLogprobs)
void	setTopP(Double topP)
void	setUser(String user)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OpenAiChatOptions

public OpenAiChatOptions()

Method Details

builder

public static OpenAiChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

fromOptions

public static OpenAiChatOptions fromOptions(OpenAiChatOptions fromOptions)

getStreamUsage

public Boolean getStreamUsage()

setStreamUsage

public void setStreamUsage(Boolean enableStreamUsage)

getModel

public String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

setModel

public void setModel(String model)

getFrequencyPenalty

public Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

getLogitBias

public Map<String,Integer> getLogitBias()

setLogitBias

public void setLogitBias(Map<String,Integer> logitBias)

getLogprobs

public Boolean getLogprobs()

setLogprobs

public void setLogprobs(Boolean logprobs)

getTopLogprobs

public Integer getTopLogprobs()

setTopLogprobs

public void setTopLogprobs(Integer topLogprobs)

getMaxTokens

public Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getMaxCompletionTokens

public Integer getMaxCompletionTokens()

setMaxCompletionTokens

public void setMaxCompletionTokens(Integer maxCompletionTokens)

getN

public Integer getN()

setN

public void setN(Integer n)

getOutputModalities

public List<String> getOutputModalities()

setOutputModalities

public void setOutputModalities(List<String> modalities)

getOutputAudio

public OpenAiApi.ChatCompletionRequest.AudioParameters getOutputAudio()

setOutputAudio

public void setOutputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)

getPresencePenalty

public Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getResponseFormat

public ResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(ResponseFormat responseFormat)

getStreamOptions

public OpenAiApi.ChatCompletionRequest.StreamOptions getStreamOptions()

setStreamOptions

public void setStreamOptions(OpenAiApi.ChatCompletionRequest.StreamOptions streamOptions)

getSeed

public Integer getSeed()

setSeed

public void setSeed(Integer seed)

getStopSequences

public List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public List<String> getStop()

setStop

public void setStop(List<String> stop)

getTemperature

public Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

setTemperature

public void setTemperature(Double temperature)

getTopP

public Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

setTopP

public void setTopP(Double topP)

getTools

public List<OpenAiApi.FunctionTool> getTools()

setTools

public void setTools(List<OpenAiApi.FunctionTool> tools)

getToolChoice

public Object getToolChoice()

setToolChoice

public void setToolChoice(Object toolChoice)

getProxyToolCalls

@Deprecated
public Boolean getProxyToolCalls()

Deprecated.

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

@Deprecated
public void setProxyToolCalls(Boolean proxyToolCalls)

Deprecated.

Specified by:

setProxyToolCalls in interface FunctionCallingOptions

getUser

public String getUser()

setUser

public void setUser(String user)

getParallelToolCalls

public Boolean getParallelToolCalls()

setParallelToolCalls

public void setParallelToolCalls(Boolean parallelToolCalls)

getToolCallbacks

public List<FunctionCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<FunctionCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions

Set the names of the tools to register with the ChatModel.

Specified by:

setToolNames in interface ToolCallingChatOptions

isInternalToolExecutionEnabled

@Nullable
public Boolean isInternalToolExecutionEnabled()

Description copied from interface: ToolCallingChatOptions

Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

isInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

Description copied from interface: ToolCallingChatOptions

Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

setInternalToolExecutionEnabled in interface ToolCallingChatOptions

getFunctionCallbacks

@Deprecated
public List<FunctionCallback> getFunctionCallbacks()

Deprecated.

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

@Deprecated
public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated.

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatModel.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

functionCallbacks - the Function Callbacks to be registered with the ChatModel.

getFunctions

@Deprecated
public Set<String> getFunctions()

Deprecated.

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

Set of function names from the ChatModel registry to be used in the next chat completion requests.

setFunctions

@Deprecated
public void setFunctions(Set<String> functionNames)

Deprecated.

Description copied from interface: FunctionCallingOptions

Set the list of function names from the ChatModel registry to be used in the next chat completion requests.

Specified by:

setFunctions in interface FunctionCallingOptions

Parameters:

functionNames - the list of function names from the ChatModel registry to be used in the next chat completion requests.

getHttpHeaders

public Map<String,String> getHttpHeaders()

setHttpHeaders

public void setHttpHeaders(Map<String,String> httpHeaders)

getTopK

public Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

getToolContext

public Map<String,Object> getToolContext()

Specified by:

getToolContext in interface FunctionCallingOptions

setToolContext

public void setToolContext(Map<String,Object> toolContext)

Specified by:

setToolContext in interface FunctionCallingOptions

getStore

public Boolean getStore()

setStore

public void setStore(Boolean store)

getMetadata

public Map<String,String> getMetadata()

setMetadata

public void setMetadata(Map<String,String> metadata)

getReasoningEffort

public String getReasoningEffort()

setReasoningEffort

public void setReasoningEffort(String reasoningEffort)

copy

public OpenAiChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object