跳到主要内容

使用文档配合 AI 工具

潞晨云文档站支持 llms.txt 协议,用户既可以直接浏览文档,也可以将其无缝集成到支持该协议的 AI 工具中,让 AI 基于潞晨云文档提供更准确的回答。

1. 在 Cursor 中使用文档

1.1 配置文档数据源

  1. 打开 Cursor 项目,按 Command + L(macOS)或 Ctrl + L(Windows/Linux)打开聊天面板
  2. 在输入框中输入 @,从弹出菜单中选择 Docs
  3. 点击 Add new doc
  4. 输入文档地址:https://cloud.luchentech.com/doc/llms.txt
  5. 点击确认,等待文档索引完成

1.2 使用文档

配置完成后,在 Cursor 聊天中输入 @Docs 即可选择潞晨云文档作为上下文,向 AI 提问有关潞晨云 API、模型使用等问题,AI 将基于文档内容给出回答。

2. llms.txt 协议简介

2.1 协议背景

llms.txt 是一种 Web 标准,旨在帮助大语言模型更高效地访问和理解网站内容。网站在根目录放置 llms.txt 文件,即可为 AI 系统提供清晰的导航与内容摘要,从而提升信息检索的准确性。

2.2 文件结构

llms.txt 文件采用 Markdown 格式,通常包含以下部分:

  1. 标题:网站或项目名称
  2. 摘要:对网站或项目的简要介绍
  3. 章节列表:列出网站的重要章节,每个章节包含链接和简要说明

潞晨云文档站的 llms.txt 示例(完整内容见 https://cloud.luchentech.com/doc/llms.txt):

# 潞晨云文档

> 潞晨云平台完整文档。快速入门、模型 API、微调 SDK、教程、常见问题等开发资源。

## 模型 API

### 用户指南

- [快速入门](https://cloud.luchentech.com/doc/docs/Model-APIs/User-Guides/QuickStart.md): ...
- [文本模型](https://cloud.luchentech.com/doc/docs/Model-APIs/User-Guides/Text-Models.md): ...
...

2.3 文件用途

/llms.txt

提供 AI 友好的文档导航索引,方便 LLM 快速发现和定位所需内容。类似于为 AI 做的搜索引擎优化——用户可以通过通用 LLM 直接获取潞晨云产品的具体信息。

各文档 .md 文件

每篇文档的纯文本版本(如 https://cloud.luchentech.com/doc/docs/Model-APIs/User-Guides/QuickStart.md),AI 工具可直接将其加载到上下文中,获取完整的文档细节。

2.4 与现有标准的区别

llms.txt 与 robots.txt、sitemap.xml 在功能上有部分重叠,但用途和定位不同:

  • robots.txt:用于指示搜索引擎爬虫哪些页面可以或不可以抓取,主要关注访问控制
  • sitemap.xml:提供网站的结构地图,帮助搜索引擎了解页面布局,主要用于索引
  • llms.txt:为大语言模型提供结构化的内容概览,帮助 AI 系统更好地理解和处理网站信息,提升与 AI 的交互质量

3. 在其他工具中使用

其他支持 llms.txt 协议 的工具同样可以使用潞晨云文档。例如在 ChatGPT 中,可以直接将 https://cloud.luchentech.com/doc/llms.txt 作为文档链接添加到对话上下文中。在 Windsurf、Cline 等支持类似功能的工具中,操作方式也类似——找到添加外部文档或数据源的入口,填入 llms.txt 地址即可。

4. 延伸阅读