langchain_community.callbacks.arthur_callback.ArthurCallbackHandler

class langchain_community.callbacks.arthur_callback.ArthurCallbackHandler(arthur_model: ArthurModel)[source]

回调处理程序，用于记录到 Arthur 平台。

Arthur 帮助企业团队大规模优化模型运营和性能。Arthur API 跟踪跨表格、NLP 和 CV 模型的模型性能、可解释性和公平性。我们的 API 与模型和平台无关，并随着复杂和动态的企业需求持续扩展。要了解有关 Arthur 的更多信息，请访问我们的网站 https://www.arthur.ai/ 或阅读 Arthur 文档 https://docs.arthur.ai/

初始化回调处理程序。

属性

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略 LLM 回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

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

run_inline

是否内联运行回调。

方法

__init__(arthur_model)

初始化回调处理程序。

from_credentials(model_id[, arthur_url, ...])

从 Arthur 凭据初始化回调处理程序。

on_agent_action(action, **kwargs)

当代理执行特定操作时，不执行任何操作。

on_agent_finish(finish, **kwargs)

不执行任何操作

on_chain_end(outputs, **kwargs)

在链式结束时，不执行任何操作。

on_chain_error(error, **kwargs)

当 LLM 链输出错误时，不执行任何操作。

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 结束时，将数据发送到 Arthur。

on_llm_error(error, **kwargs)

当 LLM 输出错误时，不执行任何操作。

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

当工具结束时，不执行任何操作。

on_tool_error(error, **kwargs)

当工具输出错误时，不执行任何操作。

on_tool_start(serialized, input_str, **kwargs)

当工具启动时，不执行任何操作。
参数

arthur_model (ArthurModel) –

__init__(arthur_model: ArthurModel) → None[source]

初始化回调处理程序。

参数

arthur_model (ArthurModel) –

返回类型

None

classmethod from_credentials(model_id: str, arthur_url: Optional[str] = 'https://app.arthur.ai', arthur_login: Optional[str] = None, arthur_password: Optional[str] = None) → ArthurCallbackHandler[source]

从 Arthur 凭据初始化回调处理程序。

参数

  • model_id (str) – 要记录到的 arthur 模型的 ID。

  • arthur_url (str, optional) – 要记录到的 Arthur 实例的 URL。默认为“https://app.arthur.ai”。

  • arthur_login (str, optional) – 用于连接到 Arthur 的登录名。默认为 None。

  • arthur_password (str, optional) – 用于连接到 Arthur 的密码。默认为 None。

返回

初始化的回调处理程序。

返回类型

ArthurCallbackHandler

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

当代理执行特定操作时，不执行任何操作。

参数
返回类型

Any

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

不执行任何操作

参数
返回类型

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]

当 LLM 链输出错误时，不执行任何操作。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

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

返回类型

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) – 附加关键字参数。

返回类型

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 结束时，将数据发送到 Arthur。

参数
返回类型

None

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

当 LLM 输出错误时，不执行任何操作。

参数

  • 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 启动时，保存输入提示

参数

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

  • kwargs (Any) –

返回类型

None

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

当工具结束时，不执行任何操作。

参数

  • output (Any) –

  • observation_prefix (Optional[str]) –

  • llm_prefix (Optional[str]) –

  • kwargs (Any) –

返回类型

None

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

当工具输出错误时，不执行任何操作。

参数

  • error (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

ArthurCallbackHandler 的使用示例