`langchain_community.callbacks.argilla_callback`.ArgillaCallbackHandler¶

class langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler(dataset_name: str, workspace_name: Optional[str] = None, api_url: Optional[str] = None, api_key: Optional[str] = None)[源代码]¶

Argilla的回调处理程序。

参数

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]) – Argilla中包含指定FeedbackDataset的工作空间名称。默认为None，表示将使用默认工作空间。
api_url (可选[str]) – 我们希望使用的Argilla服务器URL，FeedbackDataset位于其中。默认为None，表示将使用ARGILLA_API_URL环境变量或默认值。
api_key (可选[str]) – 连接到Argilla服务器的API密钥。默认为None，表示将使用ARGILLA_API_KEY环境变量或默认值。

异常处理

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。

参数

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]) – Argilla中包含指定FeedbackDataset的工作空间名称。默认为None，表示将使用默认工作空间。
api_url (可选[str]) – 我们希望使用的Argilla服务器URL，FeedbackDataset位于其中。默认为None，表示将使用ARGILLA_API_URL环境变量或默认值。
api_key (可选[str]) – 连接到Argilla服务器的API密钥。默认为None，表示将使用ARGILLA_API_KEY环境变量或默认值。

异常处理

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)	如果父运行ID或运行ID在 self.prompts 中，则将输出记录到Argilla，并从 self.prompts 中弹出运行。
`on_chain_error`(error, **kwargs)	当LLM链输出错误时不执行任何操作。
`on_chain_start`(serialized, inputs, **kwargs)	如果键 input 在 inputs 中，则可以使用父运行ID或运行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[, ...])	当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)	工具开始时执行空操作。

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

初始化ArgillaCallbackHandler。

参数

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]) – Argilla中包含指定FeedbackDataset的工作空间名称。默认为None，表示将使用默认工作空间。
api_url (可选[str]) – 我们希望使用的Argilla服务器URL，FeedbackDataset位于其中。默认为None，表示将使用ARGILLA_API_URL环境变量或默认值。
api_key (可选[str]) – 连接到Argilla服务器的API密钥。默认为None，表示将使用ARGILLA_API_KEY环境变量或默认值。

异常处理

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

返回类型

None

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

当智能体执行特定操作时，不执行任何操作。

参数

action (AgentAction) –
kwargs (Any) –

返回类型

Any

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

不执行任何操作

参数

finish (AgentFinish) –
kwargs (Any) –

返回类型

None

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

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

参数

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

如果键在中，那么使用或作为键将其保存到中。这样做是为了避免重复记录相同的输入提示，即LLM启动时和链启动时记录一次。

参数

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。: a处理器，请使用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[源代码]¶

LLM结束时记录到Argilla。

参数

response (LLMResult) –
kwargs (Any) –

返回类型

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]) – 序列化的检索器。
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[source]¶

不执行任何操作

参数

text (str) –
kwargs (Any) –

返回类型

None

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

工具结束时执行空操作。

参数

output (Any) –
observation_prefix (Optional[str]) –
llm_prefix (Optional[str]) –
kwargs (Any) –

返回类型

None

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

工具输出错误时执行空操作。

参数

error (BaseException) –
kwargs (Any) –

返回类型

None

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

工具开始时执行空操作。

参数

serialized (Dict[str, Any]) –
input_str (字符串) –
kwargs (Any) –

返回类型

None

使用 ArgillaCallbackHandler 的示例¶

Argilla

langchain_community.callbacks.argilla_callback.ArgillaCallbackHandler¶

使用 ArgillaCallbackHandler 的示例¶

`langchain_community.callbacks.argilla_callback`.ArgillaCallbackHandler¶