`langchain_community.chat_message_histories.cosmos_db`.CosmosDBChatMessageHistory¶

class langchain_community.chat_message_histories.cosmos_db.CosmosDBChatMessageHistory(cosmos_endpoint: str, cosmos_database: str, cosmos_container: str, session_id: str, user_id: str, credential: Optional[Any] = None, connection_string: Optional[str] = None, ttl: Optional[int] = None, cosmos_client_kwargs: Optional[dict] = None)[source]¶

由 Azure CosmosDB 支持的聊天消息历史。

初始化 CosmosDBChatMessageHistory 类的新实例。

请确保调用 prepare_cosmos 或使用上下文管理器以确保您的数据库已就绪。

必须提供凭据或连接字符串。

参数

cosmos_endpoint (str) – Azure Cosmos DB 账户的连接端点。
cosmos_database (str) – 要使用的数据库名称。
cosmos_container (str) – 要使用的容器名称。
session_id (str) – 要使用的会话 ID，在加载时可以覆盖。
user_id (str) – 要使用的用户 ID，在加载时可以覆盖。
credential (Any) – 用于对 Azure Cosmos DB 进行身份验证的凭据。
connection_string (Optional[str]) – 用于身份验证的连接字符串。
ttl (Optional[int]) – 容器中文档的有效生存时间（以秒为单位）。
cosmos_client_kwargs (Optional[dict]) – 要传递给 CosmosClient 的额外kwargs。

属性

messages

返回消息列表的属性或属性。

方法

`__init__`(cosmos_endpoint, cosmos_database, ...)	初始化 CosmosDBChatMessageHistory 类的新实例。
`aadd_messages`(messages)	异步添加消息列表。
`aclear`()	异步从存储中移除所有消息。
`add_ai_message`(message)	向存储中添加AI消息字符串的便捷方法。
`add_message`(message)	将自创建的消息添加到存储中。
`add_messages`(messages)	添加消息列表。
`add_user_message`(message)	向存储中添加人类消息字符串的便捷方法。
`aget_messages`()	获取消息的异步版本。
`clear`()	从本内存和Cosmos清除会话内存。
`load_messages`()	从Cosmos检索消息。
`prepare_cosmos`()	准备CosmosDB客户端。
`upsert_messages`()	更新cosmosdb项。

__init__(cosmos_endpoint: str, cosmos_database: str, cosmos_container: str, session_id: str, user_id: str, credential: Optional[Any] = None, connection_string: Optional[str] = None, ttl: Optional[int] = None, cosmos_client_kwargs: Optional[dict] = None)[来源代码]¶

初始化 CosmosDBChatMessageHistory 类的新实例。

请确保调用 prepare_cosmos 或使用上下文管理器以确保您的数据库已就绪。

必须提供凭据或连接字符串。

参数

cosmos_endpoint (str) – Azure Cosmos DB 账户的连接端点。
cosmos_database (str) – 要使用的数据库名称。
cosmos_container (str) – 要使用的容器名称。
session_id (str) – 要使用的会话 ID，在加载时可以覆盖。
user_id (str) – 要使用的用户 ID，在加载时可以覆盖。
credential（《可选`[Any]`) – 使用以认证到 Azure Cosmos DB 的凭据。
connection_string (Optional[str]) – 用于身份验证的连接字符串。
ttl (Optional[int]) – 容器中文档的有效生存时间（以秒为单位）。
cosmos_client_kwargs (Optional[dict]) – 要传递给 CosmosClient 的额外kwargs。

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

异步添加消息列表。

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

async aclear() → None¶

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

返回类型: None

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

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

请注意，这是一个便捷方法。代码应优先选择批量添加消息的接口，以节省对底层持久化层的往返次数。

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

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

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

将自创建的消息添加到存储中。

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

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

添加消息列表。

实现应该覆盖此方法，以有效地处理批量添加消息，从而避免不必要的对底层存储的往返次数。

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

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

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

请注意，这是一个便捷方法。代码应优先选择批量添加消息的接口，以节省对底层持久化层的往返次数。

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

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

async aget_messages() → List[BaseMessage]¶

获取消息的异步版本。

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

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

返回类型: List[BaseMessage]

clear() → None[source]¶

从本内存和Cosmos清除会话内存。

返回类型: None

load_messages() → None[source]¶

从Cosmos检索消息。

返回类型: None

prepare_cosmos() → None[source]¶

准备CosmosDB客户端。

使用此函数或上下文管理器以确保您的数据库已准备好。

返回类型: None

upsert_messages() → None[source]¶

更新cosmosdb项。

返回类型: None

langchain_community.chat_message_histories.cosmos_db.CosmosDBChatMessageHistory¶

`langchain_community.chat_message_histories.cosmos_db`.CosmosDBChatMessageHistory¶