Skip to content

代码示例与素材索引

本目录用于补足整套《前端转 AI Agent 工程师进阶指南》的“可执行示例层”。前面的主线章节、专题、项目线解决的是方法论和体系设计问题;这里则更偏向“拿来就能改”的最小代码骨架、接口契约、状态设计和截图素材规划。

1. 这个目录解决什么问题

很多学习资料的问题不是没有方法论,而是:

  • 概念讲完后,读者不知道从哪一份代码开始搭。
  • 知道应该做截图或证据材料,但不知道该截什么、怎么命名、怎么归档。
  • 做完项目后,代码、截图、流程图和评测结果分散,后续很难整理成课程或作品集。

因此,这个目录重点补三类内容:

  • 最小代码示例。
  • 接口与状态契约示例。
  • 截图与素材归档规范。

2. 使用方式

建议按下面顺序使用:

  1. 先读章节和专题,明确方法论和边界。
  2. 再看对应示例文档,拿到最小骨架。
  3. 按自己的项目场景改代码、改字段、改状态。
  4. 同步按照素材规范保留截图、流程图和结果样本。
  5. 最后把这些素材沉淀回作品集与面试材料。

3. 示例索引

示例主题对应主线主要语言核心输出路径
示例 01单 Agent 工具调用最小闭环第 3 章Python / TypeScript工具 schema、执行循环、前端状态枚举示例1 单Agent工具调用
示例 02RAG 接口与评测最小闭环第 4-5 章Python / TypeScript检索生成接口、引用结构、前端回答卡片示例2 RAG接口与评测
示例 03工作流状态机与任务面板第 6-9 章TypeScript / Python节点状态、工作流执行器、任务工作台映射示例3 工作流状态机

4. 素材目录

与代码示例配套的素材说明放在:

  • 素材规范:docs/examples/assets/README.md
  • 截图目录:docs/examples/assets/screenshots/
  • 图表目录:docs/examples/assets/diagrams/

5. 推荐阅读顺序

路线 A:先做最小项目

路线 B:先补作品集证据

  • 先看 docs/examples/assets/README.md
  • 再根据项目线去回填截图、链路图和评测结果

6. 和整套指南怎么配合

  • 如果你在走 12 章 主线,这个目录是配套实操层。
  • 如果你在做 4 条项目线,这里可以直接当项目骨架参考。
  • 如果你在准备作品集和面试,这里也是截图和证据材料的统一入口。

7. 可运行代码骨架

  • 总入口:examples/README.md
  • 统一 CLI:examples/run.py
  • 示例 01:examples/example-01-single-agent/main.py
  • 示例 02:examples/example-02-rag/main.py
  • 示例 03:examples/example-03-workflow/main.py