langchain_couchbase.chat_message_histories.CouchbaseChatMessageHistory

class langchain_couchbase.chat_message_histories.CouchbaseChatMessageHistory(*, cluster: Cluster, bucket_name: str, scope_name: str, collection_name: str, session_id: str, session_id_key: str = 'session_id', message_key: str = 'message', create_index: bool = True)

Couchbase Chat Message History：使用Couchbase作为存储的聊天消息历史

初始化Couchbase Chat Message History：
:param cluster: 具有活动连接的couchbase clusters对象。
:type cluster: Cluster
:param bucket_name: 存档文档的bucket名称。
:type bucket_name: str
:param scope_name: 存档文档的bucket中的scope名称。
:type scope_name: str
:param collection_name: 在范围内存储文档的集合名称。

。

参数

• session_id (str) – 用于关联单个聊天会话中消息的会话值。它作为聊天消息中的一个字段存储。

• session_id_key (str) – 用于会话id的字段名称。默认设置为“session_id”。

• message_key (str) – 用于消息的字段名称。默认设置为“message”。

• create_index (bool) – 如果为True，则创建索引。默认设置为True。

• cluster (Cluster) –

• bucket_name (str) –

• scope_name (str) –

• collection_name (str) –

属性

messages

获取与session_id关联的缓存中的所有消息

方法

__init__(*, cluster, bucket_name, ...[, ...])	初始化Couchbase聊天消息历史：:param cluster: Couchbase集群对象，具有活动连接。:type cluster: Cluster :param bucket_name: 用于存储文档的桶名称。:type bucket_name: str :param scope_name: 在桶中用于存储文档的范围名称。:type scope_name: str :param collection_name: 在范围中用于存储文档的集合名称。:type collection_name: str :param session_id: 用于关联单个聊天会话的消息的值。它作为聊天信息中的一个字段存储。:type session_id: str :param session_id_key: 要用于会话ID的字段名称。默认设置为"session_id"。:type session_id_key: str :param message_key: 要用于消息的字段名称。默认设置为"message"。:type message_key: str :param create_index: 如果为True，则创建索引。默认设置为True。:type create_index: bool。
aadd_messages(messages)	异步添加消息列表。
aclear()	异步从存储中删除所有消息
add_ai_message(message)	添加AI消息字符串到存储的便利方法。
add_message(message)	将消息添加到缓存中
add_messages(messages)	批量方式将消息添加到缓存中
add_user_message(message)	添加人类消息字符串到存储的便利方法。
aget_messages()	获取消息的异步版本。
clear()	清除缓存

__init__(*, cluster: Cluster, bucket_name: str, scope_name: str, collection_name: str, session_id: str, session_id_key: str = 'session_id', message_key: str = 'message', create_index: bool = True) → None

初始化Couchbase Chat Message History：
:param cluster: 具有活动连接的couchbase clusters对象。
:type cluster: Cluster
:param bucket_name: 存档文档的bucket名称。
:type bucket_name: str
:param scope_name: 存档文档的bucket中的scope名称。
:type scope_name: str
:param collection_name: 在范围内存储文档的集合名称。

。

参数

• session_id (str) – 用于关联单个聊天会话中消息的会话值。它作为聊天消息中的一个字段存储。

• session_id_key (str) – 用于会话id的字段名称。默认设置为“session_id”。

• message_key (str) – 用于消息的字段名称。默认设置为“message”。

• create_index (bool) – 如果为True，则创建索引。默认设置为True。

• cluster (Cluster) –

• bucket_name (str) –

• scope_name (str) –

• collection_name (str) –

返回类型

None

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

异步添加消息列表。

参数

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

返回类型

None

async aclear() → None

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

返回类型

None

添加 AI 消息

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

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

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

参数

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

返回类型

None

add_message(message: BaseMessage) → None

将消息添加到缓存中

参数

message (BaseMessage) –

返回类型

None

add_messages(messages: Sequence[BaseMessage]) → None

批量方式将消息添加到缓存中

参数

messages (Sequence[BaseMessage]) –

返回类型

None

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

添加人类消息字符串到存储的便利方法。

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

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

参数

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

返回类型

None

async aget_messages() → List[BaseMessage]¶

获取消息的异步版本。

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

通常，检索消息可能涉及对底层持久层进行IO操作。

返回类型

列表[BaseMessage]

clear() → None

清除缓存

返回类型

None