DeepEvalCallbackHandler

class langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler(metrics: List[Any], implementation_name: str | None = None)

将日志记录到deepeval的回调处理程序。

Parameters:

• implementation_name (str | None) – deepeval 中 implementation 的名称

• metrics (List[Any]) – 一个指标列表

Raises:

ImportError – 如果未安装 deepeval 包。

示例

>>> from langchain_community.llms import OpenAI
>>> from langchain_community.callbacks import DeepEvalCallbackHandler
>>> from deepeval.metrics import AnswerRelevancy
>>> metric = AnswerRelevancy(minimum_score=0.3)
>>> deepeval_callback = DeepEvalCallbackHandler(
...     implementation_name="exampleImplementation",
...     metrics=[metric],
... )
>>> llm = OpenAI(
...     temperature=0,
...     callbacks=[deepeval_callback],
...     verbose=True,
...     openai_api_key="API_KEY_HERE",
... )
>>> llm.generate([
...     "What is the best evaluation tool out there? (no bias at all)",
... ])
"Deepeval, no doubt about it."

初始化 deepevalCallbackHandler。

Parameters:

• implementation_name (str | None) – 你想要的实现的名称。

• metrics (List[Any]) – 你想要跟踪哪些指标？

Raises:

• ImportError – 如果未安装 deepeval 包。

• ConnectionError – 如果与deepeval的连接失败。

属性

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

方法

__init__(metrics[, implementation_name])	初始化 deepevalCallbackHandler。
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, *, ...)	当聊天模型开始运行时执行。
on_custom_event(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
on_llm_end(response, **kwargs)	当LLM结束时，将记录日志到deepeval。
on_llm_error(error, **kwargs)	当LLM输出错误时，不执行任何操作。
on_llm_new_token(token, **kwargs)	当生成新令牌时不执行任何操作。
on_llm_start(serialized, prompts, **kwargs)	存储提示
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)	工具启动时不执行任何操作。

__init__(metrics: List[Any], implementation_name: str | None = None) → None

初始化 deepevalCallbackHandler。

Parameters:

• implementation_name (str | None) – 你想要的实现的名称。

• metrics (List[Any]) – 你想要跟踪哪些指标？

Raises:

• ImportError – 如果未安装 deepeval 包。

• ConnectionError – 如果与deepeval的连接失败。

Return type:

无

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

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

Parameters:

• action (AgentAction)

• kwargs (Any)

Return type:

任何

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

什么都不做

Parameters:

• 完成 (AgentFinish)

• kwargs (Any)

Return type:

无

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

当链结束时，不执行任何操作。

Parameters:

• outputs (Dict[str, Any])

• kwargs (Any)

Return type:

无

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

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

Parameters:

• error (BaseException)

• kwargs (Any)

Return type:

无

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:

无

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, **kwargs: Any) → None

当LLM结束时，将记录日志到deepeval。

Parameters:

• response (LLMResult)

• kwargs (Any)

Return type:

无

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

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

Parameters:

• error (BaseException)

• kwargs (Any)

Return type:

无

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

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

Parameters:

• token (str)

• kwargs (Any)

Return type:

无

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

存储提示

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

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

Parameters:

• output (Any)

• observation_prefix (str | None)

• llm_prefix (str | None)

• kwargs (Any)

Return type:

无

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

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

Parameters:

• error (BaseException)

• kwargs (Any)

Return type:

无

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:

无

使用 DeepEvalCallbackHandler 的示例

• Confident

• Confident AI