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	withFrequencyPenalty(Double frequencyPenalty)
OpenAiChatOptions.Builder	withFunction(String functionName)
OpenAiChatOptions.Builder	withFunctionCallbacks(List<FunctionCallback> functionCallbacks)
OpenAiChatOptions.Builder	withFunctions(Set<String> functionNames)
OpenAiChatOptions.Builder	withHttpHeaders(Map<String,String> httpHeaders)
OpenAiChatOptions.Builder	withLogitBias(Map<String,Integer> logitBias)
OpenAiChatOptions.Builder	withLogprobs(Boolean logprobs)
OpenAiChatOptions.Builder	withMaxCompletionTokens(Integer maxCompletionTokens)
OpenAiChatOptions.Builder	withMaxTokens(Integer maxTokens)
OpenAiChatOptions.Builder	withModel(String model)
OpenAiChatOptions.Builder	withModel(OpenAiApi.ChatModel openAiChatModel)
OpenAiChatOptions.Builder	withN(Integer n)
OpenAiChatOptions.Builder	withParallelToolCalls(Boolean parallelToolCalls)
OpenAiChatOptions.Builder	withPresencePenalty(Double presencePenalty)
OpenAiChatOptions.Builder	withProxyToolCalls(Boolean proxyToolCalls)
OpenAiChatOptions.Builder	withResponseFormat(OpenAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
OpenAiChatOptions.Builder	withSeed(Integer seed)
OpenAiChatOptions.Builder	withStop(List<String> stop)
OpenAiChatOptions.Builder	withStreamUsage(boolean enableStreamUsage)
OpenAiChatOptions.Builder	withTemperature(Double temperature)
OpenAiChatOptions.Builder	withToolChoice(String toolChoice)
OpenAiChatOptions.Builder	withToolContext(Map<String,Object> toolContext)
OpenAiChatOptions.Builder	withTools(List<OpenAiApi.FunctionTool> tools)
OpenAiChatOptions.Builder	withTopLogprobs(Integer topLogprobs)
OpenAiChatOptions.Builder	withTopP(Double topP)
OpenAiChatOptions.Builder	withUser(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

withModel

public OpenAiChatOptions.Builder withModel(String model)

withModel

public OpenAiChatOptions.Builder withModel(OpenAiApi.ChatModel openAiChatModel)

withFrequencyPenalty

public OpenAiChatOptions.Builder withFrequencyPenalty(Double frequencyPenalty)

withLogitBias

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

withLogprobs

public OpenAiChatOptions.Builder withLogprobs(Boolean logprobs)

withTopLogprobs

public OpenAiChatOptions.Builder withTopLogprobs(Integer topLogprobs)

withMaxTokens

public OpenAiChatOptions.Builder withMaxTokens(Integer maxTokens)

withMaxCompletionTokens

public OpenAiChatOptions.Builder withMaxCompletionTokens(Integer maxCompletionTokens)

withN

public OpenAiChatOptions.Builder withN(Integer n)

withPresencePenalty

public OpenAiChatOptions.Builder withPresencePenalty(Double presencePenalty)

withResponseFormat

public OpenAiChatOptions.Builder withResponseFormat(OpenAiApi.ChatCompletionRequest.ResponseFormat responseFormat)

withStreamUsage

public OpenAiChatOptions.Builder withStreamUsage(boolean enableStreamUsage)

withSeed

public OpenAiChatOptions.Builder withSeed(Integer seed)

withStop

public OpenAiChatOptions.Builder withStop(List<String> stop)

withTemperature

public OpenAiChatOptions.Builder withTemperature(Double temperature)

withTopP

public OpenAiChatOptions.Builder withTopP(Double topP)

withTools

public OpenAiChatOptions.Builder withTools(List<OpenAiApi.FunctionTool> tools)

withToolChoice

public OpenAiChatOptions.Builder withToolChoice(String toolChoice)

withUser

public OpenAiChatOptions.Builder withUser(String user)

withParallelToolCalls

public OpenAiChatOptions.Builder withParallelToolCalls(Boolean parallelToolCalls)

withFunctionCallbacks

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

withFunctions

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

withFunction

public OpenAiChatOptions.Builder withFunction(String functionName)

withProxyToolCalls

public OpenAiChatOptions.Builder withProxyToolCalls(Boolean proxyToolCalls)

withHttpHeaders

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

withToolContext

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

build

public OpenAiChatOptions build()