langchain_community.chat_message_histories.neo4j.Neo4jChatMessageHistory

class langchain_community.chat_message_histories.neo4j.Neo4jChatMessageHistory(session_id: Union[str, int], url: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, database: str = 'neo4j', node_label: str = 'Session', window: int = 3, *, graph: Optional[Neo4jGraph] = None)[source]

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

属性

messages

从 Neo4j 获取消息

方法

__init__(session_id[, url, username, ...]>)

aadd_messages(messages)

异步添加消息列表。

aclear()

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

add_ai_message(message)

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

add_message(message)

将消息追加到Neo4j记录中

add_messages(messages)

添加消息列表。

add_user_message(message)

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

aget_messages()

异步获取消息的版本。

clear()

从Neo4j清除会话内存。
参数

  • session_id (Union[str, int]) –

  • url (Optional[str]) –

  • username (Optional[str]) –

  • password (Optional[str]) –

  • database (str) –

  • node_label (str) –

  • window (int) –

  • graph (Optional[Neo4jGraph]) –

__init__(session_id: Union[str, int], url: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, database: str = 'neo4j', node_label: str = 'Session', window: int = 3, *, graph: Optional[Neo4jGraph] = None)[source]
参数

  • session_id (Union[str, int]) –

  • url (Optional[str]) –

  • username (Optional[str]) –

  • password (Optional[str]) –

  • database (str) –

  • node_label (str) –

  • window (int) –

  • graph (Optional[Neo4jGraph]) –

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 消息字符串的便捷方法。

请注意，这是一个便利的方法。代码应优先使用批量添加消息的接口，以节省底层持久层的来回通信。

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

参数

message (Union[AIMessage, str]) – 添加的AI消息。

返回类型

None

add_message(message: BaseMessage) → None

将消息追加到Neo4j记录中

参数

message (BaseMessage) –

返回类型

None

add_messages(messages: Sequence[BaseMessage]) → None

添加消息列表。

实现应该覆盖此方法，以高效地批量添加消息，以避免不必要的对底层存储的往返通信。

参数

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

返回类型

None

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

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

请注意，这是一个便利的方法。代码应优先使用批量添加消息的接口，以节省底层持久层的来回通信。

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

参数

message (Union[HumanMessage, str]) – 添加到存储中的人类消息。

返回类型

None

async aget_messages() → List[BaseMessage]

异步获取消息的版本。

可以覆盖此方法以提供高效的异步实现。

一般来说，获取消息可能涉及到与底层持久化层的 IO 操作。

返回类型

列表[基础消息]

clear() → None[源代码]

从Neo4j清除会话内存。

返回类型

None

使用 Neo4jChatMessageHistory 的示例