langchain_community.callbacks.flyte_callback.FlyteCallbackHandler

class langchain_community.callbacks.flyte_callback.FlyteCallbackHandler[源代码]

用于Flyte任务中的回调处理器。

初始化回调处理器。

属性

always_verbose

即使verbose为False，也调用详细模式回调。

ignore_agent

是否忽略agent回调。

ignore_chain

是否忽略chain回调。

ignore_chat_model

是否忽略聊天模型回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调。

ignore_retry

是否忽略重试回调。

raise_error

如果发生异常，是否引发错误。

run_inline

是否在线运行回调。

方法

__init__()

初始化回调处理器。

get_custom_callback_meta()

on_agent_action(action, **kwargs)

在agent动作上运行。

on_agent_finish(finish, **kwargs)

当agent运行结束时运行。

on_chain_end(outputs, **kwargs)

链结束时运行。

on_chain_error(error, **kwargs)

链发生错误时运行。

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运行结束时运行。

on_llm_error(error, **kwargs)

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

在代理结束运行时运行。

on_tool_end(output, **kwargs)

当工具运行结束时运行。

on_tool_error(error, **kwargs)

当工具出错时运行。

on_tool_start(serialized, input_str, **kwargs)

当工具开始运行时运行。

reset_callback_meta()

重置回调元数据。
__init__() → None[source]

初始化回调处理器。

返回类型

None

get_custom_callback_meta() → Dict[str, Any]
返回类型

Dict[str, Any]

on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]

在agent动作上运行。

参数
返回类型

任何

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

当agent运行结束时运行。

参数
返回类型

None

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

链结束时运行。

参数

  • outputs (Dict[str, Any]) –

  • kwargs (Any) –

返回类型

None

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

链发生错误时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

None

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

链开始运行时运行。

参数

  • serialized (Dict[str, Any]) –

  • inputs (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) – 额外的关键字参数。

返回类型

任何

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

返回类型

任何

在版本0.2.15中引入。

on_llm_end(response: LLMResult, **kwargs: Any) → None[source]

LLM运行结束时运行。

参数
返回类型

None

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

LLM发生错误时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

None

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

LLM生成新令牌时运行。

参数

  • token (str) –

  • kwargs (Any) –

返回类型

None

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

在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) – 额外的关键字参数。

返回类型

任何

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) – 额外的关键字参数。

返回类型

任何

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) – 额外的关键字参数。

返回类型

任何

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) – 额外的关键字参数。

返回类型

任何

on_text(text: str, **kwargs: Any) → None[source]

在代理结束运行时运行。

参数

  • text (str) –

  • kwargs (Any) –

返回类型

None

on_tool_end(output: str, **kwargs: Any) → None[source]

当工具运行结束时运行。

参数

  • output (str) –

  • kwargs (Any) –

返回类型

None

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

当工具出错时运行。

参数

  • error (BaseException) –

  • kwargs (Any) –

返回类型

None

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

当工具开始运行时运行。

参数

  • serialized (Dict[str, Any]) –

  • input_str (字符串) –

  • kwargs (Any) –

返回类型

None

reset_callback_meta() → None

重置回调元数据。

返回类型

None

使用FlyteCallbackHandler的示例