langchain_community.chat_message_histories.elasticsearch.ElasticsearchChatMessageHistory

class langchain_community.chat_message_histories.elasticsearch.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, ensure_ascii: Optional[bool] = True)

自版本 0.0.27 被弃用： 请使用 langchain-elasticsearch 包。

使用 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连接。

• ensure_ascii (可选[bool]) – 用于在json.dumps中转义ASCII符号。默认为True。

• index (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)	将人类消息字符串添加到存储中的方便方法。
aget_messages()	异步获取消息的版本。
clear()	清除Elasticsearch中的会话内存。
connect_to_elasticsearch(*[, es_url, ...])
get_user_agent()

__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, ensure_ascii: Optional[bool] = True)

参数

• index (str) –

• session_id (str) –

• es_connection (Optional[Elasticsearch]) –

• es_url (Optional[str]) –

• es_cloud_id (Optional[str]) –

• es_user (Optional[str]) –

• es_api_key (Optional[str]) –

• es_password (Optional[str]) –

• ensure_ascii (Optional[bool]) –

asyncaadd_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]) – 要添加的 AI 消息。

返回类型

None

add_message(message: BaseMessage) → None

将消息添加到Elasticsearch中的聊天会话。

参数

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

清除Elasticsearch中的会话内存。

返回类型

None

静态 connect_to_elasticsearch(*, es_url: Optional[str] = None, cloud_id: Optional[str] = None, api_key: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None) → Elasticsearch

参数

• es_url (Optional[str]) –

• cloud_id (可选str) –

• api_key (可选str) –

• username (可选str) –

• password (可选str) –

返回类型

Elasticsearch

静态 get_user_agent() → str

返回类型

str

使用ElasticsearchChatMessageHistory的示例

• Elasticsearch