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()
OpenAiChatOptions	copy()
boolean	equals(Object o)
static OpenAiChatOptions	fromOptions(OpenAiChatOptions fromOptions)
Double	getFrequencyPenalty()
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
Map<String,String>	getHttpHeaders()
Map<String,Integer>	getLogitBias()
Boolean	getLogprobs()
Integer	getMaxCompletionTokens()
Integer	getMaxTokens()
Map<String,String>	getMetadata()
String	getModel()
Integer	getN()
OpenAiApi.ChatCompletionRequest.AudioParameters	getOutputAudio()
List<String>	getOutputModalities()
Boolean	getParallelToolCalls()
Double	getPresencePenalty()
Boolean	getProxyToolCalls()	Deprecated.
String	getReasoningEffort()
ResponseFormat	getResponseFormat()
Integer	getSeed()
List<String>	getStop()
List<String>	getStopSequences()
Boolean	getStore()
OpenAiApi.ChatCompletionRequest.StreamOptions	getStreamOptions()
Boolean	getStreamUsage()
Double	getTemperature()
List<FunctionCallback>	getToolCallbacks()
Object	getToolChoice()
Map<String,Object>	getToolContext()
Set<String>	getToolNames()
List<OpenAiApi.FunctionTool>	getTools()
Integer	getTopK()
Integer	getTopLogprobs()
Double	getTopP()
String	getUser()
int	hashCode()
Boolean	isInternalToolExecutionEnabled()
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)
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)
void	setToolChoice(Object toolChoice)
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)
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()

fromOptions

public static OpenAiChatOptions fromOptions(OpenAiChatOptions fromOptions)

getStreamUsage

public Boolean getStreamUsage()

setStreamUsage

public void setStreamUsage(Boolean enableStreamUsage)

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

setModel

public void setModel(String model)

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

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()

Specified by:

getMaxTokens in interface ChatOptions

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()

Specified by:

getPresencePenalty in interface ChatOptions

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()

Specified by:

getStopSequences in interface ChatOptions

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public List<String> getStop()

setStop

public void setStop(List<String> stop)

getTemperature

public Double getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Double temperature)

getTopP

public Double getTopP()

Specified by:

getTopP in interface ChatOptions

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()

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<FunctionCallback> toolCallbacks)

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Specified by:

setToolNames in interface ToolCallingChatOptions

isInternalToolExecutionEnabled

@Nullable
public Boolean isInternalToolExecutionEnabled()

Specified by:

isInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

Specified by:

setInternalToolExecutionEnabled in interface ToolCallingChatOptions

getFunctionCallbacks

@Deprecated
public List<FunctionCallback> getFunctionCallbacks()

Deprecated.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

setFunctionCallbacks

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

Deprecated.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

getFunctions

@Deprecated
public Set<String> getFunctions()

Deprecated.

Specified by:

getFunctions in interface FunctionCallingOptions

setFunctions

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

Deprecated.

Specified by:

setFunctions in interface FunctionCallingOptions

getHttpHeaders

public Map<String,String> getHttpHeaders()

setHttpHeaders

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

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

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()

Specified by:

copy in interface 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