Package org.springframework.ai.openaisdk

Class OpenAiSdkChatOptions.Builder

java.lang.Object

org.springframework.ai.openaisdk.OpenAiSdkChatOptions.Builder

Enclosing class:

OpenAiSdkChatOptions

public static final class OpenAiSdkChatOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiSdkChatOptions.Builder	apiKey(String apiKey)
OpenAiSdkChatOptions.Builder	azure(boolean azure)
OpenAiSdkChatOptions.Builder	azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)
OpenAiSdkChatOptions.Builder	baseUrl(String baseUrl)
OpenAiSdkChatOptions	build()
OpenAiSdkChatOptions.Builder	credential(com.openai.credential.Credential credential)
OpenAiSdkChatOptions.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiSdkChatOptions.Builder	deploymentName(String deploymentName)
OpenAiSdkChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)
OpenAiSdkChatOptions.Builder	from(OpenAiSdkChatOptions fromOptions)
OpenAiSdkChatOptions.Builder	gitHubModels(boolean gitHubModels)
OpenAiSdkChatOptions.Builder	internalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
OpenAiSdkChatOptions.Builder	logitBias(Map<String,Integer> logitBias)
OpenAiSdkChatOptions.Builder	logprobs(Boolean logprobs)
OpenAiSdkChatOptions.Builder	maxCompletionTokens(Integer maxCompletionTokens)
OpenAiSdkChatOptions.Builder	maxRetries(Integer maxRetries)
OpenAiSdkChatOptions.Builder	maxTokens(Integer maxTokens)
OpenAiSdkChatOptions.Builder	merge(OpenAiSdkChatOptions from)
OpenAiSdkChatOptions.Builder	metadata(Map<String,String> metadata)
OpenAiSdkChatOptions.Builder	model(String model)
OpenAiSdkChatOptions.Builder	N(Integer n)
OpenAiSdkChatOptions.Builder	organizationId(String organizationId)
OpenAiSdkChatOptions.Builder	outputAudio(OpenAiSdkChatOptions.AudioParameters audio)
OpenAiSdkChatOptions.Builder	outputModalities(List<String> outputModalities)
OpenAiSdkChatOptions.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiSdkChatOptions.Builder	presencePenalty(Double presencePenalty)
OpenAiSdkChatOptions.Builder	proxy(Proxy proxy)
OpenAiSdkChatOptions.Builder	reasoningEffort(String reasoningEffort)
OpenAiSdkChatOptions.Builder	responseFormat(OpenAiSdkChatModel.ResponseFormat responseFormat)
OpenAiSdkChatOptions.Builder	seed(Integer seed)
OpenAiSdkChatOptions.Builder	serviceTier(String serviceTier)
OpenAiSdkChatOptions.Builder	stop(List<String> stop)
OpenAiSdkChatOptions.Builder	store(Boolean store)
OpenAiSdkChatOptions.Builder	streamOptions(OpenAiSdkChatOptions.StreamOptions streamOptions)
OpenAiSdkChatOptions.Builder	streamUsage(boolean streamUsage)
OpenAiSdkChatOptions.Builder	temperature(Double temperature)
OpenAiSdkChatOptions.Builder	timeout(Duration timeout)
OpenAiSdkChatOptions.Builder	toolCallbacks(List<ToolCallback> toolCallbacks)
OpenAiSdkChatOptions.Builder	toolCallbacks(ToolCallback... toolCallbacks)
OpenAiSdkChatOptions.Builder	toolChoice(Object toolChoice)
OpenAiSdkChatOptions.Builder	toolContext(Map<String,Object> toolContext)
OpenAiSdkChatOptions.Builder	toolNames(String... toolNames)
OpenAiSdkChatOptions.Builder	toolNames(Set<String> toolNames)
OpenAiSdkChatOptions.Builder	topLogprobs(Integer topLogprobs)
OpenAiSdkChatOptions.Builder	topP(Double topP)
OpenAiSdkChatOptions.Builder	user(String user)
OpenAiSdkChatOptions.Builder	verbosity(String verbosity)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

from

