Class ChatRequest.Builder

java.lang.Object

dev.langchain4j.model.chat.request.ChatRequest.Builder

Enclosing class:

ChatRequest

public static class ChatRequest.Builder
extends Object

Builder for ChatRequest.

Override semantics: when parameters(ChatRequestParameters) is set together with one or more individual setters (e.g., modelName(String), temperature(Double), etc.), the values from the individual setters take precedence over the corresponding fields of parameters, while all other fields of parameters (including provider-specific fields on subclasses of ChatRequestParameters) are preserved. Merging is performed via ChatRequestParameters.overrideWith(ChatRequestParameters), which only overrides with non-null (and, for collections, non-empty) values — setting a field back to null via an individual setter will not clear an existing value on parameters.

This makes it easy to modify a single field of an existing ChatRequest via ChatRequest.toBuilder() without losing any other configuration.

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(ChatRequest chatRequest)

Method Summary

Modifier and Type	Method	Description
ChatRequest	build()
ChatRequest.Builder	frequencyPenalty(Double frequencyPenalty)
ChatRequest.Builder	maxOutputTokens(Integer maxOutputTokens)
ChatRequest.Builder	messages(ChatMessage... messages)
ChatRequest.Builder	messages(List<ChatMessage> messages)
ChatRequest.Builder	modelName(String modelName)
ChatRequest.Builder	parameters(ChatRequestParameters parameters)	Sets the ChatRequestParameters to be used as the base for this request.
ChatRequest.Builder	presencePenalty(Double presencePenalty)
ChatRequest.Builder	responseFormat(ResponseFormat responseFormat)
ChatRequest.Builder	stopSequences(List<String> stopSequences)
ChatRequest.Builder	temperature(Double temperature)
ChatRequest.Builder	toolChoice(ToolChoice toolChoice)
ChatRequest.Builder	toolSpecifications(ToolSpecification... toolSpecifications)
ChatRequest.Builder	toolSpecifications(List<ToolSpecification> toolSpecifications)
ChatRequest.Builder	topK(Integer topK)
ChatRequest.Builder	topP(Double topP)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Builder

public Builder(ChatRequest chatRequest)

Method Details

messages

public ChatRequest.Builder messages(List<ChatMessage> messages)

messages

public ChatRequest.Builder messages(ChatMessage... messages)

parameters

public ChatRequest.Builder parameters(ChatRequestParameters parameters)

Sets the ChatRequestParameters to be used as the base for this request.

Any individual setters called on this ChatRequest.Builder (e.g., modelName(String), temperature(Double), etc.) will override the corresponding fields of the supplied parameters; all other fields of parameters are preserved. See ChatRequest.Builder for full override semantics.

modelName

public ChatRequest.Builder modelName(String modelName)

temperature

public ChatRequest.Builder temperature(Double temperature)

topP

public ChatRequest.Builder topP(Double topP)

topK

public ChatRequest.Builder topK(Integer topK)

frequencyPenalty

public ChatRequest.Builder frequencyPenalty(Double frequencyPenalty)

presencePenalty

public ChatRequest.Builder presencePenalty(Double presencePenalty)

maxOutputTokens

public ChatRequest.Builder maxOutputTokens(Integer maxOutputTokens)

stopSequences

public ChatRequest.Builder stopSequences(List<String> stopSequences)

toolSpecifications

public ChatRequest.Builder toolSpecifications(List<ToolSpecification> toolSpecifications)

toolSpecifications

public ChatRequest.Builder toolSpecifications(ToolSpecification... toolSpecifications)

toolChoice

public ChatRequest.Builder toolChoice(ToolChoice toolChoice)

responseFormat

public ChatRequest.Builder responseFormat(ResponseFormat responseFormat)

build

public ChatRequest build()