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)

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

参数:

api_key: 标签工作室API密钥 url: 标签工作室URL project_id: 标签工作室项目ID project_name: 标签工作室项目名称 project_config: 标签工作室项目配置（XML） mode: 标签工作室模式（”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.')

Attributes

DEFAULT_PROJECT_NAME
ignore_agent	是否忽略代理回调。
ignore_chain	是否忽略链式回调。
ignore_chat_model	是否忽略聊天模型的回调。
ignore_llm	是否忽略LLM回调。
ignore_retriever	是否忽略检索器回调函数。
ignore_retry	是否忽略重试回调。
raise_error
run_inline

Methods

__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_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)	当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

• api_key (Optional[str]) –

• url (Optional[str]) –

• project_id (Optional[int]) –

• project_name (str) –

• project_config (Optional[str]) –

• mode (Union[str, LabelStudioMode]) –

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

Parameters

• api_key (Optional[str]) –

• url (Optional[str]) –

• project_id (Optional[int]) –

• project_name (str) –

• project_config (Optional[str]) –

• mode (Union[str, LabelStudioMode]) –

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

Parameters

• run_id (str) –

• generations (List[List[Generation]]) –

Return type

None

on_agent_action(action: AgentAction, **kwargs: Any) → Any

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

Parameters

• action (AgentAction) –

• kwargs (Any) –

Return type

Any

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

什么都不做

Parameters

• finish (AgentFinish) –

• kwargs (Any) –

Return type

None

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

当链结束运行时运行。

Parameters

• outputs (Dict[str, Any]) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

当链开始运行时运行。

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

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

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

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

Parameters

• response (LLMResult) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• token (str) –

• kwargs (Any) –

Return type

None

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

当一个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

什么都不做

Parameters

• text (str) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• output (str) –

• observation_prefix (Optional[str]) –

• llm_prefix (Optional[str]) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• error (BaseException) –

• kwargs (Any) –

Return type

None

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

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

Parameters

• serialized (Dict[str, Any]) –

• input_str (str) –

• kwargs (Any) –

Return type

None

Examples using LabelStudioCallbackHandler

• Label Studio

• labelstudio.md