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

Packages that use ChatMessage

Package	Description
dev.langchain4j.data.message
dev.langchain4j.memory
dev.langchain4j.model
dev.langchain4j.model.chat
dev.langchain4j.model.moderation
dev.langchain4j.rag.query
dev.langchain4j.rag.query.transformer
dev.langchain4j.store.memory.chat

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 response message from an AI (language model).
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	GsonChatMessageJsonCodec.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>	GsonChatMessageJsonCodec.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	GsonChatMessageJsonCodec.messageToJson(ChatMessage message)

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

Modifier and Type	Method	Description
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	GsonChatMessageJsonCodec.messagesToJson(List<ChatMessage> messages)

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.

Uses of ChatMessage in dev.langchain4j.model

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

Modifier and Type	Method	Description
int	Tokenizer.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	Tokenizer.estimateTokenCountInMessages(Iterable<ChatMessage> messages)	Estimates the count of tokens in the given 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 Response<AiMessage>	ChatLanguageModel.generate(ChatMessage... messages)	Generates a response from the model based on a sequence of messages.
Response<AiMessage>	DisabledChatLanguageModel.generate(ChatMessage... messages)

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

Modifier and Type	Method	Description
int	TokenCountEstimator.estimateTokenCount(List<ChatMessage> messages)	Estimates the count of tokens in the specified list of messages.
Response<AiMessage>	ChatLanguageModel.generate(List<ChatMessage> messages)	Generates a response from the model based on a sequence of messages.
default Response<AiMessage>	ChatLanguageModel.generate(List<ChatMessage> messages, ToolSpecification toolSpecification)	Generates a response from the model based on a list of messages and a single tool specification.
default Response<AiMessage>	ChatLanguageModel.generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications)	Generates a response from the model based on a list of messages and a list of tool specifications.
Response<AiMessage>	DisabledChatLanguageModel.generate(List<ChatMessage> messages)
Response<AiMessage>	DisabledChatLanguageModel.generate(List<ChatMessage> messages, ToolSpecification toolSpecification)
Response<AiMessage>	DisabledChatLanguageModel.generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications)
void	DisabledStreamingChatLanguageModel.generate(List<ChatMessage> messages, ToolSpecification toolSpecification, StreamingResponseHandler<AiMessage> handler)
void	DisabledStreamingChatLanguageModel.generate(List<ChatMessage> messages, StreamingResponseHandler<AiMessage> handler)
void	DisabledStreamingChatLanguageModel.generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications, StreamingResponseHandler<AiMessage> handler)
default void	StreamingChatLanguageModel.generate(List<ChatMessage> messages, ToolSpecification toolSpecification, StreamingResponseHandler<AiMessage> handler)	Generates a response from the model based on a list of messages and a tool specification.
void	StreamingChatLanguageModel.generate(List<ChatMessage> messages, StreamingResponseHandler<AiMessage> handler)	Generates a response from the model based on a sequence of messages.
default void	StreamingChatLanguageModel.generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications, StreamingResponseHandler<AiMessage> handler)	Generates a response from the model based on a list of messages and a list of tool specifications.

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.rag.query

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

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

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

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

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

Modifier	Constructor	Description
	Metadata(UserMessage userMessage, 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.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)