langchain_community.chat_message_histories.streamlit.StreamlitChatMessageHistory

class langchain_community.chat_message_histories.streamlit.StreamlitChatMessageHistory(key: str = 'langchain_messages')

使用Streamlit会话状态存储消息的聊天消息历史。

参数

key (str) – 在Streamlit会话状态中用于存储消息的键。

属性

messages

获取当前的消息列表

方法

__init__([key])
aadd_messages(messages)	异步添加消息列表。
aclear()	异步从存储中删除所有消息
add_ai_message(message)	将AI消息字符串添加到存储中的便捷方法。
add_message(message)	将消息添加到会话内存
add_messages(messages)	添加消息列表。
add_user_message(message)	将人类消息字符串添加到存储中的便捷方法。
aget_messages()	获取消息的异步版本。
clear()	清除会话内存

__init__(key: str = 'langchain_messages')

参数

key (str) –

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

将消息添加到会话内存

参数

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

asyncaget_messages() → List[BaseMessage]

获取消息的异步版本。

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

通常，获取消息可能涉及对底层持久层的 IO 操作。

返回类型

List[BaseMessage]

clear() → None

清除会话内存

返回类型

None

StreamlitChatMessageHistory 的使用示例

• Streamlit