什么是 LLMs.txt?一文讲述

llms.txt 是一个 Markdown 格式的文本文件,放在网站根目录,里面索引了网站内所有可供 LLM(大模型)处理的 Markdown 页面。此外,它还可简要描述每个页面内容、用途以及相关属性。

用 Apifox,节省研发团队的每一分钟

什么是 LLMs.txt?一文讲述

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

背景:为什么需要 LLMs.txt?

随着人工智能特别是大模型(LLMs, Large Language Models)的飞速发展,越来越多的 AI 助手能够联网并直接读取网页信息。这为知识获取和自动化软件开发带来巨大便利。然而,传统网页结构包含 HTML、CSS 以及大量为浏览器设计的 JavaScript 脚本。对于 AI 助手而言,这些内容不仅无用,还造成信息噪音、处理延迟,并快速消耗 Token,影响文档加载速度和 AI 的理解效率。

 
为了解决这个问题,Answer.AI 于 2024 年 9 月提出了全新方案:建议网站为每个页面提供 Markdown 友好的内容版本,并在网站根目录增加专为 LLMs 优化的索引文件——lms.txt。llms.txt 文件类似于站点地图 sitemap.xml,但 llms.txt 面向 AI 设计,专注于结构化、简明、易理解的信息。

 

llms.txt 长什么样?如何工作?

llms.txt 实际上是一个 Markdown 格式的文本文件,放在网站根目录,里面索引了网站内所有可供 LLM(大模型)处理的 Markdown 页面。此外,它还可简要描述每个页面内容、用途以及相关属性。

 
访问某个页面,只需在其 HTML URL 后加 .md,即可打开 Markdown 版本。这样,AI 助手读取内容时无需解析复杂网页,只需聚焦精炼的信息,大幅提升响应速度和理解力。

 
简化来说,llms.txt 就是 AI 领域的 sitemap.xml

什么是 LLMs.txt


Apifox 目前已支持使用 llms.txt,你可以在“在线文档”中使用,例如 Apifox 的帮助文档就启用了 llms.txt。

 

如何在 Apifox 启用和使用 llms.txt?


默认开启,无需手动配置,每个已发布的在线文档均会生成 llms.txt 和 Markdown 页面。

 
在“在线文档”中,你将看到以下新功能按钮:

  • 「复制页面」:一键复制当前页面的 Markdown
  • 「以 Markdown 格式查看」:直接浏览当前 Markdown 内容
  • 「llms.txt」:访问整站的 llms.txt 索引文件
什么是 LLMs.txt


如果你还没有发布“在线文档”,或者需要关闭 llms.txt,那么可以在「分享文档 > 发布文档站 > AI 相关特性」中进行配置。

什么是 LLMs.txt

 

让 AI 助手使用 llms.txt 的两种方法

方法一:将 Markdown 链接分享给可联网的 AI 助手

  1. 直接给文档页面 URL 加 .md 后缀,或点“以 Markdown 格式查看”
  2. 在 AI 助手(如腾讯元宝、Cursor、ChatGPT Plus 等)中输入链接,例如:
  • “请查看 https://xxx.apifox.cn/api-xxxxxx.md 获取 API 详细信息”
什么是 LLMs.txt


  • Cursor 中用 @https://xxx.apifox.cn/api-xxxxxx.md 作为上下文
什么是 LLMs.txt

 

方法二:复制 Markdown 内容给无法访问 URL 的 AI

  1. 点击“复制页面”
  2. 粘贴到 AI 对话,例:“基于这个 API 定义生成 TypeScript 客户端代码:……”
什么是 LLMs.txt

这样,无论 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 时代!

Apifox 新版
Apifox 

了解更多: