Package org.springframework.ai.openaisdk

Class OpenAiSdkChatOptions.AbstractBuilder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>

java.lang.Object

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

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

org.springframework.ai.openaisdk.OpenAiSdkChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

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

Direct Known Subclasses:

OpenAiSdkChatOptions.Builder

Enclosing class:

OpenAiSdkChatOptions

@NullMarked
protected abstract static class OpenAiSdkChatOptions.AbstractBuilder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	apiKey
protected @Nullable String	baseUrl
protected @Nullable com.openai.credential.Credential	credential
protected Map<String,String>	customHeaders
protected @Nullable Boolean	isGitHubModels
protected @Nullable Boolean	isMicrosoftFoundry
protected @Nullable Map<String,Integer>	logitBias
protected @Nullable Boolean	logprobs
protected @Nullable Integer	maxCompletionTokens
protected @Nullable Integer	maxRetries
protected @Nullable Map<String,String>	metadata
protected @Nullable String	microsoftDeploymentName
protected @Nullable com.openai.azure.AzureOpenAIServiceVersion	microsoftFoundryServiceVersion
protected @Nullable Integer	n
protected @Nullable String	organizationId
protected @Nullable OpenAiSdkChatOptions.AudioParameters	outputAudio
protected @Nullable List<String>	outputModalities
protected @Nullable Boolean	parallelToolCalls
protected @Nullable Proxy	proxy
protected @Nullable String	reasoningEffort
protected @Nullable OpenAiSdkChatModel.ResponseFormat	responseFormat
protected @Nullable Integer	seed
protected @Nullable String	serviceTier
protected @Nullable Boolean	store
protected @Nullable OpenAiSdkChatOptions.StreamOptions	streamOptions
protected @Nullable Duration	timeout
protected @Nullable Object	toolChoice
protected @Nullable Integer	topLogprobs
protected @Nullable String	user
protected @Nullable String	verbosity

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
B	apiKey(@Nullable String apiKey)
B	azure(@Nullable Boolean azure)
B	azureOpenAIServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
B	baseUrl(@Nullable String baseUrl)
OpenAiSdkChatOptions	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	credential(@Nullable com.openai.credential.Credential credential)
B	customHeaders(Map<String,String> customHeaders)
B	deploymentName(@Nullable String deploymentName)
B	gitHubModels(@Nullable Boolean gitHubModels)
B	logitBias(@Nullable Map<String,Integer> logitBias)
B	logprobs(@Nullable Boolean logprobs)
B	maxCompletionTokens(@Nullable Integer maxCompletionTokens)
B	maxRetries(@Nullable Integer maxRetries)
B	maxTokens(@Nullable Integer maxTokens)	Builds with the maximum number of tokens to use for the chat.
B	metadata(@Nullable Map<String,String> metadata)
B	microsoftFoundry(@Nullable Boolean microsoftFoundry)
B	microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)
B	n(@Nullable Integer n)
B	N(@Nullable Integer n)	Deprecated.
B	organizationId(@Nullable String organizationId)
B	outputAudio(@Nullable OpenAiSdkChatOptions.AudioParameters audio)
B	outputModalities(@Nullable List<String> outputModalities)
B	outputSchema(@Nullable String outputSchema)
B	parallelToolCalls(@Nullable Boolean parallelToolCalls)
B	proxy(@Nullable Proxy proxy)
B	reasoningEffort(@Nullable String reasoningEffort)
B	responseFormat(@Nullable OpenAiSdkChatModel.ResponseFormat responseFormat)
B	seed(@Nullable Integer seed)
B	serviceTier(@Nullable String serviceTier)
B	stop(@Nullable List<String> stop)
B	store(@Nullable Boolean store)
B	streamOptions(@Nullable OpenAiSdkChatOptions.StreamOptions streamOptions)
B	streamUsage(boolean streamUsage)
B	timeout(@Nullable Duration timeout)
B	toolChoice(@Nullable Object toolChoice)
B	topLogprobs(@Nullable Integer topLogprobs)
B	user(@Nullable String user)
B	verbosity(@Nullable String verbosity)

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

baseUrl

protected @Nullable String baseUrl

apiKey

protected @Nullable String apiKey

credential

protected @Nullable com.openai.credential.Credential credential

microsoftDeploymentName

protected @Nullable String microsoftDeploymentName

microsoftFoundryServiceVersion

