langchain_community.callbacks.confident_callback.DeepEvalCallbackHandler

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

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

参数:

implementation_name: deepeval中`implementation`的名称 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，毫无疑问。"

初始化`deepevalCallbackHandler`。

参数：

implementation_name：您想要的实现名称。 metrics：您想要跟踪的指标是什么？

引发：

ImportError：如果未安装`deepeval`包。 ConnectionError：如果连接到deepeval失败。

Attributes

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

Methods

__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_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)	工具启动时不执行任何操作。

Parameters

• metrics (List[Any]) –

• implementation_name (Optional[str]) –

Return type

None

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

初始化`deepevalCallbackHandler`。

参数：

implementation_name：您想要的实现名称。 metrics：您想要跟踪的指标是什么？

引发：

ImportError：如果未安装`deepeval`包。 ConnectionError：如果连接到deepeval失败。

Parameters

• metrics (List[Any]) –

• implementation_name (Optional[str]) –

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

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

注意 : 此方法用于聊天模型。如果您正在为非聊天模型实现处理程序，则应改用on_llm_start。

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

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

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

存储提示

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

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

Parameters

• output (Any) –

• 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 DeepEvalCallbackHandler

• Confident AI

• Here we want to make sure the answer is minimally relevant