Skip to main content
LangGraph 拥有一个内置的持久化层,它将图状态保存为检查点。当你使用检查器编译图时,执行过程中的每一步都会保存图状态的快照,并按线程组织。这支持人机协作工作流、对话记忆、时间旅行调试和容错执行。 检查点
Agent Server 自动处理检查点 当使用 Agent Server 时,你不需要手动实现或配置检查器。服务器在后台为你处理所有持久化基础设施。

为什么使用持久性

以下功能需要持久性:
  • 人机协作:检查器通过允许人类检查、中断和批准图步骤来促进 人机协作工作流。这些工作流需要检查器,因为人必须能够在任何时间点查看图的状态,并且图必须能够在人对状态进行任何更新后恢复执行。有关示例,请参阅 中断
  • 记忆:检查器允许在交互之间保留 “记忆”。在重复的人类交互(如对话)的情况下,任何后续消息都可以发送到该线程,该线程将保留对之前消息的记忆。有关如何使用检查器添加和管理对话记忆的信息,请参阅 添加记忆
  • 时间旅行:检查器允许 “时间旅行”,允许用户重播之前的图执行以审查和/或调试特定的图步骤。此外,检查器使得在任意检查点分叉图状态以探索替代轨迹成为可能。
  • 容错:检查点提供容错和错误恢复:如果某个超级步骤中一个或多个节点失败,你可以从最后一个成功步骤重新启动图。
  • 待处理的写入:当图节点在给定 超级步骤 的执行过程中失败时,LangGraph 会存储该超级步骤中任何其他成功完成的节点的待处理检查点写入。当你从该超级步骤恢复图执行时,你不会重新运行成功的节点。

核心概念

线程

线程是检查器保存的每个检查点分配的唯一 ID 或线程标识符。它包含一系列 运行 的累积状态。当运行被执行时,助手底层图的 状态 将被持久化到线程中。 调用带有检查器的图时,你必须在配置的 configurable 部分指定 thread_id
{
  configurable: {
    thread_id: "1";
  }
}
可以检索线程的当前和历史状态。要持久化状态,必须在执行运行之前创建线程。LangSmith API 提供了几个用于创建和管理线程和线程状态的端点。有关更多详细信息,请参阅 API 参考 检查器使用 thread_id 作为存储和检索检查点的主键。如果没有它,检查器无法保存状态或在 中断 后恢复执行,因为检查器使用 thread_id 来加载保存的状态。

检查点

线程在特定时间点的状态称为检查点。检查点是每个 超级步骤 保存的图状态快照,由 StateSnapshot 对象表示(有关完整字段参考,请参阅 StateSnapshot 字段)。

超级步骤

LangGraph 在每个 超级步骤 边界创建检查点。超级步骤是图的单个“滴答”,其中为该步骤调度的所有节点执行(可能并行)。对于像 START -> A -> B -> END 这样的顺序图,输入、节点 A 和节点 B 有单独的超级步骤——每个之后生成一个检查点。理解超级步骤边界对于 时间旅行 很重要,因为你只能从检查点(即超级步骤边界)恢复执行。 检查点被持久化并可用于稍后恢复线程的状态。 让我们看看当简单图按如下方式调用时会保存哪些检查点:
import { StateGraph, StateSchema, ReducedValue, START, END, MemorySaver } from "@langchain/langgraph";
import { z } from "zod/v4";

const State = new StateSchema({
  foo: z.string(),
  bar: new ReducedValue(
    z.array(z.string()).default(() => []),
    {
      inputSchema: z.array(z.string()),
      reducer: (x, y) => x.concat(y),
    }
  ),
});

const workflow = new StateGraph(State)
  .addNode("nodeA", (state) => {
    return { foo: "a", bar: ["a"] };
  })
  .addNode("nodeB", (state) => {
    return { foo: "b", bar: ["b"] };
  })
  .addEdge(START, "nodeA")
  .addEdge("nodeA", "nodeB")
  .addEdge("nodeB", END);

const checkpointer = new MemorySaver();
const graph = workflow.compile({ checkpointer });

const config = { configurable: { thread_id: "1" } };
await graph.invoke({ foo: "", bar: [] }, config);
运行图后,我们期望看到正好 4 个检查点:
  • 空检查点,下一个要执行的节点为 [START]
  • 检查点包含用户输入 {'foo': '', 'bar': []} 和下一个要执行的节点 nodeA
  • 检查点包含 nodeA 的输出 {'foo': 'a', 'bar': ['a']} 和下一个要执行的节点 nodeB
  • 检查点包含 nodeB 的输出 {'foo': 'b', 'bar': ['a', 'b']} 且没有下一个要执行的节点
