langchain_core.chat_history.InMemoryChatMessageHistory¶

class langchain_core.chat_history.InMemoryChatMessageHistory[source]¶

Bases: BaseChatMessageHistory, BaseModel

In memory implementation of chat message history.

Stores messages in a memory list.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param messages: List[BaseMessage] [Optional]¶

A list of messages stored in memory.

async aadd_messages(messages: Sequence[BaseMessage]) None[source]¶

Async add messages to the store.

Parameters

messages (Sequence[BaseMessage]) – The messages to add.

Return type

None

async aclear() None[source]¶

Async clear all messages from the store.

Return type

None

add_ai_message(message: Union[AIMessage, str]) None¶

Convenience method for adding an AI message string to the store.

Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.

This method may be deprecated in a future release.

Parameters

message (Union[AIMessage, str]) – The AI message to add.

Return type

None

add_message(message: BaseMessage) None[source]¶

Add a self-created message to the store.

Parameters

message (BaseMessage) – The message to add.

Return type

None

add_messages(messages: Sequence[BaseMessage]) None¶

Add a list of messages.

Implementations should over-ride this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.

Parameters

messages (Sequence[BaseMessage]) – A sequence of BaseMessage objects to store.

Return type

None

add_user_message(message: Union[HumanMessage, str]) None¶

Convenience method for adding a human message string to the store.

Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.

This method may be deprecated in a future release.

Parameters

message (Union[HumanMessage, str]) – The human message to add to the store.

Return type

None

async aget_messages() List[BaseMessage][source]¶

Async version of getting messages.

Can over-ride this method to provide an efficient async implementation. In general, fetching messages may involve IO to the underlying persistence layer.

Returns

List of messages.

Return type

List[BaseMessage]

clear() None[source]¶

Clear all messages from the store.

Return type

None