以编程方式使用文档

生成式用户界面(Generative UI)允许智能体超越文本,生成丰富的用户界面。这使得创建更具交互性和上下文感知能力的应用程序成为可能,用户界面可根据对话流程和 AI 响应进行自适应。

!Agent Chat showing a prompt about booking/lodging and a generated set of hotel listing cards (images, titles, prices, locations) rendered inline as UI components.

LangSmith 支持将您的 React 组件与图形代码放在一起。这允许您专注于为图形构建特定的 UI 组件,同时轻松接入现有的聊天界面,例如 Agent Chat 并仅在实际需要时加载代码。

教程

1. 定义并配置 UI 组件

首先,创建您的第一个 UI 组件。对于每个组件,您需要提供一个唯一标识符,用于在图形代码中引用该组件。

const WeatherComponent = (props: { city: string }) => {
  return Weather for {props.city};
};

  weather: WeatherComponent,
};

接下来,在您的 langgraph.json configuration:

{
  "node_version": "20",
  "graphs": {
    "agent": "./src/agent/index.ts:graph"
  },
  "ui": {
    "agent": "./src/agent/ui.tsx"
  }
}

中定义您的 UI 组件 ui 部分指向图形将使用的 UI 组件。默认情况下,我们建议使用与图形名称相同的键,但您可以按自己喜欢的方式拆分组件,请参阅 自定义 UI 组件的命名空间 了解更多详情。

LangSmith 会自动打包您的 UI 组件代码和样式,并将其作为外部资源提供服务,可由 LoadExternalComponent 组件加载。某些依赖项如 reactreact-dom 将自动从包中排除。

CSS 和 Tailwind 4.x 也开箱即用支持,因此您可以在 UI 组件中自由使用 Tailwind 类和 shadcn/ui

src/agent/ui.tsx

    const WeatherComponent = (props: { city: string }) => {
      return Weather for {props.city};
    };

      weather: WeatherComponent,
    };
    

src/agent/styles.css

    @import "tailwindcss";
    

2. 在图形中发送 UI 组件

Python

    from typing import Annotated, Sequence, TypedDict

    from langchain.messages import AIMessage
    from langchain_core.messages import BaseMessage
    from langchain_openai import ChatOpenAI
    from langgraph.graph import StateGraph
    from langgraph.graph.message import add_messages
    from langgraph.graph.ui import AnyUIMessage, ui_message_reducer, push_ui_message


    class AgentState(TypedDict):  # noqa: D101
        messages: Annotated[Sequence[BaseMessage], add_messages]
        ui: Annotated[Sequence[AnyUIMessage], ui_message_reducer]


    async def weather(state: AgentState):
        class WeatherOutput(TypedDict):
            city: str

        weather: WeatherOutput = (
            await ChatOpenAI(model="gpt-5.4-mini")
            .with_structured_output(WeatherOutput)
            .with_config({"tags": ["nostream"]})
            .ainvoke(state["messages"])
        )

        message = AIMessage(
            id=str(uuid.uuid4()),
            content=f"Here's the weather for {weather['city']}",
        )

        # Emit UI elements associated with the message
        push_ui_message("weather", weather, message=message)
        return {"messages": [message]}


    workflow = StateGraph(AgentState)
    workflow.add_node(weather)
    workflow.add_edge("__start__", "weather")
    graph = workflow.compile()
    

JS

使用 typedUi 工具从您的智能体节点发出 UI 元素:

      typedUi,
      uiMessageReducer,
    } from "@langchain/langgraph-sdk/react-ui/server";




      Annotation,
      MessagesAnnotation,
      StateGraph,
      type LangGraphRunnableConfig,
    } from "@langchain/langgraph";

    const AgentState = Annotation.Root({
      ...MessagesAnnotation.spec,
      ui: Annotation({ reducer: uiMessageReducer, default: () => [] }),
    });

      .addNode("weather", async (state, config) => {
        // Provide the type of the component map to ensure
        // type safety of `ui.push()` calls as well as
        // pushing the messages to the `ui` and sending a custom event as well.
        const ui = typedUi<typeof ComponentMap>(config);

        const weather = await new ChatOpenAI({ model: "gpt-5.4-mini" })
          .withStructuredOutput(z.object({ city: z.string() }))
          .withConfig({ tags: ["nostream"] })
          .invoke(state.messages);

        const response = {
          id: crypto.randomUUID(),
          type: "ai",
          content: `Here's the weather for ${weather.city}`,
        };

        // Emit UI elements associated with the AI message
        ui.push({ name: "weather", props: weather }, { message: response });

        return { messages: [response] };
      })
      .addEdge("__start__", "weather")
      .compile();
    