注意,bar 通道值包含来自两个节点的输出,因为我们为 bar 通道有一个归约器。

检查点命名空间

每个检查点都有一个 checkpoint_ns(检查点命名空间)字段,用于标识它属于哪个图或子图:
  • ""(空字符串):检查点属于父(根)图。
  • "node_name:uuid":检查点属于作为给定节点调用的子图。对于嵌套子图,命名空间用 | 分隔符连接(例如,"outer_node:uuid|inner_node:uuid")。
你可以在节点内通过配置访问检查点命名空间:
import { RunnableConfig } from "@langchain/core/runnables";

function myNode(state: typeof State.Type, config: RunnableConfig) {
  const checkpointNs = config.configurable?.checkpoint_ns;
  // "" 表示父图,"node_name:uuid" 表示子图
}
有关与子图状态和检查点一起工作的更多详细信息,请参阅 子图

获取和更新状态

获取状态

在与保存的图状态交互时,你必须指定 线程标识符。你可以通过调用 graph.getState(config) 查看图的 最新 状态。这将返回一个 StateSnapshot 对象,对应于配置中提供的线程 ID 关联的最新检查点,或者如果提供,则对应于线程的检查点 ID 关联的检查点。
// 获取最新状态快照
const config = { configurable: { thread_id: "1" } };
await graph.getState(config);

// 获取特定 checkpoint_id 的状态快照
const config = {
  configurable: {
    thread_id: "1",
    checkpoint_id: "1ef663ba-28fe-6528-8002-5a559208592c",
  },
};
await graph.getState(config);
在我们的示例中,getState 的输出看起来像这样:
StateSnapshot {
  values: { foo: 'b', bar: ['a', 'b'] },
  next: [],
  config: {
    configurable: {
      thread_id: '1',
      checkpoint_ns: '',
      checkpoint_id: '1ef663ba-28fe-6528-8002-5a559208592c'
    }
  },
  metadata: {
    source: 'loop',
    writes: { nodeB: { foo: 'b', bar: ['b'] } },
    step: 2
  },
  createdAt: '2024-08-29T19:19:38.821749+00:00',
  parentConfig: {
    configurable: {
      thread_id: '1',
      checkpoint_ns: '',
      checkpoint_id: '1ef663ba-28f9-6ec4-8001-31981c2c39f8'
    }
  },
  tasks: []
}

StateSnapshot 字段

字段类型描述
valuesobject此检查点的状态通道值。
nextstring[]下一个要执行的节点名称。空 [] 表示图已完成。
configobject包含 thread_idcheckpoint_nscheckpoint_id
metadataobject执行元数据。包含 source"input""loop""update")、writes(节点输出)和 step(超级步骤计数器)。
createdAtstring创建此检查点的 ISO 8601 时间戳。
parentConfigobject | null前一个检查点的配置。第一个检查点为 null
tasksPregelTask[]此步骤要执行的任务。每个任务都有 idnameerrorinterrupts,以及可选的 state(子图快照,当使用 subgraphs: true 时)。

获取状态历史

