引言
在开发长时间运行的工具或应用程序时,实时监控其执行进度是非常重要的。通过自定义回调事件,我们可以在多步骤过程中发送事件,提供进度更新,不仅能帮助开发者调试,还可以向最终用户展示任务的执行状态。在这篇文章中,我们将探讨如何在LangChain中调度自定义回调事件。
主要内容
1. 自定义事件的基本概念
在LangChain中,自定义事件需要具备两个关键属性:name
和 data
。
- name: 事件名称,由用户定义。
- data: 事件关联的数据,建议使用JSON可序列化的数据结构。
2. LangChain的兼容性要求
若要在LangChain中使用自定义事件,确保您的版本是langchain-core>=0.2.15
。此外,自定义事件只能从现有的Runnable
中调度。
对于使用异步代码的开发者,如果您在Python 3.10及以下版本中工作,需要手动传播RunnableConfig
对象。Python 3.11及以上版本将自动传播,但建议始终手动处理以确保兼容性。
3. 使用Astream Events API
通过Astream Events API
可以高效地消费自定义事件。需要使用新版本v2
API来查看自定义事件。
代码示例
以下是一个如何在异步环境中调度和消费自定义事件的完整示例:
# 使用API代理服务提高访问稳定性
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})
await adispatch_custom_event("event2", 5)
return x
async for event in foo.astream_events("hello world", version="v2"):
print(event)
常见问题和解决方案
问题1: 为什么我看不到事件被调度?
解决方案:
- 确认您在使用
langchain-core>=0.2.15
。 - 如果您使用Python 3.10及以下版本,请确保手动传播
RunnableConfig
。
问题2: 如何在不同版本的Python中处理兼容性?
解决方案:
在Python 3.10及以下版本中手动传递配置对象。确保您的代码兼容所有潜在使用的Python版本。
总结及进一步学习资源
通过本文介绍的技术,您可以在应用程序中实现更细粒度、更灵活的进度监控。想进一步深入了解相关API和示例,请查看以下资源:
参考资料
- LangChain核心模块文档
- Python异步编程指南
如果这篇文章对你有帮助,欢迎点赞并关注我的博客。您的支持是我持续创作的动力!
—END—