protected @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion

organizationId

protected @Nullable String organizationId

isMicrosoftFoundry

protected @Nullable Boolean isMicrosoftFoundry

isGitHubModels

protected @Nullable Boolean isGitHubModels

timeout

protected @Nullable Duration timeout

maxRetries

protected @Nullable Integer maxRetries

proxy

protected @Nullable Proxy proxy

customHeaders

protected Map<String,String> customHeaders

logitBias

protected @Nullable Map<String,Integer> logitBias

logprobs

protected @Nullable Boolean logprobs

topLogprobs

protected @Nullable Integer topLogprobs

maxCompletionTokens

protected @Nullable Integer maxCompletionTokens

n

protected @Nullable Integer n

outputModalities

protected @Nullable List<String> outputModalities

outputAudio

protected @Nullable OpenAiSdkChatOptions.AudioParameters outputAudio

responseFormat

protected @Nullable OpenAiSdkChatModel.ResponseFormat responseFormat

streamOptions

protected @Nullable OpenAiSdkChatOptions.StreamOptions streamOptions

seed

protected @Nullable Integer seed

toolChoice

protected @Nullable Object toolChoice

user

protected @Nullable String user

parallelToolCalls

protected @Nullable Boolean parallelToolCalls

store

protected @Nullable Boolean store

metadata

protected @Nullable Map<String,String> metadata

reasoningEffort

protected @Nullable String reasoningEffort

verbosity

protected @Nullable String verbosity

serviceTier

protected @Nullable String serviceTier

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

baseUrl

public B baseUrl(@Nullable String baseUrl)

apiKey

public B apiKey(@Nullable String apiKey)

credential

public B credential(@Nullable com.openai.credential.Credential credential)

deploymentName

public B deploymentName(@Nullable String deploymentName)

microsoftFoundryServiceVersion

public B microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)

azureOpenAIServiceVersion

public B azureOpenAIServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)

organizationId

public B organizationId(@Nullable String organizationId)

microsoftFoundry

public B microsoftFoundry(@Nullable Boolean microsoftFoundry)

azure

public B azure(@Nullable Boolean azure)

gitHubModels

public B gitHubModels(@Nullable Boolean gitHubModels)

timeout

public B timeout(@Nullable Duration timeout)

maxRetries

public B maxRetries(@Nullable Integer maxRetries)

proxy

public B proxy(@Nullable Proxy proxy)

customHeaders

public B customHeaders(Map<String,String> customHeaders)

logitBias

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

logprobs

public B logprobs(@Nullable Boolean logprobs)

topLogprobs

public B topLogprobs(@Nullable Integer topLogprobs)

maxTokens

public B maxTokens(@Nullable Integer maxTokens)

Description copied from interface: ChatOptions.Builder

Builds with the maximum number of tokens to use for the chat.

Specified by:

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

Specified by:

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

Overrides:

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

Parameters:

maxTokens -

Returns:

the builder.

maxCompletionTokens

public B maxCompletionTokens(@Nullable Integer maxCompletionTokens)

n

public B n(@Nullable Integer n)

N

@Deprecated
public B N(@Nullable Integer n)

Deprecated.

outputModalities

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

outputAudio

public B outputAudio(@Nullable OpenAiSdkChatOptions.AudioParameters audio)

responseFormat

public B responseFormat(@Nullable OpenAiSdkChatModel.ResponseFormat responseFormat)

streamOptions

public B streamOptions(@Nullable OpenAiSdkChatOptions.StreamOptions streamOptions)

streamUsage

public B streamUsage(boolean streamUsage)

seed

public B seed(@Nullable Integer seed)

stop

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

toolChoice

public B toolChoice(@Nullable Object toolChoice)

user

public B user(@Nullable String user)

parallelToolCalls

public B parallelToolCalls(@Nullable Boolean parallelToolCalls)

store

public B store(@Nullable Boolean store)

metadata

public B metadata(@Nullable Map<String,String> metadata)

reasoningEffort

public B reasoningEffort(@Nullable String reasoningEffort)

verbosity

public B verbosity(@Nullable String verbosity)

serviceTier

public B serviceTier(@Nullable String serviceTier)

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>

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 OpenAiSdkChatOptions.AbstractBuilder<B>>

Overrides:

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

build

public OpenAiSdkChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

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

Specified by:

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

Overrides:

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

Returns:

the Chat options.