跳到主要内容
Open on GitHub

回调

先决条件

LangChain 提供了一个回调系统,允许您介入 LLM 应用程序的各个阶段。这对于日志记录、监控、流式传输及其他任务非常有用。

您可以通过使用 API 中随处可见的 callbacks 参数来订阅这些事件。此参数是一个处理程序对象列表,这些对象需要实现下面更详细描述的一个或多个方法。

回调事件

事件事件触发关联方法
聊天模型开始当聊天模型开始时on_chat_model_start
LLM 开始当 LLM 开始时on_llm_start
LLM 新令牌当 LLM 或聊天模型发出新令牌时on_llm_new_token
LLM 结束当 LLM 或聊天模型结束时on_llm_end
LLM 错误当 LLM 或聊天模型出错时on_llm_error
链开始当链开始运行时on_chain_start
链结束当链结束时on_chain_end
链错误当链出错时on_chain_error
工具开始当工具开始运行时on_tool_start
工具结束当工具结束时on_tool_end
工具错误当工具出错时on_tool_error
代理动作当代理执行动作时on_agent_action
代理完成当代理结束时on_agent_finish
检索器开始当检索器开始时on_retriever_start
检索器结束当检索器结束时on_retriever_end
检索器错误当检索器出错时on_retriever_error
文本当任意文本运行时on_text
重试当重试事件运行时on_retry

回调处理程序

回调处理程序可以是同步的或异步

在运行时,LangChain 会配置适当的回调管理器(例如,CallbackManagerAsyncCallbackManager),它将负责在事件触发时调用每个“注册”回调处理程序上的相应方法。

传递回调

callbacks 属性在 API 中的大多数对象(模型、工具、代理等)的两个不同位置可用。

  • 请求时回调:在请求时除了输入数据之外传递。在所有标准 Runnable 对象上可用。这些回调会被定义它们的对象的所有子对象继承。例如,chain.invoke({"number": 25}, {"callbacks": [handler]})
  • 构造函数回调chain = TheNameOfSomeChain(callbacks=[handler])。这些回调作为参数传递给对象的构造函数。回调仅限于定义它们的对象,并且不会被对象的任何子对象继承。
警告

构造函数回调仅限于定义它们的对象。它们不会被对象的子对象继承。

如果您正在创建自定义链或可运行对象,您需要记住将请求时回调传播到任何子对象。

Python <=3.10 中的异步

任何调用其他可运行对象并在 Python <=3.10 中以异步方式运行的 RunnableLambdaRunnableGeneratorTool 都必须手动将回调传播到子对象。这是因为在这种情况下 LangChain 无法自动将回调传播到子对象。

这是您可能无法看到自定义可运行对象或工具发出事件的常见原因。

有关如何使用回调的详细信息,请参阅此处的相关操作指南