LabelStudioCallbackHandler#

class langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler(api_key: str | None = None, url: str | None = None, project_id: int | None = None, project_name: str = 'LangChain-%Y-%m-%d', project_config: str | None = None, mode: str | LabelStudioMode = LabelStudioMode.PROMPT)[source]#

Label Studio 回调处理程序。提供将预测结果发送到 Label Studio 的能力，以便进行人工评估、反馈和注释。

Parameters:

api_key (str | None) – Label Studio API 密钥
url (str | None) – Label Studio 的 URL
project_id (int | None) – Label Studio 项目 ID
project_name (str) – Label Studio 项目名称
project_config (str | None) – Label Studio 项目配置 (XML)
mode (str | LabelStudioMode) – Label Studio 模式（“prompt” 或 “chat”）

示例

>>> from langchain_community.llms import OpenAI
>>> from langchain_community.callbacks import LabelStudioCallbackHandler
>>> handler = LabelStudioCallbackHandler(
...             api_key='<your_key_here>',
...             url='http://localhost:8080',
...             project_name='LangChain-%Y-%m-%d',
...             mode='prompt'
... )
>>> llm = OpenAI(callbacks=[handler])
>>> llm.invoke('Tell me a story about a dog.')

属性

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

方法

`__init__`([api_key, url, project_id, ...])
`add_prompts_generations`(run_id, generations)
`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, *, ...)	当LLM开始时，将提示保存在内存中。
`on_custom_event`(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
`on_llm_end`(response, **kwargs)	为每个提示和生成创建一个新的Label Studio任务。
`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:

api_key (str | None)
url (str | None)
project_id (int | None)
project_name (str)
project_config (str | None)
mode (str | LabelStudioMode)

add_prompts_generations(run_id: str, generations: List[List[Generation]]) → None[source]#

Parameters:

run_id (str)
generations (List[List[Generation]])

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

当链结束运行时执行。

Parameters:

outputs (Dict[str, Any]) – 链的输出。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
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]) – 输入。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
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[source]#

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

Parameters:

serialized (Dict[str, Any])
messages (List[List[BaseMessage]])
run_id (UUID)
parent_run_id (UUID | None)
标签 (列表[字符串] | 无)
metadata (Dict[str, Any] | None)
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]#

为每个提示和生成创建一个新的Label Studio任务。

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: str, observation_prefix: str | None = None, llm_prefix: str | None = None, **kwargs: Any) → None[source]#

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

Parameters:

output (str)
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:

无

使用 LabelStudioCallbackHandler 的示例

Label Studio