专业版RAG知识库代码生成调试提示词

角色定义

以RAG知识库架构师与高级开发工程师的身份，目标是生成一份可直接投入生产的、具备可调试性与可维护性的RAG知识库代码。你需要把控从文档加载到检索生成的完整链路，强调代码清晰度、异常处理与运行时的可见性，让后续的调试与迭代变得高效可控。

适用场景

• 构建企业级RAG知识库原型系统，需要快速验证检索与生成效果。
• 调试现有RAG代码中的召回缺失、生成幻觉或性能瓶颈。
• 团队内部需要一套标准化的代码模板，用于统一开发风格与调试流程。
• 在AI对话工具（如ChatGPT、Claude）中作为系统提示词，用于辅助生成或审查代码。

核心提示词

以下是一段可直接复制使用的提示词文本，用于引导AI生成或调试RAG知识库代码：

• “生成一个完整的RAG知识库代码，使用LangChain框架（或LlamaIndex），包含以下模块：文档加载器（支持PDF、TXT、Markdown）、文本分割器（chunk_size=500, overlap=100）、嵌入模型（text-embedding-3-small或本地bge）、向量数据库（Chroma或FAISS）、检索器（支持MMR或相似度检索）、LLM链（调用GPT-4或本地模型）。要求：每个步骤添加详细日志输出（使用logging模块，级别INFO），打印加载文档数量、分割后chunk数、嵌入耗时、检索结果top-3及相似度分数；异常处理完备（try/except捕获文件加载、API调用、数据库连接等错误）；函数独立封装，主流程清晰可读；变量命名遵循PEP8；提供单元测试示例（pytest）以验证各模块正确性。”
• 附加要求：“添加超时重试机制（用于LLM调用），支持缓存检索结果（使用LRU缓存），并输出性能监控指标（每步耗时统计）。”

风格方向

• 工业级代码风格：类型注解完整、docstring规范、符合企业Python开发标准。
• 可调试优先：日志详尽但不冗余，支持通过日志级别切换控制输出；支持断点友好地分离各阶段。
• 模块化：每个功能（加载、分割、嵌入、检索、生成）为独立类或函数，接口清晰。
• 配置驱动：关键参数（模型名称、chunk大小、top-k等）抽离为配置文件或环境变量。

构图建议

这里的构图指代码结构与模块组织方式，建议采用以下分层架构布局：

• 入口层：main.py，读取配置，依次调用各模块，输出最终回答。
• 数据层：data_loader.py（多格式支持）、text_spliter.py、embedding_provider.py、vector_store.py。
• 检索层：retriever.py（支持多种检索策略）、reranker.py（可选）。
• 生成层：llm_chain.py（对话+检索结果注入）、memory.py（可选对话记忆）。
• 调试层：logger_config.py、performance_monitor.py、exception_handler.py。

视觉上可参考UML组件图或系统架构图，但代码实现建议按此目录组织，以便快速定位问题。

细节强化

• 文档加载器支持编码自动检测（如chardet），避免乱码导致调试困难。
• 文本分割后自动计算并记录每个chunk的源文档、页码、字符数，便于溯源。
• 嵌入层加入本地缓存（pickle或sqlite），避免重复计算相同文本。
• 检索结果输出包含metadata（文件名、页号）与相似度分数，方便人工核对。
• LLM调用使用流式输出（stream=True）并记录首token延迟，辅助分析生成卡顿。
• 提供一键运行脚本（run.sh）与dockerfile，确保环境一致，减少“在我电脑上能跑”的问题。

使用建议

• 将上述核心提示词粘贴至AI对话工具（如ChatGPT、Claude、Copilot）的输入框，即可获得一段完整的可调试RAG代码。
• 若需调试已有代码，可将核心提示词中“生成”改为“审查并改进以下代码”，并附上待调试代码。
• 推荐结合版本控制（git），每完成一个模块后提交，方便回滚和对比调试更改。
• 实际运行时，先将日志级别设为DEBUG以观察完整链路，稳定后降为INFO；性能监控数据可输出到csv文件用于调优。