综合介绍
llms.txt是一个专门为大语言模型(LLM)设计的标准化文档格式,旨在帮助网站提供简洁、结构化的信息,便于LLM在推理过程中高效利用。这个规范得到了Cloudflare和Anthropic等知名公司的支持。通过使用llms.txt文件,网站可以为AI编程工具提供准确上下文信息,快速实现目标功能。
功能列表
- 提供标准化的文档格式,便于LLM解析
- 支持多种应用场景,如API文档、开发者指南等
- 兼容现有网络标准,如sitemaps和robots.txt
- 帮助网站提高信息的可访问性和利用率
- 支持自动化工具和AI编程工具的集成
使用帮助
安装流程
llms.txt文件不需要安装,只需在网站根目录下创建一个名为llms.txt的Markdown文件,并按照标准格式填写相关内容即可。
使用流程
- 创建llms.txt文件 :在网站根目录下创建一个名为llms.txt的Markdown文件。
- 填写背景信息 :在文件中提供简洁的背景信息,帮助LLM理解网站的主要内容和用途。
- 添加指导内容 :提供关于如何使用网站的指导内容,帮助LLM更好地解析和利用网站信息。
- 链接详细信息 :在llms.txt文件中添加指向详细Markdown文件的链接,这些文件可以包含更具体的信息,如API文档、产品说明等。
- 保持文件更新 :定期更新llms.txt文件,确保信息的准确性和时效性。
示例
# llms.txt
## 背景信息
本网站提供关于大语言模型(LLM)使用的详细文档和指导内容,旨在帮助开发者和用户更好地理解和利用LLM技术。
## 指导内容
- 如何使用本网站的API文档
- 常见问题解答
- 开发者指南
## 链接
- API文档
- 开发者指南
- 常见问题解答
参考
https://developers.cloudflare.com/llms-full.txt
https://docs.anthropic.com/llms-full.txt
https://docs.play.ai/llms-full.txt
通过以上步骤,您可以轻松创建一个llms.txt文件,帮助LLM更好地利用您的网站信息。
相关新闻:通过 /llms.txt 简化 AI 文档
我们的团队最近发布了对 /llms.txt 和 /llms-full.txt 的支持,这意味着 Mintlify 现在可以自动生成并托管所有纯文本格式的文档,以便大型语言模型 (LLM) 更容易地摄取。
在 2024 年 9 月,Answer.AI 的联合创始人 Jeremy Howard 提出了 /llms.txt 文件格式,作为网站向 LLM 提供关键信息的标准化方式。这种基于 Markdown 的文件将网站的内容提炼成简洁、结构化的格式,避免了 LLM 解析复杂的 HTML、广告或 JavaScript 的需要。
通过采用这个标准,我们正在朝着未来迈进,届时每家公司都将提供两个版本的文档:一个版本供人类使用,另一个版本供 LLM 使用。
文档是为了传递答案
在 AI 出现之前,从文档中找到答案可能就像猜谜游戏。
在文档中搜索取决于是否使用了正确的关键词。如果您搜索“invoice editing”(发票编辑),但文档中将其称为“billing adjustments”(账单调整),那么您就没辙了。如果没有有效的搜索,客户通常不得不费力解读导航层级结构,并浏览无休止的页面。
人们可能会尝试转向第三方搜索引擎来查找正确的文档或相关的社区论坛。但这依赖于强大的 SEO,并且也要碰运气才能使用正确的关键词——又是一次掷骰子。
在 Mintlify,我们专注于通过以下方式解决这些挑战:
- SEO 优化:例如,我们提供在子目录而不是子域名下托管。
- AI 聊天:我们的聊天小部件使用您的文档作为知识库智能地回答问题,无需精确的关键词。
帮助 AI 帮助你
现在,我们正在为 LLM 提供一种更好的方式来处理文档,帮助人们使用 AI 工具来查找和应用关于您产品的信息:
/llms.txt: 面向 AI 的大规模友好导航
这个自动生成的 Markdown 文件提供了您整个文档导航的简化视图,允许像 ChatGPT 或 Perplexity 这样的 LLM 更容易地索引您的内容。可以将其视为 AI 的 SEO——用户现在可以直接通过通用 LLM 找到特定于产品的信息。
/llms-full.txt: 所有文档集中在一处
这个自动生成的文件将您的所有文档文本编译成一个 Markdown 文件。
一些 AI 工具允许您粘贴链接以将信息直接加载到它们的上下文窗口中。例如,您可以将您的文档提供给像 Codeium 这样的 AI 编码助手,使其能够根据您产品的具体细节(例如您的身份验证流程)提供上下文感知的建议。
您可以使用 /llms-full.txt 提供一个全面的文件,而不是粘贴数十个链接来丰富助手。
下一步
通过采用 /llms.txt 标准,我们很高兴能够帮助为 其在整个行业中的广泛使用 奠定基础。
这些发布仅仅是开始。我们将继续投资于 AI 可以使文档更实用和更易访问的新方法——请继续关注即将到来的重大更新。