langchain_community.callbacks.comet_ml_callback.CometCallbackHandler

class langchain_community.callbacks.comet_ml_callback.CometCallbackHandler(task_type: Optional[str] = 'inference', workspace: Optional[str] = None, project_name: Optional[str] = None, tags: Optional[Sequence] = None, name: Optional[str] = None, visualizations: Optional[List[str]] = None, complexity_metrics: bool = False, custom_metrics: Optional[Callable] = None, stream_logs: bool = True)¶

Comet 记录的回调处理器。

参数

• job_type (str) – Comet_ml 任务的类型，如下推演、测试或qc

• project_name (str) – Comet_ml 项目名称

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

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

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

• complexity_metrics (布尔值) – 是否记录复杂性度量

• stream_logs (布尔值) – 是否将回调操作流式传输到Comet

• task_type (可选 [字符串]) –

• workspace (可选 [字符串]) –

• name (可选 [字符串]) –

• visualizations (可选 [列表[字符串]]) –

• custom_metrics (可选 [可调用]) –

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

初始化回调处理程序。

属性

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__([task_type, workspace, ...])	初始化回调处理程序。
flush_tracker([langchain_asset, task_type, ...])	刷新跟踪器并设置会话。
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[, ...])	在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()	重置回调元数据。

(task_type: Optional[str] = 'inference', workspace: Optional[str] = None, project_name: Optional[str] = None, tags: Optional[Sequence] = None, name: Optional[str] = None, visualizations: Optional[List[str]] = None, complexity_metrics: bool = False, custom_metrics: Optional[Callable] = None, stream_logs: bool = True) → None

初始化回调处理程序。

参数

• task_type (可选 [字符串]) –

• workspace (可选 [字符串]) –

• project_name (可选[str]) –

• tags (可选[Sequence]) –

• name (可选 [字符串]) –

• visualizations (可选 [列表[字符串]]) –

• complexity_metrics (布尔值) –

• custom_metrics (可选 [可调用]) –

• stream_logs (布尔值) –

返回类型

None

flush_tracker(langchain_asset: Optional[Any] = None, task_type: Optional[str] = 'inference', workspace: Optional[str] = None, project_name: Optional[str] = 'comet-langchain-demo', tags: Optional[Sequence] = None, name: Optional[str] = None, visualizations: Optional[List[str]] = None, complexity_metrics: bool = False, custom_metrics: Optional[Callable] = None, finish: bool = False, reset: bool = False) → None

刷新跟踪器并设置会话。

以下内容将开始一个新的表格。

参数

• name (可选[str]) – 执行的会话名称，以便于识别

• langchain_asset (可选[Any]) – 要保存的langchain资产

• finish (布尔值) – 是否完成运行

• 返回值 – None

• task_type (可选 [字符串]) –

• workspace (可选 [字符串]) –

• project_name (可选[str]) –

• tags (可选[Sequence]) –

• visualizations (可选 [列表[字符串]]) –

• complexity_metrics (布尔值) –

• custom_metrics (可选 [可调用]) –

• reset (布尔值) –

返回类型

None

get_custom_callback_meta() → Dict{str, Any}

返回类型

Dict{str, Any}

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

在代理操作上运行。

参数

• action (AgentAction) –

• kwargs (Any) –

返回类型

Any

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

在代理运行结束时代码执行。

参数

• finish (AgentFinish) –

• kwargs (Any) –

返回类型

None

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

链运行结束时运行。

参数

• outputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

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

链出现错误时运行。

参数

• 错误 (BaseException) –

• kwargs (Any) –

返回类型

None

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

链开始运行时运行。

参数

• serialized (Dict[str, Any]) –

• inputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], **kwargs: Any) → Any

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

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

非聊天模型的处理器，应使用 on_llm_start。

参数

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

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

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

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

• tags (Optional[[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出错时执行。

参数

• 错误 (BaseException) –

• kwargs (Any) –

返回类型

None

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

在LLM生成新令牌时执行。

参数

• 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]) – 获取的文档。

• 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) – 发生的错误。

• 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]) – 序列化的检索器。

• query (str) – 查询。

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

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

• tags (Optional[[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) – 重试状态。

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

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

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

返回类型

Any

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

在代理结束执行时。

参数

• text (str) –

• kwargs (Any) –

返回类型

None

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

在工具运行结束后执行。

参数

• output (Any) –

• kwargs (Any) –

返回类型

None

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

在工具出错时执行。

参数

• 错误 (BaseException) –

• kwargs (Any) –

返回类型

None

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

在工具开始运行时执行。

参数

• serialized (Dict[str, Any]) –

• input_str (str) –

• kwargs (Any) –

返回类型

None

reset_callback_meta() → None

重置回调元数据。

返回类型

None

使用 CometCallbackHandler 的示例

• Comet