AimCallbackHandler#

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

记录到Aim的回调处理程序。

Parameters:

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

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

  • system_tracking_interval (int, optional) –

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

    以禁用系统指标跟踪。

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

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

初始化回调处理程序。

属性

always_verbose

即使verbose为False，是否也要调用verbose回调。

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

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

run_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生成一个新token时运行。

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: str | None = None, experiment_name: str | None = None, system_tracking_interval: int | None = 10, log_system_params: bool = True) → None[source]#

初始化回调处理程序。

Parameters:

  • repo (str | None)

  • experiment_name (str | None)

  • system_tracking_interval (int | None)

  • log_system_params (bool)

Return type:

无

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

刷新跟踪器并重置会话。

Parameters:

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

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

  • system_tracking_interval (int, optional) –

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

    以禁用系统指标跟踪。

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

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

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

  • finish (bool) – 是否完成运行。

  • 返回 – 无

Return type:

无

get_custom_callback_meta() → Dict[str, Any]#
Return type:

Dict[str, Any]

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

在代理操作上运行。

Parameters:
Return type:

任何

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]#

当代理结束运行时执行。

Parameters:
Return type:

无

on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None[source]#

当链结束运行时执行。

Parameters:

  • outputs (Dict[str, Any])

  • kwargs (Any)

Return type:

无

on_chain_error(error: BaseException, **kwargs: Any) → None[来源]#

当链发生错误时运行。

Parameters:

  • error (BaseException)

  • kwargs (Any)

Return type:

无

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None[source]#

当链开始运行时执行。

Parameters:

  • serialized (Dict[str, Any])

  • inputs (Dict[str, Any])

  • kwargs (Any)

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

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

ATTENTION: This method is called for chat models. If you’re implementing

对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

  • serialized (Dict[str, Any]) – 序列化的聊天模型。

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

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

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

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

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

Parameters:

  • name (str) – 自定义事件的名称。

  • data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

  • run_id (UUID) – 运行的ID。

  • tags (list[str] | None) – 与自定义事件关联的标签（包括继承的标签）。

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

  • kwargs (Any)

Return type:

任何

在版本0.2.15中添加。

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

当LLM结束运行时执行。

Parameters:
Return type:

无

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

当LLM出错时运行。

Parameters:

  • error (BaseException)

  • kwargs (Any)

Return type:

无

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

当LLM生成新令牌时运行。

Parameters:

  • token (str)

  • kwargs (Any)

Return type:

无

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

当LLM启动时运行。

Parameters:

  • serialized (Dict[str, Any])

  • 提示 (列表[字符串])

  • kwargs (Any)

Return type:

无

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

当Retriever结束运行时执行。

Parameters:

  • documents (Sequence[Document]) – 检索到的文档。

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

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

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

Return type:

任何

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当Retriever出错时运行。

Parameters:

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

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

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

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

Return type:

任何

on_retriever_start(serialized: dict[str, Any], query: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当Retriever开始运行时执行。

Parameters:

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

  • query (str) – 查询。

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

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

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

  • metadata (可选[字典[字符串, 任意类型]]) – 元数据。

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

Return type:

任何

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在重试事件上运行。

Parameters:

  • retry_state (RetryCallState) – 重试状态。

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

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

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

Return type:

任何

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

当代理结束时运行。

Parameters:

  • 文本 (str)

  • kwargs (Any)

Return type:

无

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

工具结束运行时执行。

Parameters:

  • output (Any)

  • kwargs (Any)

Return type:

无

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

当工具出错时运行。

Parameters:

  • error (BaseException)

  • kwargs (Any)

Return type:

无

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

当工具开始运行时执行。

Parameters:

  • serialized (Dict[str, Any])

  • input_str (str)

  • kwargs (Any)

Return type:

无

reset_callback_meta() → None#

重置回调元数据。

Return type:

无

setup(**kwargs: Any) → None[来源]#
Parameters:

kwargs (任意)

Return type:

无

使用 AimCallbackHandler 的示例