langchain_community.callbacks.aim_callback. AimCallbackHandler

class langchain_community.callbacks.aim_callback.AimCallbackHandler(repo: Optional[str] = None, experiment_name: Optional[str] = None, system_tracking_interval: Optional[int] = 10, log_system_params: bool = True)[source]

用于将日志记录到 Aim 的回调处理器。

参数

  • repo (str, 可选) – Aim 仓库路径或绑定 Run 对象的 Repo 对象。如果跳过，则使用默认的 Repo。

  • experiment_name (str, 可选) – 设置 Run 的 experiment 属性。未指定时为 'default'。可后来用于查询运行/序列。

  • system_tracking_interval (int, 可选)

    设置系统使用指标（CPU、内存等）的追踪间隔（秒）。设置为 None

    以禁用系统指标追踪。

  • log_system_params (bool, 可选) – 启用/禁用记录系统参数（如已安装的软件包、git 信息、环境变量等）的日志。

此处理器将使用相关的回调方法调用，并为每个回调函数的输入格式化与 LLM 运行状态的元数据，然后将响应记录到 Aim。

初始化回调处理器。

属性

always_verbose

是否即使 verbose 为 False 也调用详细回调。

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略 LLM 回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

如果发生异常，是否引发错误。

run_inline

是否以 inline 方式运行回调。

方法

__init__([repo, experiment_name, ...])

初始化回调处理器。

flush_tracker([repo, experiment_name, ...])

刷新追踪器和重置会话。

get_custom_callback_meta()

on_agent_action(action, **kwargs)

在代理行动时运行。

on_agent_finish(finish, **kwargs)

当代理终止运行时运行。

on_chain_end(outputs, **kwargs)

当链终止运行时运行。

on_chain_error(error, **kwargs)

当链出错时运行。

on_chain_start(serialized, inputs, **kwargs)

当链开始运行时运行。

on_chat_model_start(serialized, messages, *, ...)

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

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

覆盖以定义一个自定义事件的处理器。

on_llm_end(response, **kwargs)

当 LLM 终止运行时运行。

on_llm_error(error, **kwargs)

当 LLM 出错时运行。

on_llm_new_token(token, **kwargs)

当 LLM 生成了一个新标记时运行。

on_llm_start(serialized, prompts, **kwargs)

当 LLM 开始时运行。

on_retriever_end(documents, *, run_id[, ...])

当检索器终止运行时运行。

on_retriever_error(error, *, run_id[, ...])

当检索器出错时运行。

on_retriever_start(serialized, query, *, run_id)

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

on_retry(retry_state, *, run_id[, parent_run_id])

在重试事件上运行。

on_text(text, **kwargs)

当代理结束运行时执行。

on_tool_end(output, **kwargs)

当工具运行结束时执行。

on_tool_error(error, **kwargs)

当工具出错时执行。

on_tool_start(serialized, input_str, **kwargs)

当工具开始运行时执行。

reset_callback_meta()

重置回调元数据。

setup(**kwargs)

__init__(repo: Optional[str] = None, experiment_name: Optional[str] = None, system_tracking_interval: Optional[int] = 10, log_system_params: bool = True) → None[source]

初始化回调处理器。

参数

  • repo (可选[str]) –

  • experiment_name (可选[str]) –

  • system_tracking_interval (可选[int]) –

  • log_system_params (布尔值) –

返回类型

无

flush_tracker(repo: Optional[str] = None, experiment_name: Optional[str] = None, system_tracking_interval: Optional[int] = 10, log_system_params: bool = True, langchain_asset: Optional[Any] = None, reset: bool = True, finish: bool = False) → None[来源]

刷新追踪器和重置会话。

