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.guardrails
dev.langchain4j.internal
dev.langchain4j.jackson3
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.bedrock	AWS Bedrock integration for LangChain4j.
dev.langchain4j.model.chat
dev.langchain4j.model.chat.request
dev.langchain4j.model.chat.router
dev.langchain4j.model.decision.request
dev.langchain4j.model.embedding.onnx
dev.langchain4j.model.google.genai
dev.langchain4j.model.googleai
dev.langchain4j.model.mistralai.internal.mapper
dev.langchain4j.model.moderation
dev.langchain4j.model.openai
dev.langchain4j.model.openai.internal
dev.langchain4j.model.openaiofficial
dev.langchain4j.model.vertexai.anthropic.internal.mapper
dev.langchain4j.model.watsonx
dev.langchain4j.rag
dev.langchain4j.rag.content.injector
dev.langchain4j.rag.query
dev.langchain4j.rag.query.router
dev.langchain4j.rag.query.transformer
dev.langchain4j.service
dev.langchain4j.service.tool
dev.langchain4j.service.tool.search
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.oracle
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 agentId, 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)
static List<ChatMessage>	UserMessage.replaceLast(List<ChatMessage> messages, UserMessage replacement)	Replaces the last UserMessage in the given list with the specified replacement, if the last UserMessage differs from the replacement.

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)
static Optional<UserMessage>	UserMessage.findLast(Collection<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)
static List<ChatMessage>	UserMessage.replaceLast(List<ChatMessage> messages, UserMessage replacement)	Replaces the last UserMessage in the given list with the specified replacement, if the last UserMessage differs from the replacement.

Uses of ChatMessage in dev.langchain4j.guardrail

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

Modifier and Type	Method	Description
default ChatExchange	ChatExecutor.exchange(List<ChatMessage> chatMessages)	Like ChatExecutor.execute(List), but also returns the request that produced the response.
default CompletableFuture<ChatExchange>	ChatExecutor.exchangeAsync(List<ChatMessage> chatMessages)	Non-blocking counterpart of ChatExecutor.exchange(List).
ChatResponse	ChatExecutor.execute(List<ChatMessage> chatMessages)	Executes a chat request using the provided chat messages
default CompletableFuture<ChatResponse>	ChatExecutor.executeAsync(List<ChatMessage> chatMessages)	Non-blocking counterpart of ChatExecutor.execute(List).

Uses of ChatMessage in dev.langchain4j.guardrails

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

Modifier and Type	Method	Description
DecisionModelOutputGuardrail.Builder	DecisionModelOutputGuardrail.Builder.messageFilter(Predicate<? super ChatMessage> messageFilter)	Sets which messages of the conversation the decision model receives, in addition to the response.

Uses of ChatMessage in dev.langchain4j.internal

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

Modifier and Type	Method	Description
static List<ChatMessage>	DecisionModelInputUtils.window(List<ChatMessage> messages, Predicate<? super ChatMessage> filter, int maxMessages, int maxMessageLength)	The messages a decision model receives about a conversation: the system messages that pass the filter, and the last maxMessages other messages that pass the filter, without the tool results at their start whose AI message is not among them, plus the last user message if it is older (unless maxMessages is 0).

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

Modifier and Type	Method	Description
static String	DecisionModelInputUtils.text(ChatMessage message)	The text of a user or assistant message.

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

Modifier and Type	Method	Description
static DecisionModelInputUtils.Transcript	DecisionModelInputUtils.transcript(List<ChatMessage> messages)	A conversation as a transcript, see DecisionModelInputUtils.transcript(List, String).
static DecisionModelInputUtils.Transcript	DecisionModelInputUtils.transcript(List<ChatMessage> messages, String provider)	A conversation as a transcript: one map per message, with the images of the conversation referred to by their position, for example [image 1].
static void	ChatRequestValidationUtils.validateMessages(List<ChatMessage> messages)
static List<ChatMessage>	DecisionModelInputUtils.window(List<ChatMessage> messages, Predicate<? super ChatMessage> filter, int maxMessages, int maxMessageLength)	The messages a decision model receives about a conversation: the system messages that pass the filter, and the last maxMessages other messages that pass the filter, without the tool results at their start whose AI message is not among them, plus the last user message if it is older (unless maxMessages is 0).
static List<ChatMessage>	DecisionModelInputUtils.window(List<ChatMessage> messages, Predicate<? super ChatMessage> filter, int maxMessages, int maxMessageLength)	The messages a decision model receives about a conversation: the system messages that pass the filter, and the last maxMessages other messages that pass the filter, without the tool results at their start whose AI message is not among them, plus the last user message if it is older (unless maxMessages is 0).

