Package dev.langchain4j.model.anthropic

Class AnthropicChatModel

java.lang.Object

dev.langchain4j.model.anthropic.AnthropicChatModel

All Implemented Interfaces:

ChatModel

public class AnthropicChatModel
extends Object
implements ChatModel

Represents an Anthropic language model with a Messages (chat) API.
More details are available here.

It supports tools. See more information 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 conform to Anthropic API requirements. This process includes verifying that the first message is a UserMessage and removing any 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	AnthropicChatModel.AnthropicChatModelBuilder

Method Summary

Modifier and Type	Method	Description
static AnthropicChatModel.AnthropicChatModelBuilder	builder()
ChatResponse	chat(ChatRequest chatRequest)	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.ChatModel

chat, chat, chat, defaultRequestParameters, doChat, supportedCapabilities

Method Details

builder

public static AnthropicChatModel.AnthropicChatModelBuilder builder()

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatModel

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

Specified by:

chat in interface ChatModel

Parameters:

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

Returns:

a ChatResponse, containing all the outputs from the LLM

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface ChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface ChatModel