Files
agent-craft/README.md
T

175 lines
10 KiB
Markdown
Raw Normal View History

2025-10-25 16:32:18 +08:00
# 🤖 Agent Craft
2025-10-24 12:16:22 +08:00
> 智能体开发教学库 | A beginner-friendly guide to building AI agents
2025-11-02 16:03:18 +08:00
[![Python CI](https://github.com/Annyfee/agent-craft/actions/workflows/ci.yml/badge.svg)](https://github.com/Annyfee/agent-craft/actions/workflows/ci.yml)
2025-10-25 16:32:18 +08:00
## 📘 项目简介
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
**Agent Craft** 是一个系统性开源教学项目,采用 **「博客讲解 + 代码实践」双驱动模式**,带你从零构建完整的 AI Agent 开发能力。
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
- 📄 **配套博客详解**:每章内容均配有 CSDN
深度文章,涵盖原理剖析、代码解析与调试技巧
2025-10-28 17:40:49 +08:00
- 💻 **可运行代码仓库**:每个模块对应独立目录,含完整代码、详细注释与运行指引,支持本地复现
2025-10-25 16:32:18 +08:00
- 🚀 内容覆盖:从 **Prompt 工程****LangChain / LangGraph / RAG / SDK 封装**
- ⚙️ 能力进阶:涵盖 **智能体思维链、工具调用、任务规划、多智能体协作**
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
> 💡 本仓库目标:帮助开发者从零构建可运行的智能体应用,真正理解 Agent 的底层逻辑,而不仅仅是“调用框架”。
2025-10-24 12:16:22 +08:00
---
2025-10-25 16:32:18 +08:00
## 🧭 模块总览(16 模块)
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
> 💡 每个模块对应独立目录(含代码、说明与示例),可独立运行与学习。
2025-11-12 11:07:54 +08:00
> 🔥 已更新至 08 LangGraph 基础篇,持续更新中!
2025-10-25 16:32:18 +08:00
2025-11-07 11:02:15 +08:00
| 章节 | 模块 | 博客 | 核心关键词 | 难度 |
|:-----------:|:--------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------:|:----------------------------------------------------|:-----:|
| 🏗️ **基础篇** | [01 Agent 入门 & 环境搭建](https://github.com/Annyfee/agent-craft/tree/main/01_agent_introduction) | [🏠](https://blog.csdn.net/2401_87328929/article/details/153729555) | OpenAI API | ⭐ |
| | [02 LLM 基础调用](https://github.com/Annyfee/agent-craft/tree/main/02_llm_fundamentals) | [🏠](https://blog.csdn.net/2401_87328929/article/details/153735431) | LLM API 调用 · prompt · 上下文记忆 | ⭐ |
| | [03 Function Calling 与工具调用](https://github.com/Annyfee/agent-craft/tree/main/03_function_calling_tools) | [🏠](https://blog.csdn.net/2401_87328929/article/details/153866573) | Function Call · 工具函数封装 | ⭐⭐ |
| ⚙️ **框架篇** | [04 LangChain 基础篇](https://github.com/Annyfee/agent-craft/tree/main/04_langchain_basics) | [🏠](https://blog.csdn.net/2401_87328929/article/details/153978186) | LLM · Prompt · Chain · Memory | ⭐⭐ |
| | [05 LangChain 进阶篇](https://github.com/Annyfee/agent-craft/tree/main/05_langchain_advanced) | [🏠](https://blog.csdn.net/2401_87328929/article/details/154064397) | Agents · 缓存 · 流式输出 | ⭐⭐⭐ |
| | [06 RAG 基础篇](https://github.com/Annyfee/agent-craft/tree/main/06_rag_basics) | [🏠](https://blog.csdn.net/2401_87328929/article/details/154230067) | RAG概念 · Split · Embedding · FAISS · RAG 链 | ⭐⭐ |
| | [07 RAG 进阶篇](https://github.com/Annyfee/agent-craft/tree/main/07_rag_advanced) | [🏠](https://blog.csdn.net/2401_87328929/article/details/154408744) | Chroma · Reranker · RAG工具化 · 集成 | ⭐⭐⭐ |
2025-11-12 11:07:54 +08:00
| | [08 LangGraph 基础篇]() | [🏠](https://blog.csdn.net/2401_87328929/article/details/154576812) | Langgraph三要素 · LangSmith · ReAct · 提示词安全注入 | ⭐⭐⭐ |
| | 09 LangGraph 进阶篇 | 🚧撰写中 | `Multi-Agent` · `Human-in-the-Loop` · “总控-员工”架构 | ⭐⭐⭐⭐ |
2025-11-07 11:02:15 +08:00
| 🧠 **智能篇** | 10 MCP 基础 (Client) | 🚧 | `MCP` 协议 · `CherryStudio` · 消费公共 MCP | ⭐⭐⭐ |
| | 11 MCP 进阶 (Server) | 🚧 | `Streamable HTTP` · `src layout` · 构建私有 MCP | ⭐⭐⭐⭐ |
| | 12 Swarm & Agents SDK | 🚧 | `Swarm` · `Handoff` · “航空公司客服”项目 | ⭐⭐⭐⭐ |
| 🏁 **实战篇** | 13 Streamlit 快速入门 | 🚧 | `st.chat_input` · `st.session_state` · 封装 RAG Agent | ⭐⭐⭐ |
2025-11-09 20:13:00 +08:00
| | 14 综合实战项目 | 🚧 | LangGraph + RAG + MCP + Streamlit + Vercel | ⭐⭐⭐⭐⭐ |
2025-11-07 11:02:15 +08:00
| 🚀 **工程篇** | 15 部署与本地化 | 🚧 | `Ollama` · `LM Studio` · `LangServe` | ⭐⭐⭐ |
| | **16 项目打包与发布** | 🚧 | `pyproject.toml` · `pip build` · `setuptools` · 发布 | ⭐⭐⭐⭐ |
2025-10-24 12:16:22 +08:00
---
2025-10-25 16:32:18 +08:00
## 🧩 当前学习建议(适用于已完成模块)
2025-11-12 11:07:54 +08:00
目前已开放模块:**01 ~ 08**。
2025-10-25 16:32:18 +08:00
建议按顺序学习,每一章都有完整代码示例与注释。
### ✅ 模块 01 — Agent 入门 & 环境搭建
- **目标**:理解 Agent 概念,完成环境配置与首次调用。
2025-10-29 09:17:05 +08:00
- **内容**:环境依赖|API Key 配置|最小可运行 Agent
2025-10-25 16:32:18 +08:00
### ✅ 模块 02 — LLM 基础调用
- **目标**:掌握模型调用逻辑,初步构建智能体能力。
2025-10-29 09:17:05 +08:00
- **内容**:LLM了解与调用|Prompt编写与逻辑构思|多轮对话记忆|独立搭建一个智能体
2025-10-25 16:32:18 +08:00
### ✅ 模块 03 — Function Calling 与工具调用
- **目标**:实现 LLM 调用外部函数,赋予模型“执行力”。
2025-10-29 09:17:05 +08:00
- **内容**Function calling原理|工具函数封装|API接入实践|多轮调用流程|Agent能力扩展
2025-10-25 16:32:18 +08:00
2025-10-29 08:59:58 +08:00
### ✅ 模块 04 — LangChain 基础篇
- **目标**:认识Langchain六大模块,学会用Langchain构建智能体。
- **内容**LLM 调用|Prompt 设计|Chain 构建|Memory 记忆|实战练习
2025-10-30 18:52:51 +08:00
### ✅ 模块 05 — LangChain 进阶篇
2025-10-29 08:59:58 +08:00
2025-10-30 18:52:51 +08:00
- **目标**:掌握Langchain Agents的核心机制,构建能调用工具、持续思考、具备记忆的智能体。
- **内容**Function Calling@tool 工具封装|ReAct 循环|Agent 构建|SQL Agent|记忆+流式|开发优化
2025-11-02 21:00:31 +08:00
### ✅ 模块 06 — Rag 基础篇
2025-11-02 22:55:59 +08:00
- **目标**:理解Rag的概念与整个运行流程,并能够搭建一个可以引用外部知识库获取信息的智能体。
2025-11-02 21:00:31 +08:00
- **内容**:RAG 概念|文本加载与分块 (Load & Split)|向量化 (Embedding)|向量存储 (FAISS)LCEL RAG 链
2025-11-06 18:48:54 +08:00
### ✅ 模块 07 — Rag 进阶篇
- **目标**:学会进阶的Chroma向量数据库,会Reranker精排序,最终将04到07所学的Langchain六大模块完整集成。
- **内容**Chroma 持久化 | Reranker 精排 | RAG 工具化 | Langchain六大模块集成
2025-11-12 11:07:54 +08:00
### ✅ 模块 08 — LangGraph 基础篇
- **目标**:懂得Langgraph的三要素,会使用LangSmith调试当前agent,并能自己写一个简单的Langgraph流程。
- **内容**Langgraph核心三要素|ReAct循环白盒化实现 | LangSmith调试追踪 | 持久化记忆 | 提示词安全注入
> 📌 后续模块将陆续开放(MCP、多智能体、Streamlit等)
2025-10-25 16:32:18 +08:00
---
## 🧠 Agent Craft 的核心学习路径
> “让每个人都能真正理解 Agent 的底层逻辑,而不仅仅是调用框架。”
我们采用 **渐进式构建** 的教学理念,从最基础的 Prompt 开始,逐步搭建完整的 AI Agent 能力栈:
```mermaid
flowchart LR
A[Prompt 层] --> B[LLM 核心调用]
B --> C[LangChain 工具链]
2025-11-01 11:19:02 +08:00
C --> D[RAG 检索增强生成]
D --> E[LangGraph 流程控制]
2025-10-25 16:32:18 +08:00
E --> F[MCP 扩展能力]
F --> G[多智能体协作与规划]
G --> H[SDK 封装与部署]
```
2025-10-24 12:16:22 +08:00
## 🚀 快速开始
### 1️⃣ 环境准备
```bash
# 克隆项目
git clone https://github.com/Annyfee/agent-craft.git
cd agent-craft
# 安装依赖
pip install -r requirements.txt
```
### 2️⃣ API Key 配置
```bash
# 复制环境变量模板
cp .env.example .env
```
`.env` 文件中配置:
2025-10-25 16:32:18 +08:00
2025-10-24 12:16:22 +08:00
```env
OPENAI_API_KEY=your_deepseek_api_key_here
2025-11-12 11:07:54 +08:00
LANGCHAIN_API_KEY=your_langsmith_api_key
2025-10-24 12:16:22 +08:00
```
2025-11-12 11:07:54 +08:00
> 💡 **获取API Key**: 访问 [DeepSeek官网](https://platform.deepseek.com/)、[LangSmith官网](https://smith.langchain.com/)
> 注册并获取API Key
2025-10-24 12:16:22 +08:00
### 3️⃣ 运行示例
```bash
python "01 Agent 入门 & 环境搭建/Agent-demo.py"
```
2025-10-25 16:32:18 +08:00
2025-11-02 16:03:18 +08:00
### 4️⃣ 运行测试
项目已集成CI/CD流程,包含基本测试和代码检查。你可以通过以下方式运行测试:
```bash
# 直接运行测试脚本(推荐,不需要安装额外依赖)
python tests/test_basic.py
# 或者使用pytest(如果已安装)
python -m pytest tests/ -v
```
测试将检查项目目录结构完整性和基本模块导入情况,即使部分依赖未安装,也能完成基本检查。
2025-10-24 12:16:22 +08:00
---
2025-10-25 16:32:18 +08:00
## 🤝 参与和交流
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
欢迎提交 **Issue / PR / 改进建议**
2025-10-24 12:16:22 +08:00
2025-10-25 16:32:18 +08:00
如果有商业/技术交流需求,请联系我:
2025-10-24 12:16:22 +08:00
2025-10-31 09:35:40 +08:00
📬 微信:a19731567148(备注 Agent
2025-10-25 16:32:18 +08:00
📖 个人博客:[CSDN 主页](https://blog.csdn.net/2401_87328929)
2025-10-27 20:14:47 +08:00