langchain_core.callbacks.base.AsyncCallbackHandler

class langchain_core.callbacks.base.AsyncCallbackHandler

LangChain 的异步回调处理器。

属性

ignore_agent	是否忽略 Agent 回调。
ignore_chain	是否忽略 Chain 回调。
ignore_chat_model	是否忽略 Chat Model 回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略 LLM 回调。
ignore_retriever	是否忽略 Retriever 回调。
ignore_retry	是否忽略重试回调。
raise_error	如果发生异常是否引发错误。
run_inline	是否内联运行回调。

方法

__init__()
on_agent_action(action, *, run_id[, ...])	在 Agent 执行动作时运行。
on_agent_finish(finish, *, run_id[, ...])	在 agent 结束时运行。
on_chain_end(outputs, *, run_id[, ...])	在 Chain 结束运行时运行。
on_chain_error(error, *, run_id[, ...])	在 Chain 出错时运行。
on_chain_start(serialized, inputs, *, run_id)	在 Chain 开始运行时运行。
on_chat_model_start(serialized, messages, *, ...)	在 Chat Model 开始运行时运行。
on_custom_event(name, data, *, run_id[, ...])	覆盖以定义自定义事件的处理程序。
on_llm_end(response, *, run_id[, ...])	在 LLM 结束运行时运行。
on_llm_error(error, *, run_id[, ...])	在 LLM 出错时运行。
on_llm_new_token(token, *[, chunk, ...])	在新 LLM 令牌上运行。
on_llm_start(serialized, prompts, *, run_id)	在 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, tags])	在任意文本上运行。
on_tool_end(output, *, run_id[, ...])	在工具结束运行时运行。
on_tool_error(error, *, run_id[, ...])	在工具出错时运行。
on_tool_start(serialized, input_str, *, run_id)	在工具开始运行时运行。

__init__()

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

在 Agent 执行动作时运行。

参数

• action (AgentAction) – Agent 动作。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 agent 结束时运行。

参数

• finish (AgentFinish) – Agent 结束。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 Chain 结束运行时运行。

参数

• outputs (Dict[str, Any]) – Chain 的输出。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 Chain 出错时运行。

参数

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async 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) → None

在 Chain 开始运行时运行。

参数

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

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

返回类型

None

async 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

在 Chat Model 开始运行时运行。

注意：此方法为聊天模型调用。如果您正在实现

非聊天模型的处理程序，您应该使用 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

async on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

覆盖以定义自定义事件的处理程序。

参数

• name (str) – 自定义事件的名称。

• data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

• run_id (UUID) – 运行的 ID。

• tags (Optional[List[str]]) – 与自定义事件关联的标签（包括继承的标签）。

• metadata (Optional[Dict[str, Any]]) – 与自定义事件关联的元数据（包括继承的元数据）。

• kwargs (Any) –

返回类型

None

0.2.15 版本新增。

async on_llm_end(response: LLMResult, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 LLM 结束运行时运行。

参数

• response (LLMResult) – The response which was generated.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 LLM 出错时运行。

参数

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (Optional[UUID]) – The parent run ID. This is the ID of the parent run.

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) –

  Additional keyword arguments. - response (LLMResult): The response which was generated before

  the error occurred.

返回类型

None

async on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

Run on new LLM token. Only available when streaming is enabled.

参数

• token (str) – The new token.

• chunk (GenerationChunk | ChatGenerationChunk) – The new generated chunk, containing content and other information.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

在 LLM 开始运行时运行。

ATTENTION: This method is called for non-chat models (regular LLMs). If

you’re implementing a handler for a chat model, you should use on_chat_model_start instead.

参数

• serialized (Dict[str, Any]) – The serialized LLM.

• prompts (List[str]) – The prompts.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 Retriever 结束时运行。

参数

• documents (Sequence[Document]) – The documents retrieved.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 Retriever 出错时运行。

参数

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async 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) → None

在 Retriever 开始时运行。

参数

• serialized (Dict[str, Any]) – The serialized retriever.

• query (str) – The query.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在重试事件时运行。

参数

• retry_state (RetryCallState) – The retry state.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• kwargs (Any) – 额外的关键字参数。

返回类型

Any

async on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在任意文本上运行。

参数

• text (str) – The text.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在工具结束运行时运行。

参数

• output (Any) – The output of the tool.

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id:

参数

• error (BaseException) – 发生的错误。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• kwargs (Any) – 额外的关键字参数。

返回类型

None

async 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) → None

在工具开始运行时运行。

参数

• serialized (Dict[str, Any]) – The serialized tool.

• input_str (str) – The input string.

• 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]]) – The inputs.

• kwargs (Any) – 额外的关键字参数。

返回类型

None

Examples using AsyncCallbackHandler

• Bedrock

• How to use callbacks in async environments