BaseCallbackManager#

class langchain_core.callbacks.base.BaseCallbackManager(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)[来源]#

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

向回调管理器添加标签。

copy()

复制回调管理器。

merge(other)

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

on_chain_start(serialized, inputs, *, run_id)

当链开始运行时执行。

on_chat_model_start(serialized, messages, *, ...)

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

on_llm_start(serialized, prompts, *, run_id)

当LLM开始运行时执行。

on_retriever_start(serialized, query, *, run_id)

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

on_tool_start(serialized, input_str, *, run_id)

当工具开始运行时执行。

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[source]#

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

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

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

Return type:

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

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

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:

copy() T[source]#

复制回调管理器。

Parameters:

self (T)

Return type:

T

merge(other: BaseCallbackManager) T[来源]#

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

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

Returns:

相同类型的合并回调管理器

与当前对象相同。

Return type:

BaseCallbackManager

Parameters:

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

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], inputs: dict[str, Any], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) Any#

当链开始运行时运行。

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

  • inputs (Dict[str, Any]) – 输入。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) Any#

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

ATTENTION: This method is called for chat models. If you’re implementing

对于非聊天模型的处理程序,您应该使用 on_llm_start 代替。

Parameters:
  • serialized (Dict[str, Any]) – 序列化的聊天模型。

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

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_llm_start(serialized: dict[str, Any], prompts: list[str], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) Any#

当LLM开始运行时执行。

ATTENTION: This method is called for non-chat models (regular LLMs). If

你正在为聊天模型实现一个处理程序,你应该使用on_chat_model_start来代替。

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

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

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_retriever_start(serialized: dict[str, Any], query: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) Any#

当Retriever开始运行时执行。

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

  • query (str) – 查询。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_tool_start(serialized: dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inputs: dict[str, Any] | None = None, **kwargs: Any) Any#

当工具开始运行时执行。

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

  • input_str (str) – 输入字符串。

  • run_id (UUID) – 运行ID。这是当前运行的ID。

  • parent_run_id (UUID) – 父运行ID。这是父运行的ID。

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

  • inputs (可选[Dict[str, Any]]) – 输入。

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

Return type:

任何

remove_handler(handler: BaseCallbackHandler) None[source]#

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

Parameters:

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

Return type:

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

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

Parameters:

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

Return type:

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

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

Parameters:

标签 (列表[字符串]) – 要移除的标签。

Return type:

set_handler(handler: BaseCallbackHandler, inherit: bool = True) None[source]#

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

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

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

Return type:

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

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

Parameters:
  • handlers (List[BaseCallbackHandler]) – 要设置的处理器。

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

Return type: