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)[source]

回调处理程序，用于登录到Argilla。

参数:
dataset_name: Argilla中`FeedbackDataset`的名称。请注意，它必须

预先存在。如果您需要关于如何在Argilla中创建`FeedbackDataset`的帮助， 请访问 https://docs.argilla.io/en/latest/tutorials_and_integrations/integrations/use_argilla_callback_in_langchain.html。

workspace_name: Argilla中指定的工作区的名称，

FeedbackDataset`所在的地方。默认为`None，这意味着将使用 默认工作区。

api_url: 我们要使用的Argilla服务器的URL，以及

FeedbackDataset`所在的地方。默认为`None，这意味着将使用 `ARGILLA_API_URL`环境变量或默认值。

api_key: 连接到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，毫无疑问。"

初始化`ArgillaCallbackHandler`。

参数：

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

抛出：

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

Attributes

BLOG_URL

DEFAULT_API_URL

ISSUES_URL

REPO_URL

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型的回调。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调函数。

ignore_retry

是否忽略重试回调。

raise_error

run_inline

Methods

__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`中。这样做是为了避免在LLM启动时和链启动时重复记录相同的输入提示。

on_chat_model_start(serialized, messages, *, ...)

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

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)

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

  • dataset_name (str) –

  • workspace_name (Optional[str]) –

  • api_url (Optional[str]) –

  • api_key (Optional[str]) –

Return type

None

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

初始化`ArgillaCallbackHandler`。

参数：

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

抛出：

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

Parameters

  • dataset_name (str) –

  • workspace_name (Optional[str]) –

  • api_url (Optional[str]) –

  • api_key (Optional[str]) –

Return type

None

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

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

Parameters
Return type

Any

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

什么都不做

Parameters
Return type

None

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

None

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

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

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

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。

Parameters

  • serialized (Dict[str, Any]) –

  • messages (List[List[BaseMessage]]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

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

当LLM结束时，将日志记录到Argilla。

Parameters
Return type

None

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

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

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

当生成一个新的令牌时不执行任何操作。

Parameters

  • token (str) –

  • kwargs (Any) –

Return type

None

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

当一个LLM启动时，将提示保存在内存中。

Parameters

  • serialized (Dict[str, Any]) –

  • prompts (List[str]) –

  • kwargs (Any) –

Return type

None

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

当Retriever运行结束时运行。

Parameters

  • documents (Sequence[Document]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

Any

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当Retriever出错时运行。

Parameters

  • error (BaseException) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

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

Parameters

  • serialized (Dict[str, Any]) –

  • query (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在重试事件上运行。

Parameters

  • retry_state (RetryCallState) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

Any

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

什么都不做

Parameters

  • text (str) –

  • kwargs (Any) –

Return type

None

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

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

Parameters

  • output (Any) –

  • observation_prefix (Optional[str]) –

  • llm_prefix (Optional[str]) –

  • kwargs (Any) –

Return type

None

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

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

Parameters

  • error (BaseException) –

  • kwargs (Any) –

Return type

None

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

None

Examples using ArgillaCallbackHandler