Uses of ChatMessage in dev.langchain4j.jackson3

Methods in dev.langchain4j.jackson3 that return ChatMessage

Modifier and Type	Method	Description
ChatMessage	Jackson3ChatMessageJsonCodec.messageFromJson(String json)

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

Modifier and Type	Method	Description
List<ChatMessage>	Jackson3ChatMessageJsonCodec.messagesFromJson(String json)

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

Modifier and Type	Method	Description
String	Jackson3ChatMessageJsonCodec.messageToJson(ChatMessage message)

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

Modifier and Type	Method	Description
String	Jackson3ChatMessageJsonCodec.messagesToJson(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.
default CompletableFuture<List<ChatMessage>>	ChatMemory.messagesAsync()	Non-blocking counterpart of ChatMemory.messages(), used by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service APIs.

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
default void	ChatMemory.set(ChatMessage... messages)	Replaces all messages in the chat memory with the specified messages.

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
default CompletableFuture<Void>	ChatMemory.addAsync(List<ChatMessage> messages)	Non-blocking counterpart of ChatMemory.add(Iterable), used by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service APIs.
default void	ChatMemory.set(Iterable<ChatMessage> messages)	Replaces all messages in the chat memory with the specified messages.
default CompletableFuture<Void>	ChatMemory.setAsync(List<ChatMessage> messages)	Non-blocking counterpart of ChatMemory.set(Iterable), used by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service APIs (e.g. to rewrite memory for tool compensation without blocking the model-delivery thread).

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()
CompletableFuture<List<ChatMessage>>	MessageWindowChatMemory.messagesAsync()
CompletableFuture<List<ChatMessage>>	TokenWindowChatMemory.messagesAsync()

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)

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

Modifier and Type	Method	Description
CompletableFuture<Void>	MessageWindowChatMemory.addAsync(List<ChatMessage> messagesToAdd)
CompletableFuture<Void>	TokenWindowChatMemory.addAsync(List<ChatMessage> messagesToAdd)
void	MessageWindowChatMemory.set(Iterable<ChatMessage> iter)
void	TokenWindowChatMemory.set(Iterable<ChatMessage> iter)
CompletableFuture<Void>	MessageWindowChatMemory.setAsync(List<ChatMessage> messages)
CompletableFuture<Void>	TokenWindowChatMemory.setAsync(List<ChatMessage> messages)

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<AnthropicMessage>	AnthropicMapper.toAnthropicMessages(List<ChatMessage> messages, boolean sendThinking, boolean midConversationSystemMessages)
static List<AnthropicMessage>	AnthropicMapper.toAnthropicMessages(List<ChatMessage> messages, boolean sendThinking, boolean midConversationSystemMessages, String cacheTtl)
static List<AnthropicTextContent>	AnthropicMapper.toAnthropicSystemPrompt(List<ChatMessage> messages, AnthropicCacheType cacheType)
static List<AnthropicTextContent>	AnthropicMapper.toAnthropicSystemPrompt(List<ChatMessage> messages, AnthropicCacheType cacheType, boolean midConversationSystemMessages)
static List<AnthropicTextContent>	AnthropicMapper.toAnthropicSystemPrompt(List<ChatMessage> messages, AnthropicCacheType cacheType, boolean midConversationSystemMessages, String cacheTtl)

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.bedrock

Classes in dev.langchain4j.model.bedrock that implement ChatMessage

Modifier and Type	Class	Description
class	BedrockSystemMessage	AWS Bedrock-specific system message supporting granular cache points.

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)
default Flow.Publisher<ChatModelStreamingEvent>	StreamingChatModel.chat(ChatMessage... messages)	Reactive convenience overload accepting the messages directly: returns a cold Publisher that streams the response to messages.
default CompletableFuture<ChatResponse>	ChatModel.chatAsync(ChatMessage... messages)	Non-blocking convenience counterpart of ChatModel.chat(ChatMessage...).

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 Flow.Publisher<ChatModelStreamingEvent>	StreamingChatModel.chat(List<ChatMessage> messages)	Reactive convenience counterpart of StreamingChatModel.chat(List, StreamingChatResponseHandler): returns a cold Publisher that streams the response to messages.
default void	StreamingChatModel.chat(List<ChatMessage> messages, StreamingChatResponseHandler handler)
default CompletableFuture<ChatResponse>	ChatModel.chatAsync(List<ChatMessage> messages)	Non-blocking convenience counterpart of ChatModel.chat(List).

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.chat.router

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

