Skip to main content
本指南演示了 LangGraph 图 API 的基础知识。它将引导你了解状态,以及如何组合常见的图结构,如序列分支循环。它还涵盖了 LangGraph 的控制功能,包括用于 Map-Reduce 工作流的 [Send API](#map-reduce 和 send api) 以及用于将状态更新与节点间“跳转”相结合的 [Command API](#使用 command 结合控制流和状态更新)。

设置

安装 langgraph
设置 LangSmith 以获得更好的调试体验注册 LangSmith 以快速发现问题并提升你的 LangGraph 项目的性能。LangSmith 允许你使用跟踪数据来调试、测试和监控使用 LangGraph 构建的 LLM 应用——在文档中了解更多入门信息。

定义和更新状态

这里我们展示如何在 LangGraph 中定义和更新状态。我们将演示:
  1. 如何使用状态来定义图的模式
  2. 如何使用归约器来控制状态更新的处理方式。

定义状态

LangGraph 中的状态可以是 TypedDictPydantic 模型或数据类。下面我们将使用 TypedDict。有关使用 Pydantic 的详细信息,请参阅[使用 Pydantic 模型作为图状态](#使用 pydantic 模型作为图状态)。 默认情况下,图将具有相同的输入和输出模式,状态决定了该模式。有关如何定义不同的输入和输出模式,请参阅定义输入和输出模式 让我们考虑一个使用消息的简单示例。这代表了用于许多 LLM 应用程序的一种通用状态表述。更多详情请参阅我们的概念页面
此状态跟踪一个消息对象列表,以及一个额外的整数字段。

更新状态

让我们构建一个包含单个节点的示例图。我们的节点只是一个读取图状态并对其进行更新的 Python 函数。此函数的第一个参数始终是状态:
此节点只是向我们的消息列表追加一条消息,并填充一个额外的字段。
节点应直接返回对状态的更新,而不是修改状态。
接下来,让我们定义一个包含此节点的简单图。我们使用 StateGraph 来定义一个操作此状态的图。然后我们使用 add_node 来填充我们的图。
LangGraph 提供了内置的可视化工具来查看你的图。让我们检查一下我们的图。有关可视化的详细信息,请参阅可视化你的图
具有单个节点的简单图 在这种情况下,我们的图只执行一个节点。让我们进行一个简单的调用:
请注意:
  • 我们通过更新状态的单个键来启动调用。
  • 我们在调用结果中接收到整个状态。
为了方便,我们经常通过漂亮打印来检查消息对象的内容:

使用归约器处理状态更新

状态中的每个键都可以有自己的独立归约器函数,该函数控制如何应用来自节点的更新。如果没有明确指定归约器函数,则假定对该键的所有更新都应覆盖它。 对于 TypedDict 状态模式,我们可以通过用归约器函数注解状态的相应字段来定义归约器。 在前面的示例中,我们的节点通过向其追加消息来更新状态中的 "messages" 键。下面,我们为这个键添加一个归约器,以便更新自动追加:
现在我们的节点可以简化:

MessagesState

实际上,更新消息列表还有额外的考虑因素:
  • 我们可能希望更新状态中的现有消息。
  • 我们可能希望接受消息格式的简写,例如 OpenAI 格式
LangGraph 包含一个内置的归约器 add_messages,它处理这些考虑因素:
这是涉及聊天模型的应用程序的一种通用状态表示。为了方便,LangGraph 包含一个预构建的 MessagesState,这样我们可以有:

使用 Overwrite 绕过归约器

在某些情况下,你可能希望绕过归约器并直接覆盖状态值。LangGraph 提供了 Overwrite 类型来实现此目的。当节点返回一个用 Overwrite 包装的值时,归约器将被绕过,通道将直接设置为该值。 当你想要重置或替换累积的状态,而不是将其与现有值合并时,这很有用。
你也可以使用带有特殊键 "__overwrite__" 的 JSON 格式:
当节点并行执行时,在给定的超级步骤中,只有一个节点可以使用 Overwrite 来处理同一个状态键。如果多个节点尝试在同一个超级步骤中覆盖同一个键,将引发 InvalidUpdateError

定义输入和输出模式

默认情况下,StateGraph 使用单一模式操作,所有节点都期望使用该模式进行通信。但是,也可以为图定义不同的输入和输出模式。 当指定了不同的模式时,内部模式仍将用于节点之间的通信。输入模式确保提供的输入符合预期的结构,而输出模式根据定义的输出模式过滤内部数据,仅返回相关信息。 下面,我们将看到如何定义不同的输入和输出模式。
请注意,调用的输出仅包含输出模式。

在节点之间传递私有状态

在某些情况下,你可能希望节点交换对中间逻辑至关重要但不需要成为图主要模式一部分的信息。这些私有数据与图的整体输入/输出无关,只应在特定节点之间共享。 下面,我们将创建一个由三个节点(node_1、node_2 和 node_3)组成的示例顺序图,其中私有数据在前两个步骤(node_1 和 node_2)之间传递,而第三个步骤(node_3)只能访问公共的整体状态。

使用 pydantic 模型作为图状态

StateGraph 在初始化时接受一个 state_schema 参数,该参数指定图中节点可以访问和更新的状态的“形状”。 在我们的示例中,我们通常使用 Python 原生的 TypedDictdataclass 作为 state_schema,但 state_schema 可以是任何类型 这里,我们将看到如何使用 Pydantic BaseModel 作为 state_schema 来添加对输入的运行时验证。
已知限制 * 目前,图的输出不会是 pydantic 模型的实例。 * 运行时验证仅发生在图第一个节点的输入上,而不是后续节点或输出上。 * pydantic 的验证错误跟踪不会显示错误发生在哪个节点。 * Pydantic 的递归验证可能很慢。对于性能敏感的应用程序,你可能需要考虑改用 dataclass
使用无效输入调用图
有关 Pydantic 模型状态的更多功能,请参见下文:
当使用 Pydantic 模型作为状态模式时,了解序列化的工作方式非常重要,特别是在以下情况下:
  • 将 Pydantic 对象作为输入传递
  • 接收图的输出
  • 处理嵌套的 Pydantic 模型
让我们看看这些行为的实际应用。
Pydantic 对某些数据类型执行运行时类型强制转换。这可能很有帮助,但如果你没有意识到,也可能导致意外行为。
在状态模式中使用 LangChain 消息类型时,序列化有一些重要的考虑因素。你应该使用 AnyMessage(而不是 BaseMessage)来正确序列化/反序列化通过网络传输的消息对象。

添加运行时配置

有时你希望在调用图时能够配置它。例如,你可能希望能够在运行时指定使用哪个 LLM 或系统提示,而不将这些参数污染到图状态中 要添加运行时配置:
  1. 为你的配置指定一个模式
  2. 将配置添加到节点或条件边的函数签名中
  3. 将配置传递到图中。
请参见下面的简单示例:
下面我们演示一个实际示例,我们在运行时配置使用哪个 LLM。我们将同时使用 OpenAI 和 Anthropic 模型。
下面我们演示一个实际示例,我们在运行时配置两个参数:LLM 和要使用的系统消息。

添加重试策略

有许多用例你可能希望节点具有自定义的重试策略,例如,如果你正在调用 API、查询数据库或调用 LLM 等。LangGraph 允许你为节点添加重试策略。 要配置重试策略,请将 retry_policy 参数传递给 add_noderetry_policy 参数接受一个 RetryPolicy 命名元组对象。下面我们使用默认参数实例化一个 RetryPolicy 对象并将其与节点关联:
默认情况下,retry_on 参数使用 default_retry_on 函数,它会重试除以下异常之外的任何异常:
  • ValueError
  • TypeError
  • ArithmeticError
  • ImportError
  • LookupError
  • NameError
  • SyntaxError
  • RuntimeError
  • ReferenceError
  • StopIteration
  • StopAsyncIteration
  • OSError
此外,对于来自流行 HTTP 请求库(如 requestshttpx)的异常,它仅在 5xx 状态码时重试。
考虑一个我们从 SQL 数据库读取的示例。下面我们向节点传递两个不同的重试策略:

配置节点超时

add_node 上的 timeout= 参数限制单个异步节点尝试可能运行的时间。传递一个数字(秒)、一个 timedelta 或一个 TimeoutPolicy 以对运行和空闲超时进行更精细的控制。当超过限制时,LangGraph 会引发 NodeTimeoutError,并让重试策略决定是否重试。
每个节点的超时需要 langgraph>=1.2,目前处于 alpha 阶段。
有关完整的超时生命周期、空闲超时刷新源和 runtime.heartbeat(),请参阅容错

处理节点错误

add_node 上的 error_handler= 参数注册一个函数,该函数在节点失败且所有重试耗尽后运行。处理程序接收当前状态和一个带有失败上下文的类型化 NodeError,并且可以通过 Command 路由到恢复分支:
节点级错误处理程序需要 langgraph>=1.2,目前处于 alpha 阶段。
有关补偿模式和 Command 路由,请参阅容错

在节点内访问执行信息

你可以通过 runtime.execution_info 访问执行标识和重试信息。这提供了线程、运行和检查点标识符以及重试状态,而无需直接从 config 读取。

访问线程和运行 ID

使用 execution_info 在节点内访问线程 ID、运行 ID 和其他标识字段:

根据重试状态调整行为

当节点具有重试策略时,使用 execution_info 检查当前尝试次数,并在第一次尝试失败后切换到回退:
即使没有重试策略,execution_info 也可在 Runtime 对象上使用——node_attempt 默认为 1node_first_attempt_time 设置为节点开始执行的时间。

在节点内访问服务器信息

当你的图在 LangGraph Server 上运行时,你可以通过 runtime.server_info 访问服务器特定的元数据。这提供了助手 ID、图 ID 和经过身份验证的用户,而无需直接从配置元数据或可配置键读取。
当图未在 LangGraph Server 上运行时(例如,在本地开发或测试期间),server_infoNone
需要 deepagents>=0.5.0(或 langgraph>=1.1.5)才能使用 runtime.execution_inforuntime.server_info

在节点内访问排空状态

当请求优雅关闭时,runtime.drain_requestedTrue。在节点内读取此值,以便在下一个超级步骤边界之前跳过昂贵的工作:
需要 langgraph>=1.2,目前处于 alpha 阶段。有关完整的 RunControl API,请参阅优雅关闭

添加节点缓存

节点缓存对于希望避免重复操作的情况很有用,例如在执行昂贵操作(无论是时间还是成本方面)时。LangGraph 允许你为图中的节点添加个性化的缓存策略。 要配置缓存策略,请将 cache_policy 参数传递给 add_node 函数。在以下示例中,一个 CachePolicy 对象被实例化,其生存时间为 120 秒,并使用默认的 key_func 生成器。然后将其与节点关联:
然后,要为图启用节点级缓存,请在编译图时设置 cache 参数。下面的示例使用 InMemoryCache 来设置具有内存缓存的图,但 SqliteCache 也可用。

创建步骤序列

前提条件 本指南假设你熟悉上面关于状态的部分。
这里我们演示如何构建一个简单的步骤序列。我们将展示:
  1. 如何构建顺序图
  2. 用于构建类似图的内置简写。
要添加一系列节点,我们使用 graphadd_nodeadd_edge 方法:
我们也可以使用内置的简写 .add_sequence
LangGraph 使得为你的应用程序添加底层持久化层变得容易。 这允许在节点执行之间对状态进行检查点,因此你的 LangGraph 节点控制:它们还决定了执行步骤如何被流式传输,以及你的应用程序如何使用 Studio 进行可视化和调试。让我们演示一个端到端的示例。我们将创建三个步骤的序列:
  1. 在状态的一个键中填充一个值
  2. 更新相同的值
  3. 填充一个不同的值
让我们首先定义我们的状态。这控制着图的模式,也可以指定如何应用更新。有关更多详细信息,请参阅使用归约器处理状态更新在我们的例子中,我们将只跟踪两个值:
我们的节点只是读取图状态并对其进行更新的 Python 函数。此函数的第一个参数始终是状态:
请注意,当向状态发出更新时,每个节点只需指定它希望更新的键的值。默认情况下,这将覆盖相应键的值。你也可以使用归约器来控制更新的处理方式——例如,你可以将连续的更新追加到一个键中。有关更多详细信息,请参阅使用归约器处理状态更新
最后,我们定义图。我们使用 StateGraph 来定义一个操作此状态的图。然后我们将使用 add_nodeadd_edge 来填充我们的图并定义其控制流。
指定自定义名称 你可以使用 add_node 为节点指定自定义名称:
请注意:
  • add_edge 接受节点的名称,对于函数,默认为 node.__name__
  • 我们必须指定图的入口点。为此,我们添加一条带有 START 节点的边。
  • 当没有更多节点可执行时,图停止。
接下来我们编译我们的图。这会对图的结构进行一些基本检查(例如,识别孤立节点)。如果我们通过检查点器为应用程序添加持久化,它也会在这里传入。
LangGraph 提供了内置的可视化工具来查看你的图。让我们检查一下我们的序列。有关可视化的详细信息,请参阅可视化你的图
步骤序列图让我们进行一个简单的调用:
请注意:
  • 我们通过为单个状态键提供值来启动调用。我们必须始终至少为一个键提供值。
  • 我们传入的值被第一个节点覆盖。
  • 第二个节点更新了该值。
  • 第三个节点填充了一个不同的值。
内置简写 langgraph>=0.2.46 包含一个内置的简写 add_sequence,用于添加节点序列。你可以如下编译相同的图:

创建分支

节点的并行执行对于加速整体图操作至关重要。LangGraph 提供了对节点并行执行的原生支持,这可以显著提高基于图的工作流的性能。这种并行化是通过扇出和扇入机制实现的,利用标准边和 conditional_edges。以下是一些示例,展示如何添加创建适合你的分支数据流。

并行运行图节点

在这个示例中,我们从 Node A 扇出到 B and C,然后扇入到 D。对于我们的状态,我们指定了归约器 add 操作。这将组合或累积状态中特定键的值,而不是简单地覆盖现有值。对于列表,这意味着将新列表与现有列表连接起来。有关使用归约器更新状态的更多详细信息,请参阅上面的状态归约器部分。
并行执行图 使用归约器,你可以看到在每个节点中添加的值被累积了。
在上面的示例中,节点 "b""c" 在同一个超级步骤中并发执行。因为它们在同一个步骤中,所以节点 "d""b""c" 都完成后执行。重要的是,并行超级步骤的更新可能不会按一致的顺序排列。如果你需要并行超级步骤的更新具有一致的、预定的顺序,你应该将输出与用于排序的值一起写入状态中的单独字段。
LangGraph 在超级步骤内执行节点,这意味着虽然并行分支是并行执行的,但整个超级步骤是事务性的。如果这些分支中的任何一个引发异常,则不会有任何更新应用到状态(整个超级步骤出错)。重要的是,当使用检查点器时,超级步骤内成功节点的结果会被保存,并且在恢复时不会重复。如果你有容易出错的(可能想处理不稳定的 API 调用),LangGraph 提供了两种解决方法:
  1. 你可以在节点内编写常规的 Python 代码来捕获和处理异常。
  2. 你可以设置一个 retry_policy 来指示图重试引发某些类型异常的节点。只有失败的分支会被重试,因此你不必担心执行冗余工作。
这些结合在一起,让你可以执行并行执行并完全控制异常处理。
设置最大并发数 你可以在调用图时通过在配置中设置 max_concurrency 来控制最大并发任务数。

延迟节点执行

当你想要延迟节点的执行直到所有其他待处理任务完成时,延迟节点执行很有用。当分支具有不同的长度时,这在 Map-Reduce 流程等工作流中尤其相关。 上面的示例展示了当每个路径只有一步时如何扇出和扇入。但如果一个分支有多个步骤呢?让我们在 "b" 分支中添加一个节点 "b_2"
延迟执行图
在上面的示例中,节点 "b""c" 在同一个超级步骤中并发执行。我们在节点 d 上设置了 defer=True,因此它将不会执行,直到所有待处理任务完成。在这种情况下,这意味着 "d" 等待执行,直到整个 "b" 分支完成。

条件分支

如果你的扇出应该在运行时根据状态变化,你可以使用 add_conditional_edges 来使用图状态选择一个或多个路径。请参见下面的示例,其中节点 a 生成一个状态更新,该更新决定下一个节点。
条件分支图
你的条件边可以路由到多个目标节点。例如:

Map-Reduce 和 send API

LangGraph 使用 Send API 支持 Map-Reduce 和其他高级分支模式。以下是使用它的一个示例:
带有扇出的 Map-Reduce 图

创建和控制循环

在创建带有循环的图时,我们需要一种终止执行的机制。最常见的是通过添加一个条件边来实现,该边在达到某个终止条件时路由到 END 节点。 你也可以在调用或流式传输图时设置图的递归限制。递归限制设置了图在引发错误之前允许执行的超级步骤数量。阅读更多关于递归限制概念的信息。 让我们考虑一个带有循环的简单图,以更好地理解这些机制的工作原理。
要返回状态的最后一个值而不是收到递归限制错误,请参阅下一节
创建循环时,你可以包含一个指定终止条件的条件边:
要控制递归限制,请在配置中指定 "recursion_limit"。这将引发一个 GraphRecursionError,你可以捕获并处理它:
让我们定义一个带有简单循环的图。请注意,我们使用条件边来实现终止条件。
简单循环图 这种架构类似于 ReAct 代理,其中节点 "a" 是一个工具调用模型,节点 "b" 代表工具。 在我们的 route 条件边中,我们指定当状态中的 "aggregate" 列表超过阈值长度后应结束。 调用图,我们看到在达到终止条件之前,我们在节点 "a""b" 之间交替。

施加递归限制

在某些应用程序中,我们可能无法保证会达到给定的终止条件。在这些情况下,我们可以设置图的递归限制。这将在给定数量的超级步骤后引发 GraphRecursionError。然后我们可以捕获并处理此异常:
与其引发 GraphRecursionError,我们可以向状态添加一个新键来跟踪达到递归限制之前剩余的步骤数。然后我们可以使用此键来确定是否应结束运行。LangGraph 实现了一个特殊的 RemainingSteps 注解。在底层,它创建了一个 ManagedValue 通道——一个在图运行期间存在而之后不再存在的状态通道。
为了更好地理解递归限制的工作原理,让我们考虑一个更复杂的例子。下面我们实现一个循环,但其中一个步骤扇出到两个节点:
带有分支的复杂循环图这个图看起来很复杂,但可以概念化为超级步骤的循环:
  1. 节点 A
  2. 节点 B
  3. 节点 C 和 D
  4. 节点 A
我们有一个四个超级步骤的循环,其中节点 C 和 D 并发执行。像以前一样调用图,我们看到在达到终止条件之前,我们完成了两个完整的“圈”:
然而,如果我们设置递归限制为四,我们只完成一圈,因为每圈是四个超级步骤:

异步

使用异步编程范式可以在并发运行 IO 密集型代码时(例如,向聊天模型提供者发出并发 API 请求)产生显著的性能改进。 要将图的 sync 实现转换为 async 实现,你需要:
  1. 更新 nodes 使用 async def 而不是 def
  2. 更新内部代码以适当地使用 await
  3. 根据需要使用 .ainvoke.astream 调用图。
因为许多 LangChain 对象实现了 Runnable Protocol,该协议具有所有 sync 方法的 async 变体,所以通常将 sync 图升级为 async 图相当快。 请参见下面的示例。为了演示底层 LLM 的异步调用,我们将包含一个聊天模型:
👉 阅读 OpenAI 聊天模型集成文档
异步流式传输 有关异步流式传输的示例,请参阅流式传输指南

使用 Command 结合控制流和状态更新

结合控制流(边)和状态更新(节点)可能很有用。例如,你可能希望在同一个节点中同时执行状态更新并决定下一个节点。LangGraph 提供了一种通过从节点函数返回 Command 对象来实现此目的的方法:
我们在下面展示一个端到端的示例。让我们创建一个包含 3 个节点的简单图:A、B 和 C。我们将首先执行节点 A,然后根据节点 A 的输出决定接下来是转到节点 B 还是节点 C。
我们现在可以使用上面的节点创建 StateGraph。请注意,图没有用于路由的条件边!这是因为控制流是在 node_a 内部使用 Command 定义的。
你可能已经注意到我们使用 Command 作为返回类型注解,例如 Command[Literal["node_b", "node_c"]]。这对于图渲染是必要的,并告诉 LangGraph node_a 可以导航到 node_bnode_c
基于 Command 的图导航 如果我们多次运行图,我们会看到它根据节点 A 中的随机选择采取不同的路径(A -> B 或 A -> C)。

导航到父图中的节点

如果你正在使用子图,你可能希望从子图中的节点导航到不同的子图(即父图中的不同节点)。为此,你可以在 Command 中指定 graph=Command.PARENT
让我们使用上面的示例来演示这一点。我们将通过将上面示例中的 nodeA 更改为一个单节点图来实现,该图将作为子图添加到我们的父图中。
使用 Command.PARENT 进行状态更新 当你从子图节点向父图节点发送更新时,对于父图和子图状态模式共享的键,你必须在父图状态中为要更新的键定义一个归约器。请参见下面的示例。

在工具内使用

一个常见的用例是从工具内部更新图状态。例如,在客户支持应用程序中,你可能希望在对话开始时根据客户的帐户号或 ID 查找客户信息。要从工具更新图状态,你可以从工具返回 Command(update={"my_custom_key": "foo", "messages": [...]})
当你从工具返回 Command 时,你必须Command.update 中包含 messages(或用于消息历史的任何状态键),并且 messages 中的消息列表必须包含一个 ToolMessage。这对于生成的消息历史有效是必要的(LLM 提供者要求带有工具调用的 AI 消息后面必须跟有工具结果消息)。
如果你正在使用通过 Command 更新状态的工具,我们建议使用预构建的 ToolNode,它自动处理返回 Command 对象的工具并将其传播到图状态。如果你正在编写一个调用工具的自定义节点,你需要手动将工具返回的 Command 对象作为节点的更新进行传播。

可视化你的图

这里我们演示如何可视化你创建的图。 你可以可视化任何任意的 Graph,包括 StateGraph 让我们通过绘制分形来获得一些乐趣 :)。

Mermaid

我们也可以将图类转换为 Mermaid 语法。

PNG

如果需要,我们可以将图渲染为 .png。这里我们可以使用三个选项:
  • 使用 Mermaid.ink API(不需要额外的包)
  • 使用 Mermaid + Pyppeteer(需要 pip install pyppeteer
  • 使用 graphviz(需要 pip install graphviz
使用 Mermaid.Ink 默认情况下,draw_mermaid_png() 使用 Mermaid.Ink 的 API 来生成图表。
分形图可视化 使用 Mermaid + Pyppeteer
使用 Graphviz