langchain_core.callbacks.manager.CallbackManagerForChainGroup

class langchain_core.callbacks.manager.CallbackManagerForChainGroup(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: CallbackManagerForChainRun, **kwargs: Any)[source]

链组回调管理器。

初始化回调管理器。

参数

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

  • inheritable_handlers (可选[列表[BaseCallbackHandler]]) – 可继承处理器列表。默认为 None。

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

  • parent_run_manager (CallbackManagerForChainRun) – 父运行管理器。

  • **kwargs (任意) – 额外关键字参数。

属性

is_async

回调管理器是否为异步。

方法

__init__(handlers[, inheritable_handlers, ...])

初始化回调管理器。

add_handler(handler[, inherit])

向回调管理器添加处理器。

add_metadata(metadata[, inherit])

向回调管理器添加元数据。

add_tags(tags[, inherit])

为回调管理器添加标签。

configure([inheritable_callbacks, ...])

配置回调管理器。

复制()

复制回调管理器。

on_chain_end(outputs, **kwargs)

当追踪链组结束时执行。

on_chain_error(error, **kwargs)

在链错误时执行。

on_chain_start(serialized, inputs[, run_id])

在链开始运行时执行。

on_chat_model_start(serialized, messages[, ...])

当 LLM 开始运行时执行。

on_custom_event(name, data[, run_id])

向处理程序发送一个临时的event (异步版本)。

on_llm_start(serialized, prompts[, run_id])

当 LLM 开始运行时执行。

on_retriever_start(serialized, query[, ...])

当检索器开始运行时执行。

on_tool_start(serialized, input_str[, ...])

当工具开始运行时执行。

remove_handler(handler)

从回调管理器中删除处理程序。

remove_metadata(keys)

从回调管理器中删除元数据。

remove_tags(tags)

从回调管理器中删除标签。

set_handler(handler[, inherit])

将处理程序设置为回调管理器上的唯一处理程序。

set_handlers(handlers[, inherit])

将处理程序设置为回调管理器上的唯一处理程序。
__init__(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: CallbackManagerForChainRun, **kwargs: Any) → None[源代码]

初始化回调管理器。

参数

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

  • inheritable_handlers (可选[列表[BaseCallbackHandler]]) – 可继承处理器列表。默认为 None。

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

  • parent_run_manager (CallbackManagerForChainRun) – 父运行管理器。

  • **kwargs (任意) – 额外关键字参数。

返回类型

None

add_handler(handler: BaseCallbackHandler, inherit: bool = True) → None

向回调管理器添加处理器。

参数

  • handler (BaseCallbackHandler) – 添加的处理程序。

  • inherit (bool) – 是否继承处理程序。默认为 True。

返回类型

None

add_metadata(metadata: Dict[str, Any], inherit: bool = True) → None

向回调管理器添加元数据。

参数

  • metadata (Dict[str, Any]) – 添加的元数据。

  • 继承 (bool) – 是否继承元数据。默认为 True。

返回类型

None

add_tags(tags: List[str], inherit: bool = True) → None

为回调管理器添加标签。

参数

  • tags (List[str]) – 要添加的标签。

  • inherit (bool) – 是否继承标签。默认为 True。

返回类型

None

classmethod configure(inheritable_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, local_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, verbose: bool = False, inheritable_tags: Optional[List[str]] = None, local_tags: Optional[List[str]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None, local_metadata: Optional[Dict[str, Any]] = None) → CallbackManager

配置回调管理器。

参数

  • inheritable_callbacks (Optional[Callbacks], optional) – 可继承的回调。默认为 None。

  • local_callbacks (Optional[Callbacks], optional) – 局部回调。默认为 None。

  • verbose (bool, optional) – 是否启用详细模式。默认为 False。

  • inheritable_tags (Optional[List[str]], optional) – 可继承的标签。默认为 None。

  • local_tags (Optional[List[str]], optional) – 局部标签。默认为 None。

  • inheritable_metadata (Optional[Dict[str, Any]], optional) – 可继承的元数据。默认为 None。

  • local_metadata (Optional[Dict[str, Any]], optional) – 本地元数据。默认为 None。

返回

配置的回调管理器。

返回类型

回调管理器

copy() → CallbackManagerForChainGroup[source]

复制回调管理器。

返回类型

CallbackManagerForChainGroup

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

当追踪链组结束时执行。

参数

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

  • **kwargs (任意) – 额外关键字参数。

返回类型

None

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

在链错误时执行。

参数

  • error (Exception 或 KeyboardInterrupt) – 错误。

  • **kwargs (任意) – 额外关键字参数。

返回类型

None

on_chain_start(serialized: Dict[str, Any], inputs: Union[Dict[str, Any], Any], run_id: Optional[UUID] = None, **kwargs: Any) → CallbackManagerForChainRun

在链开始运行时执行。

参数

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

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

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

  • **kwargs (任意) – 额外关键字参数。

返回

链运行时的回调管理器。

返回类型

CallbackManagerForChainRun

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], run_id: Optional[UUID] = None, **kwargs: Any) → List[CallbackManagerForLLMRun]

