`langchain_core.callbacks.manager`.CallbackManagerForRetrieverRun¶

class langchain_core.callbacks.manager.CallbackManagerForRetrieverRun(*, 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 (列表[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (列表[BaseCallbackHandler]) – 继承处理器列表。
parent_run_id (UUID，可选) – 父运行ID。默认为None。
tags (可选 [ 字符串列表 ]) – 标签列表。默认为None。
inheritable_tags (可选 [ 字符串列表 ]) – 可继承的标签列表。默认为None。
metadata (可选 [ 字典 [ 字符串，任意类型 ] ]) – 元数据。默认为None。
inheritable_metadata (可选 [ 字典 [ 字符串，任意类型 ] ]) – 可继承的元数据。默认为None。

方法

`__init__` (*，run_id，handlers，...[，...])	初始化运行管理器。
`get_child`([tag])	获取子回调管理器。
`get_noop_manager`()	返回一个不执行任何操作的Manager。
`on_custom_event`(name，data，*，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 (列表[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (列表[BaseCallbackHandler]) – 继承处理器列表。
parent_run_id (UUID，可选) – 父运行ID。默认为None。
tags (可选 [ 字符串列表 ]) – 标签列表。默认为None。
inheritable_tags (可选 [ 字符串列表 ]) – 可继承的标签列表。默认为None。
metadata (可选 [ 字典 [ 字符串，任意类型 ] ]) – 元数据。默认为None。
inheritable_metadata (可选 [ 字典 [ 字符串，任意类型 ] ]) – 可继承的元数据。默认为None。

返回类型

None

get_child(tag: Optional[str]) → CallbackManager¶

获取子回调管理器。

参数: tag (str, 可选) – 子回调管理器的标记。默认为 None。
返回: 子回调管理器。
返回类型: CallbackManager

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

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

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

参数

name (str) – 自定义事件的名称。
data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。
run_id (UUID) – 运行的ID。
tags (Optional[List[str]]) – 与自定义事件关联的标签（包括继承的标签）。
metadata (Optional[Dict[str, Any]]) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (Any) –

返回类型

任意

0.2.15版本中新引入。

在检索器运行结束时调用。

参数

documents (Sequence[Document]) – 获取的文档。
**kwargs (Any) – 额外的关键字参数。

返回类型

None

on_retriever_error(error: BaseException, **kwargs: Any) → None[源代码]¶

在检索器出现错误时调用。

参数

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

返回类型

None

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

在收到重试请求时调用。

参数

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

返回类型

None

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

在接收到文本时调用。

参数

text (str) – 收到的文本。
**kwargs (Any) – 额外的关键字参数。

返回

回调的结果。

返回类型

任意

使用 CallbackManagerForRetrieverRun 的示例¶

langchain_core.callbacks.manager.CallbackManagerForRetrieverRun¶

使用 CallbackManagerForRetrieverRun 的示例¶

`langchain_core.callbacks.manager`.CallbackManagerForRetrieverRun¶