AgentFramework · 开发者使用文档¶

本文档面向使用 AgentFramework 开发 Agent 应用的工程师：教你安装、用 DSL 编排工作流、编译运行、起网关、接入知识库与持久化，以及扩展自定义节点。

如果你要找的是框架内部设计（概要设计 / 接口契约 / 各模块详细设计 / 工程规范），请移步仓库 doc/、design/ 与根目录 README.md。

AgentFramework 是一套自研 Agent 开发框架：节点组件库 + 编排 DSL + LangGraph 运行时 + FastGPT 兼容网关。你可以像用 LangGraph 一样，用几段 Python 拼出「对话 → 判断 → 检索知识库 → 调第三方接口 → 交互确认 → 回复」的复杂 Agent 流程，然后一键起一个 HTTP 网关对外提供流式对话服务。

编排层        运行时层            服务层
Workflow  ──►  LangGraph  ──►  FastGPT 兼容网关
(add_node)    (compile)        (serve / create_app)
   │              │                  │
 节点组件库      断点/恢复           SSE 对话 / 变量回传
 ChatLLM ...   checkpointer        /docs (Swagger)

快速导航¶

章节	内容
安装与快速开始	安装、用 5 行代码建第一个工作流、本地运行、起网关发对话
核心概念 · 心智模型	Workflow / Node / Edge / Channel / State 分层与一次请求的生命周期
核心概念 · DSL 构建	`add_node` / `add_edge` / `add_conditional_edge` / `wf.ref` / `compile`
核心概念 · 运行时与网关	编译、checkpointer、`invoke` vs `serve`、SSE 事件、变量回传
指南 · 条件分支与分类路由	`IfElse`、`QuestionClassify`、多路分发
指南 · 知识库问答（RAG）	检索 → 注入 LLM → 引用回答
指南 · HTTP 调用	调第三方接口、按响应分流
指南 · 交互式对话（暂停/恢复）	`UserSelect` / `UserInput`，断点续跑
指南 · 变量读写与回传	`VariableUpdate` / `VariableOutput` / `{{key}}` 占位符
指南 · 断点持久化	SQLite / PostgreSQL / MongoDB / MySQL 接入
指南 · 自定义节点	声明 + 实现 + 注册，扩展框架
指南 · 网关鉴权与部署	API Key 鉴权、`serve` vs `create_app`
参考 · 内置节点速查	每个节点的参数 / 输入输出 / 最小示例
专题 · RAG 检索管线	`splitter` / `embedder` / `store` / `retriever` / `ingest` 协议与内置实现

常见问题速答¶

要不要部署一个服务才能用？ 不需要。纯库方式 app.invoke / app.astream 直接跑；需要对外对话协议（SSE / interactive / 变量回传）时才起网关。
接口文档在哪？ 网关是 FastAPI，/docs（Swagger）、/redoc、/openapi.json 自动生成；协议语义权威见仓库 doc/Agent接口契约.md。
和 LangGraph 什么关系？ 底层运行时复用 LangGraph，compile() 返回原生 CompiledStateGraph，可透传 invoke/astream；DSL 在其上加了一层节点组件与声明式 schema。

建议阅读顺序¶

安装与快速开始 —— 先跑起来
核心概念 · 心智模型 —— 建立概念
内置节点速查 —— 看有哪些积木
按场景挑指南看