API 参考总览¶
ZeroGraph 的所有公共接口按功能分类如下。
核心图构建¶
| 符号 | 说明 |
|---|---|
StateGraph |
图构建器，定义节点、边和状态模式 |
CompiledStateGraph |
编译后的可执行图 |
START |
入口常量 "__start__" |
END |
终止常量 "__end__" |
TAG_HIDDEN |
隐藏节点标记（兼容 LangSmith） |
核心类型¶
| 符号 | 说明 |
|---|---|
Send |
动态发送数据到指定节点 |
Command |
同时更新状态和控制流 |
Interrupt |
中断信息对象 |
interrupt() |
在节点内触发中断 |
RetryPolicy |
重试策略配置 |
TimeoutPolicy |
超时策略配置 |
StateSnapshot |
状态快照 |
PregelTask |
任务执行信息 |
Overwrite |
绕过 Reducer 直接覆盖 |
All |
通配类型 Literal["*"] |
StreamWriter |
流式写入回调类型 |
Channel 系统¶
| 符号 | 说明 |
|---|---|
BaseChannel |
Channel 抽象基类 |
LastValue |
最后值覆盖 |
BinaryOperatorAggregate |
Reducer 聚合 |
AnyValue |
任意值（多次写入不报错） |
add_messages |
消息列表 Reducer |
RemoveMessage |
消息删除标记 |
检查点¶
| 符号 | 说明 |
|---|---|
BaseCheckpointSaver |
检查点存储抽象基类 |
InMemorySaver |
内存检查点存储 |
SqliteSaver |
SQLite 检查点存储 |
AsyncSqliteSaver |
异步 SQLite 检查点存储 |
Checkpoint |
检查点数据结构（TypedDict） |
CheckpointMetadata |
检查点元数据（TypedDict） |
CheckpointTuple |
检查点元组（NamedTuple） |
预构建组件¶
| 符号 | 说明 |
|---|---|
ToolNode |
自动执行工具调用的节点 |
InjectedState |
注入图状态到工具参数 |
InjectedStore |
注入 Store 到工具参数 |
create_react_agent |
一行创建 ReAct 智能体 |
create_supervisor |
创建多 Agent 监督者 |
create_swarm |
创建群智协作系统 |
函数式 API¶
| 符号 | 说明 |
|---|---|
entrypoint |
工作流入口装饰器 |
task |
独立工作单元装饰器 |
基础设施¶
| 符号 | 说明 |
|---|---|
BaseCache / InMemoryCache |
缓存系统 |
CachePolicy |
缓存策略配置 |
BaseStore / InMemoryStore |
键值存储系统 |
StoreItem |
存储项数据类 |
LLMStreamAdapter |
LLM 流式适配器 |
异常¶
| 符号 | 说明 |
|---|---|
EmptyChannelError |
从空 Channel 读取 |
InvalidUpdateError |
无效 Channel 更新 |
GraphRecursionError |
超出最大步数 |
GraphInterrupt |
图中断 |
GraphBubbleUp |
控制流基类 |
ParentCommand |
父图命令 |