langchain_community.chat_message_histories.dynamodb.DynamoDBChatMessageHistory¶
- class langchain_community.chat_message_histories.dynamodb.DynamoDBChatMessageHistory(table_name: str, session_id: str, endpoint_url: Optional[str] = None, primary_key_name: str = 'SessionId', key: Optional[Dict[str, str]] = None, boto3_session: Optional[Session] = None, kms_key_id: Optional[str] = None, ttl: Optional[int] = None, ttl_key_name: str = 'expireAt', history_size: Optional[int] = None)[source]¶
存储在AWS DynamoDB中的聊天消息历史。
此类期望存在一个名为 table_name 的DynamoDB表。
- 参数
table_name (str) - DynamoDB表的名称
session_id (str) - 任意键，用于存储单个聊天会话的消息。
endpoint_url （可选，str） – 连接到 AWS 端点的 URL。这个参数是可选的，在测试用途时很有用，例如使用 Localstack。如果您计划使用 AWS 云服务，通常不需要担心设置 endpoint_url。
primary_key_name （str） – DynamoDB 表的主键名称。这个参数是可选的，默认为 “SessionId”。
key （可选，Dict{str：str}） – 一个包含自定义主键和副键的可选字典。这个参数是可选的，但在使用组合 DynamoDB 键或根据应用程序的细节（如用户 ID）隔离记录时很有用。这还可以包含全局和本地二级索引键。
kms_key_id （可选，str） – 用于客户端加密的可选 AWS KMS Key ID、AWS KMS Key ARN 或 AWS KMS 别名。
ttl （可选，int） – 可选的生存时间（TTL），单位为秒。允许您为每个项目定义一个过期时间戳，以指示何时可以从表中删除项目。DynamoDB 可在不消耗写入吞吐量的情况下处理已过期的项的删除。要在表上启用此功能，请参阅 [AWS DynamoDB 文档](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-how-to.html）
history_size （可选，int） – 存储的最大消息数。如果为 None，则没有限制。如果不为 None，则只存储最新的 history_size 条消息。
boto3_session （可选，Session） –
ttl_key_name （str） –
属性
messages从 DynamoDB 检索消息
方法
__init__(table_name, session_id[, ...])aadd_messages(messages)异步添加消息列表。
aclear()异步从存储中删除所有消息。
add_ai_message(message)将 AI 消息字符串添加到存储的便捷方法。
add_message(message)将消息追加到 DynamoDB 中的记录。
add_messages(messages)添加消息列表。
add_user_message(message)将人类消息字符串添加到存储的便捷方法。
异步获取消息版本。
clear()从 DynamoDB 清除会话内存。
- __init__(table_name: str, session_id: str, endpoint_url: Optional[str] = None, primary_key_name: str = 'SessionId', key: Optional[Dict[str, str]] = None, boto3_session: Optional[Session] = None, kms_key_id: Optional[str] = None, ttl: Optional[int] = None, ttl_key_name: str = 'expireAt', history_size: Optional[int] = None)[源码]¶
- 参数
table_name (字符串) –
session_id (字符串) –
endpoint_url (可选[字符串]) –
primary_key_name (字符串) –
key (可选[字典[字符串, 字符串]]) –
boto3_session （可选，Session） –
kms_key_id (可选[字符串]) –
ttl (可选[整数]) –
ttl_key_name （str） –
history_size (可选[整数]) –
- 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]¶
将消息追加到 DynamoDB 中的记录。
- 参数
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]¶
异步获取消息版本。
可以覆盖此方法以提供高效的异步实现。
通常，获取消息可能涉及到底层数据持久层的I/O操作。
- 返回类型
List[BaseMessage]