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

先决条件

useStream() React 钩子提供了一种无缝的方式，可将 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: "http://localhost: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()}>
            停止
          </button>
        ) : (
          <button keytype="submit">发送</button>
        )}
      </form>
    </div>
  );
}

自定义你的用户界面¶

useStream() 钩子在幕后处理所有复杂的状态管理，为你提供构建用户界面的简单接口。以下是你可以直接使用的功能：

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

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

加载状态¶

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

显示加载指示器
在处理过程中禁用输入字段
显示取消按钮

export default function App() {
  const { isLoading, stop } = useStream<{ messages: Message[] }>({
    apiUrl: "http://localhost: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: "http://localhost:2024",
  assistantId: "agent",

  threadId: threadId,
  onThreadId: setThreadId,
});

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

消息处理¶

useStream() 钩子会跟踪从服务器接收到的消息块，并将它们连接在一起以形成完整的消息。可以通过 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: "http://localhost:2024",
    assistantId: "agent",
    messagesKey: "messages",
  });

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

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

中断处理¶

useStream() 钩子暴露了 interrupt 属性，该属性将填充线程的最后一个中断信息。你可以使用中断来：

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

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

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

if (thread.interrupt) {
  return (
    <div>
      Interrupted! {thread.interrupt.value}
      <button
        type="button"
        onClick={() => {
          // `resume` 可以是代理接受的任何值
          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: "http://localhost: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 属性来获取线程的树状表示，该表示可用于为非基于消息的图渲染分支控件。

乐观更新¶

你可以在向代理执行网络请求之前乐观地更新客户端状态，从而为用户提供即时反馈，例如在代理收到请求之前立即显示用户消息。

const stream = useStream({
  apiUrl: "http://localhost:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

const handleSubmit = (text: string) => {
  const newMessage = { type: "human" as const, content: text };

  stream.submit(
    { messages: [newMessage] },
    {
      optimisticValues(prev) {
        const prevMessages = prev.messages ?? [];
        const newMessages = [...prevMessages, newMessage];
        return { ...prev, messages: newMessages };
      },
    }
  );
};

TypeScript¶

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

// 定义你的类型
type State = {
  messages: Message[];
  context?: Record<string, unknown>;
};

// 在钩子中使用它们
const thread = useStream<State>({
  apiUrl: "http://localhost: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: "http://localhost: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: "http://localhost:2024",
  assistantId: "agent",
  messagesKey: "messages",
});

事件处理¶

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

onError：发生错误时调用。
onFinish：流结束时调用。
onUpdateEvent：收到更新事件时调用。
onCustomEvent：收到自定义事件时调用。请参阅自定义事件以了解如何流式传输自定义事件。
onMetadataEvent：收到包含运行 ID 和线程 ID 的元数据事件时调用。

了解更多¶

JS/TS SDK 参考文档