langchain_core.callbacks.manager.CallbackManagerForToolRun

class langchain_core.callbacks.manager.CallbackManagerForToolRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None)[源码]

工具运行回调管理器。

初始化运行管理器。

参数
  • run_id (UUID) – 运行的ID。

  • handlers (列表[BaseCallbackHandler]) – 处理器列表。

  • inheritable_handlers (列表[BaseCallbackHandler]) – 可继承的处理器列表。

  • parent_run_id (UUID可选) – 父运行ID。默认为None。

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

  • inheritable_tags (可选[列表[字符串]]) – 可继承的标签列表。默认为None。

  • metadata (可选[字典[字符串,任何值]]) – 元数据。默认为None。

  • inheritable_metadata (可选[字典[字符串,任何值]]) – 可继承的元数据。默认为None。

方法

__init__(*, run_id, handlers, ...[, ...])

初始化运行管理器。

get_child([tag])

获取一个子回调管理器。

get_noop_manager()

返回一个不执行任何操作的管理器。

on_custom_event(name, data, *, run_id[, ...])

覆盖以定义自定义事件的处理器。

on_retry(retry_state, **kwargs)

在收到重试请求时运行。

on_text(text, **kwargs)

在接收到文本时运行。

on_tool_end(output, **kwargs)

工具运行结束时运行。

on_tool_error(error, **kwargs)

工具出错时运行。

__init__(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None) None

初始化运行管理器。

参数
  • run_id (UUID) – 运行的ID。

  • handlers (列表[BaseCallbackHandler]) – 处理器列表。

  • inheritable_handlers (列表[BaseCallbackHandler]) – 可继承的处理器列表。

  • parent_run_id (UUID可选) – 父运行ID。默认为None。

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

  • inheritable_tags (可选[列表[字符串]]) – 可继承的标签列表。默认为None。

  • metadata (可选[字典[字符串,任何值]]) – 元数据。默认为None。

  • inheritable_metadata (可选[字典[字符串,任何值]]) – 可继承的元数据。默认为None。

返回类型

None

get_child(tag: Optional[str] = None) CallbackManager

获取一个子回调管理器。

参数

tag (str可选) – 子回调管理器的标签。默认为None。

返回

子回调管理器。

返回类型

回调管理器

classmethod get_noop_manager() BRM

返回一个不执行任何操作的manager。

返回

空操作管理器。

返回类型

基础运行管理器

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) –

返回类型

任何

新功能自版本 0.2.15。

on_retry(retry_state: RetryCallState, **kwargs: Any) None

在收到重试请求时运行。

参数
  • retry_state (RetryCallState) – 重试状态。

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

返回类型

None

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

在接收到文本时运行。

参数
  • text (str) – 收到的文本。

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

返回

回调的结果。

返回类型

任何

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

工具运行结束时运行。

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

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

返回类型

None

on_tool_error(error: BaseException, **kwargs: Any) None[source]

工具出错时运行。

参数
  • error (Exception or KeyboardInterrupt) – 错误。

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

返回类型

None

有关 CallbackManagerForToolRun 的示例使用