参数

  • repo (str, 可选) – Aim 仓库路径或绑定 Run 对象的 Repo 对象。如果跳过，则使用默认的 Repo。

  • experiment_name (str, 可选) – 设置 Run 的 experiment 属性。未指定时为 'default'。可后来用于查询运行/序列。

  • system_tracking_interval (int, 可选)

    设置系统使用指标（CPU、内存等）的追踪间隔（秒）。设置为 None

    以禁用系统指标追踪。

  • log_system_params (bool, 可选) – 启用/禁用记录系统参数（如已安装的软件包、git 信息、环境变量等）的日志。

  • langchain_asset (Optional[Any]) – 要保存的 langchain 资产。

  • reset (bool) – 是否重置会话。

  • finish (bool) – 是否结束运行。

  • 返回 – None

返回类型

无

get_custom_callback_meta() → Dict[str, Any]
返回类型

Dict[str, Any]

on_agent_action(action: AgentAction, **kwargs: Any) → Any[来源]

在代理行动时运行。

参数
返回类型

任何类型

on_agent_finish(finish, **kwargs ) → None[源代码]

当代理终止运行时运行。

参数
返回类型

无

on_chain_end(outputs, **kwargs → None[源代码]

当链终止运行时运行。

参数

  • outputs (字典 { str, Any }) –

  • kwargs (任何类型) –

返回类型

无

on_chain_error(error, **kwargs → None[源代码]

当链出错时运行。

参数

  • error (BaseException) –

  • kwargs (任何类型) –

返回类型

无

on_chain_start(serialized, inputs, **kwargs → None[源代码]

当链开始运行时运行。

参数

  • serialized (字典 { str, Any }) –

  • inputs (字典 { str, Any }) –

  • kwargs (任何类型) –

返回类型

无

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[Liststr]]) – 标签。

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

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

返回类型

任何类型

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 (任何类型) –

返回类型

任何类型

新增于版本 0.2.15。

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

当 LLM 终止运行时运行。

参数

  • response (LLMResult) –

  • kwargs (任何类型) –

返回类型

无

on_llm_error(error: BaseException, **kwargs: Any) → None[source]

当 LLM 出错时运行。

参数

  • error (BaseException) –

  • kwargs (任何类型) –

返回类型

无

on_llm_new_token(token: str, **kwargs: Any) → None[source]

当 LLM 生成了一个新标记时运行。

参数

  • token (str) –

  • kwargs (任何类型) –

返回类型

无

on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]

当 LLM 开始时运行。

参数

  • serialized (字典 { str, Any }) –

  • prompts (List[str]) –

  • kwargs (任何类型) –

返回类型

无

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当检索器终止运行时运行。

参数

  • documents (Sequence[Document]) – 获取到的文档。

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

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

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

返回类型

任何类型

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当检索器出错时运行。

参数

  • error (BaseException) – 发生的错误。

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

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

  • kwargs (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

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

参数

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

  • query (str) – 查询。

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

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

  • tags (Optional[Liststr]]) – 标签。

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

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

返回类型

任何类型

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在重试事件上运行。

参数

  • retry_state (RetryCallState) – 重试状态。

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

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

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

返回类型

任何类型

on_text(text: str, **kwargs: Any) → None[source]

当代理结束运行时执行。

参数

  • text (str) –

  • kwargs (任何类型) –

返回类型

无

on_tool_end(output: Any, **kwargs: Any) → None[source]

当工具运行结束时执行。

参数

  • output (Any) –

  • kwargs (任何类型) –

返回类型

无

on_tool_error(error: BaseException, **kwargs: Any) → None[source]

当工具出错时执行。

参数

  • error (BaseException) –

  • kwargs (任何类型) –

返回类型

无

on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]

当工具开始运行时执行。

参数

  • serialized (字典 { str, Any }) –

  • input_str (str) –

  • kwargs (任何类型) –

返回类型

无

reset_callback_meta() → None

重置回调元数据。

返回类型

无

setup(**kwargs: Any) → None[source]
参数

kwargs (任何类型) –

返回类型

无

AimCallbackHandler 的使用示例