langchain_community.callbacks.wandb_callback.WandbCallbackHandler

class langchain_community.callbacks.wandb_callback.WandbCallbackHandler(job_type: Optional[str] = None, project: Optional[str] = 'langchain_callback_demo', entity: Optional[str] = None, tags: Optional[Sequence] = None, group: Optional[str] = None, name: Optional[str] = None, notes: Optional[str] = None, visualize: bool = False, complexity_metrics: bool = False, stream_logs: bool = False)[source]

将日志记录到 Weights and Biases 的回调处理程序。

参数

  • job_type (str) – 作业的类型。

  • project (str) – 要记录到的项目。

  • entity (str) – 要记录到的实体。

  • tags (list) – 要记录的标签。

  • group (str) – 要记录到的组。

  • name (str) – 运行的名称。

  • notes (str) – 要记录的笔记。

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

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

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

此处理程序将利用调用的关联回调方法，并使用有关 LLM 运行状态的元数据格式化每个回调函数的输入，并将响应添加到 {method}_records 和 action 的记录列表中。然后，它使用 run.log() 方法将响应记录到 Weights and Biases。

初始化回调处理程序。

属性

always_verbose

即使 verbose 为 False，是否调用详细回调。

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略 LLM 回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

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

run_inline

是否内联运行回调。

方法

__init__([job_type, project, entity, tags, ...])

初始化回调处理程序。

flush_tracker([langchain_asset, reset, ...])

刷新跟踪器并重置会话。

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

当检索器结束运行时运行。

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

重置回调元数据。
__init__(job_type: Optional[str] = None, project: Optional[str] = 'langchain_callback_demo', entity: Optional[str] = None, tags: Optional[Sequence] = None, group: Optional[str] = None, name: Optional[str] = None, notes: Optional[str] = None, visualize: bool = False, complexity_metrics: bool = False, stream_logs: bool = False) → None[source]

初始化回调处理程序。

参数

  • job_type (Optional[str]) –

  • project (Optional[str]) –

  • entity (Optional[str]) –

  • tags (Optional[Sequence]) –

  • group (Optional[str]) –

  • name (Optional[str]) –

  • notes (Optional[str]) –

  • visualize (bool) –

  • complexity_metrics (bool) –

  • stream_logs (bool) –

Return type

None

flush_tracker(langchain_asset: Optional[Any] = None, reset: bool = True, finish: bool = False, job_type: Optional[str] = None, project: Optional[str] = None, entity: Optional[str] = None, tags: Optional[Sequence] = None, group: Optional[str] = None, name: Optional[str] = None, notes: Optional[str] = None, visualize: Optional[bool] = None, complexity_metrics: Optional[bool] = None) → None[source]

刷新跟踪器并重置会话。

参数

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

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

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

  • job_type (Optional[str]) – 作业类型。

  • project (Optional[str]) – 项目。

  • entity (Optional[str]) – 实体。

  • tags (Optional[Sequence]) – 标签。

  • group (Optional[str]) – 组。

  • name (Optional[str]) – 名称。

  • notes (Optional[str]) – 笔记。

  • visualize (Optional[bool]) – 是否可视化。

  • complexity_metrics (Optional[bool]) – 是否计算复杂性指标。

  • 返回值 – None

Return type

None

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

Dict[str, Any]

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

在代理操作时运行。

参数
Return type

Any

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

当代理结束运行时运行。

参数
Return type

None

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

当链结束运行时运行。

参数

  • outputs (Dict[str, Any]) –

  • kwargs (Any) –

Return type

None

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

当链出错时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

当链开始运行时运行。

参数

  • 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 代替。

参数

  • 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) – 额外的关键字参数。

Return type

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

Return type

Any

0.2.15 版本新增。

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

当 LLM 结束运行时运行。

参数
Return type

None

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

当 LLM 出错时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

当 LLM 生成新令牌时运行。

参数

  • token (str) –

  • kwargs (Any) –

Return type

None

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

当 LLM 启动时运行。

参数

  • 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

当检索器结束运行时运行。

参数

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

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

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

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

Return type

Any

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

当检索器出错时运行。

参数

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

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

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

  • 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

当检索器开始运行时运行。

参数

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

  • query (str) – 查询。

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

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

  • 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

在重试事件时运行。

参数

  • retry_state (RetryCallState) – 重试状态。

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

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

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

Return type

Any

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

当代理结束时运行。

参数

  • text (str) –

  • kwargs (Any) –

Return type

None

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

当工具结束运行时运行。

参数

  • output (Any) –

  • kwargs (Any) –

Return type

None

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

当工具出错时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

当工具开始运行时运行。

参数

  • serialized (Dict[str, Any]) –

  • input_str (str) –

  • kwargs (Any) –

Return type

None

reset_callback_meta() → None

重置回调元数据。

Return type

None

WandbCallbackHandler 的使用示例