Prompt Engineering Guide:用四条命令在本地跑起完整提示工程教程
【免费下载链接】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(提示工程,即组织自然语言指令让模型按要求输出的技术)教程站,收录技术章节、论文、工具和 AI 智能体资料。读完本文,你能把整套教程在本地跑起来,并能讲清每个章节的数据链路。全站支持 13 种语言,每章都配有可运行的示例。
它替你省了哪几步
找资料要一篇篇翻学提示技术时,你得在论文站和博客里一篇篇找,找不到系统目录。这个站点把 16 种提示技术、模型章节、风险章节固定在侧边栏,你按章节名直接读就能拿到可复制的示例。
看完理论没法验证多数博客只给结论,不给可运行的代码。本项目每个技术章节都对应notebooks/目录下的 Jupyter Notebook(可交互的代码本),你配好 API 密钥就能原样跑通示例。
团队成员水平不一,找不到共同起点新人上手和老手查资料需要两份材料。文档有 13 种语言版本,还附带 1 小时的讲座 PDF,你可以直接把它当团队共读教材。
最小可运行环境
需要 Node 18 以上。克隆仓库后,装依赖、起开发服务器只需四条命令:
git clone https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide cd Prompt-Engineering-Guide pnpm install pnpm dev看到 http://localhost:3000/ 打开后显示站点侧边栏和首页目录,即表示成功。
核心链路怎么走
这个项目的数据流分两层。内容层走"输入→中间处理→输出":输入是你的问题和上下文,中间处理是各技术章节做的改造,输出是模型的回答或工具调用。渲染层由 Next.js 搭配 Nextra 主题(一套 Next.js 文档框架)把pages/目录下的 mdx 源文件编译成多语言页面。
图中每个圆圈对应链路上的一个角色。黄色 Prompt Engineering 负责指令措辞本身。紫色 RAG 负责拉取外部知识。粉色 State/History 负责管理多轮对话的上下文。绿色 Memory 负责长期存储。左下 Structured Outputs 负责让输出可以被机器解析。五者拼起来,就是你喂给模型的完整上下文。
把输入结构化
输入层解决"模型分不清边界"的问题。站点的基础篇和元素篇教你用分隔符包住用户输入,并用字段类型清单约束内容。结构化输出是关键一招。你指明字段的取值范围,比如优先级用 1 到 5 而不是 1 到 10,模型就不会自己发挥。
引导中间推理
中间层解决"模型急着下结论"的问题。CoT(思维链提示法,让模型先展示推理过程再作答)要求模型先列步骤再给答案。站点用一道数学应用题对比两种写法:
左栏普通提示让模型在应用题上答错,右栏思维链示例让它展示算式,答案正确。章节还延伸到零样本思维链:只在提示末尾加一句"逐步思考"也能生效。
稳定输出结果
输出层解决"事实漂移"的问题。RAG(检索增强生成,先查资料再生成答案)让系统先检索相关文档,再把文档拼进上下文交给模型生成。这样不用重训模型,知识也能保持更新:
图中链路是:输入先进检索器,检索器查文档库,命中的文档与原始提示拼接,最后由生成器产出答案。
跟一次真实请求
这里选guides/里的多智能体深度研究工作流做样本,从触发到回传完整走一遍。
图中的 Agent 是核心,向下接工具、记忆、规划三个模块。用户请求从上方进入,由 Agent 决定调哪个工具、写哪段记忆。
时间线是:你向 Webhook(让外部系统触发流程的入口)发出"OpenAI 最新研发动态" → 搜索规划器把它拆成两个子任务 → 搜索协调器按优先级执行搜索并收集结果 → 摘要器整理成报告 → 以 Markdown 形式回传给 Webhook。链路中有三个关键分叉点。规划器必须输出带 id 和优先级的结构化子任务,因为协调器按字段派发,格式错乱整条链路停摆。当前时间由工具注入而不是靠模型记忆,因为模型猜"上周"会给出错误日期范围,搜索就会不准。报告回传 Webhook 而不是直接打印,因为请求闭环后调用方才能继续做下游处理。
上手节奏建议
先从入门章节读起。打开仓库里的 basics.en.mdx,把文档里的零样本示例拷进一个 LLM 试玩,体会提示和裸问的差异。
再转入技术章节。读一遍思维链章节,然后打开 pe-lecture.ipynb 这个笔记本,跟着跑一遍推理示例,亲眼看到模型的分步输出。
最后上智能体组装。照着深度研究流程,用任意工作流工具复刻一条"拆解→搜索→总结"的两节点链路,并给每个节点写一份带字段示例的系统提示。
高频问题速查
遇到克隆后终端提示 pnpm 不是内部命令,通常是 pnpm 没装导致的,处理方式是运行 npm i -g pnpm 再重新安装依赖。
遇到启动时报 3000 端口被占用,通常是本地另一个服务占用了端口,处理方式是停掉旧进程或换一个端口再起 dev 服务器。
遇到某个章节中文内容为空,通常是该章节还没写 .zh 翻译文件导致的,处理方式是看 pages/ 目录下是否有对应的 .zh.mdx 文件,没有就切到英文版读。
遇到模型输出格式漂移、下游解析失败,通常是提示里没给字段示例导致的,处理方式是在提示里贴一份 JSON 样例,并写清每个字段的类型和取值范围。
下一步动作:打开入门章节的 basics.en.mdx,照着文档里的例子写出你的第一条结构化提示。
【免费下载链接】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),仅供参考