langchain_core.callbacks.manager.CallbackManagerForLLMRun

class langchain_core.callbacks.manager.CallbackManagerForLLMRun(*, 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)[源代码]

LLM 运行回调管理器。

初始化运行管理器。

参数

  • run_id (UUID) – 运行的 ID。

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

  • inheritable_handlers (列表[BaseCallbackHandler]) – 可继承的处理程序列表。

  • parent_run_id (UUID，可选) – 父运行的 ID。默认为 None。

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

  • 继承标签 (可选[列表[字符串]]) – 继承标签列表。默认为 None。

  • 元数据 (可选[字典[字符串，任意类型]]) – 元数据。默认为 None。

  • 可继承元数据 (可选[字典[字符串，任意类型]]) – 可继承的元数据。默认为 None。

方法

__init__(*, run_id, handlers, ...[, ...])

初始化运行管理器。

get_noop_manager()

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

on_custom_event(name, data, *, run_id[, ...])

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

on_llm_end(response, **kwargs)

当 LLM 运行结束时会运行。

on_llm_error(error, **kwargs)

当 LLM 发生错误时会运行。

on_llm_new_token(token, *[, chunk])

当 LLM 生成新令牌时会运行。

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。

  • 继承标签 (可选[列表[字符串]]) – 继承标签列表。默认为 None。

  • 元数据 (可选[字典[字符串，任意类型]]) – 元数据。默认为 None。

  • 可继承元数据 (可选[字典[字符串，任意类型]]) – 可继承的元数据。默认为 None。

返回类型

None

classmethodget_noop_manager() → BRM

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

返回

无操作的经理。

返回类型

BaseRunManager

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 (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

  • run_id (UUID) – 运行的 ID。

  • tags (Optional[List[str]]) – 与自定义事件相关联的标记（包括继承的标记）。

  • metadata (Optional[Dict[str, Any]]) – 与自定义事件相关联的元数据（包括继承的元数据）。

  • kwargs (Any) –

返回类型

任何

自版本 0.2.15 以来新增。

on_llm_end(response: LLMResult, **kwargs: Any) → None[source]

当 LLM 运行结束时会运行。

参数

  • response (LLMResult) – LLM 结果。

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

返回类型

None

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

当 LLM 发生错误时会运行。

参数

  • error (Exception 或 KeyboardInterrupt) – 错误。

  • kwargs (Any) –

    附加关键字参数。 - response (LLMResult): 发生错误之前生成的响应。

    。

返回类型

None

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, **kwargs: Any) → None[源代码]

当 LLM 生成新令牌时会运行。

参数

  • token (str) – 新的令牌。

  • chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]], optional) – 拼接块。默认为 None。

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

返回类型

None

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

在接收到重试时运行。

参数

  • retry_state (RetryCallState) – 重试状态。

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

返回类型

None

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

在接收到文本时会运行。

参数

  • 文本 (字符串) – 接收到的文本。

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

返回

回调的结果。

返回类型

任何

使用CallbackManagerForLLMRun的示例