回调管理器#

class langchain_core.callbacks.manager.CallbackManager(handlers: list[BaseCallbackHandler], inheritable_handlers: list[BaseCallbackHandler] | None = None, parent_run_id: UUID | None = None, *, tags: list[str] | None = None, inheritable_tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inheritable_metadata: dict[str, Any] | None = None)[source]#

LangChain的回调管理器。

初始化回调管理器。

Parameters:

handlers (List[BaseCallbackHandler]) – 处理程序。
inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理程序。默认为 None。
parent_run_id (可选[UUID]) – 父运行ID。默认为None。
tags (可选[列表[字符串]]) – 标签。默认为 None。
inheritable_tags (Optional[List[str]]) – 可继承的标签。默认值为 None。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。默认为 None。
inheritable_metadata (可选[字典[字符串, 任意类型]])

属性

is_async

回调管理器是否为异步。

方法

`__init__`(handlers[, inheritable_handlers, ...])	初始化回调管理器。
`add_handler`(handler[, inherit])	向回调管理器添加一个处理程序。
`add_metadata`(metadata[, inherit])	向回调管理器添加元数据。
`add_tags`(tags[, inherit])	向回调管理器添加标签。
`configure`([inheritable_callbacks, ...])	配置回调管理器。
`copy`()	复制回调管理器。
`merge`(other)	将回调管理器与另一个回调管理器合并。
`on_chain_start`(serialized, inputs[, run_id])	当链开始运行时执行。
`on_chat_model_start`(serialized, messages[, ...])	当聊天模型开始运行时执行。
`on_custom_event`(name, data[, run_id])	将临时事件分派给处理程序（异步版本）。
`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: list[BaseCallbackHandler] | None = None, parent_run_id: UUID | None = None, *, tags: list[str] | None = None, inheritable_tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inheritable_metadata: dict[str, Any] | None = None) → None#

初始化回调管理器。

Parameters:

handlers (List[BaseCallbackHandler]) – 处理程序。
inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理程序。默认为 None。
parent_run_id (可选[UUID]) – 父运行ID。默认为None。
tags (可选[列表[字符串]]) – 标签。默认为 None。
inheritable_tags (Optional[List[str]]) – 可继承的标签。默认值为 None。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。默认为 None。
inheritable_metadata (dict[str, Any] | None)

Return type:

无

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

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

Parameters:

handler (BaseCallbackHandler) – 要添加的处理程序。
inherit (bool) – 是否继承处理程序。默认为 True。

Return type:

无

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

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

Parameters:

metadata (Dict[str, Any]) – 要添加的元数据。
inherit (bool) – 是否继承元数据。默认值为 True。

Return type:

无

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

向回调管理器添加标签。

Parameters:

tags (List[str]) – 要添加的标签。
inherit (bool) – 是否继承标签。默认值为 True。

Return type:

无

classmethod configure(inheritable_callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None, local_callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None, verbose: bool = False, inheritable_tags: list[str] | None = None, local_tags: list[str] | None = None, inheritable_metadata: dict[str, Any] | None = None, local_metadata: dict[str, Any] | None = None) → CallbackManager[source]#

配置回调管理器。

Parameters:

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 (可选[列表[字符串]], 可选) – 本地标签。默认为 None。
inheritable_metadata (Optional[Dict[str, Any]], optional) – 可继承的元数据。默认为 None。
local_metadata (Optional[Dict[str, Any]], optional) – 本地元数据。默认为 None。

Returns:

配置的回调管理器。

Return type:

CallbackManager

copy() → T#

复制回调管理器。

Parameters:: self (T)
Return type:: T

merge(other: BaseCallbackManager) → T#

将回调管理器与另一个回调管理器合并。

可以在子类中被重写。主要在merge_configs内部使用。

Returns:

相同类型的合并回调管理器: 与当前对象相同。

Return type:

BaseCallbackManager

Parameters:

self (T)
其他 (BaseCallbackManager)

示例：合并两个回调管理器。

from langchain_core.callbacks.manager import CallbackManager, trace_as_chain_group
from langchain_core.callbacks.stdout import StdOutCallbackHandler

manager = CallbackManager(handlers=[StdOutCallbackHandler()], tags=["tag2"])
with trace_as_chain_group("My Group Name", tags=["tag1"]) as group_manager:
    merged_manager = group_manager.merge(manager)
    print(merged_manager.handlers)
    # [
    #    <langchain_core.callbacks.stdout.StdOutCallbackHandler object at ...>,
    #    <langchain_core.callbacks.streaming_stdout.StreamingStdOutCallbackHandler object at ...>,
    # ]

    print(merged_manager.tags)
    #    ['tag2', 'tag1']

on_chain_start(serialized: dict[str, Any] | None, inputs: dict[str, Any] | Any, run_id: UUID | None = None, **kwargs: Any) → CallbackManagerForChainRun[source]#

当链开始运行时执行。

Parameters:

serialized (可选[字典[字符串, 任意类型]]) – 序列化的链。
inputs (Union[Dict[str, Any], Any]) – 链的输入。
run_id (UUID, optional) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。

Returns:

链运行的回调管理器。

Return type:

CallbackManagerForChainRun

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], run_id: UUID | None = None, **kwargs: Any) → list[CallbackManagerForLLMRun][source]#

当聊天模型开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的LLM。
messages (List[List[BaseMessage]]) – 消息列表。
run_id (UUID, optional) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

列表[CallbackManagerForLLMRun]

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

向处理程序分派一个临时事件（异步版本）。

此事件不应在任何内部LangChain代码中使用。该事件专门为库的用户设计，用于分派适合其应用程序的自定义事件。

Parameters:

name (str) – 临时事件的名称。
data (Any) – 临时事件的数据。
run_id (UUID | None) – 运行的ID。默认为None。
kwargs (Any)

Return type:

无

在版本0.2.14中添加。

on_llm_start(serialized: dict[str, Any], prompts: list[str], run_id: UUID | None = None, **kwargs: Any) → list[CallbackManagerForLLMRun][source]#

当LLM开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的LLM。
prompts (List[str]) – 提示列表。
run_id (UUID, optional) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。

Returns:

每个回调管理器: 提示作为LLM运行。

Return type:

列表[CallbackManagerForLLMRun]

on_retriever_start(serialized: dict[str, Any] | None, query: str, run_id: UUID | None = None, parent_run_id: UUID | None = None, **kwargs: Any) → CallbackManagerForRetrieverRun[source]#

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

Parameters:

serialized (可选[字典[字符串, 任意类型]]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID, optional) – 运行的ID。默认为None。
parent_run_id (UUID, optional) – 父运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。

Return type:

CallbackManagerForRetrieverRun

on_tool_start(serialized: dict[str, Any] | None, input_str: str, run_id: UUID | None = None, parent_run_id: UUID | None = None, inputs: dict[str, Any] | None = None, **kwargs: Any) → CallbackManagerForToolRun[source]#

当工具开始运行时执行。

Parameters:

serialized (dict[str, Any] | None) – 工具的序列化表示。
input_str (str) – 工具的输入作为字符串。非字符串输入将被转换为字符串。
run_id (UUID | None) – 运行的ID。默认为None。
parent_run_id (UUID | None) – 父运行的ID。默认为None。
inputs (dict[str, Any] | None) – 如果提供了工具的原始输入。当需要原始输入时，建议使用此参数而不是input_str。如果提供了输入，则期望输入格式为字典。键将对应于工具中的命名参数。
**kwargs (Any) – 额外的关键字参数。

Returns:

工具运行的回调管理器。

Return type:

CallbackManagerForToolRun

remove_handler(handler: BaseCallbackHandler) → None#

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

Parameters:: handler (BaseCallbackHandler) – 要移除的处理程序。
Return type:: 无

remove_metadata(keys: list[str]) → None#

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

Parameters:: keys (List[str]) – 要移除的键。
Return type:: 无

remove_tags(tags: list[str]) → None#

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

Parameters:: 标签 (列表[字符串]) – 要移除的标签。
Return type:: 无

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

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

Parameters:

handler (BaseCallbackHandler) – 要设置的处理器。
inherit (bool) – 是否继承处理程序。默认为 True。

Return type:

无

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

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

Parameters:

handlers (List[BaseCallbackHandler]) – 要设置的处理器。
inherit (bool) – 是否继承处理程序。默认值为 True。

Return type:

无

使用 CallbackManager 的示例