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()
AzureOpenAiChatOptions	copy()
static AzureOpenAiChatOptions	fromOptions(AzureOpenAiChatOptions fromOptions)
String	getDeploymentName()
com.azure.ai.openai.models.AzureChatEnhancementConfiguration	getEnhancements()
Double	getFrequencyPenalty()
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
Map<String,Integer>	getLogitBias()
Integer	getMaxTokens()
String	getModel()
Integer	getN()
Double	getPresencePenalty()
Boolean	getProxyToolCalls()	Deprecated.
AzureOpenAiResponseFormat	getResponseFormat()
Long	getSeed()
List<String>	getStop()
List<String>	getStopSequences()
com.azure.ai.openai.models.ChatCompletionStreamOptions	getStreamOptions()
Double	getTemperature()
List<FunctionCallback>	getToolCallbacks()
Map<String,Object>	getToolContext()
Set<String>	getToolNames()
Integer	getTopK()
Integer	getTopLogProbs()
Double	getTopP()
String	getUser()
Boolean	isInternalToolExecutionEnabled()
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)
void	setInternalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
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)
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)
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()

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

builder

public static AzureOpenAiChatOptions.Builder builder()

fromOptions

public static AzureOpenAiChatOptions fromOptions(AzureOpenAiChatOptions fromOptions)

getMaxTokens

public Integer getMaxTokens()

Specified by:

getMaxTokens in interface ChatOptions

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

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)

getPresencePenalty

public Double getPresencePenalty()

Specified by:

getPresencePenalty in interface ChatOptions

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

setModel

public void setModel(String model)

getDeploymentName

public String getDeploymentName()

setDeploymentName

public void setDeploymentName(String deploymentName)

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)

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

public void setFunctions(Set<String> functions)

Specified by:

setFunctions in interface FunctionCallingOptions

getResponseFormat

public AzureOpenAiResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(AzureOpenAiResponseFormat responseFormat)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

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

Specified by:

copy in interface ChatOptions