Uses of Interface
dev.langchain4j.data.message.ChatMessage

Packages that use ChatMessage

Package	Description
dev.langchain4j.agentic.scope
dev.langchain4j.data.message
dev.langchain4j.guardrail
dev.langchain4j.internal
dev.langchain4j.mcp.client
dev.langchain4j.memory
dev.langchain4j.memory.chat
dev.langchain4j.model
dev.langchain4j.model.anthropic
dev.langchain4j.model.anthropic.internal.mapper
dev.langchain4j.model.azure
dev.langchain4j.model.chat
dev.langchain4j.model.chat.request
dev.langchain4j.model.googleai
dev.langchain4j.model.mistralai
dev.langchain4j.model.mistralai.internal.mapper
dev.langchain4j.model.moderation
dev.langchain4j.model.openai
dev.langchain4j.model.openai.internal
dev.langchain4j.model.watsonx
dev.langchain4j.rag
dev.langchain4j.rag.content.injector
dev.langchain4j.rag.query
dev.langchain4j.rag.query.transformer
dev.langchain4j.service
dev.langchain4j.service.tool
dev.langchain4j.store.memory.azure.cosmos.nosql
dev.langchain4j.store.memory.chat
dev.langchain4j.store.memory.chat.cassandra
dev.langchain4j.store.memory.chat.coherence
dev.langchain4j.store.memory.chat.tablestore

Uses of ChatMessage in dev.langchain4j.agentic.scope

Methods in dev.langchain4j.agentic.scope that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	DefaultAgenticScope.AgentMessage.message()	Returns the value of the message record component.

Constructors in dev.langchain4j.agentic.scope with parameters of type ChatMessage

Modifier	Constructor	Description
	AgentMessage(String agentName, String agentUniqueName, ChatMessage message)	Creates an instance of a AgentMessage record class.

Uses of ChatMessage in dev.langchain4j.data.message

Classes in dev.langchain4j.data.message that implement ChatMessage

Modifier and Type	Class	Description
class	AiMessage	Represents a message generated by AI (language model).
class	CustomMessage	Represents a custom message.
class	SystemMessage	Represents a system message, typically defined by a developer.
class	ToolExecutionResultMessage	Represents the result of a tool execution in response to a ToolExecutionRequest.
class	UserMessage	Represents a message from a user, typically an end user of the application.

Methods in dev.langchain4j.data.message that return ChatMessage

Modifier and Type	Method	Description
static ChatMessage	ChatMessageDeserializer.messageFromJson(String json)	Deserializes a JSON string into a ChatMessage.
ChatMessage	ChatMessageJsonCodec.messageFromJson(String json)	Deserializes a JSON string to a ChatMessage object.
ChatMessage	JacksonChatMessageJsonCodec.messageFromJson(String json)

Methods in dev.langchain4j.data.message that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
Class<? extends ChatMessage>	ChatMessageType.messageClass()	Returns the class of the message type.
static List<ChatMessage>	ChatMessageDeserializer.messagesFromJson(String json)	Deserializes a JSON string into a list of ChatMessage.
List<ChatMessage>	ChatMessageJsonCodec.messagesFromJson(String json)	Deserializes a JSON string to a list of ChatMessage objects.
List<ChatMessage>	JacksonChatMessageJsonCodec.messagesFromJson(String json)

Methods in dev.langchain4j.data.message with parameters of type ChatMessage

Modifier and Type	Method	Description
String	ChatMessageJsonCodec.messageToJson(ChatMessage message)	Serializes a ChatMessage object to a JSON string.
static String	ChatMessageSerializer.messageToJson(ChatMessage message)	Serializes a chat message into a JSON string.
String	JacksonChatMessageJsonCodec.messageToJson(ChatMessage message)

Method parameters in dev.langchain4j.data.message with type arguments of type ChatMessage

