WhyLabsCallbackHandler#

class langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler(logger: Logger, handler: Any)[来源]#

用于记录到WhyLabs的回调处理程序。此回调处理程序利用langkit从与LLM交互时的提示和响应中提取特征。这些特征可用于护栏、评估和观察交互，以检测与幻觉、提示工程或输出验证相关的问题。LangKit是由WhyLabs开发的LLM监控工具包。

以下是一些可以使用LangKit监控的示例： * 文本质量

可读性评分

复杂度和等级分数

文本相关性 - 提示/响应之间的相似度评分 - 与用户定义主题的相似度评分 - 主题分类
安全与隐私 - 模式 - 匹配用户定义的正则表达式模式组的字符串计数 - 越狱 - 与已知越狱尝试的相似度评分 - 提示注入 - 与已知提示攻击的相似度评分 - 拒绝 - 与已知LLM拒绝响应的相似度评分
情感和毒性分析 - 情感分析 - 毒性分析

欲了解更多信息，请参阅 https://docs.whylabs.ai/docs/language-model-monitoring 或查看 LangKit 仓库：whylabs/langkit

— :param api_key: WhyLabs API 密钥。可选，因为首选

指定API密钥的方法是通过环境变量WHYLABS_API_KEY。

Parameters:

org_id (Optional[str]) – 用于写入配置文件的WhyLabs组织ID。可选，因为指定组织ID的首选方式是通过环境变量WHYLABS_DEFAULT_ORG_ID。
dataset_id (Optional[str]) – 要写入配置文件的WhyLabs数据集ID。可选，因为指定数据集ID的首选方式是通过环境变量WHYLABS_DEFAULT_DATASET_ID。
sentiment (bool) – 是否启用情感分析。默认为 False。
toxicity (bool) – 是否启用毒性分析。默认为 False。
themes (bool) – 是否启用主题分析。默认为 False。
logger (Logger)
handler (任意)

启动滚动日志记录器。

属性

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

方法

`__init__`(logger, handler)	初始化滚动记录器。
`close`()	关闭任何记录器以允许在退出前写出任何配置文件。
`flush`()	如果使用滚动记录器，则显式写入当前配置文件。
`from_params`(*[, api_key, org_id, ...])	从参数实例化whylogs Logger。
`on_agent_action`(action, *, run_id[, ...])	在代理操作时运行。
`on_agent_finish`(finish, *, run_id[, ...])	在代理结束时运行。
`on_chain_end`(outputs, *, run_id[, parent_run_id])	当链结束时运行。
`on_chain_error`(error, *, run_id[, parent_run_id])	当链发生错误时运行。
`on_chain_start`(serialized, inputs, *, run_id)	当链开始运行时执行。
`on_chat_model_start`(serialized, messages, *, ...)	当聊天模型开始运行时执行。
`on_custom_event`(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
`on_llm_end`(response, *, run_id[, parent_run_id])	当LLM运行结束时执行。
`on_llm_error`(error, *, run_id[, parent_run_id])	当LLM出错时运行。
`on_llm_new_token`(token, *[, chunk, ...])	在新LLM令牌上运行。
`on_llm_start`(serialized, prompts, *, run_id)	当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, *, run_id[, parent_run_id])	在任意文本上运行。
`on_tool_end`(output, *, run_id[, parent_run_id])	当工具结束运行时执行。
`on_tool_error`(error, *, run_id[, parent_run_id])	当工具出错时运行。
`on_tool_start`(serialized, input_str, *, run_id)	当工具开始运行时执行。

__init__(logger: Logger, handler: Any)[来源]#

启动滚动日志记录器。

Parameters:

logger (Logger)
handler (任意)

close() → None[source]#

关闭所有日志记录器，以便在退出前写出所有配置文件。

Return type:: 无

flush() → None[source]#

如果使用滚动日志记录器，请显式写入当前配置文件。

Return type:: 无

classmethod from_params(*, api_key: str | None = None, org_id: str | None = None, dataset_id: str | None = None, sentiment: bool = False, toxicity: bool = False, themes: bool = False, logger: Logger | None = None) → WhyLabsCallbackHandler[source]#

从参数实例化 whylogs 日志记录器。

Parameters:

api_key (Optional[str]) – WhyLabs API 密钥。可选，因为首选的指定 API 密钥的方式是通过环境变量 WHYLABS_API_KEY。
org_id (Optional[str]) – 要写入配置文件的WhyLabs组织ID。如果未设置，则必须在环境变量WHYLABS_DEFAULT_ORG_ID中指定。
dataset_id (可选[str]) – 此回调收集遥测数据的模型或数据集。如果未设置，则必须在环境变量 WHYLABS_DEFAULT_DATASET_ID 中指定。
sentiment (bool) – 如果为True，将初始化一个模型来执行情感分析复合评分。默认为False，不会收集此指标。
toxicity (bool) – 如果为True，将初始化一个模型来评分毒性。默认为False，不会收集此指标。
themes (bool) – 如果为True，将初始化一个模型来计算与配置主题的距离。默认为None，不会收集此指标。
logger (Optional[Logger]) – 如果指定，将绑定配置的logger作为遥测收集代理。默认为LangKit模式，带有定期的WhyLabs写入器。

Return type:

WhyLabsCallbackHandler

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理操作上运行。

Parameters:

action (AgentAction) – 代理动作。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理端运行。

Parameters:

finish (AgentFinish) – 代理完成。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_chain_end(outputs: dict[str, Any], *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当链结束运行时执行。

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, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当链发生错误时运行。

Parameters:

error (BaseException) – 发生的错误。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_chain_start(serialized: dict[str, Any], inputs: dict[str, Any], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当链开始运行时运行。

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#

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

ATTENTION: This method is called for chat models. If you’re implementing: 对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

serialized (Dict[str, Any]) – 序列化的聊天模型。
messages (List[List[BaseMessage]]) – 消息。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
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, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当LLM结束运行时执行。

Parameters:

response (LLMResult) – 生成的响应。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当LLM出错时运行。

Parameters:

error (BaseException) – 发生的错误。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_llm_new_token(token: str, *, chunk: GenerationChunk | ChatGenerationChunk | None = None, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在新的LLM令牌上运行。仅在启用流式传输时可用。

Parameters:

token (str) – 新的token。
chunk (GenerationChunk | ChatGenerationChunk) – 新生成的块，包含内容和其他信息。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_llm_start(serialized: dict[str, Any], prompts: list[str], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

当LLM开始运行时执行。

ATTENTION: This method is called for non-chat models (regular LLMs). If: 你正在为聊天模型实现一个处理程序，你应该使用on_chat_model_start来代替。

Parameters:

serialized (Dict[str, Any]) – 序列化的LLM。
prompts (List[str]) – 提示词。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
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, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在任意文本上运行。

Parameters:

文本 (str) – 文本内容。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当工具结束运行时执行。

Parameters:

output (Any) – 工具的输出。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当工具出错时运行。

Parameters:

error (BaseException) – 发生的错误。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_tool_start(serialized: dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inputs: dict[str, Any] | None = None, **kwargs: Any) → Any#

当工具开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的工具。
input_str (str) – 输入字符串。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
inputs (可选[Dict[str, Any]]) – 输入。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

使用 WhyLabsCallbackHandler 的示例

WhyLabs