Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions.Builder

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder

Enclosing class:

AzureOpenAiChatOptions

public static final class AzureOpenAiChatOptions.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected AzureOpenAiChatOptions	options

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(AzureOpenAiChatOptions options)

Method Summary

Modifier and Type	Method	Description
AzureOpenAiChatOptions	build()
AzureOpenAiChatOptions.Builder	deploymentName(String deploymentName)
AzureOpenAiChatOptions.Builder	enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
AzureOpenAiChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)
AzureOpenAiChatOptions.Builder	internalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
AzureOpenAiChatOptions.Builder	logitBias(Map<String,Integer> logitBias)
AzureOpenAiChatOptions.Builder	logprobs(Boolean logprobs)
AzureOpenAiChatOptions.Builder	maxCompletionTokens(Integer maxCompletionTokens)	Sets an upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
AzureOpenAiChatOptions.Builder	maxTokens(Integer maxTokens)	Sets the maximum number of tokens to generate in the chat completion.
AzureOpenAiChatOptions.Builder	N(Integer n)
AzureOpenAiChatOptions.Builder	presencePenalty(Double presencePenalty)
AzureOpenAiChatOptions.Builder	reasoningEffort(String reasoningEffort)
AzureOpenAiChatOptions.Builder	responseFormat(AzureOpenAiResponseFormat responseFormat)
AzureOpenAiChatOptions.Builder	seed(Long seed)
AzureOpenAiChatOptions.Builder	stop(List<String> stop)
AzureOpenAiChatOptions.Builder	streamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)
AzureOpenAiChatOptions.Builder	streamUsage(Boolean enableStreamUsage)
AzureOpenAiChatOptions.Builder	temperature(Double temperature)
AzureOpenAiChatOptions.Builder	toolCallbacks(List<ToolCallback> toolCallbacks)
AzureOpenAiChatOptions.Builder	toolCallbacks(ToolCallback... toolCallbacks)
AzureOpenAiChatOptions.Builder	toolContext(Map<String,Object> toolContext)
AzureOpenAiChatOptions.Builder	toolNames(String... toolNames)
AzureOpenAiChatOptions.Builder	toolNames(Set<String> toolNames)
AzureOpenAiChatOptions.Builder	topLogprobs(Integer topLogprobs)
AzureOpenAiChatOptions.Builder	topP(Double topP)
AzureOpenAiChatOptions.Builder	user(String user)

Methods inherited from class java.lang.Object

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

Field Details

options

protected AzureOpenAiChatOptions options

Constructor Details

Builder

public Builder()

Builder

public Builder(AzureOpenAiChatOptions options)

Method Details

deploymentName

public AzureOpenAiChatOptions.Builder deploymentName(String deploymentName)

frequencyPenalty

public AzureOpenAiChatOptions.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

public AzureOpenAiChatOptions.Builder logitBias(Map<String,Integer> logitBias)

maxTokens

public AzureOpenAiChatOptions.Builder maxTokens(Integer maxTokens)

Sets the maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length.

Model-specific usage:

• Use for non-reasoning models (e.g., gpt-4o, gpt-3.5-turbo)
• Cannot be used with reasoning models (e.g., o1, o3, o4-mini series)

Mutual exclusivity: This parameter cannot be used together with maxCompletionTokens(Integer). If both are set, the last one set will be used and the other will be cleared with a warning.

Parameters:

maxTokens - the maximum number of tokens to generate, or null to unset

Returns:

this builder instance

maxCompletionTokens

public AzureOpenAiChatOptions.Builder maxCompletionTokens(Integer maxCompletionTokens)

Sets an upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

Model-specific usage:

• Required for reasoning models (e.g., o1, o3, o4-mini series)
• Cannot be used with non-reasoning models (e.g., gpt-4o, gpt-3.5-turbo)

Mutual exclusivity: This parameter cannot be used together with maxTokens(Integer). If both are set, the last one set will be used and the other will be cleared with a warning.

Parameters:

maxCompletionTokens - the maximum number of completion tokens to generate, or null to unset

Returns:

this builder instance

N

public AzureOpenAiChatOptions.Builder N(Integer n)

presencePenalty

public AzureOpenAiChatOptions.Builder presencePenalty(Double presencePenalty)

stop

public AzureOpenAiChatOptions.Builder stop(List<String> stop)

temperature

public AzureOpenAiChatOptions.Builder temperature(Double temperature)

topP

public AzureOpenAiChatOptions.Builder topP(Double topP)

user

public AzureOpenAiChatOptions.Builder user(String user)

responseFormat

public AzureOpenAiChatOptions.Builder responseFormat(AzureOpenAiResponseFormat responseFormat)

streamUsage

public AzureOpenAiChatOptions.Builder streamUsage(Boolean enableStreamUsage)

reasoningEffort

public AzureOpenAiChatOptions.Builder reasoningEffort(String reasoningEffort)

seed

public AzureOpenAiChatOptions.Builder seed(Long seed)

logprobs

public AzureOpenAiChatOptions.Builder logprobs(Boolean logprobs)

topLogprobs

public AzureOpenAiChatOptions.Builder topLogprobs(Integer topLogprobs)

enhancements

public AzureOpenAiChatOptions.Builder enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

toolContext

public AzureOpenAiChatOptions.Builder toolContext(Map<String,Object> toolContext)

streamOptions

public AzureOpenAiChatOptions.Builder streamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)

toolCallbacks

public AzureOpenAiChatOptions.Builder toolCallbacks(List<ToolCallback> toolCallbacks)

toolCallbacks

public AzureOpenAiChatOptions.Builder toolCallbacks(ToolCallback... toolCallbacks)

toolNames

public AzureOpenAiChatOptions.Builder toolNames(Set<String> toolNames)

toolNames

public AzureOpenAiChatOptions.Builder toolNames(String... toolNames)

internalToolExecutionEnabled

public AzureOpenAiChatOptions.Builder internalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

build

public AzureOpenAiChatOptions build()