Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatOptions

All Implemented Interfaces:

ChatOptions, 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, Alexandros Pappas, Andres da Silva Santos

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.
boolean	equals(Object o)
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.
Boolean	getInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
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.
String	getReasoningEffort()
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()
Boolean	getStreamUsage()
Double	getTemperature()	Returns the temperature to use for the chat.
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Map<String,Object>	getToolContext()	Get the configured tool context.
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()
int	hashCode()
Boolean	isLogprobs()
void	setDeploymentName(String deploymentName)
void	setEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
void	setFrequencyPenalty(Double frequencyPenalty)
void	setFunctions(Set<String> functions)
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	setReasoningEffort(String reasoningEffort)
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	setStreamUsage(Boolean enableStreamUsage)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolContext(Map<String,Object> toolContext)	Set the tool context values as map.
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureOpenAiChatOptions

public AzureOpenAiChatOptions()

Method Details

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<ToolCallback> 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

getInternalToolExecutionEnabled

@Nullable
public Boolean getInternalToolExecutionEnabled()

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:

getInternalToolExecutionEnabled 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 a new ChatOptions.Builder.

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)

setFunctions

public void setFunctions(Set<String> functions)

getResponseFormat

public AzureOpenAiResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(AzureOpenAiResponseFormat responseFormat)

getStreamUsage

public Boolean getStreamUsage()

setStreamUsage

public void setStreamUsage(Boolean enableStreamUsage)

getReasoningEffort

public String getReasoningEffort()

setReasoningEffort

public void setReasoningEffort(String reasoningEffort)

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)

getToolContext

public Map<String,Object> getToolContext()

Description copied from interface: ToolCallingChatOptions

Get the configured tool context.

Specified by:

getToolContext in interface ToolCallingChatOptions

Returns:

the tool context map.

setToolContext

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

Description copied from interface: ToolCallingChatOptions

Set the tool context values as map.

Specified by:

setToolContext in interface ToolCallingChatOptions

Parameters:

toolContext - as map

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object