langchain_elasticsearch.chat_history.ElasticsearchChatMessageHistory¶
- class langchain_elasticsearch.chat_history.ElasticsearchChatMessageHistory(index: str, session_id: str, *, es_connection: Optional[Elasticsearch] = None, es_url: Optional[str] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_api_key: Optional[str] = None, es_password: Optional[str] = None, esnsure_ascii: Optional[bool] = True)[源代码]¶
将聊天记录存储在Elasticsearch中的聊天记录。
- 参数
es_url (可选[str]) – 连接到Elasticsearch实例的URL。
es_cloud_id (可选[str]) – 连接到Elasticsearch实例的云ID。
es_user (可选[str]) – 连接到Elasticsearch时使用的用户名。
es_password (可选[str]) – 连接到Elasticsearch时使用的密码。
es_api_key (可选[str]) – 连接到Elasticsearch时使用的API密钥。
es_connection (可选[Elasticsearch]) – 可选的现有Elasticsearch连接。
esnsure_ascii (可选[bool]) – 用于在json.dumps中转义ASCII符号。默认为True。
索引('str') – 要使用索引的名称。
session_id (str) – 用于存储单个聊天会话消息的任意键。
属性
messages从Elasticsearch检索消息
方法
__init__(index, session_id, *[, ...])aadd_messages(messages)异步添加消息列表。
aclear()异步从存储中删除所有消息。
add_ai_message(message)将AI消息字符串添加到存储中的便捷方法。
add_message(message)将消息添加到Elasticsearch中的聊天会话
add_messages(messages)添加消息列表。
add_user_message(message)将人类消息字符串添加到存储中的便捷方法。
异步获取消息版本。
clear()清除Elasticsearch中的会话内存
- __init__(index: str, session_id: str, *, es_connection: Optional[Elasticsearch] = None, es_url: Optional[str] = None, es_cloud_id: Optional[str] = None, es_user: Optional[str] = None, es_api_key: Optional[str] = None, es_password: Optional[str] = None, esnsure_ascii: Optional[bool] = True)[源代码]¶
- 参数
index (str) –
session_id (str) –
es_connection (可选[Elasticsearch]) –
es_url (可选[str]) –
es_cloud_id (可选[str]) –
es_user (可选[str]) –
es_api_key (可选[str]) –
es_password (可选[str]) –
esnsure_ascii (可选[bool]) –
- async aadd_messages(messages: Sequence[BaseMessage]) None¶
异步添加消息列表。
- 参数
messages (序列[[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]¶
将消息添加到Elasticsearch中的聊天会话
- 参数
message (BaseMessage) –
- 返回类型
None
- add_messages(messages: Sequence[BaseMessage]) None¶
添加消息列表。
实现应覆盖此方法以高效处理批量添加消息，以避免不必要的到底层存储的往返。
- 参数
messages (序列[[BaseMessage]]) – 要存储的 BaseMessage 对象序列。
- 返回类型
None
- add_user_message(message: Union[HumanMessage, str]) None¶
将人类消息字符串添加到存储中的便捷方法。
请注意，这是一个方便的方法。代码应优先使用批量 add_messages 接口，以节省到底层持久化层的往返。
此方法可能在未来的版本中弃用。
- 参数
消息 (联合体[HumanMessage，str]) – 要添加到存储库中的人类消息。
- 返回类型
None
- async aget_messages() List[BaseMessage]¶
异步获取消息版本。
可以覆盖此方法以提供高效的异步实现。
通常，获取消息可能涉及到底层的持久化层的IO操作。
- 返回类型
列表[BaseMessage]