Modifier and Type	Method	Description
static List<SystemMessage>	SystemMessage.findAll(List<ChatMessage> messages)
static Optional<SystemMessage>	SystemMessage.findFirst(List<ChatMessage> messages)
static Optional<SystemMessage>	SystemMessage.findLast(List<ChatMessage> messages)
String	ChatMessageJsonCodec.messagesToJson(List<ChatMessage> messages)	Serializes a list of ChatMessage objects to a JSON string.
static String	ChatMessageSerializer.messagesToJson(List<ChatMessage> messages)	Serializes a list of chat messages into a JSON string.
String	JacksonChatMessageJsonCodec.messagesToJson(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.guardrail

Method parameters in dev.langchain4j.guardrail with type arguments of type ChatMessage

Modifier and Type	Method	Description
ChatResponse	ChatExecutor.execute(List<ChatMessage> chatMessages)	Executes a chat request using the provided chat messages

Uses of ChatMessage in dev.langchain4j.internal

Method parameters in dev.langchain4j.internal with type arguments of type ChatMessage

Modifier and Type	Method	Description
static void	ChatRequestValidationUtils.validateMessages(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.mcp.client

Methods in dev.langchain4j.mcp.client that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	McpPromptMessage.toChatMessage()	Converts this MCP-specific PromptMessage representation to a ChatMessage object from the core LangChain4j API, if possible.

Uses of ChatMessage in dev.langchain4j.memory

Methods in dev.langchain4j.memory that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	ChatMemory.messages()	Retrieves messages from the chat memory.

Methods in dev.langchain4j.memory with parameters of type ChatMessage

Modifier and Type	Method	Description
void	ChatMemory.add(ChatMessage message)	Adds a message to the chat memory.
default void	ChatMemory.add(ChatMessage... messages)	Adds messages to the chat memory

Method parameters in dev.langchain4j.memory with type arguments of type ChatMessage

Modifier and Type	Method	Description
default void	ChatMemory.add(Iterable<ChatMessage> messages)	Adds messages to the chat memory

Uses of ChatMessage in dev.langchain4j.memory.chat

Methods in dev.langchain4j.memory.chat that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	MessageWindowChatMemory.messages()
List<ChatMessage>	TokenWindowChatMemory.messages()

Methods in dev.langchain4j.memory.chat with parameters of type ChatMessage

Modifier and Type	Method	Description
void	MessageWindowChatMemory.add(ChatMessage message)
void	TokenWindowChatMemory.add(ChatMessage message)

Uses of ChatMessage in dev.langchain4j.model

Methods in dev.langchain4j.model with parameters of type ChatMessage

Modifier and Type	Method	Description
int	TokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)	Estimates the count of tokens in the given message.

Method parameters in dev.langchain4j.model with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	TokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)	Estimates the count of tokens in the given messages.

Uses of ChatMessage in dev.langchain4j.model.anthropic

Methods in dev.langchain4j.model.anthropic with parameters of type ChatMessage

Modifier and Type	Method	Description
int	AnthropicTokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.anthropic with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	AnthropicTokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.anthropic.internal.mapper

Method parameters in dev.langchain4j.model.anthropic.internal.mapper with type arguments of type ChatMessage

Modifier and Type	Method	Description
static List<AnthropicMessage>	AnthropicMapper.toAnthropicMessages(List<ChatMessage> messages)
static List<AnthropicMessage>	AnthropicMapper.toAnthropicMessages(List<ChatMessage> messages, boolean sendThinking)
static List<AnthropicTextContent>	AnthropicMapper.toAnthropicSystemPrompt(List<ChatMessage> messages, AnthropicCacheType cacheType)

Uses of ChatMessage in dev.langchain4j.model.azure

Methods in dev.langchain4j.model.azure with parameters of type ChatMessage

Modifier and Type	Method	Description
int	AzureOpenAiTokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.azure with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	AzureOpenAiTokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.chat

Methods in dev.langchain4j.model.chat with parameters of type ChatMessage

Modifier and Type	Method	Description
default ChatResponse	ChatModel.chat(ChatMessage... messages)

Method parameters in dev.langchain4j.model.chat with type arguments of type ChatMessage

Modifier and Type	Method	Description
default ChatResponse	ChatModel.chat(List<ChatMessage> messages)
default void	StreamingChatModel.chat(List<ChatMessage> messages, StreamingChatResponseHandler handler)

Uses of ChatMessage in dev.langchain4j.model.chat.request

Methods in dev.langchain4j.model.chat.request that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	ChatRequest.messages()

Methods in dev.langchain4j.model.chat.request with parameters of type ChatMessage

Modifier and Type	Method	Description
ChatRequest.Builder	ChatRequest.Builder.messages(ChatMessage... messages)

Method parameters in dev.langchain4j.model.chat.request with type arguments of type ChatMessage