Modifier and Type	Method	Description
DecisionModelChatModelRouter.Builder	DecisionModelChatModelRouter.Builder.messageFilter(Predicate<? super ChatMessage> messageFilter)	Sets which messages of the conversation the decision model receives; it also applies to the last user message.

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

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

Modifier and Type	Method	Description
List<ChatMessage>	MessagesInput.messages()	The messages, in order.

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

Modifier and Type	Method	Description
DecisionRequest.Builder	DecisionRequest.Builder.inputMessages(ChatMessage... messages)	Sets the input to evaluate as a conversation, see DecisionRequest.Builder.inputMessages(List).

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

Modifier and Type	Method	Description
static MessagesInput	MessagesInput.from(List<? extends ChatMessage> messages)	Creates the input from a copy of the given messages.
DecisionRequest.Builder	DecisionRequest.Builder.inputMessages(List<? extends ChatMessage> messages)	Sets the input to evaluate as a conversation: messages in the order they were exchanged, for example a chat between a user and an AI assistant, including the tools the assistant called (AiMessage.toolExecutionRequests()) and their results (ToolExecutionResultMessage).

Uses of ChatMessage in dev.langchain4j.model.embedding.onnx

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

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

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

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

Uses of ChatMessage in dev.langchain4j.model.google.genai

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

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

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

Modifier and Type	Method	Description
com.google.genai.types.CachedContent	GoogleGenAiCaches.createCache(String modelName, List<ChatMessage> messages, Duration ttl)	Creates a context cache for the given model from the supplied messages.
int	GoogleGenAiTokenCountEstimator.estimateTokenCountInMessages(Iterable<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
GeminiCaches.GeminiCachedContent	GeminiCaches.createCache(String modelName, List<ChatMessage> messages)	Creates a context cache for the given model from the supplied messages, using the API's default expiration (currently 1 hour).
GeminiCaches.GeminiCachedContent	GeminiCaches.createCache(String modelName, List<ChatMessage> messages, Duration ttl)	Creates a context cache for the given model from the supplied messages, expiring after the given time-to-live.
GeminiCaches.GeminiCachedContent	GeminiCaches.createCache(String modelName, List<ChatMessage> messages, Instant expireTime)	Creates a context cache for the given model from the supplied messages, expiring at the given instant.
int	GoogleAiGeminiTokenCountEstimator.estimateTokenCountInMessages(Iterable<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, boolean sendThinking)

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.
static String	ModerationModel.toText(ChatMessage chatMessage)	Converts a ChatMessage to its text representation.

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)
default 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 type parameters of type ChatMessage

Modifier and Type	Method	Description
static <T extends ChatMessage> T	OpenAiPromptCacheBreakpoint.mark(T message)	Returns a copy of the given message marked as a prompt cache breakpoint, so that everything up to and including that message forms the cached prefix:

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)

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)
static Message	OpenAiUtils.toOpenAiMessage(ChatMessage message, boolean sendThinking, String thinkingFieldName)
static Message	OpenAiUtils.toOpenAiMessage(ChatMessage message, boolean sendThinking, String thinkingFieldName, boolean useInputImageFormat)

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)
static List<Message>	OpenAiUtils.toOpenAiMessages(List<ChatMessage> messages, boolean sendThinking, String thinkingFieldName)
static List<Message>	OpenAiUtils.toOpenAiMessages(List<ChatMessage> messages, boolean sendThinking, String thinkingFieldName, boolean useInputImageFormat)

Uses of ChatMessage in dev.langchain4j.model.openaiofficial

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

Modifier and Type	Method	Description
static <T extends ChatMessage> T	OpenAiOfficialPromptCacheBreakpoint.mark(T message)	Returns a copy of the given message marked as a prompt cache breakpoint, so that everything up to and including that message forms the cached prefix:

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

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