你可以通过调用 graph.getStateHistory(config) 获取给定线程的图执行完整历史记录。这将返回与配置中提供的线程 ID 关联的 StateSnapshot 对象列表。重要的是,检查点将按时间顺序排列,最新的检查点 / StateSnapshot 位于列表中的第一位。
const config = { configurable: { thread_id: "1" } };
for await (const state of graph.getStateHistory(config)) {
  console.log(state);
}
在我们的示例中,getStateHistory 的输出看起来像这样:
[
  StateSnapshot {
    values: { foo: 'b', bar: ['a', 'b'] },
    next: [],
    config: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28fe-6528-8002-5a559208592c'
      }
    },
    metadata: {
      source: 'loop',
      writes: { nodeB: { foo: 'b', bar: ['b'] } },
      step: 2
    },
    createdAt: '2024-08-29T19:19:38.821749+00:00',
    parentConfig: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f9-6ec4-8001-31981c2c39f8'
      }
    },
    tasks: []
  },
  StateSnapshot {
    values: { foo: 'a', bar: ['a'] },
    next: ['nodeB'],
    config: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f9-6ec4-8001-31981c2c39f8'
      }
    },
    metadata: {
      source: 'loop',
      writes: { nodeA: { foo: 'a', bar: ['a'] } },
      step: 1
    },
    createdAt: '2024-08-29T19:19:38.819946+00:00',
    parentConfig: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f4-6b4a-8000-ca575a13d36a'
      }
    },
    tasks: [
      PregelTask {
        id: '6fb7314f-f114-5413-a1f3-d37dfe98ff44',
        name: 'nodeB',
        error: null,
        interrupts: []
      }
    ]
  },
  StateSnapshot {
    values: { foo: '', bar: [] },
    next: ['node_a'],
    config: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f4-6b4a-8000-ca575a13d36a'
      }
    },
    metadata: {
      source: 'loop',
      writes: null,
      step: 0
    },
    createdAt: '2024-08-29T19:19:38.817813+00:00',
    parentConfig: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f0-6c66-bfff-6723431e8481'
      }
    },
    tasks: [
      PregelTask {
        id: 'f1b14528-5ee5-579c-949b-23ef9bfbed58',
        name: 'node_a',
        error: null,
        interrupts: []
      }
    ]
  },
  StateSnapshot {
    values: { bar: [] },
    next: ['__start__'],
    config: {
      configurable: {
        thread_id: '1',
        checkpoint_ns: '',
        checkpoint_id: '1ef663ba-28f0-6c66-bfff-6723431e8481'
      }
    },
    metadata: {
      source: 'input',
      writes: { foo: '' },
      step: -1
    },
    createdAt: '2024-08-29T19:19:38.816205+00:00',
    parentConfig: null,
    tasks: [
      PregelTask {
        id: '6d27aa2e-d72b-5504-a36f-8620e54a76dd',
        name: '__start__',
        error: null,
        interrupts: []
      }
    ]
  }
]
状态

查找特定检查点

你可以过滤状态历史以查找符合特定标准的检查点:
const history: StateSnapshot[] = [];
for await (const state of graph.getStateHistory(config)) {
  history.push(state);
}

// 查找特定节点执行前的检查点
const beforeNodeB = history.find((s) => s.next.includes("nodeB"));

// 按步骤号查找检查点
const step2 = history.find((s) => s.metadata.step === 2);

// 查找由 updateState 创建的检查点
const forks = history.filter((s) => s.metadata.source === "update");

// 查找发生中断的检查点
const interrupted = history.find(
  (s) => s.tasks.length > 0 && s.tasks.some((t) => t.interrupts.length > 0)
);

重放

重放从先前的检查点重新执行步骤。使用先前的 checkpoint_id 调用图以重新运行该检查点之后的节点。检查点之前的节点会被跳过(它们的结果已保存)。检查点之后的节点会重新执行,包括任何 LLM 调用、API 请求或 中断 —— 在重放期间总是会被重新触发。 有关重放过去执行的完整详细信息和代码示例,请参阅 时间旅行 重放

更新状态

你可以使用 graph.updateState() 编辑图状态。这会创建一个具有更新值的新检查点 —— 它不会修改原始检查点。更新被视为与节点更新相同:当定义时,值会通过 归约 函数传递,因此具有归约器的通道会 累积 值而不是覆盖它们。 你可以选择指定 asNode 来控制更新被视为来自哪个节点,这会影响下一个执行哪个节点。有关详细信息,请参阅 时间旅行:asNode 更新

内存存储

共享状态模型 状态模式 指定了一组键,随着图的执行会被填充。如上所述,状态可以在每个图步骤由检查器写入线程,从而实现状态持久化。 如果我们想在不同线程之间保留一些信息怎么办?考虑聊天机器人的情况,我们希望在与该用户的 所有 聊天对话(例如,线程)中保留关于该用户的特定信息! 仅靠检查器,我们无法在线程之间共享信息。这激发了对 Store 接口的需求。作为一个说明,我们可以定义一个 InMemoryStore 来跨线程存储有关用户的信息。我们只需像以前一样用检查器编译我们的图,并传递存储。
LangGraph API 自动处理存储 当使用 LangGraph API 时,你不需要手动实现或配置存储。API 在后台为你处理所有存储基础设施。
InMemoryStore 适用于开发和测试。对于生产环境,请使用持久化存储,如 PostgresStoreRedisStore。所有实现都扩展了 BaseStore,这是节点函数签名中使用的类型注解。

基本用法

