供 AI 工具阅读的文档入口¶
将文档索引地址提供给支持读取网页的 AI 工具,让工具查找并读取相关页面后,回答悦数图数据库开发版的使用问题。
1. 选择文档版本和入口¶
需要固定文档版本时,使用带版本号的地址。以下以v5.3.2为例;使用其他版本时,替换地址中的版本号。
| 入口 | 用途 |
|---|---|
| llms.txt | 主要章节的索引及完整目录链接,适合先了解文档范围。 |
| llms-index.txt | 完整页面目录,包含标题、摘要及网页和 Markdown 地址,适合查找具体语法、配置或教程。 |
使用站点默认版本时,可提供默认版本的 llms.txt。该入口会随站点默认文档版本更新。
2. 向 AI 工具提问¶
查找具体问题的资料时,可将完整目录地址和问题一起提供给工具。复制以下示例,将文档版本、产品版本或镜像标签、问题替换为实际信息:
文档版本:v5.3.2
文档目录:https://dev-docs.yueshu.com.cn/v5.3.2/llms-index.txt
产品版本或镜像标签:<实际版本或镜像标签>
问题:<需要解决的问题>
请先从目录中查找并读取相关页面,再回答问题。
如需给出命令或代码,请核对参数及适用版本。
请引用实际读取的页面地址和章节。
分享配置或报错信息前,移除其中的密码、令牌和业务数据。
3. 获取单篇文档正文¶
完整目录中的每个页面都有网页和 Markdown 两种地址。以 v5.3.2 的 Python SDK 教程为例:
- 网页文档:在浏览器中阅读,便于查看排版和跳转章节。
- Markdown 正文:以纯文本提供同一版本的说明、产品名称和代码示例,便于 AI 工具读取。
AI 工具无法读取链接
在浏览器中打开相关页面的 Markdown 地址,复制正文粘贴给工具;也可保存为.md文件,再上传至支持文件上传的工具。