LangChain通过标准化页面和改进的API参考增强集成文档
realtime news Aug 16, 2024 16:22
LangChain进行了集成文档的全面改造，采用标准化格式和增强的API参考，以加快信息检索速度。
LangChain生态系统的重要组成部分是其广泛的集成集合。LangChain提供了超过1,000个与LLM、向量存储库、工具、文档加载器等的集成。今天，LangChain团队宣布对其Python和JavaScript集成文档进行了重大改革，旨在根据LangChain博客使其对社区更有用更易访问。
所有集成页面的标准化内容
在过去的一年半中，LangChain社区贡献了超过1,000个开源集成，包括聊天模型、向量存储库、工具和检索器。随着集成数量的增长和最佳实践的发展，许多文档页面已经过时。
关键集成现在遵循一个标准化模板，突出每个类别的常见功能（例如，模型、向量存储库、检索器）。例如，聊天模型页首先会显示一个表格，显示某个集成是否支持诸如工具调用和多模态输入等功能，然后是安装和基本调用示例。
我们对这些重新设计的集成页面的目标是帮助开发人员快速识别集成可以做什么以及如何使用它。
虽然一些高级、特定集成的示例仍保留在这些页面上，但更多的重点放在链接到操作指南和API参考，以保持内容的长期有效性并避免重复。
新索引页以简化搜索
为了帮助开发人员找到他们需要的集成，LangChain简化了每种类型集成的索引页。结合较小的侧边栏，这些索引页现在包含类似于单个集成页面的表格，允许快速识别具有所需功能的集成。
这些“Features”表格目前根据多个因素排序，包括在LangSmith追踪中的使用情况和软件包下载量。LangChain计划探讨更多方法来突出和展示新兴的集成。
改进的API参考
新文档页面显著地展示了改进的Python和JavaScript API参考。
对于Python，更多的解释和用法示例已添加到docstrings中。结构和格式已更新为更现代和用户友好的，包括一个可导航的所有类的方法和属性的侧边栏。
对于JavaScript，通过默认折叠侧边栏、滤除不太相关的方法和其他生成工件，API参考页面变得不那么令人生畏。热门的聊天模型和向量存储页面已增强了各种用例示例，并且有用的运行时和构造函数定义及重要方法的可见性得到了普遍改善。
这一持续工作旨在使API参考成为LangChain社区的宝贵资源。
Image source: Shutterstock