Bee-Agent-Framework 公开API的Python化改进实践
在开源项目Bee-Agent-Framework的开发过程中,团队对公开API的设计进行了深入讨论和优化。本文将详细介绍这次API改进的技术背景、设计思路和具体实现方案。
API设计问题分析
在早期版本中,框架的公开API设计大量使用了BaseModel输入对象。这种设计虽然有利于类型检查和数据传递,但对终端用户来说却显得不够友好。典型的代码示例如下:
llm = ChatModel.from_name("ollama:granite3.1-dense:8b")
agent = BeeAgent(
bee_input=BeeInput(
llm=llm,
tools=[OpenMeteoTool(), DuckDuckGoSearchTool(max_results=3)],
memory=UnconstrainedMemory()
)
)
response = await agent.run(
run_input=BeeRunInput(prompt="What's the current weather in Las Vegas?")
).observe(lambda emitter: emitter.on("success", lambda data, event: print(data.result)))
这种设计存在几个明显问题:
- 需要用户显式创建中间输入对象
- 代码嵌套层级过深
- API调用不够直观
改进方案设计
经过团队讨论,决定采用"参数展开"的方案来简化公开API。改进后的代码示例如下:
llm = ChatModel.from_name("ollama:granite3.1-dense:8b")
agent = BeeAgent(llm=llm, tools=[OpenMeteoTool(), DuckDuckGoSearchTool(max_results=3)], memory=UnconstrainedMemory())
response = await agent.run("What's the current weather in Las Vegas?").observe(
lambda emitter: emitter.on("success", lambda data, event: print(data.result)))
这种改进带来了以下优势:
- 移除了不必要的中间对象创建
- 减少了代码嵌套层级
- 使API调用更加直观和Pythonic
具体实现策略
在实现过程中,团队制定了以下具体策略:
-
API分类处理:将API分为三类处理
- 必须修改的公开API(如BaseAgent.run、BeeAgent初始化等)
- 可选的公开API(如Emitter相关方法)
- 内部API(如Runner基础设施)
-
输入对象内部化:在公开API内部处理输入对象的创建,而不是暴露给用户
-
渐进式改进:每个API的修改都单独提交,便于回滚和问题定位
技术决策与权衡
在改进过程中,团队面临几个关键决策点:
-
Runner API的处理:经过讨论,Runner基础设施被视为内部实现细节,不应暴露给终端用户。因此移除了相关示例代码。
-
Emitter API的特殊性:由于Emitter涉及事件处理机制,其改进被单独规划。
-
输入对象与Schema的区分:明确了输入对象(用于API参数传递)和Schema(用于数据验证)的不同用途,考虑将后者重命名以避免混淆。
经验总结
这次API改进实践提供了几个有价值的经验:
-
API设计应以用户体验为先:类型安全固然重要,但不应该牺牲API的易用性。
-
合理划分公开与内部API:清晰的边界定义有助于保持框架的整洁性。
-
渐进式改进降低风险:通过小步提交的方式,可以有效地控制修改风险。
-
命名一致性很重要:区分输入对象和Schema的命名约定能减少用户困惑。
这次改进使Bee-Agent-Framework的API更加符合Python社区的惯用风格,提升了开发者的使用体验,同时也为框架的长期演进奠定了良好的基础。
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0267cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选









