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
FieldsModifier and TypeFieldDescriptionprotected @Nullable Stringprotected @Nullable Stringprotected @Nullable com.openai.credential.Credentialprotected @Nullable Booleanprotected @Nullable Booleanprotected @Nullable Booleanprotected @Nullable Integerprotected @Nullable Integerprotected @Nullable Stringprotected @Nullable com.openai.azure.AzureOpenAIServiceVersionprotected @Nullable Integerprotected @Nullable Stringprotected @Nullable OpenAiSdkChatOptions.AudioParametersprotected @Nullable Booleanprotected @Nullable Proxyprotected @Nullable Stringprotected @Nullable OpenAiSdkChatModel.ResponseFormatprotected @Nullable Integerprotected @Nullable Stringprotected @Nullable Booleanprotected @Nullable OpenAiSdkChatOptions.StreamOptionsprotected @Nullable Durationprotected @Nullable Objectprotected @Nullable Integerprotected @Nullable Stringprotected @Nullable StringFields inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
internalToolExecutionEnabled, toolCallbacks, toolContext, toolNamesFields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionazureOpenAIServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion) build()Build theChatOptions.combineWith(ChatOptions.Builder<?> other) Mutate this builder by taking allother's values that are non-null, retainingthisother values.credential(@Nullable com.openai.credential.Credential credential) customHeaders(Map<String, String> customHeaders) deploymentName(@Nullable String deploymentName) gitHubModels(@Nullable Boolean gitHubModels) maxCompletionTokens(@Nullable Integer maxCompletionTokens) maxRetries(@Nullable Integer maxRetries) Builds with the maximum number of tokens to use for the chat.microsoftFoundry(@Nullable Boolean microsoftFoundry) microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion) Deprecated.organizationId(@Nullable String organizationId) outputAudio(@Nullable OpenAiSdkChatOptions.AudioParameters audio) outputModalities(@Nullable List<String> outputModalities) outputSchema(@Nullable String outputSchema) parallelToolCalls(@Nullable Boolean parallelToolCalls) reasoningEffort(@Nullable String reasoningEffort) responseFormat(@Nullable OpenAiSdkChatModel.ResponseFormat responseFormat) serviceTier(@Nullable String serviceTier) streamOptions(@Nullable OpenAiSdkChatOptions.StreamOptions streamOptions) streamUsage(boolean streamUsage) toolChoice(@Nullable Object toolChoice) topLogprobs(@Nullable Integer topLogprobs) Methods inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder
internalToolExecutionEnabled, toolCallbacks, toolCallbacks, toolContext, toolContext, toolNames, toolNamesMethods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder
frequencyPenalty, model, presencePenalty, self, stopSequences, temperature, topK, topPMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder
frequencyPenalty, model, presencePenalty, stopSequences, temperature, topK, topP
-
Field Details
-
baseUrl
-
apiKey
-
credential
protected @Nullable com.openai.credential.Credential credential -
microsoftDeploymentName
-
microsoftFoundryServiceVersion
protected @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion -
organizationId
-
isMicrosoftFoundry
-
isGitHubModels
-
timeout
-
maxRetries
-
proxy
-
customHeaders
-
logitBias
-
logprobs
-
topLogprobs
-
maxCompletionTokens
-
n
-
outputModalities
-
outputAudio
-
responseFormat
-
streamOptions
-
seed
-
toolChoice
-
user
-
parallelToolCalls
-
store
-
metadata
-
reasoningEffort
-
verbosity
-
serviceTier
-
-
Constructor Details
-
AbstractBuilder
protected AbstractBuilder()
-
-
Method Details
-
baseUrl
-
apiKey
-
credential
-
deploymentName
-
microsoftFoundryServiceVersion
public B microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion) -
azureOpenAIServiceVersion
public B azureOpenAIServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion) -
organizationId
-
microsoftFoundry
-
azure
-
gitHubModels
-
timeout
-
maxRetries
-
proxy
-
customHeaders
-
logitBias
-
logprobs
-
topLogprobs
-
maxTokens
Description copied from interface:ChatOptions.BuilderBuilds with the maximum number of tokens to use for the chat.- Specified by:
maxTokensin interfaceChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Specified by:
maxTokensin interfaceToolCallingChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Overrides:
maxTokensin classDefaultChatOptionsBuilder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Parameters:
maxTokens-- Returns:
- the builder.
-
maxCompletionTokens
-
n
-
N
Deprecated. -
outputModalities
-
outputAudio
-
responseFormat
-
streamOptions
-
streamUsage
-
seed
-
stop
-
toolChoice
-
user
-
parallelToolCalls
-
store
-
metadata
-
reasoningEffort
-
verbosity
-
serviceTier
-
outputSchema
- Specified by:
outputSchemain interfaceStructuredOutputChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>
-
combineWith
Description copied from interface:ChatOptions.BuilderMutate this builder by taking allother's values that are non-null, retainingthisother values.- Specified by:
combineWithin interfaceChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Overrides:
combineWithin classDefaultToolCallingChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>
-
build
Description copied from interface:ChatOptions.BuilderBuild theChatOptions.- Specified by:
buildin interfaceChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Specified by:
buildin interfaceToolCallingChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Overrides:
buildin classDefaultToolCallingChatOptions.Builder<B extends OpenAiSdkChatOptions.AbstractBuilder<B>>- Returns:
- the Chat options.
-