langchain_community.callbacks.arize_callback.ArizeCallbackHandler

class langchain_community.callbacks.arize_callback.ArizeCallbackHandler(model_id: Optional[str] = None, model_version: Optional[str] = None, SPACE_KEY: Optional[str] = None, API_KEY: Optional[str] = None)[source]

回调处理器，用于记录到 Arize。

初始化回调处理器。

属性

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__([model_id, model_version, ...])

初始化回调处理器。

on_agent_action(action, **kwargs)

不执行任何操作。

on_agent_finish(finish, **kwargs)

在 Agent 结束时运行。

on_chain_end(outputs, **kwargs)

不执行任何操作。

on_chain_error(error, **kwargs)

不执行任何操作。

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)

不执行任何操作。

on_llm_new_token(token, **kwargs)

不执行任何操作。

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

当 Tool 结束运行时运行。

on_tool_error(error, **kwargs)

当 Tool 出错时运行。

on_tool_start(serialized, input_str, **kwargs)

当 Tool 开始运行时运行。
参数

  • model_id (Optional[str]) –

  • model_version (Optional[str]) –

  • SPACE_KEY (Optional[str]) –

  • API_KEY (Optional[str]) –

__init__(model_id: Optional[str] = None, model_version: Optional[str] = None, SPACE_KEY: Optional[str] = None, API_KEY: Optional[str] = None) → None[source]

初始化回调处理器。

参数

  • model_id (Optional[str]) –

  • model_version (Optional[str]) –

  • SPACE_KEY (Optional[str]) –

  • API_KEY (Optional[str]) –

返回类型

None

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

不执行任何操作。

参数
返回类型

Any

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

在 Agent 结束时运行。

参数

  • finish (AgentFinish) – Agent 结束。

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

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

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

返回类型

None

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

不执行任何操作。

参数

  • outputs (Dict[str, Any]) –

  • kwargs (Any) –

返回类型

None

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

不执行任何操作。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

None

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

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

返回类型

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

注意：此方法为 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, **kwargs: Any) → None[source]

当 LLM 结束运行时运行。

参数

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

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

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

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

返回类型

None

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

不执行任何操作。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

None

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

不执行任何操作。

参数

  • token (str) –

  • kwargs (Any) –

返回类型

None

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

当 LLM 开始运行时运行。

注意：此方法为非 chat model（常规 LLM）调用。如果

您正在实现 chat model 的处理程序，您应该使用 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, **kwargs: Any) → None[源代码]

在任意文本上运行。

参数

  • text (str) – 文本。

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

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

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

返回类型

None

on_tool_end(output: Any, observation_prefix: Optional[str] = None, llm_prefix: Optional[str] = None, **kwargs: Any) → None[源代码]

当 Tool 结束运行时运行。

参数

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

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

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

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

  • observation_prefix (Optional[str]) –

  • llm_prefix (Optional[str]) –

返回类型

None

on_tool_error(error: BaseException, **kwargs: Any) → None[源代码]

当 Tool 出错时运行。

参数

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

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

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

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

返回类型

None

on_tool_start(serialized: Dict[str, Any], input_str: str, **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