`langchain_core.callbacks.manager`.AsyncCallbackManagerForRetrieverRun¶

class langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], 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]¶

异步回调管理器，用于检索运行。

初始化运行管理器。

参数

run_id (UUID) – 运行的ID。
handlers (List[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (List[BaseCallbackHandler]) – 可继承的处理器列表。
parent_run_id (UUID, 可选) – 父运行的ID。默认为None。
tags (可选[List[str]]) – 标签列表。默认为None。
inheritable_tags (可选 [列表[str]]) – 可继承标签的列表。默认为 None。
metadata (可选 [字典[str, Any]]) – 元数据。默认为 None。
inheritable_metadata (可选 [字典[str, Any]]) – 可继承的元数据。默认为 None。

方法

`__init__`(*args, run_id, handlers, ...[,...])	初始化运行管理器。
`get_child`([tag])	获取子回调管理器。
`get_noop_manager`()	返回一个不执行任何操作的管理器。
`get_sync`()	获取等效的同步 RunManager。
`on_custom_event`(name, data, *args, run_id[,...])	重写以定义自定义事件的处理程序。
`on_retriever_end`(documents, **kwargs)	当检索器运行结束时执行。
`on_retriever_error`(error, **kwargs)	检索器出错时执行。
`on_retry`(retry_state, **kwargs)	当接收到重试请求时异步运行。
`on_text`(text, **kwargs)	当接收到文本时执行。

__init__(*, run_id: UUID, handlers: List[BaseCallbackHandler], inheritable_handlers: List[BaseCallbackHandler], 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¶

初始化运行管理器。

参数

run_id (UUID) – 运行的ID。
handlers (List[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (List[BaseCallbackHandler]) – 可继承的处理器列表。
parent_run_id (UUID, 可选) – 父运行的ID。默认为None。
tags (可选[List[str]]) – 标签列表。默认为None。
inheritable_tags (可选 [列表[str]]) – 可继承标签的列表。默认为 None。
metadata (可选 [字典[str, Any]]) – 元数据。默认为 None。
inheritable_metadata (可选 [字典[str, Any]]) – 可继承的元数据。默认为 None。

返回类型

None

get_child(tag: Optional[str] = None) → AsyncCallbackManager¶

获取子回调管理器。

参数: tag (str, optional) – 子回调管理器的标签。默认为 None。
返回：: 子回调管理器。
返回类型: AsyncCallbackManager

classmethod get_noop_manager() → BRM¶

返回一个不执行任何操作的管理器。

返回：: 无操作管理器。
返回类型: BaseRunManager

get_sync() → CallbackManagerForRetrieverRun[source]¶

获取等效的同步 RunManager。

返回：: 同步 RunManager。
返回类型: CallbackManagerForRetrieverRun

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

重写以定义自定义事件的处理程序。

参数

name (str) – 自定义事件的名称。
data (任意) – 自定义事件的数据。格式将与用户指定的格式相匹配。
run_id (UUID) – 运行的ID。
tags (可选[字符串列表]) – 与自定义事件关联的标签（包括继承的标签）。
metadata (可选[字符串：任意字典]) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (任意) –

返回类型

任意

自 0.2.15 版本开始引入。

async on_retriever_end(documents: Sequence[Document], **kwargs: Any) → None[source]¶

当检索器运行结束时执行。

参数

documents (Sequence[Document]) – 检索到的文档。
**kwargs (任意) – 额外的关键字参数。

返回类型

None

async on_retriever_error(error: BaseException, **kwargs: Any) → None[source]¶

检索器出错时执行。

参数

error (BaseException) – 错误。
**kwargs (任意) – 额外的关键字参数。

返回类型

None

async on_retry(retry_state: RetryCallState, **kwargs: Any) → None¶

当接收到重试请求时异步运行。

参数

retry_state (RetryCallState) – 重试状态。
**kwargs (任意) – 额外的关键字参数。

返回类型

None

async on_text(text: str, **kwargs: Any) → Any¶

当接收到文本时执行。

参数

text (字符串) – 收到的文本。
**kwargs (任意) – 额外的关键字参数。

返回：

回调的结果。

返回类型

任意

langchain_core.callbacks.manager.AsyncCallbackManagerForRetrieverRun¶

`langchain_core.callbacks.manager`.AsyncCallbackManagerForRetrieverRun¶