`langchain_community.callbacks.whylabs_callback`.WhyLabsCallbackHandler¶

class langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler(logger: Logger, handler: Any)[source]¶

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

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

可读性得分

复杂性和等级得分

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

有关更多信息，请参阅 https://docs.whylabs.ai/docs/language-model-monitoring 或查看 LangKit 代码库：https://github.com/whylabs/langkit

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

指定 API 密钥的方式是使用环境变量 WHYLABS_API_KEY。

参数

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

启动滚动记录器。

属性

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

启动滚动记录器。

参数

logger (Logger) –
handler (Any) –

close() → None[source]¶

关闭任何记录器以允许在退出前写出任何配置文件。

返回类型: None

flush() → None[source]¶

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

返回类型: None

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

从参数实例化 whylogs Logger。

参数

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

返回类型

WhyLabsCallbackHandler

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理操作时运行。

参数

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

返回类型

Any

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理结束时运行。

参数

finish (AgentFinish) – 代理结束。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 其他关键字参数。

返回类型

Any

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当链结束运行时运行。

参数

outputs (Dict[str, Any]) – 链的输出。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 其他关键字参数。

返回类型

Any

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

当链发生错误时运行。

参数

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

返回类型

Any

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, 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]) – 序列化的链。
inputs (Dict[str, Any]) – 输入。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 其他关键字参数。

返回类型

Any

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 代替。

参数

serialized (Dict[str, Any]) – 序列化的聊天模型。
messages (List[List[BaseMessage]]) – 消息。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
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, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当 LLM 结束运行时运行。

参数

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

返回类型

Any

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

当 LLM 发生错误时运行。

参数

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

返回类型

Any

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在新 LLM 令牌上运行。仅在启用流式处理时可用。

参数

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

返回类型

Any

on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

当 LLM 开始运行时运行。

注意: 此方法为非聊天模型（常规 LLM）调用。如果: 您正在为聊天模型实现处理程序，则应使用 on_chat_model_start 代替。

参数

serialized (Dict[str, Any]) – 序列化的 LLM。
prompts (List[str]) – 提示。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 其他关键字参数。

返回类型

Any

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

当检索器结束运行时运行。

参数

documents (Sequence[Document]) – 检索到的文档。
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¶

当检索器发生错误时运行。

参数

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]) – 序列化的 Retriever。
query (str) – 查询。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[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, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在任意文本上运行。

参数

text (str) – 文本。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
kwargs (Any) – 其他关键字参数。

返回类型

Any

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

当工具结束运行时运行。

参数

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

返回类型

Any

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

当工具发生错误时运行。

参数

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

返回类型

Any

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

当工具开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的工具。
input_str (str) – 输入字符串。
run_id (UUID) – 运行 ID。这是当前运行的 ID。
parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
inputs (Optional[Dict[str, Any]]) – 输入。
kwargs (Any) – 其他关键字参数。

返回类型

Any

使用 WhyLabsCallbackHandler 的示例¶

WhyLabs

langchain_community.callbacks.whylabs_callback.WhyLabsCallbackHandler¶

使用 WhyLabsCallbackHandler 的示例¶

`langchain_community.callbacks.whylabs_callback`.WhyLabsCallbackHandler¶