Modifier and Type	Method	Description
ChatRequest.Builder	ChatRequest.Builder.messages(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.googleai

Methods in dev.langchain4j.model.googleai with parameters of type ChatMessage

Modifier and Type	Method	Description
int	GoogleAiGeminiTokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.googleai with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	GoogleAiGeminiTokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.mistralai

Method parameters in dev.langchain4j.model.mistralai with type arguments of type ChatMessage

Modifier and Type	Method	Description
Response<Moderation>	MistralAiModerationModel.moderate(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.mistralai.internal.mapper

Method parameters in dev.langchain4j.model.mistralai.internal.mapper with type arguments of type ChatMessage

Modifier and Type	Method	Description
static List<MistralAiChatMessage>	MistralAiMapper.toMistralAiMessages(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.moderation

Methods in dev.langchain4j.model.moderation with parameters of type ChatMessage

Modifier and Type	Method	Description
Response<Moderation>	DisabledModerationModel.moderate(ChatMessage message)
default Response<Moderation>	ModerationModel.moderate(ChatMessage message)	Moderates the given chat message.

Method parameters in dev.langchain4j.model.moderation with type arguments of type ChatMessage

Modifier and Type	Method	Description
Response<Moderation>	DisabledModerationModel.moderate(List<ChatMessage> messages)
Response<Moderation>	ModerationModel.moderate(List<ChatMessage> messages)	Moderates the given list of chat messages.

Uses of ChatMessage in dev.langchain4j.model.openai

Methods in dev.langchain4j.model.openai with parameters of type ChatMessage

Modifier and Type	Method	Description
int	OpenAiTokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.openai with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	OpenAiTokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)
Response<Moderation>	OpenAiModerationModel.moderate(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.openai.internal

Methods in dev.langchain4j.model.openai.internal with parameters of type ChatMessage

Modifier and Type	Method	Description
static Message	OpenAiUtils.toOpenAiMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.openai.internal with type arguments of type ChatMessage

Modifier and Type	Method	Description
static List<Message>	OpenAiUtils.toOpenAiMessages(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.model.watsonx

Methods in dev.langchain4j.model.watsonx with parameters of type ChatMessage

Modifier and Type	Method	Description
int	WatsonxTokenCountEstimator.estimateTokenCountInMessage(ChatMessage message)

Method parameters in dev.langchain4j.model.watsonx with type arguments of type ChatMessage

Modifier and Type	Method	Description
int	WatsonxTokenCountEstimator.estimateTokenCountInMessages(Iterable<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.rag

Methods in dev.langchain4j.rag that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	AugmentationRequest.chatMessage()
ChatMessage	AugmentationResult.chatMessage()

Methods in dev.langchain4j.rag with parameters of type ChatMessage

Modifier and Type	Method	Description
AugmentationResult.AugmentationResultBuilder	AugmentationResult.AugmentationResultBuilder.chatMessage(ChatMessage chatMessage)

Constructors in dev.langchain4j.rag with parameters of type ChatMessage

Modifier	Constructor	Description
	AugmentationRequest(ChatMessage chatMessage, Metadata metadata)
	AugmentationResult(ChatMessage chatMessage, List<Content> contents)

Uses of ChatMessage in dev.langchain4j.rag.content.injector

Methods in dev.langchain4j.rag.content.injector that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	ContentInjector.inject(List<Content> contents, ChatMessage chatMessage)	Injects given Contents into a given ChatMessage.
ChatMessage	DefaultContentInjector.inject(List<Content> contents, ChatMessage chatMessage)

Methods in dev.langchain4j.rag.content.injector with parameters of type ChatMessage

Modifier and Type	Method	Description
protected Prompt	DefaultContentInjector.createPrompt(ChatMessage chatMessage, List<Content> contents)
ChatMessage	ContentInjector.inject(List<Content> contents, ChatMessage chatMessage)	Injects given Contents into a given ChatMessage.
ChatMessage	DefaultContentInjector.inject(List<Content> contents, ChatMessage chatMessage)

Uses of ChatMessage in dev.langchain4j.rag.query

Methods in dev.langchain4j.rag.query that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	Metadata.chatMessage()

Methods in dev.langchain4j.rag.query that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	Metadata.chatMemory()

Methods in dev.langchain4j.rag.query with parameters of type ChatMessage

Modifier and Type	Method	Description
Metadata.Builder	Metadata.Builder.chatMessage(ChatMessage chatMessage)
static Metadata	Metadata.from(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

Method parameters in dev.langchain4j.rag.query with type arguments of type ChatMessage

Modifier and Type	Method	Description
Metadata.Builder	Metadata.Builder.chatMemory(List<ChatMessage> chatMemory)
static Metadata	Metadata.from(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

Constructors in dev.langchain4j.rag.query with parameters of type ChatMessage

Modifier	Constructor	Description
	Metadata(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

Constructor parameters in dev.langchain4j.rag.query with type arguments of type ChatMessage

Modifier	Constructor	Description
	Metadata(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

Uses of ChatMessage in dev.langchain4j.rag.query.transformer

Methods in dev.langchain4j.rag.query.transformer with parameters of type ChatMessage

Modifier and Type	Method	Description
protected String	CompressingQueryTransformer.format(ChatMessage message)

Method parameters in dev.langchain4j.rag.query.transformer with type arguments of type ChatMessage

Modifier and Type	Method	Description
protected String	CompressingQueryTransformer.format(List<ChatMessage> chatMemory)

Uses of ChatMessage in dev.langchain4j.service

Methods in dev.langchain4j.service that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	AiServiceTokenStreamParameters.messages()
static List<ChatMessage>	AiServices.removeToolMessages(List<ChatMessage> messages)

Method parameters in dev.langchain4j.service with type arguments of type ChatMessage

Modifier and Type	Method	Description
AiServiceTokenStreamParameters.Builder	AiServiceTokenStreamParameters.Builder.messages(List<ChatMessage> messages)	Sets the messages.
static List<ChatMessage>	AiServices.removeToolMessages(List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.service.tool

Method parameters in dev.langchain4j.service.tool with type arguments of type ChatMessage

Modifier and Type	Method	Description
ToolServiceResult	ToolService.executeInferenceAndToolsLoop(ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatModel chatModel, ChatMemory chatMemory, InvocationContext invocationContext, Map<String, ToolExecutor> toolExecutors, boolean isReturnTypeResult, AiServiceListenerRegistrar aiServiceListenerRegistrar)

Uses of ChatMessage in dev.langchain4j.store.memory.azure.cosmos.nosql

Methods in dev.langchain4j.store.memory.azure.cosmos.nosql that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	AzureCosmosDBNoSqlMemoryStore.getMessages(Object memoryId)

Method parameters in dev.langchain4j.store.memory.azure.cosmos.nosql with type arguments of type ChatMessage

Modifier and Type	Method	Description
void	AzureCosmosDBNoSqlMemoryStore.updateMessages(Object memoryId, List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.store.memory.chat

Methods in dev.langchain4j.store.memory.chat that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	ChatMemoryStore.getMessages(Object memoryId)	Retrieves messages for a specified chat memory.
List<ChatMessage>	InMemoryChatMemoryStore.getMessages(Object memoryId)

Method parameters in dev.langchain4j.store.memory.chat with type arguments of type ChatMessage

Modifier and Type	Method	Description
void	ChatMemoryStore.updateMessages(Object memoryId, List<ChatMessage> messages)	Updates messages for a specified chat memory.
void	InMemoryChatMemoryStore.updateMessages(Object memoryId, List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.store.memory.chat.cassandra

Methods in dev.langchain4j.store.memory.chat.cassandra that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	CassandraChatMemoryStore.getMessages(@NonNull Object memoryId)	Retrieves messages for a specified chat memory.

Method parameters in dev.langchain4j.store.memory.chat.cassandra with type arguments of type ChatMessage

Modifier and Type	Method	Description
void	CassandraChatMemoryStore.updateMessages(@NonNull Object memoryId, @NonNull List<ChatMessage> messages)	Updates messages for a specified chat memory.

Uses of ChatMessage in dev.langchain4j.store.memory.chat.coherence

Methods in dev.langchain4j.store.memory.chat.coherence that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	CoherenceChatMemoryStore.getMessages(Object memoryId)

Method parameters in dev.langchain4j.store.memory.chat.coherence with type arguments of type ChatMessage

Modifier and Type	Method	Description
void	CoherenceChatMemoryStore.updateMessages(Object memoryId, List<ChatMessage> messages)

Uses of ChatMessage in dev.langchain4j.store.memory.chat.tablestore

Methods in dev.langchain4j.store.memory.chat.tablestore that return types with arguments of type ChatMessage

Modifier and Type	Method	Description
List<ChatMessage>	TablestoreChatMemoryStore.getMessages(Object memoryId)

Method parameters in dev.langchain4j.store.memory.chat.tablestore with type arguments of type ChatMessage

Modifier and Type	Method	Description
void	TablestoreChatMemoryStore.updateMessages(Object memoryId, List<ChatMessage> messages)