Class ChatCompletionRequest.Builder

java.lang.Object

dev.langchain4j.model.openai.internal.chat.ChatCompletionRequest.Builder

Enclosing class:

ChatCompletionRequest

public static final class ChatCompletionRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChatCompletionRequest.Builder	addAssistantMessage(String assistantMessage)
ChatCompletionRequest.Builder	addSystemMessage(String systemMessage)
ChatCompletionRequest.Builder	addToolMessage(String toolCallId, String content)
ChatCompletionRequest.Builder	addUserMessage(String userMessage)
ChatCompletionRequest	build()
ChatCompletionRequest.Builder	customParameters(Map<String,Object> customParameters)
ChatCompletionRequest.Builder	frequencyPenalty(Double frequencyPenalty)
ChatCompletionRequest.Builder	from(ChatCompletionRequest instance)
ChatCompletionRequest.Builder	functionCall(FunctionCall functionCall)	Deprecated.
ChatCompletionRequest.Builder	functionCall(String functionName)	Deprecated.
ChatCompletionRequest.Builder	functions(Function... functions)	Deprecated.
ChatCompletionRequest.Builder	functions(List<Function> functions)	Deprecated.
ChatCompletionRequest.Builder	logitBias(Map<String,Integer> logitBias)
ChatCompletionRequest.Builder	maxCompletionTokens(Integer maxCompletionTokens)
ChatCompletionRequest.Builder	maxTokens(Integer maxTokens)
ChatCompletionRequest.Builder	messages(Message... messages)
ChatCompletionRequest.Builder	messages(List<Message> messages)
ChatCompletionRequest.Builder	metadata(Map<String,String> metadata)
ChatCompletionRequest.Builder	model(String model)
ChatCompletionRequest.Builder	n(Integer n)
ChatCompletionRequest.Builder	parallelToolCalls(Boolean parallelToolCalls)
ChatCompletionRequest.Builder	presencePenalty(Double presencePenalty)
ChatCompletionRequest.Builder	reasoningEffort(String reasoningEffort)
ChatCompletionRequest.Builder	responseFormat(ResponseFormat responseFormat)
ChatCompletionRequest.Builder	responseFormat(ResponseFormatType responseFormatType)
ChatCompletionRequest.Builder	seed(Integer seed)
ChatCompletionRequest.Builder	serviceTier(String serviceTier)
ChatCompletionRequest.Builder	stop(String... stop)
ChatCompletionRequest.Builder	stop(List<String> stop)
ChatCompletionRequest.Builder	store(Boolean store)
ChatCompletionRequest.Builder	stream(Boolean stream)
ChatCompletionRequest.Builder	streamOptions(StreamOptions streamOptions)
ChatCompletionRequest.Builder	temperature(Double temperature)
ChatCompletionRequest.Builder	toolChoice(ToolChoiceMode toolChoiceMode)
ChatCompletionRequest.Builder	toolChoice(Object toolChoice)
ChatCompletionRequest.Builder	toolChoice(String functionName)
ChatCompletionRequest.Builder	tools(Tool... tools)
ChatCompletionRequest.Builder	tools(List<Tool> tools)
ChatCompletionRequest.Builder	topP(Double topP)
ChatCompletionRequest.Builder	user(String user)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

from

public ChatCompletionRequest.Builder from(ChatCompletionRequest instance)

model

public ChatCompletionRequest.Builder model(String model)

messages

public ChatCompletionRequest.Builder messages(List<Message> messages)

messages

public ChatCompletionRequest.Builder messages(Message... messages)

addSystemMessage

public ChatCompletionRequest.Builder addSystemMessage(String systemMessage)

addUserMessage

public ChatCompletionRequest.Builder addUserMessage(String userMessage)

addAssistantMessage

public ChatCompletionRequest.Builder addAssistantMessage(String assistantMessage)

addToolMessage

public ChatCompletionRequest.Builder addToolMessage(String toolCallId,
 String content)

temperature

public ChatCompletionRequest.Builder temperature(Double temperature)

topP

public ChatCompletionRequest.Builder topP(Double topP)

n

public ChatCompletionRequest.Builder n(Integer n)

stream

public ChatCompletionRequest.Builder stream(Boolean stream)

streamOptions

public ChatCompletionRequest.Builder streamOptions(StreamOptions streamOptions)

stop

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

stop

public ChatCompletionRequest.Builder stop(String... stop)

maxTokens

public ChatCompletionRequest.Builder maxTokens(Integer maxTokens)

maxCompletionTokens

public ChatCompletionRequest.Builder maxCompletionTokens(Integer maxCompletionTokens)

presencePenalty

public ChatCompletionRequest.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public ChatCompletionRequest.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

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

user

public ChatCompletionRequest.Builder user(String user)

responseFormat

public ChatCompletionRequest.Builder responseFormat(ResponseFormatType responseFormatType)

responseFormat

public ChatCompletionRequest.Builder responseFormat(ResponseFormat responseFormat)

seed

public ChatCompletionRequest.Builder seed(Integer seed)

tools

public ChatCompletionRequest.Builder tools(List<Tool> tools)

tools

public ChatCompletionRequest.Builder tools(Tool... tools)

toolChoice

public ChatCompletionRequest.Builder toolChoice(ToolChoiceMode toolChoiceMode)

toolChoice

public ChatCompletionRequest.Builder toolChoice(String functionName)

toolChoice

public ChatCompletionRequest.Builder toolChoice(Object toolChoice)

parallelToolCalls

public ChatCompletionRequest.Builder parallelToolCalls(Boolean parallelToolCalls)

store

public ChatCompletionRequest.Builder store(Boolean store)

metadata

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

reasoningEffort

public ChatCompletionRequest.Builder reasoningEffort(String reasoningEffort)

serviceTier

public ChatCompletionRequest.Builder serviceTier(String serviceTier)

functions

@Deprecated
public ChatCompletionRequest.Builder functions(Function... functions)

Deprecated.

functions

@Deprecated
public ChatCompletionRequest.Builder functions(List<Function> functions)

Deprecated.

functionCall

@Deprecated
public ChatCompletionRequest.Builder functionCall(String functionName)

Deprecated.

functionCall

@Deprecated
public ChatCompletionRequest.Builder functionCall(FunctionCall functionCall)

Deprecated.

customParameters

public ChatCompletionRequest.Builder customParameters(Map<String,Object> customParameters)

build

public ChatCompletionRequest build()