Package org.springframework.ai.openai

Class OpenAiChatOptions.Builder

java.lang.Object

org.springframework.ai.openai.OpenAiChatOptions.Builder

Enclosing class:

OpenAiChatOptions

public static class OpenAiChatOptions.Builder
extends Object

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	frequencyPenalty(Double frequencyPenalty)
OpenAiChatOptions.Builder	function(String functionName)
OpenAiChatOptions.Builder	functionCallbacks(List<FunctionCallback> functionCallbacks)
OpenAiChatOptions.Builder	functions(Set<String> functionNames)
OpenAiChatOptions.Builder	httpHeaders(Map<String,String> httpHeaders)
OpenAiChatOptions.Builder	logitBias(Map<String,Integer> logitBias)
OpenAiChatOptions.Builder	logprobs(Boolean logprobs)
OpenAiChatOptions.Builder	maxCompletionTokens(Integer maxCompletionTokens)
OpenAiChatOptions.Builder	maxTokens(Integer maxTokens)
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	parallelToolCalls(Boolean parallelToolCalls)
OpenAiChatOptions.Builder	presencePenalty(Double presencePenalty)
OpenAiChatOptions.Builder	proxyToolCalls(Boolean proxyToolCalls)
OpenAiChatOptions.Builder	responseFormat(ResponseFormat responseFormat)
OpenAiChatOptions.Builder	seed(Integer seed)
OpenAiChatOptions.Builder	stop(List<String> stop)
OpenAiChatOptions.Builder	streamUsage(boolean enableStreamUsage)
OpenAiChatOptions.Builder	temperature(Double temperature)
OpenAiChatOptions.Builder	toolChoice(Object toolChoice)
OpenAiChatOptions.Builder	toolContext(Map<String,Object> toolContext)
OpenAiChatOptions.Builder	tools(List<OpenAiApi.FunctionTool> tools)
OpenAiChatOptions.Builder	topLogprobs(Integer topLogprobs)
OpenAiChatOptions.Builder	topP(Double topP)
OpenAiChatOptions.Builder	user(String user)
OpenAiChatOptions.Builder	withFrequencyPenalty(Double frequencyPenalty)	Deprecated, for removal: This API element is subject to removal in a future version. use frequencyPenalty(Double) instead.
OpenAiChatOptions.Builder	withFunction(String functionName)	Deprecated, for removal: This API element is subject to removal in a future version. use function(String) instead.
OpenAiChatOptions.Builder	withFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. use functionCallbacks(List) instead.
OpenAiChatOptions.Builder	withFunctions(Set<String> functionNames)	Deprecated, for removal: This API element is subject to removal in a future version. use functions(Set) instead.
OpenAiChatOptions.Builder	withHttpHeaders(Map<String,String> httpHeaders)	Deprecated, for removal: This API element is subject to removal in a future version. use httpHeaders(Map) instead.
OpenAiChatOptions.Builder	withLogitBias(Map<String,Integer> logitBias)	Deprecated, for removal: This API element is subject to removal in a future version. use logitBias(Map) instead.
OpenAiChatOptions.Builder	withLogprobs(Boolean logprobs)	Deprecated, for removal: This API element is subject to removal in a future version. use logprobs(Boolean) instead.
OpenAiChatOptions.Builder	withMaxCompletionTokens(Integer maxCompletionTokens)	Deprecated, for removal: This API element is subject to removal in a future version. use maxCompletionTokens(Integer) instead.
OpenAiChatOptions.Builder	withMaxTokens(Integer maxTokens)	Deprecated, for removal: This API element is subject to removal in a future version. use maxTokens(Integer) instead.
OpenAiChatOptions.Builder	withModel(String model)	Deprecated, for removal: This API element is subject to removal in a future version. use model(String) instead.
OpenAiChatOptions.Builder	withModel(OpenAiApi.ChatModel openAiChatModel)	Deprecated, for removal: This API element is subject to removal in a future version. use model(OpenAiApi.ChatModel) instead.
OpenAiChatOptions.Builder	withN(Integer n)	Deprecated, for removal: This API element is subject to removal in a future version. use N(Integer) instead.
OpenAiChatOptions.Builder	withOutputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)	Deprecated, for removal: This API element is subject to removal in a future version. use outputAudio(AudioParameters) instead.
OpenAiChatOptions.Builder	withOutputModalities(List<String> modalities)	Deprecated, for removal: This API element is subject to removal in a future version. use outputModalities(List) instead.
OpenAiChatOptions.Builder	withParallelToolCalls(Boolean parallelToolCalls)	Deprecated, for removal: This API element is subject to removal in a future version. use parallelToolCalls(Boolean) instead.
OpenAiChatOptions.Builder	withPresencePenalty(Double presencePenalty)	Deprecated, for removal: This API element is subject to removal in a future version. use presencePenalty(Double) instead.
OpenAiChatOptions.Builder	withProxyToolCalls(Boolean proxyToolCalls)	Deprecated, for removal: This API element is subject to removal in a future version. use proxyToolCalls(Boolean) instead.
OpenAiChatOptions.Builder	withResponseFormat(ResponseFormat responseFormat)	Deprecated, for removal: This API element is subject to removal in a future version. use responseFormat(ResponseFormat) instead.
OpenAiChatOptions.Builder	withSeed(Integer seed)	Deprecated, for removal: This API element is subject to removal in a future version. use seed(Integer) instead.
OpenAiChatOptions.Builder	withStop(List<String> stop)	Deprecated, for removal: This API element is subject to removal in a future version. use stop(List) instead.
OpenAiChatOptions.Builder	withStreamUsage(boolean enableStreamUsage)	Deprecated, for removal: This API element is subject to removal in a future version. use streamUsage(boolean) instead.
OpenAiChatOptions.Builder	withTemperature(Double temperature)	Deprecated, for removal: This API element is subject to removal in a future version. use temperature(Double) instead.
OpenAiChatOptions.Builder	withToolChoice(Object toolChoice)	Deprecated, for removal: This API element is subject to removal in a future version. use toolChoice(Object) instead.
OpenAiChatOptions.Builder	withToolContext(Map<String,Object> toolContext)	Deprecated, for removal: This API element is subject to removal in a future version. use toolContext(Map) instead.
OpenAiChatOptions.Builder	withTools(List<OpenAiApi.FunctionTool> tools)	Deprecated, for removal: This API element is subject to removal in a future version. use tools(List) instead.
OpenAiChatOptions.Builder	withTopLogprobs(Integer topLogprobs)	Deprecated, for removal: This API element is subject to removal in a future version. use topLogprobs(Integer) instead.
OpenAiChatOptions.Builder	withTopP(Double topP)	Deprecated, for removal: This API element is subject to removal in a future version. use topP(Double) instead.
OpenAiChatOptions.Builder	withUser(String user)	Deprecated, for removal: This API element is subject to removal in a future version. use user(String) instead.

