`langchain_community.callbacks.labelstudio_callback`.LabelStudioCallbackHandler¶

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

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

参数

api_key (可选[字符串]) – Label Studio API 密钥
url (可选[字符串]) – Label Studio URL
project_id (可选[整型]) – Label Studio 项目 ID
project_name (字符串) – Label Studio 项目名称
project_config (可选[字符串]) – Label Studio 项目配置（XML）
mode (联合[字符串, LabelStudioMode]) – Label Studio 模式（“提示”或“聊天”）

示例

>>> 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[, ...])	当Retriever执行结束时运行。
`on_retriever_error`(error, *, run_id[, ...])	当Retriever出错时运行。
`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__(api_key: Optional[str] = None, url: Optional[str] = None, project_id: Optional[int] = None, project_name: str = 'LangChain-%Y-%m-%d', project_config: Optional[str] = None, mode: Union[str, LabelStudioMode] = LabelStudioMode.PROMPT)[source]¶

参数

api_key (可选：str) –
url (可选：str) –
project_id (可选：int) –
project_name (str) –
project_config (可选：str) –
mode (联合：str 或 LabelStudioMode) –

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

参数

run_id (str) –
代数 (列表[[列表 Generation]]) –

返回类型

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

当链式执行结束时运行。

参数

outputs (Dict[str, Any]) – 链的输出。

run_id (UUID) – 运行ID。这是当前运行的ID。

parent_run_id (UUID) – 父运行ID。这是父运行的ID。

kwargs (Any) – 额外的关键字参数。

返回类型

None

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

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

参数

错误 (BaseException) –

kwargs (Any) –

返回类型

None

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

当链式执行开始时运行。

参数

serialized (Dict[str, Any]) – 序列化的链。

inputs (Dict[str, Any]) – 输入。

run_id (UUID) – 运行ID。这是当前运行的ID。

parent_run_id (UUID) – 父运行ID。这是父运行的ID。

tags (可选[List[str]]) – 标签。

metadata (可选[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[source]¶

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

参数

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) –

返回类型

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

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

参数

response (LLMResult) –

kwargs (Any) –

返回类型

None

on_llm_error(error: BaseException, **kwargs: Any) → None[来源]¶

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

参数

错误 (BaseException) –

kwargs (Any) –

返回类型

None

on_llm_new_token(token: str, **kwargs: Any) → None[来源]¶

当生成新令牌时，不执行任何操作。

参数

token (str) –

kwargs (Any) –

返回类型

None

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

当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 (序列[文档]) - 获取到的文档。

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¶

在检索器开始运行时执行。

参数

serialized (Dict[str, Any]) – 序列化的检索器。

query (str) – 查询。

run_id (UUID) – 运行ID。这是当前运行的ID。

parent_run_id (UUID) – 父运行ID。这是父运行的ID。

tags (可选[List[str]]) – 标签。

metadata (可选[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: str, observation_prefix: Optional[str] = None, llm_prefix: Optional[str] = None, **kwargs: Any) → None[source]¶

工具结束时什么都不做。

参数

output (str) –

observation_prefix (Optional[str]) –

llm_prefix (Optional[str]) –

kwargs (Any) –

返回类型

None

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

当工具输出错误时什么都不做。

参数

错误 (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

使用LabelStudioCallbackHandler的示例¶

Label Studio

langchain_community.callbacks.labelstudio_callback.LabelStudioCallbackHandler¶

使用LabelStudioCallbackHandler的示例¶

`langchain_community.callbacks.labelstudio_callback`.LabelStudioCallbackHandler¶