langchain_community.callbacks.llmonitor_callback.LLMonitorCallbackHandler

class langchain_community.callbacks.llmonitor_callback.LLMonitorCallbackHandler(app_id: Optional[str] = None, api_url: Optional[str] = None, verbose: bool = False)

用于 LLMonitor 的回调处理器。

#### 参数

• app_id: 您要报告的应用的应用程序 ID。默认为

None，这意味着将使用 LLMONITOR_APP_ID。 - api_url: LLMonitor API 的 URL。默认为 None，这意味着将使用 LLMONITOR_API_URL 环境变量或 https://app.llmonitor.com。

#### 异常

• ValueError: 如果 app_id 未作为

参数或环境变量提供。 - ConnectionError: 如果与 API 的连接失败。

#### 示例: ```python from langchain_community.llms import OpenAI from langchain_community.callbacks import LLMonitorCallbackHandler

llmonitor_callback = LLMonitorCallbackHandler() llm = OpenAI(callbacks=[llmonitor_callback],

metadata={“userId”: “user-123”})

llm.invoke(“Hello, how are you?”) ```

属性

ignore_agent	是否忽略 Agent 回调。
ignore_chain	是否忽略 Chain 回调。
ignore_chat_model	是否忽略 Chat Model 回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略 LLM 回调。
ignore_retriever	是否忽略 Retriever 回调。
ignore_retry	是否忽略重试回调。
raise_error	如果发生异常是否抛出错误。
run_inline	是否内联运行回调。

方法

__init__([app_id, api_url, verbose])
on_agent_action(action, *, run_id[, ...])	运行 Agent action 时调用。
on_agent_finish(finish, *, run_id[, ...])	在 Agent 结束时运行。
on_chain_end(outputs, *, run_id[, parent_run_id])	在 Chain 结束运行时运行。
on_chain_error(error, *, run_id[, parent_run_id])	在 Chain 发生错误时运行。
on_chain_start(serialized, inputs, *, run_id)	在 Chain 开始运行时运行。
on_chat_model_start(serialized, messages, *, ...)	在 Chat Model 开始运行时运行。
on_custom_event(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
on_llm_end(response, *, run_id[, parent_run_id])	在 LLM 结束运行时运行。
on_llm_error(error, *, run_id[, parent_run_id])	在 LLM 发生错误时运行。
on_llm_new_token(token, *[, chunk, ...])	在新的 LLM token 上运行。
on_llm_start(serialized, prompts, *, run_id)	在 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, *, run_id[, parent_run_id])	在任意文本上运行。
on_tool_end(output, *, run_id[, ...])	在 Tool 结束运行时运行。
on_tool_error(error, *, run_id[, parent_run_id])	在 Tool 发生错误时运行。
on_tool_start(serialized, input_str, *, run_id)	在 Tool 开始运行时运行。

参数

• app_id (Optional[str]) –

• api_url (Optional[str]) –

• verbose (bool) –

__init__(app_id: Optional[str] = None, api_url: Optional[str] = None, verbose: bool = False) → None

参数

• app_id (Optional[str]) –

• api_url (Optional[str]) –

• verbose (bool) –

返回类型

None

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

运行 Agent action 时调用。

参数

• action (AgentAction) – Agent 的 action。

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

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

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

返回类型

Any

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在 Agent 结束时运行。

参数

• finish (AgentFinish) – Agent 的 finish。

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

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

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

返回类型

Any

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在 Chain 结束运行时运行。

参数

• outputs (Dict[str, Any]) – Chain 的输出。

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

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

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

返回类型

Any

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

在 Chain 发生错误时运行。

参数

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

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

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

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

返回类型

Any

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

在 Chain 开始运行时运行。

参数

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

• inputs (Dict[str, Any]) – 输入。

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

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

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

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

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

返回类型

Any

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

注意: 此方法用于 Chat Model。如果您正在为非 Chat Model 实现

处理程序，您应该使用 on_llm_start 代替。

参数

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

• 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, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → None

在 LLM 结束运行时运行。

参数

• response (LLMResult) – 生成的响应。

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

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

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

返回类型

None

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

在 LLM 发生错误时运行。

参数

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

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

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

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

返回类型

Any

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在新 LLM token 上运行时调用。仅在启用流式处理时可用。

参数

• token (str) – 新的 token。

• chunk (GenerationChunk | ChatGenerationChunk) – 新生成的 chunk，包含内容和其他信息。

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

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

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

返回类型

Any

on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

在 LLM 开始运行时运行。

注意：此方法为非聊天模型（常规 LLM）调用。如果

您正在为聊天模型实现处理程序，则应使用 on_chat_model_start 代替。

参数

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

• prompts (List[str]) – 提示。

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

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

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

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

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

返回类型

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, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs**: Any) → Any

在任意文本上运行。

参数

• text (str) – 文本。

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

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

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

返回类型

Any

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs**: Any) → None

在 Tool 结束运行时运行。

参数

• output (Any) – 工具的输出。

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

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

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

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

返回类型

None

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

在 Tool 发生错误时运行。

参数

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

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

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

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

返回类型

Any

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs**: Any) → None

在 Tool 开始运行时运行。

参数

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

• input_str (str) – 输入字符串。

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

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

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

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

• inputs (Optional[Dict[str, Any]]) – 输入。

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

返回类型

None

使用 LLMonitorCallbackHandler 的示例

• LLMonitor