langchain_core.callbacks.base.BaseCallbackManager

class langchain_core.callbacks.base.BaseCallbackManager(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, 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)

LangChain 的基础回调管理器。

初始化回调管理器。

参数

• handlers (List[BaseCallbackHandler]) – 处理程序。

• inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理程序。默认为 None。

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

• tags (Optional[List[str]]) – 标签。默认为 None。

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

• metadata (Optional[Dict[str, Any]]) – 元数据。默认为 None。

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

属性

is_async

回调管理器是否为异步。

方法

__init__(handlers[, inheritable_handlers, ...])	初始化回调管理器。
add_handler(handler[, inherit])	向回调管理器添加处理程序。
add_metadata(metadata[, inherit])	向回调管理器添加元数据。
add_tags(tags[, inherit])	向回调管理器添加标签。
copy()	复制回调管理器。
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)	当 Retriever 开始运行时运行。
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: Optional[List[BaseCallbackHandler]] = None, 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

初始化回调管理器。

参数

• handlers (List[BaseCallbackHandler]) – 处理程序。

• inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理程序。默认为 None。

• parent_run_id (Optional[UUID]) – 父运行 ID。默认为 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

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]) – 要添加的元数据。

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

返回类型

None

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

向回调管理器添加标签。

参数

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

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

返回类型

None

copy() → T

复制回调管理器。

参数

self (T) –

返回类型

T

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

当链开始运行时运行。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加的关键字参数。

返回类型

Any

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

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

注意：此方法为聊天模型调用。如果您正在实现

非聊天模型的处理程序，则应使用 on_llm_start 代替。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加的关键字参数。

返回类型

Any

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

当 LLM 开始运行时运行。

注意：此方法为非聊天模型（常规 LLM）调用。如果

您正在实现聊天模型的处理程序，则应使用 on_chat_model_start 代替。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加的关键字参数。

返回类型

Any

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

当 Retriever 开始运行时运行。

参数

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

• query (str) – 查询。

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 附加的关键字参数。

返回类型

Any

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

当工具开始运行时运行。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

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

• kwargs (Any) – 附加的关键字参数。

返回类型

Any

remove_handler(handler: BaseCallbackHandler) → None

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

参数

handler (BaseCallbackHandler) – 要移除的 handler。

返回类型

None

remove_metadata(keys: List[str]) → None

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

参数

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

返回类型

None

remove_tags(tags: List[str]) → None

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

参数

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

返回类型

None

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

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

参数

• handler (BaseCallbackHandler) – 要设置的 handler。

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

返回类型

None

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

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

参数

• handlers (List[BaseCallbackHandler]) – 要设置的 handlers。

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

返回类型

None