当 LLM 开始运行时执行。

参数

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

  • messages (List[List[BaseMessage]]) – 消息列表。

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

  • **kwargs (任意) – 额外关键字参数。

返回

为每次 LLM 运行的消息列表提供一个回调管理器。

返回类型

List[CallbackManagerForLLMRun]

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

向处理程序发送一个临时的event (异步版本)。

此事件不应在任何 LangChain 代码内部使用。此事件专门用于库的用户以分发针对其应用程序定制的自定义事件。

参数

  • name (str) – 临时事件的名称。

  • data (Any) – 临时事件的相关数据。

  • run_id (Optional[UUID]) – 运行ID。默认为 None。

  • kwargs (Any) –

返回类型

None

新版本 0.2.14 加入。

on_llm_start(serialized: Dict[str, Any], prompts: List[str], run_id: Optional[UUID] = None, **kwargs: Any) → List[CallbackManagerForLLMRun]

当 LLM 开始运行时执行。

参数

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

  • prompts (List[str]) – 提示列表。

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

  • **kwargs (任意) – 额外关键字参数。

返回

为每次 LLM 运行的消息列表提供一个回调管理器。

作为 LLM 运行的提示。

返回类型

List[CallbackManagerForLLMRun]

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

当检索器开始运行时执行。

参数

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

  • query (str) – 查询。

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

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

  • **kwargs (任意) – 额外关键字参数。

返回类型

CallbackManagerForRetrieverRun

on_tool_start(serialized: Dict[str, Any], input_str: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → CallbackManagerForToolRun

当工具开始运行时执行。

参数

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

  • input_str (str) – 工具的输入字符串。非字符串输入将被转换为字符串。

  • run_id (Optional[UUID]) – 运行ID。默认为None。

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

  • inputs (Optional[Dict[str, Any]]) – 工具的原始输入（如果提供）。当需要原始输入时，建议使用inputs而不是input_str。如果提供，inputs应格式化为字典。键将对应于工具中的命名参数。

  • **kwargs (任意) – 额外关键字参数。

返回

工具运行的回调管理器。

返回类型

CallbackManagerForToolRun

remove_handler(handler: BaseCallbackHandler) → None

从回调管理器中删除处理程序。

参数

handler (BaseCallbackHandler) – 要移除的处理程序。

返回类型

None

remove_metadata(keys: List[str]) → None

从回调管理器中删除元数据。

参数

keys (List[str]) – 要移除的键。

返回类型

None

remove_tags(tags: List[str]) → None

从回调管理器中删除标签。

参数

tags (列表[字符串]) – 要删除的标记。

返回类型

None

set_handler(handler: BaseCallbackHandler, inherit: bool = True) → None

将处理程序设置为回调管理器上的唯一处理程序。

参数

  • handler (BaseCallbackHandler) – 要设置的处理器。

  • inherit (bool) – 是否继承处理程序。默认为 True。

返回类型

None

set_handlers(handlers: List[BaseCallbackHandler], inherit: bool = True) → None

将处理程序设置为回调管理器上的唯一处理程序。

参数

  • handlers (列表[BaseCallbackHandler]) – 要设置的处理器。

  • inherit (布尔型) – 是否继承处理器。默认为 True。

返回类型

None