langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler

用于登录deepeval的回调处理程序。

参数

• implementation_name (可选[字符串]) – deepeval中的实现名称

• metrics (列表[任何]) – 一系列的指标

抛出

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。

参数

• implementation_name (可选[字符串]) – 想要的实现名称

• metrics (列表[任何]) – 您希望跟踪哪些指标？

抛出

• 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[, ...])	当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)	当工具开始运行时，不执行任何操作。

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

初始化deepevalCallbackHandler。

参数

• implementation_name (可选[字符串]) – 想要的实现名称

• metrics (列表[任何]) – 您希望跟踪哪些指标？

抛出

• ImportError – 如果未安装deepeval包。

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

函数返回类型

None

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

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

参数

• action (AgentAction) –

• kwargs (Any) –

函数返回类型

Any

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

不执行任何操作

参数

• finish (AgentFinish) –

• kwargs (Any) –

函数返回类型

None

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

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

参数

• 输出 (Dict[str, Any]) –

• kwargs (Any) –

函数返回类型

None

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

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

参数

• 错误 (BaseException) –

• kwargs (Any) –

函数返回类型

None

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

当链式开始时，不执行任何操作

参数

• 序列化 (Dict[str, Any]) –

• 输入 (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

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

请注意：该方法为聊天模型调用。如果您实现

非聊天模型的处理器，应使用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, **kwargs: Any) → None

当LLM结束时记录到deepeval。

参数

• response –

• 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

存储提示

参数

• 序列化 (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 (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

当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

当Retriever开始运行时运行。

参数

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

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

不执行任何操作

参数

• text (str) –

• kwargs (Any) –

函数返回类型

None

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

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

参数

• output (Any) –

• observation_prefix (Optional[str]) –

• llm_prefix (Optional[str]) –

• kwargs (Any) –

函数返回类型

None

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

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

参数

• 错误 (BaseException) –

• kwargs (Any) –

函数返回类型

None

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

当工具开始运行时，不执行任何操作。

参数

• 序列化 (Dict[str, Any]) –

• input_str (字符串) –

• kwargs (Any) –

函数返回类型

None

使用 DeepEvalCallbackHandler 的实例

• 自信

• 自信 AI