langchain_core.callbacks.manager.CallbackManagerForChainRun

class langchain_core.callbacks.manager.CallbackManagerForChainRun(*, 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)[source]

链执行回调管理器。

初始化运行管理器。

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

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

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

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

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

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

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

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

方法

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

初始化运行管理器。

get_child([tag])

获取一个子回调管理器。

get_noop_manager()

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

on_agent_action(action, **kwargs)

当收到代理动作时运行。

on_agent_finish(finish, **kwargs)

当收到代理完成信号时运行。

on_chain_end(outputs, **kwargs)

当链完成运行时运行。

on_chain_error(error, **kwargs)

当链出现错误时运行。

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

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

on_retry(retry_state, **kwargs)

当收到重试请求时运行。

on_text(text, **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 (List[BaseCallbackHandler]) – 处理器列表。

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

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

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

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

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

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

返回类型

None

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

获取一个子回调管理器。

参数

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

返回值

子回调管理器。

返回类型

CallbackManager

classmethodget_noop_manager() BRM

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

返回值

无操作管理器。

返回类型

BaseRunManager

on_agent_action(action: AgentAction, **kwargs: Any) Any[source]

当收到代理动作时运行。

参数
  • action (AgentAction) – 代理动作。

  • **kwargs (Any) – 其他关键词参数。

返回值

回调的执行结果。

返回类型

Any

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

当收到代理完成信号时运行。

参数
  • finish (AgentFinish) – 代理完成。

  • **kwargs (Any) – 其他关键词参数。

返回值

回调的执行结果。

返回类型

Any

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

当链完成运行时运行。

参数
  • outputs (Union[Dict[str, Any], Any]) – 事件的输出。

  • **kwargs (Any) – 其他关键词参数。

返回类型

None

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

当链出现错误时运行。

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

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

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

  • kwargs (Any) –

返回类型

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) – 其他关键词参数。

返回值

回调的执行结果。

返回类型

Any