Instructor 采用 llms.txt：让文档更便于 AI 理解¶
我们很高兴地宣布，Instructor 现在实现了 llms.txt 规范！您现在可以在 python.useinstructor.com/llms.txt 找到我们的 llms.txt 文件。此次采用标志着我们朝着让文档更易于 AI 语言模型访问迈出了重要一步。
什么是 llms.txt？¶
llms.txt 规范由 Jeremy Howard 和 Answer.AI 团队开发，解决了 AI 与文档交互中的一个关键挑战：大多数网站的上下文窗口太小，并且包含导航、广告和 JavaScript 的 HTML 页面难以被 LLM 有效处理。
可以将 llms.txt 视为 AI 语言模型的 robots.txt——一种帮助 AI 系统理解和导航文档的标准化方法。虽然 robots.txt 告诉搜索引擎可以索引哪些内容，但 llms.txt 帮助 AI 模型找到并理解有关您项目的最相关信息。
为什么 Instructor 采用 llms.txt¶
作为一个专注于 LLM 结构化输出的库，我们实施这一标准是完全合理的。原因如下：
-
更好的 AI 集成：我们的用户经常通过 AI 编码助手与 Instructor 交互。拥有 llms.txt 文件有助于这些工具更好地理解我们的文档。
-
更清晰的文档访问：AI 模型现在可以直接访问我们文档的干净 Markdown 版本，而无需解析完整的 HTML 文档。
-
支持标准：我们相信标准化 AI 模型与文档交互方式的重要性。通过尽早采用 llms.txt，我们正在帮助建立对 AI 友好的文档的最佳实践。
这对用户意味着什么¶
如果您在使用 Instructor 时使用 GitHub Copilot、Claude 或 Cursor 等 AI 编码助手，您应该会注意到：
- 更准确的代码建议
- 更好地理解 Instructor 的功能
- 更相关的文档引用
例如，当您向 AI 助手询问 Instructor 的功能时，它现在可以通过 llms.txt 文件直接访问我们的 Markdown 文档，而无需尝试解析我们的 HTML 文档。
工作原理¶
我们的 llms.txt 文件提供了：
- Instructor 的简明概述
- 关键文档的 Markdown 格式链接
- 关于用法和最佳实践的重要说明
- 示例代码和教程的参考
AI 模型可以使用这些信息更好地理解：
- Instructor 的核心概念
- 如何使用我们的关键功能
- 实施的最佳实践
- 在哪里找到详细文档
实施 llms.txt¶
llms.txt 规范正在得到广泛采用，我们鼓励其他 Python 库和框架也实施它。以下是如何将 llms.txt 添加到您的项目中：
- 在您的文档根目录下创建
/llms.txt文件 - 遵循标准格式
- 包含关键信息和 Markdown 链接
- 使用各种 AI 助手进行测试
展望未来¶
这仅仅是个开始。随着越来越多的项目采用 llms.txt，我们期望看到：
- 更好的 AI 辅助编码体验
- 更标准化的文档访问
- 提高 AI 对代码库的理解
- 增强人与 AI 之间的协作
我们很高兴能成为建立此标准的一份子，并期待看到它如何发展。如果您有兴趣了解更多关于 llms.txt 的信息或想讨论其实现，请在 GitHub 或 Twitter 上联系我们。
有关 llms.txt 规范的更多详细信息，请查看官方仓库，并加入关于如何使文档更对 AI 友好的讨论。
祝您编码愉快！