3. 在 React 应用程序中处理 UI 元素

在客户端,您可以使用 useStream()LoadExternalComponent 来显示 UI 元素。

"use client";



  const { thread, values } = useStream({
    apiUrl: "http://localhost:2024",
    assistantId: "agent",
  });

  return (

      {thread.messages.map((message) => (

          {message.content}
          {values.ui
            ?.filter((ui) => ui.metadata?.message_id === message.id)
            .map((ui) => (

            ))}

      ))}

  );
}

在幕后, LoadExternalComponent 将从 LangSmith 获取 UI 组件的 JS 和 CSS,并在 Shadow DOM 中渲染它们,从而确保与应用程序其他部分的样式隔离。

操作指南

在客户端提供自定义组件

如果您已经在客户端应用程序中加载了组件,可以提供这些组件的映射,以便直接渲染,而无需从 LangSmith 获取 UI 代码。

const clientComponents = {
  weather: WeatherComponent,
};

;

组件加载时显示加载 UI

您可以提供后备 UI,在组件加载时进行渲染。

自定义 UI 组件的命名空间。

默认情况下 LoadExternalComponent 将使用 assistantId 中的 useStream() 来获取 UI 组件的代码。您可以通过向 namespace 提供 LoadExternalComponent component.

src/app/page.tsx


    

langgraph.json

    {
      "ui": {
        "custom-namespace": "./src/agent/ui.tsx"
      }
    }
    

从 UI 组件访问和交互线程状态

您可以通过使用以下方式在 UI 组件内访问线程状态 useStreamContext hook.

const WeatherComponent = (props: { city: string }) => {
  const { thread, submit } = useStreamContext();
  return (
    <>
      Weather for {props.city}

      <button
        onClick={() => {
          const newMessage = {
            type: "human",
            content: `What's the weather in ${props.city}?`,
          };

          submit({ messages: [newMessage] });
        }}
      >
        Retry
      </button>
    </>
  );
};

向客户端组件传递额外的上下文

您可以通过向以下组件提供以下内容来向客户端组件传递额外的上下文 meta prop 传递给 LoadExternalComponent component.

然后,您可以通过以下方式访问 meta UI 组件中使用以下方式访问 prop useStreamContext hook.

const WeatherComponent = (props: { city: string }) => {
  const { meta } = useStreamContext<
    { city: string },
    { MetaType: { userId?: string } }
  >();

  return (

      Weather for {props.city} (user: {meta?.userId})

  );
};

从服务器流式传输 UI 消息

您可以通过使用以下回调在节点执行完成前流式传输 UI 消息 onCustomEvent 的回调 useStream() hook。当 LLM 生成响应时更新 UI 组件时,这特别有用。

const { thread, submit } = useStream({
  apiUrl: "http://localhost:2024",
  assistantId: "agent",
  onCustomEvent: (event, options) => {
    options.mutate((prev) => {
      const ui = uiMessageReducer(prev.ui ?? [], event);
      return { ...prev, ui };
    });
  },
});

然后,您可以通过调用以下方法向 UI 组件推送更新 ui.push() / push_ui_message() 并使用与要更新的 UI 消息相同的 ID。

