Package dev.langchain4j.model.anthropic

Class AnthropicStreamingChatModel

java.lang.Object

dev.langchain4j.model.anthropic.AnthropicStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

public class AnthropicStreamingChatModel
extends Object
implements StreamingChatModel

Represents an Anthropic language model with a Messages (chat) API. The model's response is streamed token by token and should be handled with StreamingResponseHandler.
More details are available here and here.

It supports Images as inputs. UserMessages can contain one or multiple ImageContents. Images must not be represented as URLs; they should be Base64-encoded strings and include a mimeType.

The content of SystemMessages is sent using the "system" parameter.

Sanitization is performed on the ChatMessages provided to ensure conformity with Anthropic API requirements. This includes ensuring the first message is a UserMessage and that there are no consecutive UserMessages. Any messages removed during sanitization are logged as warnings and not submitted to the API.

Supports caching SystemMessages and ToolSpecifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder

Method Summary

Modifier and Type	Method	Description
static AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder	builder()
void	chat(ChatRequest chatRequest, StreamingChatResponseHandler handler)	This is the main API to interact with the chat model.
List<ChatModelListener>	listeners()
ModelProvider	provider()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.StreamingChatModel

chat, chat, defaultRequestParameters, doChat, supportedCapabilities

Method Details

builder

public static AnthropicStreamingChatModel.AnthropicStreamingChatModelBuilder builder()

chat

public void chat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Description copied from interface: StreamingChatModel

This is the main API to interact with the chat model.

Specified by:

chat in interface StreamingChatModel

Parameters:

chatRequest - a ChatRequest, containing all the inputs to the LLM

handler - a StreamingChatResponseHandler that will handle streaming response from the LLM

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface StreamingChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface StreamingChatModel