Package dev.langchain4j.model.anthropic
Class AnthropicStreamingChatModel
java.lang.Object
dev.langchain4j.model.anthropic.AnthropicStreamingChatModel
- All Implemented Interfaces:
StreamingChatLanguageModel
Represents an Anthropic language model with a Messages (chat) API.
The model's response is streamed token by token and should be handled with
More details are available here and here.
It supports
The content of
Sanitization is performed on the
Does not support tools.
StreamingResponseHandler
.
More details are available here and here.
It supports
Image
s as inputs. UserMessage
s can contain one or multiple ImageContent
s.
Image
s must not be represented as URLs; they should be Base64-encoded strings and include a mimeType
.
The content of
SystemMessage
s is sent using the "system" parameter.
If there are multiple SystemMessage
s, they are concatenated with a double newline (\n\n).
Sanitization is performed on the
ChatMessage
s provided to ensure conformity with Anthropic API requirements.
This includes ensuring the first message is a UserMessage
and that there are no consecutive UserMessage
s.
Any messages removed during sanitization are logged as warnings and not submitted to the API.
Does not support tools.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
-
Method Summary
Modifier and TypeMethodDescriptionvoid
generate
(List<ChatMessage> messages, StreamingResponseHandler<AiMessage> handler) Generates a response from the model based on a sequence of messages.static AnthropicStreamingChatModel
withApiKey
(String apiKey) Creates an instance ofAnthropicStreamingChatModel
with the specified API key.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.StreamingChatLanguageModel
generate, generate, generate, generate
-
Method Details
-
withApiKey
Creates an instance ofAnthropicStreamingChatModel
with the specified API key.- Parameters:
apiKey
- the API key for authentication- Returns:
- an
AnthropicStreamingChatModel
instance
-
generate
Description copied from interface:StreamingChatLanguageModel
Generates a response from the model based on a sequence of messages. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...- Specified by:
generate
in interfaceStreamingChatLanguageModel
- Parameters:
messages
- A list of messages.handler
- The handler for streaming the response.
-