public OpenAiSdkChatOptions.Builder from(OpenAiSdkChatOptions fromOptions)

merge

public OpenAiSdkChatOptions.Builder merge(OpenAiSdkChatOptions from)

model

public OpenAiSdkChatOptions.Builder model(String model)

deploymentName

public OpenAiSdkChatOptions.Builder deploymentName(String deploymentName)

baseUrl

public OpenAiSdkChatOptions.Builder baseUrl(String baseUrl)

apiKey

public OpenAiSdkChatOptions.Builder apiKey(String apiKey)

credential

public OpenAiSdkChatOptions.Builder credential(com.openai.credential.Credential credential)

azureOpenAIServiceVersion

public OpenAiSdkChatOptions.Builder azureOpenAIServiceVersion(com.openai.azure.AzureOpenAIServiceVersion azureOpenAIServiceVersion)

organizationId

public OpenAiSdkChatOptions.Builder organizationId(String organizationId)

azure

public OpenAiSdkChatOptions.Builder azure(boolean azure)

gitHubModels

public OpenAiSdkChatOptions.Builder gitHubModels(boolean gitHubModels)

timeout

public OpenAiSdkChatOptions.Builder timeout(Duration timeout)

maxRetries

public OpenAiSdkChatOptions.Builder maxRetries(Integer maxRetries)

proxy

public OpenAiSdkChatOptions.Builder proxy(Proxy proxy)

customHeaders

public OpenAiSdkChatOptions.Builder customHeaders(Map<String,String> customHeaders)

frequencyPenalty

public OpenAiSdkChatOptions.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

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

logprobs

public OpenAiSdkChatOptions.Builder logprobs(Boolean logprobs)

topLogprobs

public OpenAiSdkChatOptions.Builder topLogprobs(Integer topLogprobs)

maxTokens

public OpenAiSdkChatOptions.Builder maxTokens(Integer maxTokens)

maxCompletionTokens

public OpenAiSdkChatOptions.Builder maxCompletionTokens(Integer maxCompletionTokens)

N

public OpenAiSdkChatOptions.Builder N(Integer n)

outputModalities

public OpenAiSdkChatOptions.Builder outputModalities(List<String> outputModalities)

outputAudio

public OpenAiSdkChatOptions.Builder outputAudio(OpenAiSdkChatOptions.AudioParameters audio)

presencePenalty

public OpenAiSdkChatOptions.Builder presencePenalty(Double presencePenalty)

responseFormat

public OpenAiSdkChatOptions.Builder responseFormat(OpenAiSdkChatModel.ResponseFormat responseFormat)

streamOptions

public OpenAiSdkChatOptions.Builder streamOptions(OpenAiSdkChatOptions.StreamOptions streamOptions)

streamUsage

public OpenAiSdkChatOptions.Builder streamUsage(boolean streamUsage)

seed

public OpenAiSdkChatOptions.Builder seed(Integer seed)

stop

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

temperature

public OpenAiSdkChatOptions.Builder temperature(Double temperature)

topP

public OpenAiSdkChatOptions.Builder topP(Double topP)

toolChoice

public OpenAiSdkChatOptions.Builder toolChoice(Object toolChoice)

user

public OpenAiSdkChatOptions.Builder user(String user)

parallelToolCalls

public OpenAiSdkChatOptions.Builder parallelToolCalls(Boolean parallelToolCalls)

toolCallbacks

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

toolCallbacks

public OpenAiSdkChatOptions.Builder toolCallbacks(ToolCallback... toolCallbacks)

toolNames

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

toolNames

public OpenAiSdkChatOptions.Builder toolNames(String... toolNames)

internalToolExecutionEnabled

public OpenAiSdkChatOptions.Builder internalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

toolContext

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

store

public OpenAiSdkChatOptions.Builder store(Boolean store)

metadata

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

reasoningEffort

public OpenAiSdkChatOptions.Builder reasoningEffort(String reasoningEffort)

verbosity

public OpenAiSdkChatOptions.Builder verbosity(String verbosity)

serviceTier

public OpenAiSdkChatOptions.Builder serviceTier(String serviceTier)

build

public OpenAiSdkChatOptions build()