`langchain_mongodb.chat_message_histories`.MongoDBChatMessageHistory¶

class langchain_mongodb.chat_message_histories.MongoDBChatMessageHistory(connection_string: str, session_id: str, database_name: str = 'chat_history', collection_name: str = 'message_store', *, session_id_key: str = 'SessionId', history_key: str = 'History', create_index: bool = True, index_kwargs: Optional[Dict] = None)[source]¶

聊天消息历史记录，用于在 MongoDB 中存储历史记录。

设置

安装 langchain-mongodb python 包。

pip install langchain-mongodb

实例化

from langchain_mongodb import MongoDBChatMessageHistory


history = MongoDBChatMessageHistory(
    connection_string="mongodb://your-host:your-port/",  # mongodb://localhost:27017/
    session_id = "your-session-id",
)

添加和检索消息

# Add single message
history.add_message(message)

# Add batch messages
history.add_messages([message1, message2, message3, ...])

# Add human message
history.add_user_message(human_message)

# Add ai message
history.add_ai_message(ai_message)

# Retrieve messages
messages = history.messages

使用 MongoDBChatMessageHistory 实例初始化。

参数

connection_string (str) – str 连接字符串，用于连接到 MongoDB。
session_id (str) –
str 任意键，用于存储单个聊天会话的消息。

单个聊天会话的消息。
database_name (str) – Optional[str] 要使用的数据库名称。
collection_name (str) – Optional[str] 要使用的集合名称。
session_id_key (str) – Optional[str] 存储会话 ID 的字段名称。
history_key (str) – Optional[str] 存储聊天历史记录的字段名称。
create_index (bool) – Optional[bool] 是否在会话 ID 字段上创建索引。
index_kwargs (Optional[Dict]) – Optional[Dict] 传递给索引创建的附加关键字参数。

属性

messages

从 MongoDB 检索消息

方法

`__init__`(connection_string, session_id[, ...])	使用 MongoDBChatMessageHistory 实例初始化。
`aadd_messages`(messages)	异步添加消息列表。
`aclear`()	异步删除存储中的所有消息
`add_ai_message`(message)	用于向存储添加 AI 消息字符串的便捷方法。
`add_message`(message)	将消息追加到 MongoDB 中的记录
`add_messages`(messages)	添加消息列表。
`add_user_message`(message)	用于向存储添加人类消息字符串的便捷方法。
`aget_messages`()	获取消息的异步版本。
`clear`()	从 MongoDB 清除会话内存

__init__(connection_string: str, session_id: str, database_name: str = 'chat_history', collection_name: str = 'message_store', *, session_id_key: str = 'SessionId', history_key: str = 'History', create_index: bool = True, index_kwargs: Optional[Dict] = None)[source]¶

使用 MongoDBChatMessageHistory 实例初始化。

参数

connection_string (str) – str 连接字符串，用于连接到 MongoDB。
session_id (str) –
str 任意键，用于存储单个聊天会话的消息。

单个聊天会话的消息。
database_name (str) – Optional[str] 要使用的数据库名称。
collection_name (str) – Optional[str] 要使用的集合名称。
session_id_key (str) – Optional[str] 存储会话 ID 的字段名称。
history_key (str) – Optional[str] 存储聊天历史记录的字段名称。
create_index (bool) – Optional[bool] 是否在会话 ID 字段上创建索引。
index_kwargs (Optional[Dict]) – Optional[Dict] 传递给索引创建的附加关键字参数。

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

异步添加消息列表。

参数: messages (Sequence[BaseMessage]) – 要存储的 BaseMessage 对象序列。
返回类型: None

async aclear() → None¶

异步删除存储中的所有消息

返回类型: None

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

用于向存储添加 AI 消息字符串的便捷方法。

请注意，这是一个便捷方法。代码应优先使用批量 add_messages 接口，以节省与底层持久层之间的往返行程。

此方法在未来的版本中可能会被弃用。

参数: message (Union[AIMessage, str]) – 要添加的 AI 消息。
返回类型: None

add_message(message: BaseMessage) → None[source]¶

将消息追加到 MongoDB 中的记录

参数: message (BaseMessage) –
返回类型: None

add_messages(messages: Sequence[BaseMessage]) → None¶

添加消息列表。

实现应重写此方法，以高效处理批量添加消息，从而避免与底层存储进行不必要的往返行程。

参数: messages (Sequence[BaseMessage]) – 要存储的 BaseMessage 对象序列。
返回类型: None

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

用于向存储添加人类消息字符串的便捷方法。

请注意，这是一个便捷方法。代码应优先使用批量 add_messages 接口，以节省与底层持久层之间的往返行程。

此方法在未来的版本中可能会被弃用。

参数: message (Union[HumanMessage, str]) – 要添加到存储的人类消息。
返回类型: None

async aget_messages() → List[BaseMessage]¶

获取消息的异步版本。

可以重写此方法以提供高效的异步实现。

通常，获取消息可能涉及与底层持久层的 IO。

返回类型: List[BaseMessage]

clear() → None[source]¶

从 MongoDB 清除会话内存

返回类型: None

langchain_mongodb.chat_message_histories.MongoDBChatMessageHistory¶

`langchain_mongodb.chat_message_histories`.MongoDBChatMessageHistory¶