Langchainrb项目中的OpenAPI规范生成器演进
2025-07-08 15:22:54作者:俞予舒Fleming
在Langchainrb项目中,开发团队一直在探索如何优化工具(Tool)的创建体验。工具类是指那些可以被AI助手调用的功能模块,它们需要遵循OpenAPI规范来定义接口。本文将介绍该项目从手动编写JSON规范到自动化生成的演进过程。
早期方案:手动编写JSON规范
最初,Langchainrb要求开发者手动编写JSON格式的OpenAPI规范文件。这种方式存在几个明显问题:
- 规范文件编写复杂且容易出错
- 维护成本高,任何接口变更都需要同步修改JSON文件
- 缺乏类型安全,Ruby本身是动态类型语言
项目中的database.json就是一个典型的例子,开发者需要完整定义每个接口的路径、参数、返回值等信息。
技术探索:自动化生成方案
团队开始探索使用LLM来自动生成OpenAPI规范的可能性。核心思路是:
- 设计一个YAML格式的提示模板,指导LLM理解Ruby类结构
- 创建Generator类,负责与LLM交互并输出最终的JSON文件
- 将生成器放置在utils或generators目录下
这种方案的优势在于可以利用LLM的理解能力,将Ruby类自动转换为符合规范的API描述。
类型注解的挑战
在探索过程中,团队注意到Python生态中Google的解决方案——通过函数签名和文档字符串自动生成工具定义。然而,Ruby缺乏内置的类型注解系统,这使得类似的自动化方案在Ruby中实现更具挑战性。
最终解决方案:工具定义扩展
经过多次迭代,项目最终采用了更优雅的解决方案——通过Langchain::ToolDefinition模块扩展工具类。新方案的特点包括:
- 不再需要继承自基类,只需扩展工具定义模块
- 使用define_function方法显式声明要暴露的接口
- 支持在方法级别定义详细的参数和返回值说明
这种声明式API不仅简化了开发流程,还提高了代码的可读性和可维护性。开发者现在可以专注于业务逻辑实现,而无需关心底层的规范文件生成。
演进意义
这一演进过程体现了几个重要的工程实践:
- 从手动配置到自动化生成的转变,提高了开发效率
- 充分利用语言特性(Ruby的模块扩展)而非对抗语言限制
- 保持API简洁性的同时提供足够的表达能力
新方案特别适合Ruby开发者,因为它遵循了Ruby社区的惯用模式,同时解决了AI助手集成中的技术难题。这一改进使得Langchainrb在Ruby生态中的AI集成变得更加自然和高效。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
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).Dockerfile014
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
251
2.49 K
deepin linux kernel
C
24
6
Ascend Extension for PyTorch
Python
93
120
暂无简介
Dart
550
122
React Native鸿蒙化仓库
JavaScript
217
300
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
600
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
595
128
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
410
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
356
1.76 K
openGauss kernel ~ openGauss is an open source relational database management system
C++
153
204