Streamlit回调处理器

class langchain_community.callbacks.streamlit.streamlit_callback_handler.StreamlitCallbackHandler(parent_container: DeltaGenerator, *, max_thought_containers: int = 4, expand_new_thoughts: bool = True, collapse_completed_thoughts: bool = True, thought_labeler: LLMThoughtLabeler | None = None)

写入Streamlit应用程序的回调处理程序。

创建一个 StreamlitCallbackHandler 实例。

Parameters:

• parent_container (DeltaGenerator) – 将包含Handler创建的所有Streamlit元素的st.container。

• max_thought_containers (int) – 一次显示的最大已完成LLM思考容器数量。当达到此阈值时，新的思考将导致最旧的思考被折叠到一个“历史”扩展器中。默认为4。

• expand_new_thoughts (bool) – 每个LLM“想法”都有自己的st.expander。此参数控制该扩展器是否默认展开。默认为True。

• collapse_completed_thoughts (bool) – 如果为True，LLM思维扩展器在完成时将被折叠。默认为True。

• thought_labeler (可选[LLMThoughtLabeler]) – 一个可选的自定义LLMThoughtLabeler实例。如果未指定，处理程序将使用默认的思维标签逻辑。默认为None。

属性

ignore_agent	是否忽略代理回调。
ignore_chain	是否忽略链式回调。
ignore_chat_model	是否忽略聊天模型回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略LLM回调。
ignore_retriever	是否忽略检索器回调。
ignore_retry	是否忽略重试回调。
raise_error	如果发生异常，是否引发错误。
run_inline	是否内联运行回调。

方法

