Documentation Index
Fetch the complete documentation index at: https://nvd-54.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
assistant-ui 是一个无头 React UI 框架,用于 AI 聊天。它提供完整的运行时层——线程管理、消息分支、附件处理——通过 useExternalStoreRuntime 适配器连接到 useStream。
工作原理
- 使用
useStream 进行流式传输 —— 连接到你的智能体并获取响应式消息、加载状态和提交/取消回调
- 使用
useExternalStoreRuntime 适配 —— 通过将 BaseMessage[] 转换为 ThreadMessageLike[],将 stream.messages 桥接到 assistant-ui 的运行时格式
- 提供运行时 —— 用
AssistantRuntimeProvider 包裹你的 UI 并渲染任意 assistant-ui 线程组件
bun add @assistant-ui/react @assistant-ui/react-markdown
连接 useStream
useExternalStoreRuntime 适配器将 stream.messages 桥接到 assistant-ui 运行时。将其传递给 AssistantRuntimeProvider 并渲染任意线程组件:
import { useCallback, useMemo } from "react";
import {
AssistantRuntimeProvider,
useExternalStoreRuntime,
type AppendMessage,
type ThreadMessageLike,
} from "@assistant-ui/react";
import { useStream } from "@langchain/react";
import { Thread } from "@assistant-ui/react";
export function Chat() {
const stream = useStream({
apiUrl: "http://localhost:2024",
assistantId: "agent",
});
const onNew = useCallback(
async (message: AppendMessage) => {
const text = message.content
.filter((c) => c.type === "text")
.map((c) => c.text)
.join("");
await stream.submit({ messages: [{ type: "human", content: text }] });
},
[stream],
);
// 将 LangChain 消息转换为 assistant-ui 的 ThreadMessageLike 格式
const messages = useMemo(
() => toThreadMessages(stream.messages),
[stream.messages],
);
const runtime = useExternalStoreRuntime<ThreadMessageLike>({
messages,
onNew,
onCancel: () => stream.stop(),
convertMessage: (m) => m,
});
return (
<AssistantRuntimeProvider runtime={runtime}>
<Thread />
</AssistantRuntimeProvider>
);
}
转换消息
toThreadMessages 将 LangChain BaseMessage[] 映射到 assistant-ui 期望的 ThreadMessageLike[] 格式。处理每种消息类型——human、AI 和 tool——并转换内容块、工具调用和推理 Token:
import { AIMessage, HumanMessage, ToolMessage } from "@langchain/core/messages";
import type { ThreadMessageLike } from "@assistant-ui/react";
export function toThreadMessages(messages: BaseMessage[]): ThreadMessageLike[] {
const result: ThreadMessageLike[] = [];
for (const msg of messages) {
if (HumanMessage.isInstance(msg)) {
result.push({
role: "user",
content: [{ type: "text", text: getTextContent(msg.content) }],
});
} else if (AIMessage.isInstance(msg)) {
const parts: ThreadMessageLike["content"] = [];
// 推理 Token
const reasoning = getReasoningText(msg);
if (reasoning) parts.push({ type: "reasoning", reasoning });
// 工具调用
for (const tc of msg.tool_calls ?? []) {
parts.push({
type: "tool-call",
toolCallId: tc.id ?? "",
toolName: tc.name,
args: tc.args,
});
}
// 文本回复
const text = getTextContent(msg.content);
if (text) parts.push({ type: "text", text });
result.push({ role: "assistant", content: parts });
} else if (ToolMessage.isInstance(msg)) {
// 将工具结果附加到前一条助手消息
const last = result[result.length - 1];
if (last?.role === "assistant") {
for (const part of last.content) {
if (
part.type === "tool-call" &&
part.toolCallId === msg.tool_call_id
) {
(part as { result?: string }).result = getTextContent(msg.content);
}
}
}
}
}
return result;
}
自定义线程 UI
<Thread /> 提供完整的默认线程 UI,包括消息列表、编辑器和滚动管理。通过覆盖组件插槽来自定义各个部分:
import { Thread, ThreadMessages, Composer } from "@assistant-ui/react";
function CustomThread() {
return (
<Thread.Root>
<ThreadMessages
components={{
UserMessage: MyUserMessage,
AssistantMessage: MyAssistantMessage,
ToolFallback: MyToolCard,
}}
/>
<Composer />
</Thread.Root>
);
}
最佳实践
- **缓存消息转换:**将
toThreadMessages(stream.messages) 包裹在 useMemo 中,避免每次渲染都重新运行转换
- **处理附件:**使用
CompositeAttachmentAdapter 配合 SimpleImageAttachmentAdapter 处理图片上传;使用自定义适配器扩展文件支持
- **使用分支功能:**assistant-ui 通过
MessageBranch 内置了消息分支支持;编辑消息即可从该点重新生成
- **线程持久化:**使用
fetchStateHistory: true 和 reconnectOnMount: true 的 useStream 让 assistant-ui 在页面加载时访问完整的线程历史
将这些文档连接到 Claude、VSCode 等工具,通过 MCP 获取实时答案。