XataChatMessageHistory#

class langchain_community.chat_message_histories.xata.XataChatMessageHistory(session_id: str, db_url: str, api_key: str, branch_name: str = 'main', table_name: str = 'messages', create_table: bool = True)[来源]#

聊天消息历史存储在Xata数据库中。

使用Xata客户端进行初始化。

属性

messages

方法

__init__(session_id, db_url, api_key[, ...])

使用 Xata 客户端进行初始化。

aadd_messages(messages)

异步添加消息列表。

aclear()

异步从存储中移除所有消息

add_ai_message(message)

将AI消息字符串添加到存储中的便捷方法。

add_message(message)

将消息附加到Xata表中

add_messages(messages)

添加消息列表。

add_user_message(message)

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

aget_messages()

获取消息的异步版本。

clear()

从Xata表中删除会话。
Parameters:

  • session_id (str)

  • db_url (str)

  • api_key (str)

  • branch_name (str)

  • table_name (str)

  • create_table (bool)

__init__(session_id: str, db_url: str, api_key: str, branch_name: str = 'main', table_name: str = 'messages', create_table: bool = True) → None[源代码]#

使用Xata客户端进行初始化。

Parameters:

  • session_id (str)

  • db_url (str)

  • api_key (str)

  • branch_name (str)

  • table_name (str)

  • create_table (bool)

Return type:

无

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

异步添加消息列表。

Parameters:

messages (Sequence[BaseMessage]) – 要存储的BaseMessage对象序列。

Return type:

无

async aclear() → None#

异步从存储中移除所有消息

Return type:

无

add_ai_message(message: AIMessage | str) → None#

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

请注意，这是一个便捷方法。代码应优先使用批量 add_messages 接口，以减少与底层持久层的往返次数。

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

Parameters:

message (AIMessage | str) – 要添加的AI消息。

Return type:

无

add_message(message: BaseMessage) → None[来源]#

将消息附加到Xata表中

Parameters:

消息 (BaseMessage)

Return type:

无

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

添加消息列表。

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

Parameters:

messages (Sequence[BaseMessage]) – 要存储的BaseMessage对象序列。

Return type:

无

add_user_message(message: HumanMessage | str) → None#

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

请注意，这是一个便捷方法。代码应优先使用批量 add_messages 接口，以减少对底层持久层的往返次数。

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

Parameters:

message (HumanMessage | str) – 要添加到存储中的人类消息。

Return type:

无

async aget_messages() → list[BaseMessage]#

获取消息的异步版本。

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

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

Return type:

列表[BaseMessage]

clear() → None[来源]#

从Xata表中删除会话。

Return type:

无

使用 XataChatMessageHistory 的示例