langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler

类名langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler(*, answer_prefix_tokens: Optional[List[str]] = None, strip_tokens: bool = True, stream_prefix: bool = False)

代理的流式回调处理器。仅适用于支持流式API的LLM代理。

仅将代理的最后输出流式传输。

实例化FinalStreamingStdOutCallbackHandler。

参数

  • answer_prefix_tokens (可选[str]列表) – 作为答案前缀的标记序列。默认为["最终", "答案", ":"]

  • strip_tokens () – 在比较answer_prefix_tokens与最后标记时忽略空白符和新行？(以确定是否已到达答案)

  • stream_prefix () – 是否也应流式传输答案前缀本身？

属性

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

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

run_inline

是否直接运行回调。

方法

__init__(*, answer_prefix_tokens, ...)

实例化FinalStreamingStdOutCallbackHandler。

append_to_last_tokens(token)

check_if_answer_reached()

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[, ...])

在Retriever运行结束时执行。

on_retriever_error(error,  *,  run_id[, ...])

在Retriever发生错误时执行。

on_retriever_start(serialized,  query,  *,  run_id)

在Retriever开始运行时执行。

on_retry(retry_state,  *,  run_id[, parent_run_id])

在重试事件上执行。

on_text(text,  **kwargs)

在任意文本上运行。

on_tool_end(输出参数, **kwargs)

在工具运行结束时执行。

on_tool_error(错误信息, **kwargs)

在工具出错时执行。

on_tool_start(序列化数据, 输入字符串, **kwargs)

在工具开始运行时执行。
__init__(*, answer_prefix_tokens: Optional[List[str]]] = None, strip_tokens: bool = True, stream_prefix: bool = False) → None[source]

实例化FinalStreamingStdOutCallbackHandler。

参数

  • answer_prefix_tokens (可选[str]列表) – 作为答案前缀的标记序列。默认为["最终", "答案", ":"]

  • strip_tokens () – 在比较answer_prefix_tokens与最后标记时忽略空白符和新行？(以确定是否已到达答案)

  • stream_prefix () – 是否也应流式传输答案前缀本身？

返回类型

None

append_to_last_tokens(token: str) → None[source]
参数

token (str) –

返回类型

None

check_if_answer_reached() → bool[source]
返回类型

bool

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[[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]]) – 与自定义事件关联的标签（包括继承的标签）。

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

  • kwargs (Any) –

返回类型

Any

新增于版本 0.2.15。

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

在LLM运行结束时执行。

参数

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

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

返回类型

None

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

在LLM发生错误时执行。

参数

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

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

返回类型

None

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

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

参数

  • token (str) –

  • kwargs (Any) –

返回类型

None

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

在LLM开始运行时执行。

参数

  • serialized (Dict[str, Any]) –

  • prompts (List[str]) –

  • 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 (可选[列表[str]]) – 标签。

  • metadata (可选[字典[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