Class OpenAiChatOptions.Builder

java.lang.Object

org.springframework.ai.openai.OpenAiChatOptions.Builder

Enclosing class:

OpenAiChatOptions

public static final class OpenAiChatOptions.Builder
extends Object

Since:

0.8.0

Author:

Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Ilayaperumal Gopinathan, lambochen

Field Summary

Fields

Modifier and Type	Field	Description
protected OpenAiChatOptions	options

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(OpenAiChatOptions options)

Method Summary

Modifier and Type	Method	Description
OpenAiChatOptions	build()
OpenAiChatOptions.Builder	extraBody(Map<String,Object> extraBody)
OpenAiChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)
OpenAiChatOptions.Builder	httpHeaders(Map<String,String> httpHeaders)
OpenAiChatOptions.Builder	internalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
OpenAiChatOptions.Builder	logitBias(Map<String,Integer> logitBias)
OpenAiChatOptions.Builder	logprobs(Boolean logprobs)
OpenAiChatOptions.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.
OpenAiChatOptions.Builder	maxTokens(Integer maxTokens)	Sets the maximum number of tokens to generate in the chat completion.
OpenAiChatOptions.Builder	metadata(Map<String,String> metadata)
OpenAiChatOptions.Builder	model(String model)
OpenAiChatOptions.Builder	model(OpenAiApi.ChatModel openAiChatModel)
OpenAiChatOptions.Builder	N(Integer n)
OpenAiChatOptions.Builder	outputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)
OpenAiChatOptions.Builder	outputModalities(List<String> modalities)
OpenAiChatOptions.Builder	outputSchema(String outputSchema)
OpenAiChatOptions.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiChatOptions.Builder	presencePenalty(Double presencePenalty)
OpenAiChatOptions.Builder	promptCacheKey(String promptCacheKey)
OpenAiChatOptions.Builder	reasoningEffort(String reasoningEffort)
OpenAiChatOptions.Builder	responseFormat(ResponseFormat responseFormat)
OpenAiChatOptions.Builder	safetyIdentifier(String safetyIdentifier)
OpenAiChatOptions.Builder	seed(Integer seed)
OpenAiChatOptions.Builder	serviceTier(String serviceTier)
OpenAiChatOptions.Builder	serviceTier(OpenAiApi.ServiceTier serviceTier)
OpenAiChatOptions.Builder	stop(List<String> stop)
OpenAiChatOptions.Builder	store(Boolean store)
OpenAiChatOptions.Builder	streamUsage(boolean enableStreamUsage)
OpenAiChatOptions.Builder	temperature(Double temperature)
OpenAiChatOptions.Builder	toolCallbacks(List<ToolCallback> toolCallbacks)
OpenAiChatOptions.Builder	toolCallbacks(ToolCallback... toolCallbacks)
OpenAiChatOptions.Builder	toolChoice(Object toolChoice)
OpenAiChatOptions.Builder	toolContext(Map<String,Object> toolContext)
OpenAiChatOptions.Builder	toolNames(String... toolNames)
OpenAiChatOptions.Builder	toolNames(Set<String> toolNames)
OpenAiChatOptions.Builder	tools(List<OpenAiApi.FunctionTool> tools)
OpenAiChatOptions.Builder	topLogprobs(Integer topLogprobs)
OpenAiChatOptions.Builder	topP(Double topP)
OpenAiChatOptions.Builder	user(String user)
OpenAiChatOptions.Builder	verbosity(String verbosity)
OpenAiChatOptions.Builder	webSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions webSearchOptions)

Methods inherited from class Object

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

Field Details

options

protected OpenAiChatOptions options

Constructor Details

Builder

public Builder()

Builder

public Builder(OpenAiChatOptions options)

Method Details

model

public OpenAiChatOptions.Builder model(String model)

model

public OpenAiChatOptions.Builder model(OpenAiApi.ChatModel openAiChatModel)

frequencyPenalty

public OpenAiChatOptions.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

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

logprobs

public OpenAiChatOptions.Builder logprobs(Boolean logprobs)

topLogprobs

public OpenAiChatOptions.Builder topLogprobs(Integer topLogprobs)

maxTokens

public OpenAiChatOptions.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 OpenAiChatOptions.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 OpenAiChatOptions.Builder N(Integer n)

outputModalities

public OpenAiChatOptions.Builder outputModalities(List<String> modalities)

outputAudio

public OpenAiChatOptions.Builder outputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)

presencePenalty

public OpenAiChatOptions.Builder presencePenalty(Double presencePenalty)

responseFormat

public OpenAiChatOptions.Builder responseFormat(ResponseFormat responseFormat)

outputSchema

public OpenAiChatOptions.Builder outputSchema(String outputSchema)

streamUsage

public OpenAiChatOptions.Builder streamUsage(boolean enableStreamUsage)

seed

public OpenAiChatOptions.Builder seed(Integer seed)

stop

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

temperature

public OpenAiChatOptions.Builder temperature(Double temperature)

topP

public OpenAiChatOptions.Builder topP(Double topP)

tools

public OpenAiChatOptions.Builder tools(List<OpenAiApi.FunctionTool> tools)

toolChoice

public OpenAiChatOptions.Builder toolChoice(Object toolChoice)

user

public OpenAiChatOptions.Builder user(String user)

parallelToolCalls

public OpenAiChatOptions.Builder parallelToolCalls(Boolean parallelToolCalls)

toolCallbacks

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

toolCallbacks

public OpenAiChatOptions.Builder toolCallbacks(ToolCallback... toolCallbacks)

toolNames

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

toolNames

public OpenAiChatOptions.Builder toolNames(String... toolNames)

internalToolExecutionEnabled

public OpenAiChatOptions.Builder internalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

httpHeaders

public OpenAiChatOptions.Builder httpHeaders(Map<String,String> httpHeaders)

toolContext

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

store

public OpenAiChatOptions.Builder store(Boolean store)

metadata

public OpenAiChatOptions.Builder metadata(Map<String,String> metadata)

reasoningEffort

public OpenAiChatOptions.Builder reasoningEffort(String reasoningEffort)

webSearchOptions

public OpenAiChatOptions.Builder webSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions webSearchOptions)

verbosity

public OpenAiChatOptions.Builder verbosity(String verbosity)

serviceTier

public OpenAiChatOptions.Builder serviceTier(String serviceTier)

serviceTier

public OpenAiChatOptions.Builder serviceTier(OpenAiApi.ServiceTier serviceTier)

promptCacheKey

public OpenAiChatOptions.Builder promptCacheKey(String promptCacheKey)

safetyIdentifier

public OpenAiChatOptions.Builder safetyIdentifier(String safetyIdentifier)

extraBody

public OpenAiChatOptions.Builder extraBody(Map<String,Object> extraBody)

build

public OpenAiChatOptions build()