Class AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder

java.lang.Object

dev.langchain4j.model.anthropic.AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder

Enclosing class:

AnthropicStreamingChatModel

public static class AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
AnthropicStreamingChatModelBuilder()

Method Summary

Modifier and Type	Method	Description
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	apiKey(String apiKey)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	baseUrl(String baseUrl)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	beta(String beta)
AnthropicStreamingChatModel	build()
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	cacheSystemMessages(Boolean cacheSystemMessages)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	cacheTools(Boolean cacheTools)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	customParameters(Map<String,Object> customParameters)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	disableParallelToolUse(Boolean disableParallelToolUse)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	httpClientBuilder(HttpClientBuilder httpClientBuilder)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	listeners(List<ChatModelListener> listeners)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	logger(org.slf4j.Logger logger)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	logRequests(Boolean logRequests)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	logResponses(Boolean logResponses)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	maxTokens(Integer maxTokens)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	modelName(AnthropicChatModelName modelName)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	modelName(String modelName)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	responseFormat(ResponseFormat responseFormat)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	returnServerToolResults(Boolean returnServerToolResults)	Controls whether to return server tool results (e.g., web_search, code_execution) inside AiMessage.attributes() under the key "server_tool_results".
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	returnThinking(Boolean returnThinking)	Controls whether to return thinking/reasoning text (if available) inside AiMessage.thinking() and whether to invoke the StreamingChatResponseHandler.onPartialThinking(PartialThinking) callback.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	sendThinking(Boolean sendThinking)	Controls whether to send thinking/reasoning text to the LLM in follow-up requests.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	serverTools(AnthropicServerTool... serverTools)	Specifies server tools to be included in each request to the Anthropic API.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	serverTools(List<AnthropicServerTool> serverTools)	Specifies server tools to be included in each request to the Anthropic API.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	stopSequences(List<String> stopSequences)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	strictTools(Boolean strictTools)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	supportedCapabilities(Capability... supportedCapabilities)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	supportedCapabilities(Set<Capability> supportedCapabilities)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	temperature(Double temperature)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	thinkingBudgetTokens(Integer thinkingBudgetTokens)	Configures thinking.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	thinkingType(String thinkingType)	Enables thinking.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	timeout(Duration timeout)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolChoice(ToolChoice toolChoice)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolChoiceName(String toolChoiceName)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolMetadataKeysToSend(String... toolMetadataKeysToSend)	Specifies metadata keys from the ToolSpecification.metadata() to be included in the request.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolMetadataKeysToSend(Set<String> toolMetadataKeysToSend)	Specifies metadata keys from the ToolSpecification.metadata() to be included in the request.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolSpecifications(ToolSpecification... toolSpecifications)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	toolSpecifications(List<ToolSpecification> toolSpecifications)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	topK(Integer topK)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	topP(Double topP)
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	userId(String userId)	Sets the user ID for the requests.
AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	version(String version)

Methods inherited from class Object

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

Constructor Details

AnthropicStreamingChatModelBuilder

public AnthropicStreamingChatModelBuilder()

Method Details

httpClientBuilder

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder httpClientBuilder(HttpClientBuilder httpClientBuilder)

baseUrl

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder baseUrl(String baseUrl)

apiKey

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder apiKey(String apiKey)

version

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder version(String version)

beta

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder beta(String beta)

modelName

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder modelName(String modelName)

modelName

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder modelName(AnthropicChatModelName modelName)

temperature

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder temperature(Double temperature)

topP

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder topP(Double topP)

topK

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder topK(Integer topK)

maxTokens

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder maxTokens(Integer maxTokens)

stopSequences

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder stopSequences(List<String> stopSequences)

responseFormat

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder responseFormat(ResponseFormat responseFormat)

toolSpecifications

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolSpecifications(List<ToolSpecification> toolSpecifications)

toolSpecifications

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolSpecifications(ToolSpecification... toolSpecifications)

cacheSystemMessages

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder cacheSystemMessages(Boolean cacheSystemMessages)

