LLMs.txt:让AI轻松读懂你的网站,开启智能文档新纪元
{ "description": "LLMs.txt is a new standard, akin to sitemap.xml, designed for AI. It provides a Markdown index of a website's content, enabling AI assistants to access clean, structured information efficiently, bypassing complex webpage code. Apifox has implemented automatic support for this feature." }
背景:为什么需要LLMs.txt?
随着人工智能特别是大语言模型(LLMs)的飞速发展,越来越多的AI助手能够联网并直接读取网页信息。这为知识获取和自动化软件开发带来了巨大便利。
然而,传统网页结构包含HTML、CSS以及大量为浏览器设计的JavaScript脚本。对于AI助手而言,这些内容不仅无用,还会造成信息噪音、处理延迟,并快速消耗Token,严重影响文档加载速度和AI的理解效率。
解决方案:LLMs.txt应运而生
为了解决这个问题,Answer.AI于2024年9月提出了创新方案:建议网站为每个页面提供Markdown友好的内容版本,并在网站根目录增加专为LLMs优化的索引文件——llms.txt。
llms.txt文件类似于站点地图sitemap.xml,但它是专门为AI设计的,专注于提供结构化、简明、易理解的信息。
LLMs.txt长什么样?如何工作?
llms.txt实际上是一个Markdown格式的文本文件,放在网站根目录,里面索引了网站内所有可供LLM处理的Markdown页面。此外,它还可以简要描述每个页面的内容、用途以及相关属性。
访问某个页面时,只需在其HTML URL后加上.md后缀,即可打开Markdown版本。这样,AI助手读取内容时无需解析复杂的网页结构,只需聚焦精炼的信息,大幅提升响应速度和理解能力。
简单来说,llms.txt就是AI领域的sitemap.xml。
Apifox已全面支持LLMs.txt
Apifox目前已支持使用llms.txt,你可以在“在线文档”功能中使用。例如,Apifox的帮助文档就已经启用了llms.txt。
如何在Apifox启用和使用llms.txt?
默认开启,无需手动配置,每个已发布的在线文档都会自动生成llms.txt和Markdown页面。
在“在线文档”中,你将看到以下新功能按钮:
- 「复制页面」:一键复制当前页面的Markdown内容
- 「以Markdown格式查看」:直接浏览当前Markdown内容
- 「llms.txt」:访问整站的llms.txt索引文件
如果你还没有发布“在线文档”,或者需要关闭llms.txt,可以在「分享文档 > 发布文档站 > AI相关特性」中进行配置。
让AI助手使用llms.txt的两种方法
方法一:将Markdown链接分享给可联网的AI助手
- 直接给文档页面URL加上.md后缀
- 或点击“以Markdown格式查看”按钮
- 在AI助手(如腾讯元宝、Cursor、ChatGPT Plus等)中输入链接
- 例如:“请查看 https://xxx.apifox.cn/api-xxxxxx.md 获取API详细信息”
- 在Cursor中使用 @https://xxx.apifox.cn/api-xxxxxx.md 作为上下文
方法二:复制Markdown内容给无法访问URL的AI
- 点击“复制页面”按钮
- 将内容粘贴到AI对话中
- 例如:“基于这个API定义生成TypeScript客户端代码:……”
这样,无论AI是否能够联网访问网页,你都可以顺利对接。
常见问题答疑
如何关闭llms.txt?
在Apifox中进入「分享文档 > 发布文档站 > AI相关特性」进行关闭。
是否影响安全?
不会!llms.txt只包含已发布的公开内容,未授权的私密内容无法被访问。
有权限控制吗?
如果配置了密码/IP/邮箱白名单,访问llms.txt及Markdown页面也需要进行鉴权。
AI不能解析URL怎么办?
手动复制“复制页面”里的Markdown内容给AI。
是否需要额外维护?
无需人工干预,系统自动生成,你只需专注写好原始API文档即可。
如何检查功能是否正常?
访问你文档站点的根目录/llms.txt,如能正确显示即表示功能已生效。
复杂模型(如数据引用)怎么办?
Apifox会智能递归解析,自动组合多层嵌套,保证内容清晰、易读。
总结
llms.txt正在成为AI读懂你网站/API文档的标准入口。它为API文档与AI的深度集成铺平了道路。通过它,无论你的AI是否有MCP能力、是否能联网,都能便捷地读取和理解你的文档内容,让AI真正成为团队开发的加速器。
赶快在Apifox上试试吧,让你的API文档全面融入AI时代!
版权与免责声明:本文仅用于信息分享与交流,不构成任何形式的法律、投资、医疗或其他专业建议,也不构成对任何结果的承诺或保证。
文中提及的商标、品牌、Logo、产品名称及相关图片/素材,其权利归各自合法权利人所有。本站内容可能基于公开资料整理,亦可能使用 AI 辅助生成或润色;我们尽力确保准确与合规,但不保证完整性、时效性与适用性,请读者自行甄别并以官方信息为准。
若本文内容或素材涉嫌侵权、隐私不当或存在错误,请相关权利人/当事人联系本站,我们将及时核实并采取删除、修正或下架等处理措施。 也请勿在评论或联系信息中提交身份证号、手机号、住址等个人敏感信息。