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任务类型，例如“推断”、“测试”或“质控” project_name (str): Comet_ml项目名称 tags (list): 要添加到任务的标签 task_name (str): Comet_ml任务的名称 visualize (bool): 是否可视化运行。 complexity_metrics (bool): 是否记录复杂度指标 stream_logs (bool): 是否将回调操作流式传输到Comet

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

初始化回调处理程序。

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__([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_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()	重置回调元数据。

Parameters

• task_type (Optional[str]) –

• workspace (Optional[str]) –

• project_name (Optional[str]) –

• tags (Optional[Sequence]) –

• name (Optional[str]) –

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

• complexity_metrics (bool) –

• custom_metrics (Optional[Callable]) –

• stream_logs (bool) –

Return type

None

__init__(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

初始化回调处理程序。

Parameters

• task_type (Optional[str]) –

• workspace (Optional[str]) –

• project_name (Optional[str]) –

• tags (Optional[Sequence]) –

• name (Optional[str]) –

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

• complexity_metrics (bool) –

• custom_metrics (Optional[Callable]) –

• stream_logs (bool) –

Return type

None

flush_tracker(langchain_asset: 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：迄今为止执行会话的名称，以便识别 langchain_asset：要保存的langchain资产。 finish：是否完成运行。

返回：

无。

Parameters

• langchain_asset (Any) –

• task_type (Optional[str]) –

• workspace (Optional[str]) –

• project_name (Optional[str]) –

• tags (Optional[Sequence]) –

• name (Optional[str]) –

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

• complexity_metrics (bool) –

• custom_metrics (Optional[Callable]) –

• finish (bool) –

• reset (bool) –

Return type

None

get_custom_callback_meta() → Dict[str, Any]

Return type

Dict[str, Any]

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

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

Parameters

• action (AgentAction) –

• kwargs (Any) –

Return type

Any

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

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

Parameters

• finish (AgentFinish) –

• kwargs (Any) –

Return type

None

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

当链结束运行时运行。

Parameters

• outputs (Dict[str, Any]) –

• kwargs (Any) –

Return type

None

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

当链式错误时运行。

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

当链开始运行时运行。

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

LLM 运行结束时运行。

Parameters

• response (LLMResult) –

• kwargs (Any) –

Return type

None

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

当LLM出现错误时运行。

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• token (str) –

• kwargs (Any) –

Return type

None

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

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

当代理程序结束时运行。

Parameters

• text (str) –

• kwargs (Any) –

Return type

None

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

当工具运行结束时运行。

Parameters

• output (Any) –

• kwargs (Any) –

Return type

None

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

当工具出现错误时运行。

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

当工具开始运行时运行。

Parameters

• serialized (Dict[str, Any]) –

• input_str (str) –

• kwargs (Any) –

Return type

None

reset_callback_meta() → None

重置回调元数据。

Return type

None

Examples using CometCallbackHandler

• os.environ[“OPENAI_ORGANIZATION”] = “…”