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]

链式组的回调管理器。

初始化回调管理器。

Attributes

is_async

回调管理器是否是异步的。

Methods

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

初始化回调管理器。

add_handler(handler[, inherit])

添加一个处理程序到回调管理器。

add_metadata(metadata[, inherit])

add_tags(tags[, inherit])

configure([inheritable_callbacks, ...])

配置回调管理器。

copy()

复制回调管理器。

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_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])

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

None

__init__(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: CallbackManagerForChainRun, **kwargs: Any) → None[source]

初始化回调管理器。

Parameters
Return type

None

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

添加一个处理程序到回调管理器。

Parameters
Return type

None

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

  • metadata (Dict[str, Any]) –

  • inherit (bool) –

Return type

None

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

  • tags (List[str]) –

  • inherit (bool) –

Return type

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。

返回:

CallbackManager: 配置好的回调管理器。

Parameters
Return type

CallbackManager

copy() → CallbackManagerForChainGroup[source]

复制回调管理器。

Return type

CallbackManagerForChainGroup

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

当跟踪的链组结束时运行。

参数:

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

Parameters

  • outputs (Union[Dict[str, Any], Any]) –

  • kwargs (Any) –

Return type

None

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

当链式错误发生时运行。

参数:

error (Exception或KeyboardInterrupt): 错误。

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

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, optional): 运行的ID。默认为None。

返回：

CallbackManagerForChainRun: 链运行的回调管理器。

Parameters

  • serialized (Dict[str, Any]) –

  • inputs (Union[Dict[str, Any], Any]) –

  • run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

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, optional): 运行的ID。默认为None。

返回：

List[CallbackManagerForLLMRun]: 每个消息列表作为LLM运行的回调管理器。

Parameters

  • serialized (Dict[str, Any]) –

  • messages (List[List[BaseMessage]]) –

  • run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

List[CallbackManagerForLLMRun]

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, optional): 运行的ID。默认为None。

返回：

List[CallbackManagerForLLMRun]: 每个提示作为LLM运行的回调管理器。

Parameters

  • serialized (Dict[str, Any]) –

  • prompts (List[str]) –

  • run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

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

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

Parameters

  • serialized (Dict[str, Any]) –

  • query (str) –

  • run_id (Optional[UUID]) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

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: 工具的序列化表示。 input_str: 作为字符串的工具输入。

非字符串输入将被转换为字符串。

run_id: 运行的ID。默认为None。 parent_run_id: 父运行的ID。默认为None。 inputs: 如果提供了工具的原始输入，则推荐使用。

当需要原始输入时推荐使用。 如果提供了，期望输入被格式化为字典。 键将对应于工具中的命名参数。

返回：

CallbackManagerForToolRun: 工具运行的回调管理器。

Parameters

  • serialized (Dict[str, Any]) –

  • input_str (str) –

  • run_id (Optional[UUID]) –

  • parent_run_id (Optional[UUID]) –

  • inputs (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

CallbackManagerForToolRun

remove_handler(handler: BaseCallbackHandler) → None

从回调管理器中移除一个处理程序。

Parameters

handler (BaseCallbackHandler) –

Return type

None

remove_metadata(keys: List[str]) → None
Parameters

keys (List[str]) –

Return type

None

remove_tags(tags: List[str]) → None
Parameters

tags (List[str]) –

Return type

None

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

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

Parameters
Return type

None

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

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

Parameters
Return type

None