Python

    from typing import Annotated, Sequence, TypedDict

    from langchain_anthropic import ChatAnthropic
    from langchain.messages import AIMessage, AIMessageChunk, BaseMessage
    from langgraph.graph import StateGraph
    from langgraph.graph.message import add_messages
    from langgraph.graph.ui import AnyUIMessage, push_ui_message, ui_message_reducer


    class AgentState(TypedDict):  # noqa: D101
        messages: Annotated[Sequence[BaseMessage], add_messages]
        ui: Annotated[Sequence[AnyUIMessage], ui_message_reducer]


    class CreateTextDocument(TypedDict):
        """Prepare a document heading for the user."""

        title: str


    async def writer_node(state: AgentState):
        model = ChatAnthropic(model="claude-sonnet-4-6")
        message: AIMessage = await model.bind_tools(
            tools=[CreateTextDocument],
            tool_choice={"type": "tool", "name": "CreateTextDocument"},
        ).ainvoke(state["messages"])

        tool_call = next(
            (x["args"] for x in message.tool_calls if x["name"] == "CreateTextDocument"),
            None,
        )

        if tool_call:
            ui_message = push_ui_message("writer", tool_call, message=message)
            ui_message_id = ui_message["id"]

            # We're already streaming the LLM response to the client through UI messages
            # so we don't need to stream it again to the `messages` stream mode.
            content_stream = model.with_config({"tags": ["nostream"]}).astream(
                f"Create a document with the title: {tool_call['title']}"
            )

            content: AIMessageChunk | None = None
            async for chunk in content_stream:
                content = content + chunk if content else chunk

                push_ui_message(
                    "writer",
                    {"content": content.text()},
                    id=ui_message_id,
                    message=message,
                    # Use `merge=True` to merge props with the existing UI message
                    merge=True,
                )

        return {"messages": [message]}
    

JS

      Annotation,
      MessagesAnnotation,
      type LangGraphRunnableConfig,
    } from "@langchain/langgraph";



      typedUi,
      uiMessageReducer,
    } from "@langchain/langgraph-sdk/react-ui/server";



    const AgentState = Annotation.Root({
      ...MessagesAnnotation.spec,
      ui: Annotation({ reducer: uiMessageReducer, default: () => [] }),
    });

    async function writerNode(
      state: typeof AgentState.State,
      config: LangGraphRunnableConfig
    ): Promise<typeof AgentState.Update> {
      const ui = typedUi<typeof ComponentMap>(config);

      const model = new ChatAnthropic({ model: "claude-sonnet-4-6" });
      const message = await model
        .bindTools(
          [
            {
              name: "create_text_document",
              description: "Prepare a document heading for the user.",
              schema: z.object({ title: z.string() }),
            },
          ],
          { tool_choice: { type: "tool", name: "create_text_document" } }
        )
        .invoke(state.messages);

      type ToolCall = { name: "create_text_document"; args: { title: string } };
      const toolCall = message.tool_calls?.find(
        (tool): tool is ToolCall => tool.name === "create_text_document"
      );

      if (toolCall) {
        const { id, name } = ui.push(
          { name: "writer", props: { title: toolCall.args.title } },
          { message }
        );

        const contentStream = await model
          // We're already streaming the LLM response to the client through UI messages
          // so we don't need to stream it again to the `messages` stream mode.
          .withConfig({ tags: ["nostream"] })
          .stream(`Create a short poem with the topic: ${message.text}`);

        let content: AIMessageChunk | undefined;
        for await (const chunk of contentStream) {
          content = content?.concat(chunk) ?? chunk;

          ui.push(
            { id, name, props: { content: content?.text } },
            // Use `merge: true` to merge props with the existing UI message
            { message, merge: true }
          );
        }
      }

      return { messages: [message] };
    }
    

ui.tsx

    function WriterComponent(props: { title: string; content?: string }) {
      return (
        <article>
          <h2>{props.title}</h2>
          <p>{props.content}</p>
        </article>
      );
    }

      weather: WriterComponent,
    };
    

从状态中移除 UI 消息

与通过添加 RemoveMessage 从状态中移除消息的方式类似,您可以通过调用以下方法从状态中移除 UI 消息 remove_ui_message / ui.delete 并使用 UI 消息的 ID。

Python

    from langgraph.graph.ui import push_ui_message, delete_ui_message

    # push message
    message = push_ui_message("weather", {"city": "London"})

    # remove said message
    delete_ui_message(message["id"])
    

JS

    // push message
    const message = ui.push({ name: "weather", props: { city: "London" } });

    // remove said message
    ui.delete(message.id);
    

了解更多