Package org.springframework.ai.openai.responses

Class OpenAiResponsesChatOptions.AbstractBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

java.lang.Object

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

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

org.springframework.ai.openai.responses.OpenAiResponsesChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

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

Direct Known Subclasses:

OpenAiResponsesChatOptions.Builder

Enclosing class:

OpenAiResponsesChatOptions

protected abstract static class OpenAiResponsesChatOptions.AbstractBuilder<B extends OpenAiResponsesChatOptions.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 @Nullable Map<String,String>	customHeaders
protected @Nullable Map<String,Object>	extraBody
protected @Nullable List<HostedTool>	hostedTools
protected @Nullable List<String>	include
protected @Nullable Boolean	isMicrosoftFoundry
protected @Nullable Integer	maxRetries
protected @Nullable Integer	maxToolCalls
protected @Nullable Map<String,String>	metadata
protected @Nullable String	microsoftDeploymentName
protected @Nullable com.openai.azure.AzureOpenAIServiceVersion	microsoftFoundryServiceVersion
protected @Nullable String	organizationId
protected @Nullable Boolean	parallelToolCalls
protected @Nullable String	promptCacheKey
protected @Nullable Proxy	proxy
protected @Nullable String	reasoningEffort
protected @Nullable String	reasoningSummary
protected @Nullable OpenAiChatModel.ResponseFormat	responseFormat
protected @Nullable String	safetyIdentifier
protected @Nullable String	serviceTier
protected @Nullable Boolean	strict
protected @Nullable Duration	timeout
protected @Nullable Object	toolChoice
protected @Nullable String	truncation
protected @Nullable String	verbosity

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

toolCallbacks, toolContext

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	apiKey(@Nullable ApiKey apiKey)	Sets the API key using an ApiKey instance.
B	baseUrl(@Nullable String baseUrl)
OpenAiResponsesChatOptions	build()	Build the ChatOptions.
B	clone()
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(@Nullable Map<String,String> customHeaders)
B	deploymentName(@Nullable String deploymentName)
B	extraBody(@Nullable Map<String,Object> extraBody)
B	frequencyPenalty(@Nullable Double frequencyPenalty)	Builds with the frequency penalty to use for the chat.
B	hostedTools(@Nullable List<HostedTool> hostedTools)
B	hostedTools(HostedTool... hostedTools)
B	include(@Nullable List<String> include)
B	maxOutputTokens(@Nullable Integer maxOutputTokens)	Alias for DefaultChatOptionsBuilder.maxTokens(Integer), named after the wire field.
B	maxRetries(@Nullable Integer maxRetries)
B	maxToolCalls(@Nullable Integer maxToolCalls)
B	metadata(@Nullable Map<String,String> metadata)
B	microsoftFoundry(@Nullable Boolean microsoftFoundry)
B	microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)
B	organizationId(@Nullable String organizationId)
B	outputSchema(@Nullable String outputSchema)
B	parallelToolCalls(@Nullable Boolean parallelToolCalls)
B	presencePenalty(@Nullable Double presencePenalty)	Builds with the presence penalty to use for the chat.
B	promptCacheKey(@Nullable String promptCacheKey)
B	proxy(@Nullable Proxy proxy)
B	reasoningEffort(@Nullable String reasoningEffort)
B	reasoningSummary(@Nullable String reasoningSummary)
B	responseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat)
B	safetyIdentifier(@Nullable String safetyIdentifier)
B	serviceTier(@Nullable String serviceTier)
B	stopSequences(@Nullable List<String> stopSequences)	Builds with the stop sequences to use for the chat.
B	strict(@Nullable Boolean strict)
B	timeout(@Nullable Duration timeout)
B	toolChoice(@Nullable Object toolChoice)
B	topK(@Nullable Integer topK)	Builds with the top K to use for the chat.
B	truncation(@Nullable String truncation)
B	verbosity(@Nullable String verbosity)

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

toolCallbacks, toolCallbacks, toolContext, toolContext

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

maxTokens, model, self, temperature, topP

Methods inherited from class java.lang.Object

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

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

maxTokens, model, temperature, 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

timeout

protected @Nullable Duration timeout

maxRetries

protected @Nullable Integer maxRetries

proxy

protected @Nullable Proxy proxy

customHeaders

protected @Nullable Map<String,String> customHeaders

reasoningEffort

protected @Nullable String reasoningEffort

reasoningSummary

protected @Nullable String reasoningSummary

verbosity

protected @Nullable String verbosity

