如何将 LangGraph 集成到你的 React 应用程序中¶

前提条件

useStream() React Hook 提供了一种无缝的方式，将 LangGraph 集成到你的 React 应用程序中。它处理了流式处理、状态管理和分支逻辑的所有复杂性，让你专注于构建出色的聊天体验。

主要特性

消息流式处理：处理消息块流以形成完整消息
消息、中断、加载状态和错误的自动状态管理
对话分支：从聊天历史记录中的任何点创建备选对话路径
UI 不可知的设计：自带组件和样式

让我们探索如何在你的 React 应用程序中使用 useStream()。

useStream() 为创建定制聊天体验提供了坚实的基础。对于预构建的聊天组件和界面，我们还建议查看 CopilotKit 和 assistant-ui。

安装¶

npm install @langchain/langgraph-sdk @langchain/core

示例¶

"use client";

import { useStream } from "@langchain/langgraph-sdk/react";
import type { Message } from "@langchain/langgraph-sdk";

export default function App() {
  const thread = useStream<{ messages: Message[] }>({
    apiUrl: "https://127.0.0.1:2024",
    assistantId: "agent",
    messagesKey: "messages",
  });

  return (
    <div>
      <div>
        {thread.messages.map((message) => (
          <div key={message.id}>{message.content as string}</div>
        ))}
      </div>

      <form
        onSubmit={(e) => {
          e.preventDefault();

          const form = e.target as HTMLFormElement;
          const message = new FormData(form).get("message") as string;

          form.reset();
          thread.submit({ messages: [{ type: "human", content: message }] });
        }}
      >
        <input type="text" name="message" />

        {thread.isLoading ? (
          <button key="stop" type="button" onClick={() => thread.stop()}>
            Stop
          </button>
        ) : (
          <button keytype="submit">Send</button>
        )}
      </form>
    </div>
  );
}

自定义你的 UI¶

useStream() Hook 负责幕后所有复杂的状态管理，为你提供简单的界面来构建你的 UI。以下是你开箱即用的功能

线程状态管理
加载和错误状态
中断
消息处理和更新
分支支持

以下是一些关于如何有效使用这些功能的示例

加载状态¶

isLoading 属性告诉你流何时处于活动状态，使你能够

显示加载指示器
在处理期间禁用输入字段
显示取消按钮

export default function App() {
  const { isLoading, stop } = useStream<{ messages: Message[] }>({
    apiUrl: "https://127.0.0.1:2024",
    assistantId: "agent",
    messagesKey: "messages",
  });

  return (
    <form>
      {isLoading && (
        <button key="stop" type="button" onClick={() => stop()}>
          Stop
        </button>
      )}
    </form>
  );
}

线程管理¶

通过内置的线程管理跟踪对话。你可以访问当前线程 ID，并在创建新线程时收到通知

const [threadId, setThreadId] = useState<string | null>(null);

const thread = useStream<{ messages: Message[] }>({
  apiUrl: "https://127.0.0.1:2024",
  assistantId: "agent",

  threadId: threadId,
  onThreadId: setThreadId,
});

我们建议将 threadId 存储在 URL 的查询参数中，以便用户在页面刷新后恢复对话。

消息处理¶

useStream() Hook 将跟踪从服务器接收的消息块，并将它们连接在一起以形成完整消息。完成的消息块可以通过 messages 属性检索。

默认情况下，messagesKey 设置为 messages，它会将新的消息块附加到 values["messages"]。如果你将消息存储在不同的键中，则可以更改 messagesKey 的值。

import type { Message } from "@langchain/langgraph-sdk";
import { useStream } from "@langchain/langgraph-sdk/react";

export default function HomePage() {
  const thread = useStream<{ messages: Message[] }>({
    apiUrl: "https://127.0.0.1:2024",
    assistantId: "agent",
    messagesKey: "messages",
  });

  return (
    <div>
      {thread.messages.map((message) => (
        <div key={message.id}>{message.content as string}</div>
      ))}
    </div>
  );
}

在底层，useStream() Hook 将使用 streamMode: "messages-key" 从图节点内的任何 LangChain 聊天模型调用接收消息流（即，单个 LLM 令牌）。在“如何从你的图流式传输消息”指南中了解有关消息流式处理的更多信息。

中断¶

useStream() Hook 公开了 interrupt 属性，该属性将填充线程的最后一次中断。你可以使用中断来

在执行节点之前渲染确认 UI
等待人工输入，允许代理向用户询问澄清问题

在“如何处理中断”指南中了解有关中断的更多信息。

const thread = useStream<
  { messages: Message[] },
  { InterruptType: string }
