ArthurCallbackHandler#

class langchain_community.callbacks.arthur_callback.ArthurCallbackHandler(arthur_model: ArthurModel)[来源]#

记录到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[, ...])	当检索器结束运行时执行。
`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[, observation_prefix, ...])	工具结束时不做任何操作。
`on_tool_error`(error, **kwargs)	当工具输出错误时，不执行任何操作。
`on_tool_start`(serialized, input_str, **kwargs)	工具启动时不执行任何操作。

Parameters:: arthur_model (ArthurModel)

__init__(arthur_model: ArthurModel) → None[源代码]#

初始化回调处理程序。

Parameters:: arthur_model (ArthurModel)
Return type:: 无

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

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

Parameters:

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。

Returns:

初始化的回调处理程序。

Return type:

ArthurCallbackHandler

on_agent_action(action: AgentAction, **kwargs: Any) → Any[来源]#

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

Parameters:

action (AgentAction)
kwargs (Any)

Return type:

任何

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

什么都不做

Parameters:

完成 (AgentFinish)
kwargs (Any)

Return type:

无

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

在链的末端，不做任何操作。

Parameters:

outputs (Dict[str, Any])
kwargs (Any)

Return type:

无

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

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

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

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

在链开始时，不执行任何操作。

Parameters:

serialized (Dict[str, Any])
inputs (Dict[str, Any])
kwargs (Any)

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当聊天模型开始运行时执行。

ATTENTION: This method is called for chat models. If you’re implementing: 对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

serialized (Dict[str, Any]) – 序列化的聊天模型。
messages (List[List[BaseMessage]]) – 消息。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

重写以定义自定义事件的处理程序。

Parameters:

name (str) – 自定义事件的名称。
data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。
run_id (UUID) – 运行的ID。
tags (list[str] | None) – 与自定义事件关联的标签（包括继承的标签）。
metadata (dict[str, Any] | None) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (Any)

Return type:

任何

在版本0.2.15中添加。

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

在LLM端，将数据发送给Arthur。

Parameters:

response (LLMResult)
kwargs (Any)

Return type:

无

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

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

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

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

在新令牌上，通过。

Parameters:

token (str)
kwargs (Any)

Return type:

无

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

在LLM启动时，保存输入的提示

Parameters:

serialized (Dict[str, Any])
提示 (列表[字符串])
kwargs (Any)

Return type:

无

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当Retriever结束运行时执行。

Parameters:

documents (Sequence[Document]) – 检索到的文档。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当Retriever出错时运行。

Parameters:

error (BaseException) – 发生的错误。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retriever_start(serialized: dict[str, Any], query: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当Retriever开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在重试事件上运行。

Parameters:

retry_state (RetryCallState) – 重试状态。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

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

什么都不做

Parameters:

文本 (str)
kwargs (Any)

Return type:

无

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

工具结束时不做任何操作。

Parameters:

output (Any)
observation_prefix (str | None)
llm_prefix (str | None)
kwargs (Any)

Return type:

无

on_tool_error(error: BaseException, **kwargs: Any) → None[来源]#

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

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

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:

无

使用 ArthurCallbackHandler 的示例

Arthur