Class AnthropicChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

dev.langchain4j.model.anthropic.AnthropicChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

public class AnthropicChatRequestParameters
extends DefaultChatRequestParameters

Anthropic-specific ChatRequestParameters that can be set per request (i.e., per ChatRequest), overriding the values configured on the AnthropicChatModel / AnthropicStreamingChatModel builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnthropicChatRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final AnthropicChatRequestParameters	EMPTY

Method Summary

Modifier and Type	Method	Description
static AnthropicChatRequestParameters.Builder	builder()
Boolean	cacheSystemMessages()
Boolean	cacheTools()
AnthropicChatRequestParameters	defaultedBy(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Boolean	disableParallelToolUse()
boolean	equals(Object o)
int	hashCode()
Boolean	midConversationSystemMessages()
AnthropicChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
String	previousMessageId()	The id of the previous response to compare against when returnCacheDiagnostics() is enabled.
Boolean	returnCacheDiagnostics()	Whether to request a (beta) cache-diagnostics comparison for this request.
Boolean	returnThinking()
Boolean	sendThinking()
Integer	thinkingBudgetTokens()
String	thinkingType()
AnthropicChatRequestParameters.Builder	toBuilder()
String	toolChoiceName()
String	toString()
String	userId()

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 AnthropicChatRequestParameters EMPTY

Method Details

cacheSystemMessages

public Boolean cacheSystemMessages()

cacheTools

public Boolean cacheTools()

thinkingType

public String thinkingType()

thinkingBudgetTokens

public Integer thinkingBudgetTokens()

sendThinking

public Boolean sendThinking()

midConversationSystemMessages

public Boolean midConversationSystemMessages()

returnThinking

public Boolean returnThinking()

toolChoiceName

public String toolChoiceName()

disableParallelToolUse

public Boolean disableParallelToolUse()

userId

public String userId()

returnCacheDiagnostics

public Boolean returnCacheDiagnostics()

Whether to request a (beta) cache-diagnostics comparison for this request.

See Also:

• AnthropicCacheDiagnostics

previousMessageId

public String previousMessageId()

The id of the previous response to compare against when returnCacheDiagnostics() is enabled. Pass null on the first turn of a conversation to opt in without a prior message to compare, and the id of the previous AnthropicChatResponseMetadata on every subsequent turn.

This is a per-request value: it changes on every turn and there is intentionally no model-level setter for it. It can therefore be varied per request on its own, while returnCacheDiagnostics() is enabled once on the model builder — the per-request previousMessageId is not paired with, or gated on, returnCacheDiagnostics.

See Also:

• AnthropicCacheDiagnostics

overrideWith

public AnthropicChatRequestParameters 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 AnthropicChatRequestParameters 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

toBuilder

public AnthropicChatRequestParameters.Builder toBuilder()

builder

public static AnthropicChatRequestParameters.Builder builder()