Class DefaultChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

Direct Known Subclasses:

BedrockChatRequestParameters, OllamaChatRequestParameters, OpenAiChatRequestParameters, OpenAiOfficialChatRequestParameters, WatsonxChatRequestParameters

public class DefaultChatRequestParameters
extends Object
implements ChatRequestParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultChatRequestParameters.Builder<T extends DefaultChatRequestParameters.Builder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatRequestParameters	EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultChatRequestParameters(DefaultChatRequestParameters.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
static DefaultChatRequestParameters.Builder<?>	builder()
boolean	equals(Object o)
Double	frequencyPenalty()
int	hashCode()
Integer	maxOutputTokens()
String	modelName()
ChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Double	presencePenalty()
ResponseFormat	responseFormat()
List<String>	stopSequences()
Double	temperature()
ToolChoice	toolChoice()
List<ToolSpecification>	toolSpecifications()
Integer	topK()
Double	topP()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final ChatRequestParameters EMPTY

Constructor Details

DefaultChatRequestParameters

protected DefaultChatRequestParameters(DefaultChatRequestParameters.Builder<?> builder)

Method Details

modelName

public String modelName()

Specified by:

modelName in interface ChatRequestParameters

temperature

public Double temperature()

Specified by:

temperature in interface ChatRequestParameters

topP

public Double topP()

Specified by:

topP in interface ChatRequestParameters

topK

public Integer topK()

Specified by:

topK in interface ChatRequestParameters

frequencyPenalty

public Double frequencyPenalty()

Specified by:

frequencyPenalty in interface ChatRequestParameters

presencePenalty

public Double presencePenalty()

Specified by:

presencePenalty in interface ChatRequestParameters

maxOutputTokens

public Integer maxOutputTokens()

Specified by:

maxOutputTokens in interface ChatRequestParameters

stopSequences

public List<String> stopSequences()

Specified by:

stopSequences in interface ChatRequestParameters

toolSpecifications

public List<ToolSpecification> toolSpecifications()

Specified by:

toolSpecifications in interface ChatRequestParameters

toolChoice

public ToolChoice toolChoice()

Specified by:

toolChoice in interface ChatRequestParameters

responseFormat

public ResponseFormat responseFormat()

Specified by:

responseFormat in interface ChatRequestParameters

overrideWith

public ChatRequestParameters overrideWith(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the specified parameters override values from the current parameters when there is overlap. Neither the current nor the specified ChatRequestParameters objects are modified.

Example:

Current parameters:
  temperature = 1.0
  maxOutputTokens = 100

Specified parameters:
  temperature = 0.5
  modelName = my-model

Result:
  temperature = 0.5        // Overridden from specified
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

overrideWith in interface ChatRequestParameters

Parameters:

that - the parameters whose values will override the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultChatRequestParameters.Builder<?> builder()