首先,让我们在不使用 LangGraph 的情况下孤立地展示这一点。
import { MemoryStore } from "@langchain/langgraph";

const memoryStore = new MemoryStore();
记忆通过 tuple 进行命名空间划分,在这个特定示例中将是 (<user_id>, "memories")。命名空间可以是任何长度并代表任何内容,不必是用户特定的。
const userId = "1";
const namespaceForMemory = [userId, "memories"];
我们使用 store.put 方法将记忆保存到存储中的命名空间。当我们这样做时,我们指定如上定义的命名空间,以及记忆的键值对:键只是记忆的唯一标识符(memory_id),值(字典)是记忆本身。
import { v4 as uuidv4 } from "uuid";

const memoryId = uuidv4();
const memory = { food_preference: "I like pizza" };
await memoryStore.put(namespaceForMemory, memoryId, memory);
我们可以使用 store.search 方法读取命名空间中的记忆,该方法将返回给定用户的所有记忆作为列表。最新的记忆在列表的最后。
const memories = await memoryStore.search(namespaceForMemory);
memories[memories.length - 1];

// {
//   value: { food_preference: 'I like pizza' },
//   key: '07e0caf4-1631-47b7-b15f-65515d4c1843',
//   namespace: ['1', 'memories'],
//   createdAt: '2024-10-02T17:22:31.590602+00:00',
//   updatedAt: '2024-10-02T17:22:31.590605+00:00'
// }
它具有的属性是:
  • value: 该记忆的值
  • key: 此命名空间中此记忆的唯一键
  • namespace: 字符串元组,此记忆类型的命名空间
    虽然类型是 tuple,但在转换为 JSON 时可能会序列化为列表(例如,['1', 'memories'])。
  • createdAt: 创建此记忆的时间戳
  • updatedAt: 更新此记忆的时间戳

语义搜索

除了简单的检索外,存储还支持语义搜索,允许你基于含义而不是精确匹配来查找记忆。为此,请配置存储以使用嵌入模型:
import { OpenAIEmbeddings } from "@langchain/openai";

const store = new InMemoryStore({
  index: {
    embeddings: new OpenAIEmbeddings({ model: "text-embedding-3-small" }),
    dims: 1536,
    fields: ["food_preference", "$"], // 要嵌入的字段
  },
});
现在进行搜索时,你可以使用自然语言查询来查找相关记忆:
// 查找关于食物偏好的记忆
// (这可以在将记忆放入存储后进行)
const memories = await store.search(namespaceForMemory, {
  query: "What does the user like to eat?",
  limit: 3, // 返回前 3 个匹配项
});
你可以通过配置 fields 参数或在存储记忆时指定 index 参数来控制你的记忆的哪些部分被嵌入:
// 存储要嵌入的特定字段
await store.put(
  namespaceForMemory,
  uuidv4(),
  {
    food_preference: "I love Italian cuisine",
    context: "Discussing dinner plans",
  },
  { index: ["food_preference"] } // 仅嵌入 "food_preferences" 字段
);

// 不嵌入存储(仍可检索,但不可搜索)
await store.put(
  namespaceForMemory,
  uuidv4(),
  { system_info: "Last updated: 2024-01-01" },
  { index: false }
);

在 LangGraph 中使用

有了所有这些,我们在 LangGraph 中使用 memoryStorememoryStore 与检查器协同工作:检查器将状态保存到线程,如上所述,而 memoryStore 允许我们存储任意信息以供 线程访问。我们使用检查器和 memoryStore 一起编译图,如下所示。
import { MemorySaver } from "@langchain/langgraph";

// 我们需要这个,因为我们希望启用线程(对话)
const checkpointer = new MemorySaver();

// ... 定义图 ...

// 使用检查器和存储编译图
const graph = workflow.compile({ checkpointer, store: memoryStore });
我们像以前一样使用 thread_id 调用图,同时也使用 user_id,我们将用它来将我们的记忆命名空间到此特定用户,就像上面展示的那样。
// 调用图
const userId = "1";
const config = { configurable: { thread_id: "1" }, context: { userId } };

// 首先让我们只是向 AI 打招呼
for await (const update of await graph.stream(
  { messages: [{ role: "user", content: "hi" }] },
  { ...config, streamMode: "updates" }
)) {
  console.log(update);
}
你可以在 任何节点 中使用 runtime 参数访问存储和 userId。以下是你可能如何使用它来保存记忆:
import { StateSchema, MessagesValue, Runtime } from "@langchain/langgraph";
import { v4 as uuidv4 } from "uuid";