>({
  apiUrl: "https://127.0.0.1:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

if (thread.interrupt) {
  return (
    <div>
      Interrupted! {thread.interrupt.value}

      <button
        type="button"
        onClick={() => {
          // `resume` can be any value that the agent accepts
          thread.submit(undefined, { command: { resume: true } });
        }}
      >
        Resume
      </button>
    </div>
  );
}

分支¶

对于每条消息，你可以使用 getMessagesMetadata() 获取消息首次出现的第一个检查点。然后，你可以从首次出现的检查点之前的检查点创建一个新的运行，以在线程中创建一个新分支。

可以通过以下方式创建分支

编辑之前的用户消息。
请求重新生成之前的助手消息。

"use client";

import type { Message } from "@langchain/langgraph-sdk";
import { useStream } from "@langchain/langgraph-sdk/react";
import { useState } from "react";

function BranchSwitcher({
  branch,
  branchOptions,
  onSelect,
}: {
  branch: string | undefined;
  branchOptions: string[] | undefined;
  onSelect: (branch: string) => void;
}) {
  if (!branchOptions || !branch) return null;
  const index = branchOptions.indexOf(branch);

  return (
    <div className="flex items-center gap-2">
      <button
        type="button"
        onClick={() => {
          const prevBranch = branchOptions[index - 1];
          if (!prevBranch) return;
          onSelect(prevBranch);
        }}
      >
        Prev
      </button>
      <span>
        {index + 1} / {branchOptions.length}
      </span>
      <button
        type="button"
        onClick={() => {
          const nextBranch = branchOptions[index + 1];
          if (!nextBranch) return;
          onSelect(nextBranch);
        }}
      >
        Next
      </button>
    </div>
  );
}

function EditMessage({
  message,
  onEdit,
}: {
  message: Message;
  onEdit: (message: Message) => void;
}) {
  const [editing, setEditing] = useState(false);

  if (!editing) {
    return (
      <button type="button" onClick={() => setEditing(true)}>
        Edit
      </button>
    );
  }

  return (
    <form
      onSubmit={(e) => {
        e.preventDefault();
        const form = e.target as HTMLFormElement;
        const content = new FormData(form).get("content") as string;

        form.reset();
        onEdit({ type: "human", content });
        setEditing(false);
      }}
    >
      <input name="content" defaultValue={message.content as string} />
      <button type="submit">Save</button>
    </form>
  );
}

export default function App() {
  const thread = useStream({
    apiUrl: "https://127.0.0.1:2024",
    assistantId: "agent",
    messagesKey: "messages",
  });

  return (
    <div>
      <div>
        {thread.messages.map((message) => {
          const meta = thread.getMessagesMetadata(message);
          const parentCheckpoint = meta?.firstSeenState?.parent_checkpoint;

          return (
            <div key={message.id}>
              <div>{message.content as string}</div>

              {message.type === "human" && (
                <EditMessage
                  message={message}
                  onEdit={(message) =>
                    thread.submit(
                      { messages: [message] },
                      { checkpoint: parentCheckpoint },
                    )
                  }
                />
              )}

              {message.type === "ai" && (
                <button
                  type="button"
                  onClick={() =>
                    thread.submit(undefined, { checkpoint: parentCheckpoint })
                  }
                >
                  <span>Regenerate</span>
                </button>
              )}

              <BranchSwitcher
                branch={meta?.branch}
                branchOptions={meta?.branchOptions}
                onSelect={(branch) => thread.setBranch(branch)}
              />
            </div>
          );
        })}
      </div>

      <form
        onSubmit={(e) => {
          e.preventDefault();

          const form = e.target as HTMLFormElement;
          const message = new FormData(form).get("message") as string;

          form.reset();
          thread.submit({ messages: [message] });
        }}
      >
        <input type="text" name="message" />

        {thread.isLoading ? (
          <button key="stop" type="button" onClick={() => thread.stop()}>
            Stop
          </button>
        ) : (
          <button key="submit" type="submit">
            Send
          </button>
        )}
      </form>
    </div>
  );
}

对于高级用例，你可以使用 experimental_branchTree 属性来获取线程的树状表示，该表示可用于为非基于消息的图渲染分支控件。

TypeScript¶

useStream() Hook 对用 TypeScript 编写的应用程序友好，你可以为状态指定类型，以获得更好的类型安全性和 IDE 支持。

// Define your types
type State = {
  messages: Message[];
  context?: Record<string, unknown>;
};

// Use them with the hook
const thread = useStream<State>({
  apiUrl: "https://127.0.0.1:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

你还可以选择为不同场景指定类型，例如

ConfigurableType: config.configurable 属性的类型（默认值：Record<string, unknown>）
InterruptType: 中断值的类型 - 即 interrupt(...) 函数的内容（默认值：unknown）
CustomEventType: 自定义事件的类型（默认值：unknown）
UpdateType: 提交函数的类型（默认值：Partial<State>）

const thread = useStream<State, {
  UpdateType: {
    messages: Message[] | Message;
    context?: Record<string, unknown>;
  };
  InterruptType: string;
  CustomEventType: {
    type: "progress" | "debug";
    payload: unknown;
  };
  ConfigurableType: {
    model: string;
  };
}>({
  apiUrl: "https://127.0.0.1:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

如果你正在使用 LangGraph.js，你还可以重用图的注释类型。但是，请确保仅导入注释架构的类型，以避免导入整个 LangGraph.js 运行时（即，通过 import type { ... } 指令）。

import {
  Annotation,
  MessagesAnnotation,
  type StateType,
  type UpdateType,
} from "@langchain/langgraph/web";

const AgentState = Annotation.Root({
  ...MessagesAnnotation.spec,
  context: Annotation<string>(),
});

const thread = useStream<
  StateType<typeof AgentState.spec>,
  { UpdateType: UpdateType<typeof AgentState.spec> }
>({
  apiUrl: "https://127.0.0.1:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

事件处理¶

useStream() Hook 提供了几个回调选项，以帮助你响应不同的事件

onError: 发生错误时调用。
onFinish: 流完成时调用。
onUpdateEvent: 接收到更新事件时调用。
onCustomEvent: 接收到自定义事件时调用。请参阅“自定义事件”以了解如何流式传输自定义事件。
onMetadataEvent: 接收到元数据事件时调用，其中包含运行 ID 和线程 ID。

了解更多¶

JS/TS SDK 参考