__init__(parent_container, *[, ...])	创建一个 StreamlitCallbackHandler 实例。
on_agent_action(action[, color])	在代理操作时运行。
on_agent_finish(finish[, color])	在代理结束时运行。
on_chain_end(outputs, **kwargs)	当链结束时运行。
on_chain_error(error, **kwargs)	当链发生错误时运行。
on_chain_start(serialized, inputs, **kwargs)	当链开始运行时执行。
on_chat_model_start(serialized, messages, *, ...)	当聊天模型开始运行时执行。
on_custom_event(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
on_llm_end(response, **kwargs)	当LLM运行结束时执行。
on_llm_error(error, **kwargs)	当LLM出错时运行。
on_llm_new_token(token, **kwargs)	在新的LLM令牌上运行。
on_llm_start(serialized, prompts, **kwargs)	当LLM开始运行时执行。
on_retriever_end(documents, *, run_id[, ...])	当检索器结束运行时执行。
on_retriever_error(error, *, run_id[, ...])	当Retriever出错时运行。
on_retriever_start(serialized, query, *, run_id)	当检索器开始运行时执行。
on_retry(retry_state, *, run_id[, parent_run_id])	在重试事件时运行。
on_text(text[, color, end])	在任意文本上运行。
on_tool_end(output[, color, ...])	当工具结束运行时执行。
on_tool_error(error, **kwargs)	当工具出错时运行。
on_tool_start(serialized, input_str, **kwargs)	当工具开始运行时执行。

__init__(parent_container: DeltaGenerator, *, max_thought_containers: int = 4, expand_new_thoughts: bool = True, collapse_completed_thoughts: bool = True, thought_labeler: LLMThoughtLabeler | None = None)

创建一个 StreamlitCallbackHandler 实例。

Parameters:

• parent_container (DeltaGenerator) – 将包含Handler创建的所有Streamlit元素的st.container。

• max_thought_containers (int) – 一次显示的最大已完成LLM思考容器数量。当达到此阈值时，新的思考将导致最旧的思考被折叠到一个“历史”扩展器中。默认为4。

• expand_new_thoughts (bool) – 每个LLM“想法”都有自己的st.expander。此参数控制该扩展器是否默认展开。默认为True。

• collapse_completed_thoughts (bool) – 如果为True，LLM思维扩展器在完成时将被折叠。默认为True。

• thought_labeler (可选[LLMThoughtLabeler]) – 一个可选的自定义LLMThoughtLabeler实例。如果未指定，处理程序将使用默认的思维标签逻辑。默认为None。

on_agent_action(action: AgentAction, color: str | None = None, **kwargs: Any) → Any

在代理操作上运行。

Parameters:

• action (AgentAction) – 代理动作。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

• color (str | None)

Return type:

任何

on_agent_finish(finish: AgentFinish, color: str | None = None, **kwargs: Any) → None

在代理端运行。

Parameters:

• finish (AgentFinish) – 代理完成。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

• color (str | None)

Return type:

无

on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None

当链结束运行时执行。

Parameters:

• outputs (Dict[str, Any]) – 链的输出。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_chain_error(error: BaseException, **kwargs: Any) → None

当链发生错误时运行。

Parameters:

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None

当链开始运行时运行。

Parameters:

• serialized (Dict[str, Any]) – 序列化的链。

• inputs (Dict[str, Any]) – 输入。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• tags (可选[列表[字符串]]) – 标签。

• metadata (可选[字典[字符串, 任意类型]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any

当聊天模型开始运行时执行。

ATTENTION: This method is called for chat models. If you’re implementing

对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

• serialized (Dict[str, Any]) – 序列化的聊天模型。

• messages (List[List[BaseMessage]]) – 消息。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• tags (可选[列表[字符串]]) – 标签。

• metadata (可选[字典[字符串, 任意类型]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any

重写以定义自定义事件的处理程序。

Parameters:

• name (str) – 自定义事件的名称。

• data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

• run_id (UUID) – 运行的ID。

• tags (list[str] | None) – 与自定义事件关联的标签（包括继承的标签）。

• metadata (dict[str, Any] | None) – 与自定义事件关联的元数据 （包括继承的元数据）。

• kwargs (Any)

Return type:

任何

在版本0.2.15中添加。

on_llm_end(response: LLMResult, **kwargs: Any) → None

当LLM结束运行时执行。

Parameters:

• response (LLMResult) – 生成的响应。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_llm_error(error: BaseException, **kwargs: Any) → None

当LLM出错时运行。

Parameters:

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_llm_new_token(token: str, **kwargs: Any) → None

在新的LLM令牌上运行。仅在启用流式传输时可用。

Parameters:

• token (str) – 新的token。

• chunk (GenerationChunk | ChatGenerationChunk) – 新生成的块，包含内容和其他信息。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None

当LLM开始运行时执行。

ATTENTION: This method is called for non-chat models (regular LLMs). If

你正在为聊天模型实现一个处理程序，你应该使用on_chat_model_start来代替。

Parameters:

• serialized (Dict[str, Any]) – 序列化的LLM。

• prompts (List[str]) – 提示词。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• tags (可选[列表[字符串]]) – 标签。

• metadata (可选[字典[字符串, 任意类型]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any

当Retriever结束运行时执行。

Parameters:

• documents (Sequence[Document]) – 检索到的文档。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any

当Retriever出错时运行。

Parameters:

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retriever_start(serialized: dict[str, Any], query: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any

当Retriever开始运行时执行。

Parameters:

• serialized (Dict[str, Any]) – 序列化的检索器。

• query (str) – 查询。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• tags (可选[列表[字符串]]) – 标签。

• metadata (可选[字典[字符串, 任意类型]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any

在重试事件上运行。

Parameters:

• retry_state (RetryCallState) – 重试状态。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_text(text: str, color: str | None = None, end: str = '', **kwargs: Any) → None

在任意文本上运行。

Parameters:

• 文本 (str) – 文本内容。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

• color (str | None)

• end (str)

Return type:

无

on_tool_end(output: Any, color: str | None = None, observation_prefix: str | None = None, llm_prefix: str | None = None, **kwargs: Any) → None

当工具结束运行时执行。

Parameters:

• output (Any) – 工具的输出。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

• color (str | None)

• observation_prefix (str | None)

• llm_prefix (str | None)

Return type:

无

on_tool_error(error: BaseException, **kwargs: Any) → None

当工具出错时运行。

Parameters:

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None

当工具开始运行时执行。

Parameters:

• serialized (Dict[str, Any]) – 序列化的工具。

• input_str (str) – 输入字符串。

• run_id (UUID) – 运行ID。这是当前运行的ID。

• parent_run_id (UUID) – 父运行ID。这是父运行的ID。

• tags (可选[列表[字符串]]) – 标签。

• metadata (可选[字典[字符串, 任意类型]]) – 元数据。

• inputs (可选[Dict[str, Any]]) – 输入。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

使用 StreamlitCallbackHandler 的示例

• GPT4All

• Streamlit