const MessagesState = new StateSchema({
  messages: MessagesValue,
});

const updateMemory: GraphNode<typeof MessagesState> = async (state, runtime) => {
  // 从配置中获取用户 id
  const userId = runtime.context?.user_id;
  if (!userId) throw new Error("User ID is required");

  // 命名空间记忆
  const namespace = [userId, "memories"];

  // ... 分析对话并创建新记忆
  const memory = "Some memory content";

  // 创建新记忆 ID
  const memoryId = uuidv4();

  // 我们创建新记忆
  await runtime.store?.put(namespace, memoryId, { memory });
};
正如上面展示的,我们也可以在任何节点中访问存储并使用 store.search 方法获取记忆。回想一下,记忆作为可转换为字典的对象列表返回。
memories[memories.length - 1];
// {
//   value: { food_preference: 'I like pizza' },
//   key: '07e0caf4-1631-47b7-b15f-65515d4c1843',
//   namespace: ['1', 'memories'],
//   createdAt: '2024-10-02T17:22:31.590602+00:00',
//   updatedAt: '2024-10-02T17:22:31.590605+00:00'
// }
我们可以访问记忆并在模型调用中使用它们。
const callModel: GraphNode<typeof MessagesState> = async (state, runtime) => {
  // 从配置中获取用户 id
  const userId = runtime.context?.user_id;

  // 命名空间记忆
  const namespace = [userId, "memories"];

  // 基于最新消息搜索
  const memories = await runtime.store?.search(namespace, {
    query: state.messages[state.messages.length - 1].content,
    limit: 3,
  });
  const info = memories.map((d) => d.value.memory).join("\n");

  // ... 在模型调用中使用记忆
};
如果我们创建新线程,只要 user_id 相同,我们仍然可以访问相同的记忆。
// 调用图
const config = { configurable: { thread_id: "2" }, context: { userId: "1" } };

// 让我们再次打招呼
for await (const update of await graph.stream(
  { messages: [{ role: "user", content: "hi, tell me about my memories" }] },
  { ...config, streamMode: "updates" }
)) {
  console.log(update);
}
当我们使用 LangSmith 时,无论是本地(例如,在 Studio 中)还是 托管的 LangSmith,基础存储默认可用,无需在图编译期间指定。然而,要启用语义搜索,你确实需要在 langgraph.json 文件中配置索引设置。例如:
{
    ...
    "store": {
        "index": {
            "embed": "openai:text-embeddings-3-small",
            "dims": 1536,
            "fields": ["$"]
        }
    }
}
有关更多详细信息和配置选项,请参阅 部署指南

检查器库

在底层,检查点由符合 BaseCheckpointSaver 接口的检查器对象提供支持。LangGraph 提供了几种检查器实现,均通过独立的、可安装的库实现。
  • @langchain/langgraph-checkpoint: 检查器保存器的基础接口 (BaseCheckpointSaver) 和序列化/反序列化接口 (SerializerProtocol)。包括用于实验的内存检查器实现 (MemorySaver)。LangGraph 随附 @langchain/langgraph-checkpoint
  • @langchain/langgraph-checkpoint-sqlite: 使用 SQLite 数据库 (SqliteSaver) 的 LangGraph 检查器实现。适用于实验和本地工作流。需要单独安装。
  • @langchain/langgraph-checkpoint-postgres: 使用 Postgres 数据库 (PostgresSaver) 的高级检查器,在 LangSmith 中使用。适用于在生产环境中使用。需要单独安装。
  • @langchain/langgraph-checkpoint-mongodb: 使用 MongoDB 数据库 (MongoDBSaver) 的高级检查器。适用于在生产环境中使用。需要单独安装。
  • @langchain/langgraph-checkpoint-redis: 使用 Redis 数据库 (RedisSaver) 的高级检查器。适用于在生产环境中使用。需要单独安装。

检查器接口

每个检查器都符合 BaseCheckpointSaver 接口并实现以下方法:
  • .put - 存储其配置和元数据的检查点。
  • .putWrites - 存储链接到检查点的中间写入(即 待处理写入)。
  • .getTuple - 使用给定配置(thread_idcheckpoint_id)获取检查点元组。这用于在 graph.getState() 中填充 StateSnapshot
  • .list - 列出符合给定配置和筛选条件的检查点。这用于在 graph.getStateHistory() 中填充状态历史。