langchain_core.callbacks.manager.AsyncCallbackManager

class langchain_core.callbacks.manager.AsyncCallbackManager(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)[source]

处理来自 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])

向回调管理器添加标签。

configure([inheritable_callbacks, ...])

配置异步回调管理器。

copy()

复制回调管理器。

on_chain_start(serialized, inputs[, run_id])

当链开始运行时异步运行。

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

当 LLM 开始运行时异步运行。

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: 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

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) AsyncCallbackManager[source]

配置异步回调管理器。

参数
  • 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。

返回

配置的异步回调管理器。

返回类型

AsyncCallbackManager

copy() T

复制回调管理器。

参数

self (T) –

返回类型

T

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

当链开始运行时异步运行。

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

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

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

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

返回

异步回调管理器

用于链的运行。

返回类型

AsyncCallbackManagerForChainRun

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

当 LLM 开始运行时异步运行。

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

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

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

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

返回

列表

异步回调管理器,每个 LLM 运行对应于每个内部消息列表。

返回类型

List[AsyncCallbackManagerForLLMRun]

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

向处理程序分发一个特别事件(异步版本)。

此事件不应在任何 LangChain 内部代码中使用。此事件专为库的用户设计,用于分派为其应用程序量身定制的自定义事件。

参数
  • name (str) – 特别事件的名称。

  • data (Any) – 特别事件的数据。

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

  • kwargs (Any) –

返回类型

None

0.2.14 版本新增。

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

当 LLM 开始运行时运行。

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

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

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

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

返回

异步列表

回调管理器,每个 LLM 运行对应于每个提示。

返回类型

List[AsyncCallbackManagerForLLMRun]

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

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

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

  • query (str) – 查询语句。

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

  • parent_run_id (UUID, optional) – 父级运行的ID。默认为 None。

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

返回

异步回调管理器

用于检索器运行。

返回类型

AsyncCallbackManagerForRetrieverRun

async on_tool_start(serialized: Dict[str, Any], input_str: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) AsyncCallbackManagerForToolRun[source]

当工具开始运行时运行。

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

  • input_str (str) – 工具的输入。

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

  • parent_run_id (UUID, optional) – 父级运行的ID。默认为 None。

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

返回

异步回调管理器

用于工具运行。

返回类型

AsyncCallbackManagerForToolRun

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 (List[str]) – 要移除的标签。

返回类型

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 (List[BaseCallbackHandler]) – 要设置的处理程序。

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

返回类型

None