专业版RAG知识库API文档生成提示词

角色定义与任务定位
您将扮演资深技术文档架构师，专注于为RAG知识库系统编写高质量API文档。目标是：将RAG技术栈（检索增强生成）的接口能力，以可读性强、结构规范、易于集成的文档形式呈现给后端开发者、算法工程师及集成商。您输出的不是普通说明文，而是一套可直接复用的提示词模板，用于后续自动化生成或人工撰写时统一风格与内容粒度。

适用场景

  快速构建RAG知识库产品的对外API参考手册
  为内部团队提供统一的文档生成规范与示例
  面向行业应用（如企业搜索、客服问答）生成定制化接口说明
  结合知识库构建流程，同步输出文档更新


核心提示词
以下为可直接复制、填充使用的提示词模板：

  基础生成指令：“请以技术文档作者身份，为RAG知识库的 [接口名称] 生成完整API文档。要求包含：接口概述、请求URL、请求方法（GET/POST）、请求参数表（字段名、类型、必填、说明）、请求示例（cURL + JSON body）、响应格式（成功/失败）、错误码列表及说明、调用限制（频率/并发）。”
  知识库专属字段强化：“重点说明知识库ID（knowledge_base_id）、检索策略（retrieval_strategy）、片段数（top_k）、重排序开关（rerank）等RAG核心参数在请求和响应中的含义与典型示例。”
  格式约束：“使用Markdown语法（但最终输出需转为结构化HTML），每个参数表采用三栏或四栏表格，代码块标注语言（如json, bash）。每个错误码附带简短故障排查步骤。”


风格方向

  专业严谨：术语准确（如“向量检索”“分块策略”），避免模糊表述，数据格式严格遵循JSON Schema风格。
  层次分明：大标题层级（H1/H2）对应API分组，小标题用于子接口；正文描述控制在3-5行内，不赘述。
  视觉友好：使用等宽字体呈现代码块，参数表采用固定宽度列，响应示例使用可折叠区块（若HTML中可加折叠组件，则标注建议）。


构图建议

  页面布局：每个API文档页面顶部放置“接口简介”面板（概述+调用地址），下方依次为“请求”“响应”“错误码”三个独立卡片区域，区域间用浅色分割线。
  色彩方向：
    主色：#2B6CB0（深蓝，用于标题、重要字段标记）
    辅助色：#E2E8F0（浅灰，用于表格背景交替行）
    警示色：#E53E3E（红色，用于错误码高亮）
  
  代码块样式：深色背景（#1E293B）+浅色文字（#F8FAFC），行号可选，使用圆角边框与阴影。


细节强化

  参数验证：每个参数除字段类型外，补充校验规则（如“maxLength:1000”“pattern: ^[a-zA-Z0-9_]+$”）。
  典型错误场景：对每个错误码提供一个真实可复现的请求/响应对比示例，帮助开发者快速定位。
  知识库版本关联：在文档头部或页脚注明该API所对应的知识库版本号（如V2.1.0），以及与知识库构建工具的联动说明。
  性能指标：在响应示例中增加响应时间（如 latency: 142ms），并标注SLA阈值。


使用建议

  在生成第一版文档时，先填写“核心提示词”中基础指令的 [接口名称] 与具体字段名，然后批量应用于所有RAG相关接口。
  若面向不同行业（如金融、医疗），可在“请求示例”中添加该行业特有的数据字段（如行业标签、合规标识），并保持通用结构不变。
  对于知识库构建类接口（如“创建知识库”“上传文档”），建议额外生成一份“知识库构建流程总览图”（可配合构图建议中的色彩方案），插入文档的导航页。
  文档发布前，使用“细节强化”中的校验规则列表对所有参数表进行自动化审核，确保无遗漏。