Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions, ToolCallingChatOptions

public class AzureOpenAiChatOptions
extends Object
implements ToolCallingChatOptions

The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

Author:

Christian Tzolov, Thomas Vitale, Soby Chacko, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureOpenAiChatOptions.Builder

Field Summary

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

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiChatOptions()

Method Summary

Modifier and Type	Method	Description
static AzureOpenAiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
AzureOpenAiChatOptions	copy()	Returns a copy of this ChatOptions.
static AzureOpenAiChatOptions	fromOptions(AzureOpenAiChatOptions fromOptions)
String	getDeploymentName()
com.azure.ai.openai.models.AzureChatEnhancementConfiguration	getEnhancements()
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
Map<String,Integer>	getLogitBias()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Integer	getN()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Boolean	getProxyToolCalls()	Deprecated.
AzureOpenAiResponseFormat	getResponseFormat()
Long	getSeed()
List<String>	getStop()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
com.azure.ai.openai.models.ChatCompletionStreamOptions	getStreamOptions()
Double	getTemperature()	Returns the temperature to use for the chat.
List<FunctionCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Map<String,Object>	getToolContext()
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
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()
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.
Boolean	isLogprobs()
void	setDeploymentName(String deploymentName)
void	setEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
void	setFrequencyPenalty(Double frequencyPenalty)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
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	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setN(Integer n)
void	setPresencePenalty(Double presencePenalty)
void	setProxyToolCalls(Boolean proxyToolCalls)	Deprecated.
void	setResponseFormat(AzureOpenAiResponseFormat responseFormat)
void	setSeed(Long seed)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setStreamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<FunctionCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTopLogProbs(Integer topLogProbs)
void	setTopP(Double topP)
void	setUser(String user)

Methods inherited from class java.lang.Object

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

Constructor Details

AzureOpenAiChatOptions

public AzureOpenAiChatOptions()

Method Details

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

builder

public static AzureOpenAiChatOptions.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 AzureOpenAiChatOptions fromOptions(AzureOpenAiChatOptions fromOptions)

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)

getLogitBias

public Map<String,Integer> getLogitBias()

setLogitBias

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

getUser

public String getUser()

setUser

public void setUser(String user)

getN

public Integer getN()

setN

public void setN(Integer n)

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)

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)

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)

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)

getDeploymentName

public String getDeploymentName()

setDeploymentName

public void setDeploymentName(String deploymentName)

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)

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

public void setFunctions(Set<String> functions)

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:

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

getResponseFormat

public AzureOpenAiResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(AzureOpenAiResponseFormat responseFormat)

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

getSeed

public Long getSeed()

setSeed

public void setSeed(Long seed)

isLogprobs

public Boolean isLogprobs()

setLogprobs

public void setLogprobs(Boolean logprobs)

getTopLogProbs

public Integer getTopLogProbs()

setTopLogProbs

public void setTopLogProbs(Integer topLogProbs)

getEnhancements

public com.azure.ai.openai.models.AzureChatEnhancementConfiguration getEnhancements()

setEnhancements

public void setEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

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

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

getStreamOptions

public com.azure.ai.openai.models.ChatCompletionStreamOptions getStreamOptions()

setStreamOptions

public void setStreamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)

copy

public AzureOpenAiChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions