Class WatsonxGatewayChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

dev.langchain4j.model.watsonx.WatsonxGatewayChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

public class WatsonxGatewayChatRequestParameters
extends DefaultChatRequestParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WatsonxGatewayChatRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final WatsonxGatewayChatRequestParameters	EMPTY

Method Summary

Modifier and Type	Method	Description
static WatsonxGatewayChatRequestParameters.Builder	builder()
WatsonxGatewayChatRequestParameters	defaultedBy(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
boolean	equals(Object o)
int	hashCode()
Map<String,Integer>	logitBias()
Boolean	logprobs()
Map<String,String>	metadata()
List<String>	modalities()
ChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Boolean	parallelToolCalls()
com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.ReasoningEffort	reasoningEffort()
com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.Router	router()
Integer	seed()
com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.ServiceTier	serviceTier()
Boolean	store()
Duration	timeout()
String	toolChoiceName()
Integer	topLogprobs()
String	toString()
String	user()

Methods inherited from class DefaultChatRequestParameters

frequencyPenalty, maxOutputTokens, modelName, presencePenalty, responseFormat, stopSequences, temperature, toolChoice, toolSpecifications, topK, topP

Methods inherited from class Object

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

Field Details

EMPTY

public static final WatsonxGatewayChatRequestParameters EMPTY

Method Details

logitBias

public Map<String,Integer> logitBias()

logprobs

public Boolean logprobs()

topLogprobs

public Integer topLogprobs()

seed

public Integer seed()

toolChoiceName

public String toolChoiceName()

timeout

public Duration timeout()

serviceTier

public com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.ServiceTier serviceTier()

reasoningEffort

public com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.ReasoningEffort reasoningEffort()

router

public com.ibm.watsonx.ai.gateway.chat.ModelGatewayParameters.Router router()

modalities

public List<String> modalities()

store

public Boolean store()

parallelToolCalls

public Boolean parallelToolCalls()

user

public String user()

metadata

public Map<String,String> metadata()

builder

public static WatsonxGatewayChatRequestParameters.Builder builder()

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

Overrides:

overrideWith in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will override the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

defaultedBy

public WatsonxGatewayChatRequestParameters defaultedBy(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the current parameters take precedence over values from the specified 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 = 1.0        // Preserved from current
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

defaultedBy in interface ChatRequestParameters

Overrides:

defaultedBy in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will be used as a default for the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultChatRequestParameters

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultChatRequestParameters

toString

public String toString()

Overrides:

toString in class DefaultChatRequestParameters