StreamingStdOutCallbackHandler#

class langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler[source]#

用于流式传输的回调处理程序。仅适用于支持流式传输的LLMs。

属性

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

如果发生异常，是否引发错误。

run_inline

是否内联运行回调。

方法

on_agent_action(action, **kwargs)

在代理操作时运行。

on_agent_finish(finish, **kwargs)

在代理结束时运行。

on_chain_end(outputs, **kwargs)

当链结束时运行。

on_chain_error(error, **kwargs)

当链发生错误时运行。

on_chain_start(serialized, inputs, **kwargs)

当链开始运行时执行。

on_chat_model_start(serialized, messages, ...)

当LLM开始运行时执行。

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, **kwargs)

在任意文本上运行。

on_tool_end(output, **kwargs)

当工具结束运行时执行。

on_tool_error(error, **kwargs)

当工具出错时运行。

on_tool_start(serialized, input_str, **kwargs)

当工具开始运行时执行。
on_agent_action(action: AgentAction, **kwargs: Any) → Any[来源]#

在代理操作上运行。

Parameters:

  • action (AgentAction) – 代理动作。

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

Return type:

任何

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]#

在代理端运行。

Parameters:

  • finish (AgentFinish) – 代理完成。

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

Return type:

无

on_chain_end(outputs: dict[str, Any], **kwargs: Any) → None[source]#

当链结束运行时执行。

Parameters:

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

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

Return type:

无

on_chain_error(error: BaseException, **kwargs: Any) → None[来源]#

当链发生错误时运行。

Parameters:

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

  • **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]) – 链的输入。

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

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], **kwargs: Any) → None[source]#

当LLM开始运行时执行。

Parameters:

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

  • messages (List[List[BaseMessage]]) – 要运行的消息。

  • **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[source]#

当LLM结束运行时执行。

Parameters:

  • response (LLMResult) – 来自LLM的响应。

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

Return type:

无

on_llm_error(error: BaseException, **kwargs: Any) → None[source]#

当LLM出错时运行。

Parameters:

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

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

Return type:

无

on_llm_new_token(token: str, **kwargs: Any) → None[source]#

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

Parameters:

  • token (str) – 新的token。

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

Return type:

无

on_llm_start(serialized: dict[str, Any], prompts: list[str], **kwargs: Any) → None[source]#

当LLM开始运行时执行。

Parameters:

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

  • prompts (List[str]) – 要运行的提示。

  • **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, **kwargs: Any) → None[source]#

在任意文本上运行。

Parameters:

  • text (str) – 要打印的文本。

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

Return type:

无

on_tool_end(output: Any, **kwargs: Any) → None[source]#

工具结束运行时执行。

Parameters:

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

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

Return type:

无

on_tool_error(error: BaseException, **kwargs: Any) → None[来源]#

当工具出错时运行。

Parameters:

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

  • **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) – 输入字符串。

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

Return type:

无

使用 StreamingStdOutCallbackHandler 的示例