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)

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)

build

public OpenAiChatOptions build()