Methods inherited from class java.lang.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)

maxCompletionTokens

public OpenAiChatOptions.Builder maxCompletionTokens(Integer maxCompletionTokens)

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)

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)

functionCallbacks

public OpenAiChatOptions.Builder functionCallbacks(List<FunctionCallback> functionCallbacks)

functions

public OpenAiChatOptions.Builder functions(Set<String> functionNames)

function

public OpenAiChatOptions.Builder function(String functionName)

proxyToolCalls

public OpenAiChatOptions.Builder proxyToolCalls(Boolean proxyToolCalls)

httpHeaders

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

toolContext

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

withModel

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withModel(String model)

Deprecated, for removal: This API element is subject to removal in a future version.

use model(String) instead.

withModel

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withModel(OpenAiApi.ChatModel openAiChatModel)

Deprecated, for removal: This API element is subject to removal in a future version.

use model(OpenAiApi.ChatModel) instead.

withFrequencyPenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withFrequencyPenalty(Double frequencyPenalty)

Deprecated, for removal: This API element is subject to removal in a future version.

use frequencyPenalty(Double) instead.

withLogitBias

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withLogitBias(Map<String,Integer> logitBias)

Deprecated, for removal: This API element is subject to removal in a future version.

use logitBias(Map) instead.

withLogprobs

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withLogprobs(Boolean logprobs)