responseFormat

protected @Nullable OpenAiChatModel.ResponseFormat responseFormat

strict

protected @Nullable Boolean strict

toolChoice

protected @Nullable Object toolChoice

parallelToolCalls

protected @Nullable Boolean parallelToolCalls

maxToolCalls

protected @Nullable Integer maxToolCalls

hostedTools

protected @Nullable List<HostedTool> hostedTools

include

protected @Nullable List<String> include

truncation

protected @Nullable String truncation

serviceTier

protected @Nullable String serviceTier

promptCacheKey

protected @Nullable String promptCacheKey

safetyIdentifier

protected @Nullable String safetyIdentifier

metadata

protected @Nullable Map<String,String> metadata

extraBody

protected @Nullable Map<String,Object> extraBody

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

clone

public B clone()

Specified by:

clone in interface ChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

clone in class DefaultToolCallingChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

stopSequences

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

Description copied from interface: ChatOptions.Builder

Builds with the stop sequences to use for the chat.

Specified by:

stopSequences in interface ChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Specified by:

stopSequences in interface ToolCallingChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

stopSequences in class DefaultChatOptionsBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Returns:

the builder.

frequencyPenalty

public B frequencyPenalty(@Nullable Double frequencyPenalty)

Description copied from interface: ChatOptions.Builder

Builds with the frequency penalty to use for the chat.

Specified by:

frequencyPenalty in interface ChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Specified by:

frequencyPenalty in interface ToolCallingChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

frequencyPenalty in class DefaultChatOptionsBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Returns:

the builder.

presencePenalty

public B presencePenalty(@Nullable Double presencePenalty)

Description copied from interface: ChatOptions.Builder

Builds with the presence penalty to use for the chat.

Specified by:

presencePenalty in interface ChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Specified by:

presencePenalty in interface ToolCallingChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

presencePenalty in class DefaultChatOptionsBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Returns:

the builder.

topK

public B topK(@Nullable Integer topK)

Description copied from interface: ChatOptions.Builder

Builds with the top K to use for the chat.

Specified by:

topK in interface ChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Specified by:

topK in interface ToolCallingChatOptions.Builder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

topK in class DefaultChatOptionsBuilder<B extends OpenAiResponsesChatOptions.AbstractBuilder<B>>

Returns:

the builder.

baseUrl

public B baseUrl(@Nullable String baseUrl)

apiKey

public B apiKey(@Nullable String apiKey)

apiKey

public B apiKey(@Nullable ApiKey apiKey)

Sets the API key using an ApiKey instance. Pass a NoopApiKey to disable authentication.

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)

organizationId

public B organizationId(@Nullable String organizationId)

microsoftFoundry

public B microsoftFoundry(@Nullable Boolean microsoftFoundry)

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(@Nullable Map<String,String> customHeaders)

maxOutputTokens

public B maxOutputTokens(@Nullable Integer maxOutputTokens)

Alias for DefaultChatOptionsBuilder.maxTokens(Integer), named after the wire field.

reasoningEffort

public B reasoningEffort(@Nullable String reasoningEffort)

reasoningSummary

public B reasoningSummary(@Nullable String reasoningSummary)

verbosity

public B verbosity(@Nullable String verbosity)

responseFormat

public B responseFormat(@Nullable OpenAiChatModel.ResponseFormat responseFormat)

strict

public B strict(@Nullable Boolean strict)

toolChoice

public B toolChoice(@Nullable Object toolChoice)

parallelToolCalls

public B parallelToolCalls(@Nullable Boolean parallelToolCalls)

maxToolCalls

public B maxToolCalls(@Nullable Integer maxToolCalls)

hostedTools

public B hostedTools(@Nullable List<HostedTool> hostedTools)

hostedTools

public B hostedTools(HostedTool... hostedTools)

include

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

truncation

public B truncation(@Nullable String truncation)

serviceTier

public B serviceTier(@Nullable String serviceTier)

promptCacheKey

public B promptCacheKey(@Nullable String promptCacheKey)

safetyIdentifier

public B safetyIdentifier(@Nullable String safetyIdentifier)

metadata

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

extraBody

public B extraBody(@Nullable Map<String,Object> extraBody)

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends OpenAiResponsesChatOptions.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 OpenAiResponsesChatOptions.AbstractBuilder<B>>

Overrides:

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

build

public OpenAiResponsesChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

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

Specified by:

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

Overrides:

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

Returns:

the Chat options.