Modifier and Type	Method	Description
static List<AnthropicMessage>	AnthropicRequestMapper.toAnthropicMessages(List<ChatMessage> messages)
static List<AnthropicSystemMessage>	AnthropicRequestMapper.toAnthropicSystemMessages(List<ChatMessage> messages)
static AnthropicRequest	AnthropicRequestMapper.toRequest(String model, List<ChatMessage> messages, List<ToolSpecification> toolSpecs, ToolChoice toolChoice, Integer maxTokens, Double temperature, Double topP, Integer topK, List<String> stopSequences, Boolean enablePromptCaching)

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, SystemMessage systemMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
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, SystemMessage systemMessage, Object chatMemoryId, 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, SystemMessage systemMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
	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, SystemMessage systemMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
	Metadata(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

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

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

Modifier and Type	Method	Description
DecisionModelQueryRouter.Builder	DecisionModelQueryRouter.Builder.messageFilter(Predicate<? super ChatMessage> messageFilter)	Sets which messages of the conversation the decision model receives; it also applies to the last user message.

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()	Returns messages that should be included in the next ChatRequest.
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

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

Modifier and Type	Method	Description
List<ChatMessage>	ToolProviderRequest.messages()
List<ChatMessage>	ToolService.NextChatRequest.messages()	Returns the value of the messages record component.
List<ChatMessage>	ToolServiceResult.messages()	The conversation the tool loop ended with (the messages sent, every tool round trip and the final response), when the AI Service has no chat memory.
CompletionStage<List<ChatMessage>>	ToolService.persistToolResultsAndResolveMessages(AiServiceContext context, ChatMemory chatMemory, List<ChatMessage> accumulator, List<ToolExecutionResultMessage> resultMessages, InvocationContext invocationContext)	Persists the tool-result messages and resolves the messages to send in the next request — the memory-touching counterpart to ToolService.processToolResults(AiServiceContext, List, Map, List, InvocationContext, ToolServiceContext), kept out of that shared bookkeeping so that each AI Service mode can perform the memory I/O on the appropriate thread (synchronously for the sync/TokenStream modes, composed for the CompletableFuture/reactive modes).
List<ChatMessage>	ToolService.persistToolResultsAndResolveMessagesSync(AiServiceContext context, ChatMemory chatMemory, List<ChatMessage> accumulator, List<ToolExecutionResultMessage> resultMessages, InvocationContext invocationContext)	Blocking counterpart of ToolService.persistToolResultsAndResolveMessages(AiServiceContext, ChatMemory, List, List, InvocationContext) for the synchronous and TokenStream AI Service modes, which use the synchronous ChatMemory methods (so a memory backed by a blocking store that only implements the synchronous methods keeps working).
static List<ChatMessage>	ToolService.resolveMessagesForNextRequest(List<ChatMessage> memoryMessages, AiServiceContext context, InvocationContext invocationContext)	Resolves the messages to send in the next request from the current memory view, honoring storeRetrievedContentInChatMemory (when false, the last user message is replaced with the original, un-augmented one so retrieved content is not persisted across rounds).

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

Modifier and Type	Method	Description
ToolServiceContext	ToolService.createContext(InvocationContext invocationContext, UserMessage userMessage, List<ChatMessage> messages)
ToolServiceResult	ToolService.executeInferenceAndToolsLoop(AiServiceContext context, Object memoryId, ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatMemory chatMemory, InvocationContext invocationContext, ToolServiceContext toolServiceContext, boolean isReturnTypeResult)
ToolServiceResult	ToolService.executeInferenceAndToolsLoop(AiServiceContext context, Object memoryId, ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatMemory chatMemory, InvocationContext invocationContext, ToolServiceContext toolServiceContext, Function<ChatRequest, ChatResponse> chatModelInvoker)
CompletableFuture<ToolServiceResult>	ToolService.executeInferenceAndToolsLoopAsync(AiServiceContext context, Object memoryId, ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatMemory chatMemory, InvocationContext invocationContext, ToolServiceContext toolServiceContext, CompletableFuture<?> cancellation)	Non-blocking counterpart of ToolService.executeInferenceAndToolsLoop(AiServiceContext, Object, ChatResponse, ChatRequestParameters, List, ChatMemory, InvocationContext, ToolServiceContext, boolean).
CompletableFuture<ToolServiceResult>	ToolService.executeInferenceAndToolsLoopAsync(AiServiceContext context, Object memoryId, ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatMemory chatMemory, InvocationContext invocationContext, ToolServiceContext toolServiceContext, CompletableFuture<?> cancellation, Function<ChatRequest, CompletableFuture<ChatResponse>> chatModelInvoker)	As ToolService.executeInferenceAndToolsLoopAsync(AiServiceContext, Object, ChatResponse, ChatRequestParameters, List, ChatMemory, InvocationContext, ToolServiceContext, CompletableFuture), but with a caller-supplied asynchronous model invoker.
DecisionModelFilteringToolProvider.Builder	DecisionModelFilteringToolProvider.Builder.messageFilter(Predicate<? super ChatMessage> messageFilter)	Sets which messages of the conversation the decision model receives; it also applies to the last user message.
ToolProviderRequest.Builder	ToolProviderRequest.Builder.messages(List<ChatMessage> messages)
ToolServiceResult.Builder	ToolServiceResult.Builder.messages(List<ChatMessage> messages)
CompletionStage<List<ChatMessage>>	ToolService.persistToolResultsAndResolveMessages(AiServiceContext context, ChatMemory chatMemory, List<ChatMessage> accumulator, List<ToolExecutionResultMessage> resultMessages, InvocationContext invocationContext)	Persists the tool-result messages and resolves the messages to send in the next request — the memory-touching counterpart to ToolService.processToolResults(AiServiceContext, List, Map, List, InvocationContext, ToolServiceContext), kept out of that shared bookkeeping so that each AI Service mode can perform the memory I/O on the appropriate thread (synchronously for the sync/TokenStream modes, composed for the CompletableFuture/reactive modes).
List<ChatMessage>	ToolService.persistToolResultsAndResolveMessagesSync(AiServiceContext context, ChatMemory chatMemory, List<ChatMessage> accumulator, List<ToolExecutionResultMessage> resultMessages, InvocationContext invocationContext)	Blocking counterpart of ToolService.persistToolResultsAndResolveMessages(AiServiceContext, ChatMemory, List, List, InvocationContext) for the synchronous and TokenStream AI Service modes, which use the synchronous ChatMemory methods (so a memory backed by a blocking store that only implements the synchronous methods keeps working).
ToolService.NextChatRequest	ToolService.prepareNextChatRequest(AiServiceContext context, Object memoryId, List<ChatMessage> messages, InvocationContext invocationContext, ToolServiceContext toolServiceContext, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, ChatRequestParameters parameters)	Builds the next round's ChatRequest, shared by every AI Service mode: given the already-resolved messages to send (see ToolService.resolveMessagesForNextRequest(List, AiServiceContext, InvocationContext)), it refreshes dynamic tool providers, folds in any tools found by tool search, overrides the tool specifications on the carried-forward parameters, applies the chat-request transformer, and fires the AiServiceRequestIssuedEvent.
static ToolServiceContext	ToolService.refreshDynamicProviders(ToolServiceContext toolServiceContext, List<ChatMessage> messages, InvocationContext invocationContext)	Re-evaluates dynamic tool providers and returns an updated ToolServiceContext with any newly provided tool specifications and executors.
static List<ChatMessage>	ToolService.resolveMessagesForNextRequest(List<ChatMessage> memoryMessages, AiServiceContext context, InvocationContext invocationContext)	Resolves the messages to send in the next request from the current memory view, honoring storeRetrievedContentInChatMemory (when false, the last user message is replaced with the original, un-augmented one so retrieved content is not persisted across rounds).

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

Modifier	Constructor	Description
	NextChatRequest(ChatRequest chatRequest, List<ChatMessage> messages, ToolServiceContext toolServiceContext, ChatRequestParameters parameters)	Creates an instance of a NextChatRequest record class.

Uses of ChatMessage in dev.langchain4j.service.tool.search

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

Modifier and Type	Method	Description
ToolServiceContext	ToolSearchService.adjust(ToolServiceContext toolServiceContext, List<ChatMessage> messages, InvocationContext invocationContext)

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)
default CompletableFuture<List<ChatMessage>>	ChatMemoryStore.getMessagesAsync(Object memoryId)	Non-blocking counterpart of ChatMemoryStore.getMessages(Object), used by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service APIs.
CompletableFuture<List<ChatMessage>>	InMemoryChatMemoryStore.getMessagesAsync(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)
default CompletableFuture<Void>	ChatMemoryStore.updateMessagesAsync(Object memoryId, List<ChatMessage> messages)	Non-blocking counterpart of ChatMemoryStore.updateMessages(Object, List), used by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service APIs.
CompletableFuture<Void>	InMemoryChatMemoryStore.updateMessagesAsync(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.oracle

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

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

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

Modifier and Type	Method	Description
void	OracleChatMemoryStore.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)