Prompt Engineering 指南教程:如何写好提示词,并打通 RAG 与 AI Agent
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
Prompt-Engineering-Guide 是一份开源的 Prompt Engineering(提示工程)指南,围绕提示词设计、RAG 与 AI Agent 三大主题,系统整理了论文、教程、讲义和可运行笔记本。它适合想提升大模型输出质量的开发者和学习者,跟着目录就能从入门读到进阶。
😩 为什么你写的提示词总不听话
你可能遇到过这种情况:问模型一个业务问题,它编出一堆看似合理但实际错误的答案;让模型"按 JSON 格式输出",结果十次里有三次多了一行解释文字;换个模型,同样的提示词效果又打了对折。
根源在于:提示词不是"说话",而是"写规格"。模型不会读心,它只会按你给出的指令、上下文和示例来生成。这个仓库的价值就在于,把散落在论文和博客里的提示词技巧,整理成了一份可以按图索骥的地图:哪里该加上下文、哪里该拆步骤、哪里该引入检索和工具。
🗺️ 一张图看懂项目怎么组织知识
这张图展示了指南中最核心的一个技术——RAG(检索增强生成):模型回答前,先从文档库(Document store)里检索相关资料(Retrieved Documents),把资料和问题一起交给语言模型(Generator)生成回答(Response)。
整个仓库也是按这条主线展开的:pages/下分 introduction(基础)、techniques(技巧)、applications(应用)、risks(风险)四大板块;notebooks/提供可运行的示例代码;guides/收录提示词模板合集。
🚀 4 步快速上手这份指南
- 克隆仓库到本地:
git clone https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide - 安装依赖:项目基于 Next.js 构建,运行
pnpm install - 本地启动文档站:
pnpm dev,浏览器打开控制台给出的地址即可按目录学习 - 不想跑本地服务的话,直接从 pages/introduction/basics.en.mdx 开始逐篇阅读,每篇都带示例
🧩 核心功能走查
提示词设计基础:角色、上下文与示例
这是使用频率最高的部分。指南从一个经典案例讲起:把"天空是"(The sky is)交给模型,它只补一个词;但改成"补全句子:天空是",输出立刻完整。差别就在指令是否明确。
实际使用时,建议按 system(设定行为)+ user(传入任务)两层组织提示词,并给模型一条"不确定就回答不知道"的兜底规则,能明显减少编造。
RAG 检索增强生成:让模型基于你的资料回答
解决"模型不知道你的私有数据"这个高频问题。做法是把内部文档切块入库,提问时先检索相关片段,再拼进提示词。仓库在 pages/techniques/rag.en.mdx 讲了原理,notebooks/pe-rag.ipynb提供了可运行的完整流程,跟着单元格执行一遍就能跑通。
AI Agent:给模型装上工具和记忆
当任务需要查数据库、调 API 或分多步执行时,单个提示词就不够了。指南的pages/agents/章节介绍了 Agent 的三件套:Tools(调用外部工具)、Memory(保存状态)、Planning(拆解任务)。
图中用户请求进入 Agent 后,由 Agent 自主决定调用哪个工具、写什么记忆、如何规划下一步,这正是提示词从"一问一答"走向"自动干活"的关键一步。
⚠️ 避坑与常见问题
现象:模型一本正经地编造事实。原因:提示词里只有问题,没有任何事实依据。解决办法:把相关资料作为 context 拼进提示词,或改用 RAG 检索后再生成,并加一句"资料中没有就说不知道"。
现象:输出格式时好时坏,下游代码解析失败。原因:格式要求写得太笼统,比如只说"输出 JSON"。解决办法:在提示词里直接给出字段名和示例结构,越具体越稳定。
现象:在仓库里找不到某个章节。原因:所有页面按"主题.语言码"命名,比如中文是basics.zh.mdx、英文是basics.en.mdx,共 13 种语言。解决办法:用主题英文名在pages/目录下搜文件名前缀即可。
📚 资源索引
- 官方文档:pages/introduction/basics.en.mdx、pages/techniques/cot.en.mdx
- 源码目录:notebooks/、guides/
- 延伸阅读:pages/papers.en.mdx、pages/tools.en.mdx
这份指南的价值不在"读一遍",而在"查得到":每次遇到模型不听话的场景,都能在这里找到对应的章节和示例。建议把它留在本地仓库里,配合 notebooks 边读边跑,提示词质量会稳定地往上走。
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考