Deprecated, for removal: This API element is subject to removal in a future version.

use logprobs(Boolean) instead.

withTopLogprobs

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withTopLogprobs(Integer topLogprobs)

Deprecated, for removal: This API element is subject to removal in a future version.

use topLogprobs(Integer) instead.

withMaxTokens

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withMaxTokens(Integer maxTokens)

Deprecated, for removal: This API element is subject to removal in a future version.

use maxTokens(Integer) instead.

withMaxCompletionTokens

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withMaxCompletionTokens(Integer maxCompletionTokens)

Deprecated, for removal: This API element is subject to removal in a future version.

use maxCompletionTokens(Integer) instead.

withN

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withN(Integer n)

Deprecated, for removal: This API element is subject to removal in a future version.

use N(Integer) instead.

withOutputModalities

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withOutputModalities(List<String> modalities)

Deprecated, for removal: This API element is subject to removal in a future version.

use outputModalities(List) instead.

withOutputAudio

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withOutputAudio(OpenAiApi.ChatCompletionRequest.AudioParameters audio)

Deprecated, for removal: This API element is subject to removal in a future version.

use outputAudio(AudioParameters) instead.

withPresencePenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withPresencePenalty(Double presencePenalty)

Deprecated, for removal: This API element is subject to removal in a future version.

use presencePenalty(Double) instead.

withResponseFormat

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withResponseFormat(ResponseFormat responseFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

use responseFormat(ResponseFormat) instead.

withStreamUsage

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withStreamUsage(boolean enableStreamUsage)

Deprecated, for removal: This API element is subject to removal in a future version.

use streamUsage(boolean) instead.

withSeed

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withSeed(Integer seed)

Deprecated, for removal: This API element is subject to removal in a future version.

use seed(Integer) instead.

withStop

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withStop(List<String> stop)

Deprecated, for removal: This API element is subject to removal in a future version.

use stop(List) instead.

withTemperature

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withTemperature(Double temperature)

Deprecated, for removal: This API element is subject to removal in a future version.

use temperature(Double) instead.

withTopP

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withTopP(Double topP)

Deprecated, for removal: This API element is subject to removal in a future version.

use topP(Double) instead.

withTools

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withTools(List<OpenAiApi.FunctionTool> tools)

Deprecated, for removal: This API element is subject to removal in a future version.

use tools(List) instead.

withToolChoice

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withToolChoice(Object toolChoice)

Deprecated, for removal: This API element is subject to removal in a future version.

use toolChoice(Object) instead.

withUser

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withUser(String user)

Deprecated, for removal: This API element is subject to removal in a future version.

use user(String) instead.

withParallelToolCalls

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withParallelToolCalls(Boolean parallelToolCalls)

Deprecated, for removal: This API element is subject to removal in a future version.

use parallelToolCalls(Boolean) instead.

withFunctionCallbacks

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated, for removal: This API element is subject to removal in a future version.

use functionCallbacks(List) instead.

withFunctions

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withFunctions(Set<String> functionNames)

Deprecated, for removal: This API element is subject to removal in a future version.

use functions(Set) instead.

withFunction

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withFunction(String functionName)

Deprecated, for removal: This API element is subject to removal in a future version.

use function(String) instead.

withProxyToolCalls

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withProxyToolCalls(Boolean proxyToolCalls)

Deprecated, for removal: This API element is subject to removal in a future version.

use proxyToolCalls(Boolean) instead.

withHttpHeaders

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withHttpHeaders(Map<String,String> httpHeaders)

Deprecated, for removal: This API element is subject to removal in a future version.

use httpHeaders(Map) instead.

withToolContext

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public OpenAiChatOptions.Builder withToolContext(Map<String,Object> toolContext)

Deprecated, for removal: This API element is subject to removal in a future version.

use toolContext(Map) instead.

build

public OpenAiChatOptions build()