回调
前置条件
LangChain 提供了一个回调系统，允许您挂钩到 LLM 应用程序的各个阶段。这对于日志记录、监控、流式传输和其他任务非常有用。
您可以通过在整个 API 中提供的 callbacks 参数来订阅这些事件。该参数是一个处理器对象列表，预期这些对象将实现以下更详细描述的一个或多个方法。
回调事件
| 事件 | 事件触发 | 关联方法 |
|---|---|---|
| Chat model start | When a chat model starts | on_chat_model_start |
| LLM start | When a llm starts | on_llm_start |
| LLM new token | When an llm OR chat model emits a new token | on_llm_new_token |
| LLM ends | When an llm OR chat model ends | on_llm_end |
| LLM errors | When an llm OR chat model errors | on_llm_error |
| Chain start | When a chain starts running | on_chain_start |
| Chain end | When a chain ends | on_chain_end |
| Chain error | When a chain errors | on_chain_error |
| Tool start | When a tool starts running | on_tool_start |
| Tool end | When a tool ends | on_tool_end |
| Tool error | When a tool errors | on_tool_error |
| Agent action | When an agent takes an action | on_agent_action |
| Agent finish | When an agent ends | on_agent_finish |
| Retriever start | When a retriever starts | on_retriever_start |
| Retriever end | When a retriever ends | on_retriever_end |
| Retriever error | When a retriever errors | on_retriever_error |
| Text | When arbitrary text is run | on_text |
| Retry | When a retry event is run | on_retry |
回调处理器
回调处理器可以是 sync 或 async：
- 同步回调处理器实现了 BaseCallbackHandler 接口。
- 异步回调处理器实现了 AsyncCallbackHandler 接口。
在运行时，LangChain 会配置一个适当的回调管理器（例如，CallbackManager 或 AsyncCallbackManager），当事件触发时，该管理器将负责调用每个“注册”的回调处理器上的相应方法。
传递回调
The callbacks property is available on most objects throughout the API (Models, Tools, Agents, etc.) in two different places:
- 请求时间回调: 在请求时传递，除输入数据外。适用于所有标准
Runnable对象。这些回调会被该对象定义的所有子对象继承。例如，chain.invoke({"number": 25}, {"callbacks": [handler]})。 - 构造函数回调:
chain = TheNameOfSomeChain(callbacks=[handler])。这些回调作为参数传递给对象的构造函数。这些回调的作用域仅限于定义它们的对象，并且不会被该对象的任何子对象继承。
警告
构造函数回调仅限定于它们所定义的对象。它们不会被该对象的后代继承。
如果您正在创建自定义链或可运行对象，请务必记得将请求时间回调传播给任何子对象。
Python<=3.10 的异步编程
任何调用其他可运行对象并在 Python<=3.10 中运行的 RunnableLambda、RunnableGenerator 或 Tool，都必须手动将回调传播给子对象。这是因为在这种情况下，LangChain 无法自动将回调传播给子对象。
这是您可能无法看到自定义可运行对象或工具发出事件的常见原因。
有关如何使用回调的详细信息，请参见此处相关的操操作指南。