langchain_google_vertexai.callbacks.VertexAICallbackHandler

class langchain_google_vertexai.callbacks.VertexAICallbackHandler[source]

跟踪 VertexAI 信息的事件处理器。

属性

always_verbose

即使 verbose 为 False，是否调用详细的回调。

completion_characters

completion_tokens

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略 LLM 回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

prompt_characters

prompt_tokens

raise_error

如果发生异常，则抛出错误。

run_inline

是否在行内运行回调。

successful_requests

方法

__init__()

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, **kwargs)

收集令牌使用情况。

on_llm_error(error, *, run_id[, parent_run_id])

在 LLM 错误发生时运行。

on_llm_new_token(token, **kwargs)

在新的 LLM 令牌上运行。

on_llm_start(serialized, prompts, **kwargs)

当 LLM 开始运行时执行。

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, *, 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__() → None[source]
返回类型

None

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

在代理行为上运行。

参数

  • 动作 (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, **kwargs: Any) → None[source]

收集令牌使用情况。

参数
返回类型

None

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, **kwargs: Any) → None[代码文件]

当发现新的LLM令牌时执行。只有在启用流时才可用。

参数

  • token (str) –

  • kwargs (Any) –

返回类型

None

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

当 LLM 开始运行时执行。

参数

  • serialized (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, ，run_id: UUID，parent_run_id: Optional[UUID] = None，**kwargs: Any) → Any

在任意文本上执行。

参数

  • $$text$$（《字符串》） – 文本内容。

  • 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$$（任意的） – 工具的输出。

  • 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