cacheTools

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder cacheTools(Boolean cacheTools)

thinkingType

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder thinkingType(String thinkingType)

Enables thinking.

thinkingBudgetTokens

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder thinkingBudgetTokens(Integer thinkingBudgetTokens)

Configures thinking.

returnThinking

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder returnThinking(Boolean returnThinking)

Controls whether to return thinking/reasoning text (if available) inside AiMessage.thinking() and whether to invoke the StreamingChatResponseHandler.onPartialThinking(PartialThinking) callback. Please note that this does not enable thinking/reasoning for the LLM; it only controls whether to parse the thinking field from the API response and return it inside the AiMessage.

Disabled by default. If enabled, the thinking text will be stored within the AiMessage and may be persisted. If enabled, thinking signatures will also be stored and returned inside the AiMessage.attributes().

See Also:

• thinkingType(String)
• thinkingBudgetTokens(Integer)
• sendThinking(Boolean)

sendThinking

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder sendThinking(Boolean sendThinking)

Controls whether to send thinking/reasoning text to the LLM in follow-up requests.

Enabled by default. If enabled, the contents of AiMessage.thinking() will be sent in the API request. If enabled, thinking signatures (inside the AiMessage.attributes()) will also be sent.

See Also:

• thinkingType(String)
• thinkingBudgetTokens(Integer)
• returnThinking(Boolean)

timeout

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder timeout(Duration timeout)

logRequests

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder logRequests(Boolean logRequests)

logResponses

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder logResponses(Boolean logResponses)

logger

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder logger(org.slf4j.Logger logger)

Parameters:

logger - an alternate Logger to be used instead of the default one provided by Langchain4J for logging requests and responses.

Returns:

this.

listeners

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder listeners(List<ChatModelListener> listeners)

toolChoice

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolChoice(ToolChoice toolChoice)

toolChoiceName

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolChoiceName(String toolChoiceName)

disableParallelToolUse

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder disableParallelToolUse(Boolean disableParallelToolUse)

serverTools

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder serverTools(List<AnthropicServerTool> serverTools)

Specifies server tools to be included in each request to the Anthropic API. For example:

AnthropicServerTool webSearchTool = AnthropicServerTool.builder()
    .type("web_search_20250305")
    .name("web_search")
    .addAttribute("max_uses", 5)
    .addAttribute("allowed_domains", List.of("accuweather.com"))
    .build();

serverTools

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder serverTools(AnthropicServerTool... serverTools)

Specifies server tools to be included in each request to the Anthropic API. For example:

AnthropicServerTool webSearchTool = AnthropicServerTool.builder()
    .type("web_search_20250305")
    .name("web_search")
    .addAttribute("max_uses", 5)
    .addAttribute("allowed_domains", List.of("accuweather.com"))
    .build();

returnServerToolResults

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder returnServerToolResults(Boolean returnServerToolResults)

Controls whether to return server tool results (e.g., web_search, code_execution) inside AiMessage.attributes() under the key "server_tool_results".

Disabled by default to avoid polluting ChatMemory with potentially large data. If enabled, server tool results will be stored as a List<AnthropicServerToolResult> within the AiMessage attributes.

See Also:

• serverTools(List)

toolMetadataKeysToSend

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolMetadataKeysToSend(Set<String> toolMetadataKeysToSend)

Specifies metadata keys from the ToolSpecification.metadata() to be included in the request.

toolMetadataKeysToSend

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder toolMetadataKeysToSend(String... toolMetadataKeysToSend)

Specifies metadata keys from the ToolSpecification.metadata() to be included in the request.

userId

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder userId(String userId)

Sets the user ID for the requests. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.

Parameters:

userId - the user identifier

Returns:

this builder

customParameters

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder customParameters(Map<String,Object> customParameters)

strictTools

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder strictTools(Boolean strictTools)

supportedCapabilities

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder supportedCapabilities(Capability... supportedCapabilities)

supportedCapabilities

public AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder supportedCapabilities(Set<Capability> supportedCapabilities)

build

public AnthropicStreamingChatModel build()