RAG知识库Python脚本编写结果优化提示词

角色定义与任务定位

以高级AI提示词工程师的身份，为RAG知识库构建者或Python后端开发人员设计提示词。目标是生成可直接用于优化RAG系统中Python脚本编写结果的提示方案，使输出的代码注释、文档片段、错误处理建议和示例脚本具备高可读性、行业适配性和知识库检索效率。

适用场景

• 在RAG知识库中为Python脚本添加或优化自然语言注释，提升检索准确率
• 将开发文档或代码片段转换为结构化知识库条目（如函数说明、参数表、返回值示例）
• 针对行业应用（如金融、医疗、法律）生成带领域术语的Python脚本优化建议
• 为文本创作类RAG知识库提供代码改写、日志说明或脚本性能调优提示

核心提示词

以下提示词可直接复制使用，替换括号内内容以适应具体项目：

• 通用优化版：请以RAG知识库优化专家的身份，分析以下Python脚本[粘贴脚本片段]，生成结构化的函数说明、参数类型、返回值示例及错误处理注释，要求每行注释不超过80字符，并使用多级标题（##、###）分隔不同模块。
• 行业适配版：针对[行业名称，如金融风控]知识库场景，优化下方Python脚本，将业务逻辑（如[具体业务规则]）用自然语言描述，并补充典型异常情况的文档字符串，使知识库问答系统能准确匹配用户提问。
• 可读性提升版：将以下Python脚本转化成适合RAG知识库的Markdown格式文档，包含：1）脚本用途摘要（一行）；2）依赖库列表及版本要求；3）每个主要函数的使用示例（带输入输出）；4）常见错误及其解决方案（用表格呈现）。
• 批量优化版：对以下目录中的所有.py文件，为每个文件生成一个知识库条目，条目包含：文件名、核心功能、关键类/函数列表、使用前提条件、性能优化建议（如向量化操作、缓存策略）。

风格方向

• 技术文档风格：精确、简洁，避免冗余形容词，重点在逻辑结构和参数说明。
• 教学/说明风格：适用于文本创作类知识库，可包含类比解释和运行结果截图描述。
• 清单式风格：多用无序列表和编号列表，方便大语言模型分点检索。
• 行业术语风格：根据标签中的行业应用，嵌入行业特定术语（如“回归测试”“数据脱敏”），提升专业性。

构图建议（此处为视觉设计建议，适用于生成配套示意图或代码截图）

• 脚本流程示意图：使用流程图形式展示RAG知识库中Python脚本调用关系，节点采用矩形（函数）、菱形（判断）、圆角矩形（开始/结束），颜色使用蓝灰中性色搭配高亮黄色标注优化点。
• 代码注释可视化：模拟IDE截图效果：左半区为原始代码（灰色背景），右半区为优化后代码（绿色背景），并用箭头标注新增加的文档字符串和类型提示。
• 知识库条目卡片：采用垂直卡片布局，顶部显示“函数名-行号”，中间为参数列表（表格），底部为返回值和异常说明（图标+短文字）。

细节强化

• 注释层次：强制要求函数文档字符串包含Args、Returns、Raises三个部分，且每个参数后标注数据类型和可选范围。
• 错误示例：在提示词中主动要求“每个函数必须附带一个错误示例及正确写法的对比代码块”。
• 版本标签：为每个脚本优化结果添加Python版本适配性说明（如“适用Python 3.9+，需安装numpy>=1.21”）。
• 检索增强：要求为关键变量和函数名添加同义词标签（置于注释的# Synonym: 位置），增加被RAG命中的概率。

使用建议

• 分步应用：先使用“通用优化版”生成初版文档，再根据具体行业通过“行业适配版”二次润色。
• 人工复核：所有经过提示词生成的脚本优化结果，建议由资深开发者检查逻辑正确性后再收入知识库。
• 模板固化：将核心提示词保存为RAG知识库的系统提示模板，在每次摄入新Python文件时自动调用，保证格式统一。
• 迭代测试：用5~10个典型查询问题（如“这个脚本哪个函数处理空值时抛出异常？”）测试知识库召回质量，根据结果调整提示词中的关键词密度和结构层级。