langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler

class langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler

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

属性

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

方法

__init__()
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(序列化数据， prompts， **kwargs)	当LLM开始执行时执行。
on_retriever_end(文档， *， run_id[， ...])	在Retriever运行结束后运行。
on_retriever_error(错误， *， run_id[， ...])	在Retriever出错时运行。
on_retriever_start(序列化数据， 查询， *， run_id)	在Retriever开始运行时运行。
on_retry(重试状态， *， run_id[， parent_run_id])	在重试事件上运行。
on_text(文本， **kwargs)	在任意文本上运行。
on_tool_end(输出， **kwargs)	在工具运行结束后运行。
on_tool_error(错误， **kwargs)	在工具出错时运行。
on_tool_start(序列化数据， 输入字符串， **kwargs)	在工具开始运行时运行。

__init__()

on_agent_action(action: AgentAction, **kwargs: Any) → Any

在代理操作时执行。

参数

• action (AgentAction) - 代理动作。

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

返回类型

Any

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None

在代理结束时执行。

参数

• finish (AgentFinish) – 代理完成。

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

返回类型

None

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

当链执行结束时执行。

参数

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

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

返回类型

None

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

当链出现错误时执行。

参数

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

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

返回类型

None

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

当链开始执行时执行。

参数

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

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

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

返回类型

None

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], **kwargs: Any) → None

当LLM开始执行时执行。

参数

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

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

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

返回类型

None

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

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

参数

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

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

• run_id (UUID) – 运行ID。

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

• 元数据 (可选[字典][\字符串,任意类型\]]) – 与自定义事件关联的元数据（包括继承的元数据）。

• kwargs (任意类型) –

返回类型

Any

自版本 0.2.15 开始支持。

on_llm_end(response: LLMResult, **kwargs: 任意类型) → None

当LLM执行结束时执行。

参数

• response (LLMResult) – 来自语言的回应。

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

返回类型

None

on_llm_error(error: BaseException, **kwargs: 任意类型) → None

当LLM出现错误时执行。

参数

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

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

返回类型

None

on_llm_new_token(token: str, **kwargs: 任意类型) → None

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

参数

• token (字符串) – 新的令牌。

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

返回类型

None

on_llm_start(serialized: 字典[\字符串,任意类型\], prompts: 列表[\字符串\], **kwargs: 任意类型) → None

当LLM开始执行时执行。

参数

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

• prompts (列表[字符串]) – 要运行的提示。

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

返回类型

None

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

在Retriever运行结束后运行。

参数

• documents (Sequence[Document]) – 获取到的文档。

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

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

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

返回类型

Any

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

在Retriever出错时运行。

参数

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

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

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

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

返回类型

Any

on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

在Retriever开始运行时运行。

参数

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

• query (str) – 查询。

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

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

返回类型

Any

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

在重试事件上运行。

参数

• retry_state (RetryCallState) – 重试状态。

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

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

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

返回类型

Any

on_text(text: str, **kwargs: Any) → None

在任意文本上运行。

参数

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

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

返回类型

None

on_tool_end(output: Any, **kwargs: Any) → None

在工具运行结束后运行。

参数

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

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

返回类型

None

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

在工具出错时运行。

参数

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

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

返回类型

None

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

在工具开始运行时运行。

参数

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

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

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

返回类型

None

使用StreamingStdOutCallbackHandler的示例

• Arthur

• Bedrock

• C Transformers

• 与Vectara通过文档进行聊天

• ChatEverlyAI

• ChatLiteLLM

• ChatLiteLLMRouter

• DeepInfra

• Eden AI

• ExLlamaV2

• GPT4All

• GPTRouter

• Huggingface Endpoints

• Llama.cpp

• Replicate

• 本地运行LLMs

• TextGen

• Titan Takeoff

• Yuan2.0

• ZHIPU AI