langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler

class langchain_community.callbacks.clearml_callback.ClearMLCallbackHandler(task_type: Optional[str] = 'inference', project_name: Optional[str] = 'langchain_callback_demo', tags: Optional[Sequence] = None, task_name: Optional[str] = None, visualize: bool = False, complexity_metrics: bool = False, stream_logs: bool = False)

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

参数

• job_type (str) – ClearML 任务的类型，例如 “inference”、“testing” 或 “qc”

• project_name (str) – ClearML 项目名称

• tags (list) – 添加到任务的标签

• task_name (str) – ClearML 任务的名称

• visualize (bool) – 是否可视化运行。

• complexity_metrics (bool) – 是否记录复杂性指标

• stream_logs (bool) – 是否将回调操作流式传输到 ClearML

• task_type (Optional[str]) –

此处理程序将利用相关的回调方法，并使用关于 LLM 运行状态的元数据格式化每个回调函数的输入，并将响应添加到 {method}_records 和 action 的记录列表中。然后，它将响应记录到 ClearML 控制台。

初始化回调处理程序。

属性

always_verbose	即使 verbose 为 False，是否调用 verbose 回调。
ignore_agent	是否忽略 agent 回调。
ignore_chain	是否忽略 chain 回调。
ignore_chat_model	是否忽略 chat model 回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略 LLM 回调。
ignore_retriever	是否忽略 retriever 回调。
ignore_retry	是否忽略 retry 回调。
raise_error	如果发生异常是否引发错误。
run_inline	是否内联运行回调。

方法

__init__([task_type, project_name, tags, ...])	初始化回调处理程序。
analyze_text(text)	使用 textstat 和 spacy 分析文本。
flush_tracker([name, langchain_asset, finish])	刷新 tracker 并设置会话。
get_custom_callback_meta()
on_agent_action(action, **kwargs)	在 agent 操作时运行。
on_agent_finish(finish, **kwargs)	当 agent 结束运行时运行。
on_chain_end(outputs, **kwargs)	当 chain 结束运行时运行。
on_chain_error(error, **kwargs)	当 chain 发生错误时运行。
on_chain_start(serialized, inputs, **kwargs)	当 chain 开始运行时运行。
on_chat_model_start(serialized, messages, *, ...)	当 chat model 开始运行时运行。
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[, ...])	当 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)	当 agent 结束时运行。
on_tool_end(output, **kwargs)	当 tool 结束运行时运行。
on_tool_error(error, **kwargs)	当 tool 发生错误时运行。
on_tool_start(serialized, input_str, **kwargs)	当 tool 开始运行时运行。
reset_callback_meta()	重置回调元数据。

__init__(task_type: Optional[str] = 'inference', project_name: Optional[str] = 'langchain_callback_demo', tags: Optional[Sequence] = None, task_name: Optional[str] = None, visualize: bool = False, complexity_metrics: bool = False, stream_logs: bool = False) → None

初始化回调处理程序。

参数

• task_type (Optional[str]) –

• project_name (Optional[str]) –

• tags (Optional[Sequence]) –

• task_name (Optional[str]) –

• visualize (bool) –

• complexity_metrics (bool) –

• stream_logs (bool) –

返回类型

None

analyze_text(text: str) → dict

使用 textstat 和 spacy 分析文本。

参数

text (str) – 要分析的文本。

返回

包含复杂性指标的字典。

返回类型

(dict)

flush_tracker(name: Optional[str] = None, langchain_asset: Optional[Any] = None, finish: bool = False) → None

刷新 tracker 并设置会话。

此后的所有内容都将是一个新表。

参数

• name (Optional[str]) – 到目前为止执行的会话的名称，以便于识别

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

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

• 返回 – None

返回类型

None

get_custom_callback_meta() → Dict[str, Any]

返回类型

Dict[str, Any]

on_agent_action(action: AgentAction, **kwargs: Any) → Any

在 agent 操作时运行。

参数

• action (AgentAction) –

• kwargs (Any) –

返回类型

Any

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

当 agent 结束运行时运行。

参数

• finish (AgentFinish) –

• kwargs (Any) –

返回类型

None

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

当 chain 结束运行时运行。

参数

• outputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

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

当 chain 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

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

当 chain 开始运行时运行。

参数

• serialized (Dict[str, Any]) –

• inputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

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

当 chat model 开始运行时运行。

注意：此方法用于聊天模型。如果您正在实现

非聊天模型的处理程序，您应该改用 on_llm_start。

参数

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

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

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

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

• tags (Optional[List[str]]) – 标签。

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

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

返回类型

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 (Any) –

返回类型

Any

0.2.15 版本新增功能。

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

当 LLM 结束运行时运行。

参数

• response (LLMResult) –

• kwargs (Any) –

返回类型

None

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

当 LLM 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

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

当 LLM 生成新 token 时运行。

参数

• token (str) –

• kwargs (Any) –

返回类型

None

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

当 LLM 启动时运行。

参数

• serialized (Dict[str, Any]) –

• prompts (List[str]) –

• kwargs (Any) –

返回类型

None

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

当 Retriever 结束运行时运行。

参数

• documents (Sequence[Document]) – The documents retrieved.

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

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

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

返回类型

Any

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

当 Retriever 发生错误时运行。

参数

• error (BaseException) – The error that occurred.

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

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

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

返回类型

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 开始运行时运行。

参数

• serialized (Dict[str, Any]) – The serialized Retriever.

• query (str) – The query.

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

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

• tags (Optional[List[str]]) – 标签。

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

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

返回类型

Any

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

在重试事件时运行。

参数

• retry_state (RetryCallState) – The retry state.

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

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

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

返回类型

Any

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

当 agent 结束时运行。

参数

• text (str) –

• kwargs (Any) –

返回类型

None

on_tool_end(output: Any, **kwargs: Any) → None

当 tool 结束运行时运行。

参数

• output (Any) –

• kwargs (Any) –

返回类型

None

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

当 tool 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

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

当 tool 开始运行时运行。

参数

• serialized (Dict[str, Any]) –

• input_str (str) –

• kwargs (Any) –

返回类型

None

reset_callback_meta() → None

重置回调元数据。

返回类型

None

使用 ClearMLCallbackHandler 的示例

• ClearML