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, optional): Aim存储库路径或绑定到Run对象的Repo对象。如果省略，默认使用Repo。 experiment_name (str, optional): 设置Run的`experiment`属性。如果未指定，默认为’default’。以后可用于查询运行/序列。 system_tracking_interval (int, optional): 设置系统使用情况指标（CPU、内存等）的跟踪间隔，单位为秒。设置为`None`以禁用系统指标跟踪。 log_system_params (bool, optional): 启用/禁用系统参数的记录，如已安装的软件包、git信息、环境变量等。

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

初始化回调处理程序。

Attributes

always_verbose

即使 verbose 为 False，也要调用详细回调函数。

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型的回调。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器的回调函数。

ignore_retry

是否忽略重试回调。

raise_error

run_inline

Methods

__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_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[, ...])

当Retriever运行结束时运行。

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

当Retriever出错时运行。

on_retriever_start(serialized, query, *, run_id)

当Retriever开始运行时运行。

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)

Parameters

  • repo (Optional[str]) –

  • experiment_name (Optional[str]) –

  • system_tracking_interval (Optional[int]) –

  • log_system_params (bool) –

Return type

None

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

初始化回调处理程序。

Parameters

  • repo (Optional[str]) –

  • experiment_name (Optional[str]) –

  • system_tracking_interval (Optional[int]) –

  • log_system_params (bool) –

Return type

None

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

刷新跟踪器并重置会话。

参数:

repo (str, optional): 目标存储库路径或与Run对象绑定的Repo对象。如果省略，默认使用Repo。 experiment_name (str, optional): 设置Run的`experiment`属性。如果未指定，默认为’default’。以后可用于查询运行/序列。 system_tracking_interval (int, optional): 设置系统使用情况指标（CPU、内存等）的跟踪间隔，单位为秒。设置为`None`以禁用系统指标跟踪。 log_system_params (bool, optional): 启用/禁用系统参数的记录，如已安装的软件包、git信息、环境变量等。 langchain_asset: 要保存的langchain资产。 reset: 是否重置会话。 finish: 是否完成运行。

返回:

None

Parameters

  • repo (Optional[str]) –

  • experiment_name (Optional[str]) –

  • system_tracking_interval (Optional[int]) –

  • log_system_params (bool) –

  • langchain_asset (Any) –

  • reset (bool) –

  • finish (bool) –

Return type

None

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

Dict[str, Any]

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

在代理程序上运行的操作。

Parameters
Return type

Any

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

当代理程序运行结束时运行。

Parameters
Return type

None

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

当链结束运行时运行。

Parameters

  • outputs (Dict[str, Any]) –

  • kwargs (Any) –

Return type

None

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

当链式错误时运行。

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

None

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。

Parameters

  • serialized (Dict[str, Any]) –

  • messages (List[List[BaseMessage]]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

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

LLM 运行结束时运行。

Parameters
Return type

None

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

当LLM出现错误时运行。

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

当LLM生成一个新的令牌时运行。

Parameters

  • token (str) –

  • kwargs (Any) –

Return type

None

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

LLM启动时运行。

Parameters

  • serialized (Dict[str, Any]) –

  • prompts (List[str]) –

  • kwargs (Any) –

Return type

None

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

当Retriever运行结束时运行。

Parameters

  • documents (Sequence[Document]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

Any

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

当Retriever出错时运行。

Parameters

  • error (BaseException) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

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

当Retriever开始运行时运行。

Parameters

  • serialized (Dict[str, Any]) –

  • query (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

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

在重试事件上运行。

Parameters

  • retry_state (RetryCallState) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

Any

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

当代理程序结束时运行。

Parameters

  • text (str) –

  • kwargs (Any) –

Return type

None

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

当工具运行结束时运行。

Parameters

  • output (Any) –

  • kwargs (Any) –

Return type

None

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

当工具出现错误时运行。

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

None

reset_callback_meta() → None

重置回调元数据。

Return type

None

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

kwargs (Any) –

Return type

None

Examples using AimCallbackHandler