Argilla回调处理器#

class langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler(dataset_name: str, workspace_name: str | None = None, api_url: str | None = None, api_key: str | None = None)[source]#

记录到Argilla的回调处理程序。

Parameters:

dataset_name (str) – Argilla 中 FeedbackDataset 的名称。请注意，它必须事先存在。如果您需要有关如何在 Argilla 中创建 FeedbackDataset 的帮助，请访问 https://docs.argilla.io/en/latest/tutorials_and_integrations/integrations/use_argilla_callback_in_langchain.html。
workspace_name (str | None) – Argilla 中指定 FeedbackDataset 所在的工作区名称。默认为 None，这意味着将使用默认工作区。
api_url (str | None) – 我们想要使用的Argilla服务器的URL，以及FeedbackDataset所在的位置。默认为None，这意味着将使用ARGILLA_API_URL环境变量或默认值。
api_key (str | None) – 用于连接到Argilla服务器的API密钥。默认为None，这意味着将使用ARGILLA_API_KEY环境变量或默认值。

Raises:

ImportError – 如果未安装 argilla 包。
ConnectionError – 如果连接到Argilla失败。
FileNotFoundError – 如果从Argilla检索FeedbackDataset失败。

示例

>>> from langchain_community.llms import OpenAI
>>> from langchain_community.callbacks import ArgillaCallbackHandler
>>> argilla_callback = ArgillaCallbackHandler(
...     dataset_name="my-dataset",
...     workspace_name="my-workspace",
...     api_url="http://localhost:6900",
...     api_key="argilla.apikey",
... )
>>> llm = OpenAI(
...     temperature=0,
...     callbacks=[argilla_callback],
...     verbose=True,
...     openai_api_key="API_KEY_HERE",
... )
>>> llm.generate([
...     "What is the best NLP-annotation tool out there? (no bias at all)",
... ])
"Argilla, no doubt about it."

初始化 ArgillaCallbackHandler。

Parameters:

dataset_name (str) – Argilla 中 FeedbackDataset 的名称。请注意，它必须事先存在。如果您需要有关如何在 Argilla 中创建 FeedbackDataset 的帮助，请访问 https://docs.argilla.io/en/latest/tutorials_and_integrations/integrations/use_argilla_callback_in_langchain.html。
workspace_name (str | None) – Argilla 中指定 FeedbackDataset 所在的工作区名称。默认为 None，这意味着将使用默认工作区。
api_url (str | None) – 我们想要使用的Argilla服务器的URL，以及FeedbackDataset所在的位置。默认为None，这意味着将使用ARGILLA_API_URL环境变量或默认值。
api_key (str | None) – 用于连接到Argilla服务器的API密钥。默认为None，这意味着将使用ARGILLA_API_KEY环境变量或默认值。

Raises:

ImportError – 如果未安装 argilla 包。
ConnectionError – 如果连接到Argilla失败。
FileNotFoundError – 如果从Argilla检索FeedbackDataset失败。

属性

`BLOG_URL`
`DEFAULT_API_URL`
`ISSUES_URL`
`REPO_URL`
`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链式回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`raise_error`	如果发生异常，是否引发错误。
`run_inline`	是否内联运行回调。

方法

`__init__`(dataset_name[, workspace_name, ...])	初始化 ArgillaCallbackHandler。
`on_agent_action`(action, **kwargs)	当代理执行特定操作时，不执行任何操作。
`on_agent_finish`(finish, **kwargs)	什么都不做
`on_chain_end`(outputs, **kwargs)	如果 parent_run_id 或 run_id 在 self.prompts 中，则将输出记录到 Argilla，并从 self.prompts 中弹出该运行。
`on_chain_error`(error, **kwargs)	当LLM链输出错误时，不执行任何操作。
`on_chain_start`(serialized, inputs, **kwargs)	如果键 input 在 inputs 中，则使用 parent_run_id 或 run_id 作为键将其保存在 self.prompts 中。
`on_chat_model_start`(serialized, messages, *, ...)	当聊天模型开始运行时执行。
`on_custom_event`(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
`on_llm_end`(response, **kwargs)	当LLM结束时，将记录日志到Argilla。
`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)	工具启动时不执行任何操作。

__init__(dataset_name: str, workspace_name: str | None = None, api_url: str | None = None, api_key: str | None = None) → None[source]#

初始化 ArgillaCallbackHandler。

Parameters:

dataset_name (str) – Argilla 中 FeedbackDataset 的名称。请注意，它必须事先存在。如果您需要有关如何在 Argilla 中创建 FeedbackDataset 的帮助，请访问 https://docs.argilla.io/en/latest/tutorials_and_integrations/integrations/use_argilla_callback_in_langchain.html。
workspace_name (str | None) – Argilla 中指定 FeedbackDataset 所在的工作区名称。默认为 None，这意味着将使用默认工作区。
api_url (str | None) – 我们想要使用的Argilla服务器的URL，以及FeedbackDataset所在的位置。默认为None，这意味着将使用ARGILLA_API_URL环境变量或默认值。
api_key (str | None) – 用于连接到Argilla服务器的API密钥。默认为None，这意味着将使用ARGILLA_API_KEY环境变量或默认值。

Raises:

ImportError – 如果未安装 argilla 包。
ConnectionError – 如果连接到Argilla失败。
FileNotFoundError – 如果从Argilla检索FeedbackDataset失败。

Return type:

无

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

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

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]#

如果parent_run_id或run_id在self.prompts中，则将输出记录到Argilla，并从self.prompts中弹出该运行。如果输出是列表或不是列表，行为会有所不同。

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]#

如果键input在inputs中，则使用parent_run_id或run_id作为键将其保存在self.prompts中。这样做是为了避免在LLM启动时和链启动时两次记录相同的输入提示。

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结束时，将记录日志到Argilla。

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[来源]#

什么都不做

Parameters:

文本 (str)
kwargs (Any)

Return type:

无

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

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

Parameters:

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

Return type:

无

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

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

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

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

工具启动时不执行任何操作。

Parameters:

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

Return type:

无

使用 ArgillaCallbackHandler 的示例

Argilla