Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions.AbstractBuilder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder<B>

org.springframework.ai.azure.openai.AzureOpenAiChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

ChatOptions.Builder<B>, ToolCallingChatOptions.Builder<B>

Direct Known Subclasses:

AzureOpenAiChatOptions.Builder

Enclosing class:

AzureOpenAiChatOptions

protected abstract static class AzureOpenAiChatOptions.AbstractBuilder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Boolean	enableStreamUsage
protected @Nullable com.azure.ai.openai.models.AzureChatEnhancementConfiguration	enhancements
protected @Nullable Map<String,Integer>	logitBias
protected @Nullable Boolean	logprobs
protected @Nullable Integer	maxCompletionTokens
protected @Nullable Integer	n
protected @Nullable String	reasoningEffort
protected @Nullable AzureOpenAiResponseFormat	responseFormat
protected @Nullable Long	seed
protected @Nullable com.azure.ai.openai.models.ChatCompletionStreamOptions	streamOptions
protected @Nullable Integer	topLogProbs
protected @Nullable String	user

Fields inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolContext, toolNames

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiChatOptions	build()	Build the ChatOptions.
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	deploymentName(@Nullable String deploymentName)
B	enhancements(@Nullable com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
B	logitBias(@Nullable Map<String,Integer> logitBias)
B	logprobs(@Nullable Boolean logprobs)
B	maxCompletionTokens(@Nullable 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.
B	maxTokens(@Nullable Integer maxTokens)	Sets the maximum number of tokens to generate in the chat completion.
B	N(@Nullable Integer n)
B	reasoningEffort(@Nullable String reasoningEffort)
B	responseFormat(@Nullable AzureOpenAiResponseFormat responseFormat)
B	seed(@Nullable Long seed)
B	stop(@Nullable List<String> stop)
B	streamOptions(@Nullable com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)
B	streamUsage(@Nullable Boolean enableStreamUsage)
B	topLogprobs(@Nullable Integer topLogprobs)
B	user(@Nullable String user)

Methods inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolCallbacks, toolContext, toolContext, toolNames, toolNames

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty, model, presencePenalty, stopSequences, temperature, topK, topP

Field Details

logitBias

protected @Nullable Map<String,Integer> logitBias

user

protected @Nullable String user

n

protected @Nullable Integer n

responseFormat

protected @Nullable AzureOpenAiResponseFormat responseFormat

seed

protected @Nullable Long seed

logprobs

protected @Nullable Boolean logprobs

topLogProbs

protected @Nullable Integer topLogProbs

maxCompletionTokens

protected @Nullable Integer maxCompletionTokens

enhancements

protected @Nullable com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements

streamOptions

protected @Nullable com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions

enableStreamUsage

protected @Nullable Boolean enableStreamUsage

reasoningEffort

protected @Nullable String reasoningEffort

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

deploymentName

public B deploymentName(@Nullable String deploymentName)

logitBias

public B logitBias(@Nullable Map<String,Integer> logitBias)

maxTokens

public B maxTokens(@Nullable 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.

Specified by:

maxTokens in interface ChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Specified by:

maxTokens in interface ToolCallingChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Overrides:

maxTokens in class DefaultChatOptionsBuilder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Parameters:

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

Returns:

this builder instance

maxCompletionTokens

public B maxCompletionTokens(@Nullable 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 B N(@Nullable Integer n)

stop

public B stop(@Nullable List<String> stop)

user

public B user(@Nullable String user)

responseFormat

public B responseFormat(@Nullable AzureOpenAiResponseFormat responseFormat)

streamUsage

public B streamUsage(@Nullable Boolean enableStreamUsage)

reasoningEffort

public B reasoningEffort(@Nullable String reasoningEffort)

seed

public B seed(@Nullable Long seed)

logprobs

public B logprobs(@Nullable Boolean logprobs)

topLogprobs

public B topLogprobs(@Nullable Integer topLogprobs)

enhancements

public B enhancements(@Nullable com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

streamOptions

public B streamOptions(@Nullable com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Overrides:

combineWith in class DefaultToolCallingChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

build

public AzureOpenAiChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Specified by:

build in interface ToolCallingChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Overrides:

build in class DefaultToolCallingChatOptions.Builder<B extends AzureOpenAiChatOptions.AbstractBuilder<B>>

Returns:

the Chat options.