AIチャット
AIのチャット画面を組み立てるコンポーネントです。通信とメッセージの状態はアプリが持ち、コンポーネントはメッセージの配列を表示します。AI SDKにも自前のバックエンドにもつなげます。
チャット画面のデモ
'use client';
import { Avatar } from '@k8ordo/ui';
import { BotMessageIcon } from '@k8ordo/ui/icons';
import {
Conversation,
Message,
PromptInput,
Suggestion,
} from '@k8ordo/ui/ai';
const avatar = (
<Avatar color="primary" icon={<BotMessageIcon />} name="AI" size="sm" />
);
export function Chat({ messages, send }: Props) {
return (
<div className={styles.chat}>
<Conversation.Root>
<Conversation.Messages>
{messages.map((m) => (
<Message.Root
avatar={m.role === 'assistant' ? avatar : undefined}
from={m.role}
key={m.id}
>
<Message.Content>{m.text}</Message.Content>
{m.role === 'assistant' && (
<Message.Actions>
<Message.Copy value={m.text} />
<Message.Feedback />
</Message.Actions>
)}
</Message.Root>
))}
</Conversation.Messages>
<Conversation.ScrollButton />
</Conversation.Root>
<Suggestion.List>
<Suggestion.Item onSelect={send} value="Tell me about IME support" />
</Suggestion.List>
<PromptInput.Root accept="image/*,application/pdf" onSubmit={send}>
<PromptInput.Attachments />
<PromptInput.Attach />
<PromptInput.Textarea placeholder="Type a message…" />
<PromptInput.Submit />
</PromptInput.Root>
</div>
);
}これらのコンポーネントで組んだチャット画面です。ツールの実行を許可すると、回答と出典が表示されます。メッセージの送信、ファイルの添付、回答のコピーや評価もできます。
基本の構成
'use client';
import { Avatar } from '@k8ordo/ui';
import { BotMessageIcon } from '@k8ordo/ui/icons';
import { Conversation, Message, PromptInput } from '@k8ordo/ui/ai';
import { useChat } from '@ai-sdk/react';
import type { UIMessage } from 'ai';
const textOf = (m: UIMessage) =>
m.parts.map((p) => (p.type === 'text' ? p.text : '')).join('');
export function Chat() {
const { messages, sendMessage, status, stop } = useChat();
return (
<div className={styles.chat}>
<Conversation.Root>
<Conversation.Messages isStreaming={status === 'streaming'}>
{messages.map((m) => (
<Message.Root
avatar={
m.role === 'user' ? undefined : (
<Avatar
color="primary"
icon={<BotMessageIcon />}
name="AI"
size="sm"
/>
)
}
from={m.role === 'user' ? 'user' : 'assistant'}
key={m.id}
>
<Message.Content>{textOf(m)}</Message.Content>
</Message.Root>
))}
</Conversation.Messages>
<Conversation.ScrollButton />
</Conversation.Root>
<PromptInput.Root
onStop={stop}
onSubmit={(text) => sendMessage({ text })}
status={status}
>
<PromptInput.Textarea placeholder="Type a message" />
<PromptInput.Submit />
</PromptInput.Root>
</div>
);
}Conversationは会話のスクロール領域です。新しいメッセージが来ると末尾までスクロールします。上にスクロールしているあいだは、ScrollButtonで最新のメッセージに戻れます。
Message.Rootは1つのメッセージです。from="user"は右寄せの吹き出しに、from="assistant"は吹き出しの無い本文になります。avatarはメッセージの横に置かれ、子要素はその隣に縦に並びます。
PromptInputは入力欄です。3つとも@k8ordo/ui/aiからimportします。
入力欄
<PromptInput.Root status={status} onSubmit={send} onStop={stop}>
<PromptInput.Textarea placeholder="Type a message" />
<PromptInput.Submit />
</PromptInput.Root>Enterで送信し、Shift+Enterで改行します。IMEの変換を確定するEnterでは送信しません。本文は前後の空白を除いてonSubmitに渡されます。本文も添付も無いメッセージは送信しません。
statusの値はAI SDKのstatusと同じで、readyかsubmittedかstreamingかerrorです。submittedとstreamingのあいだはSubmitが停止ボタンになり、押すとonStopが呼ばれます。
ファイルの添付
<PromptInput.Root
accept="image/*,application/pdf"
maxFiles={4}
onSubmit={(text, files) =>
sendMessage(text === '' ? { files } : { text, files })
}
status={status}
>
<PromptInput.Attachments />
<PromptInput.Attach />
<PromptInput.Textarea placeholder="Type a message" />
<PromptInput.Submit />
</PromptInput.Root>acceptを渡すと、Attachのファイル選択とドロップ、貼り付けでファイルを受け取ります。どの経路も、<input accept>と同じ規則で絞られます。acceptが無いときはテキストだけを受け取り、Attachは何も表示しません。
送る前のファイルはPromptInput.Attachmentsに並び、それぞれに削除ボタンが付きます。Textareaの上に1行を使うので、先頭に置きます。maxFilesを超えた分は受け取りません。
onSubmitの第2引数がFileListで、AI SDKのsendMessageにそのまま渡せます。添付だけを送るときは{ files }だけを渡します。text: ''を渡すと空のテキストパートになり、プロバイダによってはエラーになります。
質問の候補
import { Suggestion } from '@k8ordo/ui/ai';
<Suggestion.List>
{suggestions.map((s) => (
<Suggestion.Item key={s} onSelect={send} value={s} />
))}
</Suggestion.List>Suggestion.Itemは候補のチップです。押すとvalueがonSelectに渡ります。childrenを省くと、valueがそのまま表示の文字になります。
Markdownの表示
import { Response } from '@k8ordo/ui/ai/response';
<Message.Content>
<Response isStreaming={isStreaming}>{markdown}</Response>
</Message.Content>Responseは、ストリーミング中のMarkdownを表示します。閉じていないコードブロックがあっても崩れません。@k8ordo/ui/ai/responseからimportします。
streamdownの2.5以上を入れます。
npm install streamdownメモ
Responseのスタイルは、streamdownが要素に付けるdata-streamdown属性に合わせて書いてあります。Tailwind CSSは要りません。streamdown/styles.cssが要るのは、streamdownのanimatedを使うときだけです。
ツールと思考の表示
import { Reasoning, ToolInvocation } from '@k8ordo/ui/ai';
<Reasoning isStreaming={isThinking}>{reasoningText}</Reasoning>
<ToolInvocation
name="search_web"
state="output-available"
input={{ query: 'k8ordo UI' }}
output="…"
/>ToolInvocationはツールの呼び出しを折りたたみで表示します。アイコンはstateに応じて変わります。実行中はスピナーで、終わると成功かエラーか拒否のアイコンになります。stateの値はAI SDKのツールのパートと同じです。
inputは文字列以外ならJSONで表示されます。outputは文字列ならpreに、要素ならそのまま表示されます。Reasoningは思考の過程を折りたたみで表示します。isStreamingのあいだは、ラベルが「思考中…」になります。
ツールの承認
import { useChat } from '@ai-sdk/react';
import { lastAssistantMessageIsCompleteWithApprovalResponses } from 'ai';
const { addToolApprovalResponse } = useChat({
sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithApprovalResponses,
});
<ToolInvocation
name={part.name}
state={part.state}
input={part.input}
approval={part.approval}
onApprovalResponse={addToolApprovalResponse}
/>stateがapproval-requestedのときは、approvalとonApprovalResponseを渡します。折りたたみの外に、問いと「拒否」「許可」のボタンが出ます。問いはapproval.requestReasonで、無ければ既定の文言です。押すとonApprovalResponse({ id, approved })が呼ばれます。
この形はAI SDKのaddToolApprovalResponseの引数と同じなので、そのまま渡せます。答えを自動で送り返すには、useChatにsendAutomaticallyWhenを渡します。無ければ、答えたあとに何も起きません。
approval.isAutomaticのときは問いもボタンも出ません。onApprovalResponseが無ければ、問いだけが出ます。output-deniedではapproval.reasonが理由として表示されます。
添付ファイルと出典
import { Attachment, Source } from '@k8ordo/ui/ai';
<Message.Root from="user">
<Attachment.List>
<Attachment.Item filename="diagram.png" mediaType="image/png" url={url} />
</Attachment.List>
<Message.Content>{text}</Message.Content>
</Message.Root>
<Source.List>
<Source.Item href="https://ordo.k8o.me/ui/ai/chat" title="AI chat" />
<Source.Item title="Internal design doc" />
</Source.List>Attachment.Itemは、メッセージに添えられたファイルです。画像はfilenameを代替テキストにしたサムネイルに、それ以外は名前と種類のチップになります。画像のurlは描画と同時に読み込まれるので、自分のサーバーが作ったURLかdata URLを渡します。
Source.Itemは回答の出典です。hrefがhttp(s)のURLなら、新しいタブで開くリンクになります。表示する文字列はtitleで、無ければホスト名です。それ以外は文字だけで表示されます。
メッセージの操作
<Message.Root avatar={avatar} from="assistant">
<Message.Content>{text}</Message.Content>
<Message.Actions>
<Message.Copy value={text} />
<Message.Regenerate onAction={() => regenerate({ messageId: message.id })} />
<Message.Feedback onChange={(value) => saveFeedback(message.id, value)} />
</Message.Actions>
</Message.Root>Message.Actionsは、メッセージの下に置くアイコンボタンの列です。CopyとRegenerateとFeedbackは、アイコンと文言を持っています。ほかの操作は、Actionにlabelとアイコンを渡して足します。labelはツールチップにも出ます。
onActionがPromiseを返すと、終わるまでボタンは押せなくなります。Feedbackは2つのトグルです。押したものをもう一度押すと解除され、onChangeにnullが渡ります。
AI SDKとの連携
import { mapMessageParts } from '@k8ordo/ui/ai-sdk';
import { Attachment, Reasoning, Source, ToolInvocation } from '@k8ordo/ui/ai';
import { Response } from '@k8ordo/ui/ai/response';
import { validateGeneratedSpec } from '@k8ordo/ui/json-render';
import { JsonRenderUI } from '@k8ordo/ui/json-render/registry';
const parts = mapMessageParts(message);
const files = parts.filter((part) => part.kind === 'file');
const sources = parts.filter((part) => part.kind === 'source');
<Message.Root from="assistant">
{files.length > 0 && (
<Attachment.List>
{files.map((file) => (
<Attachment.Item
filename={file.filename}
key={file.url}
mediaType={file.mediaType}
url={file.url}
/>
))}
</Attachment.List>
)}
{parts.map((part, i) => {
if (part.kind === 'text') {
return (
<Message.Content key={i}>
<Response>{part.text}</Response>
</Message.Content>
);
}
if (part.kind === 'reasoning') return <Reasoning key={i}>{part.text}</Reasoning>;
if (part.kind === 'tool') {
return (
<ToolInvocation
key={part.toolCallId}
name={part.name}
state={part.state}
input={part.input}
output={
part.output === undefined
? undefined
: JSON.stringify(part.output, null, 2)
}
errorText={part.errorText}
approval={part.approval}
onApprovalResponse={addToolApprovalResponse}
/>
);
}
if (part.kind === 'data' && part.name === 'ui') {
const result = validateGeneratedSpec(part.data);
return result.ok ? <JsonRenderUI key={i} spec={result.spec} /> : null;
}
return null;
})}
{sources.length > 0 && (
<Source.List>
{sources.map((source) => (
<Source.Item href={source.url} key={source.id} title={source.title} />
))}
</Source.List>
)}
</Message.Root>@k8ordo/ui/ai-sdkのmapMessagePartsは、AI SDKのUIMessage.partsを表示しやすい1次元の配列に変えます。パートは種類にかかわらず元の順に並びます。
ツールのパートはapprovalも含むので、ToolInvocationにそのまま渡せます。ファイルと出典はfilterで先に取り出し、それぞれ1つの一覧にまとめます。dataのパートはnameで選び、中身を検証してから表示します。
aiは任意のpeer dependencyです。7.0.51以上を入れます。
吹き出しの中の生成UI
'use client';
import { Message } from '@k8ordo/ui/ai';
import { JsonRenderUI } from '@k8ordo/ui/json-render/registry';
<Message.Root from="assistant">
<Message.Content>
<JsonRenderUI spec={spec} />
</Message.Content>
</Message.Root>Message.Contentの子要素は自由です。LLMがツールの結果として返したUIのspecを、json-renderのアダプタで吹き出しの中に表示できます。
アダプタの使い方はGenerative UIを見てください。
Props
コンポーネントの型から作ったpropsの一覧です。labelやsendLabelを省くと、@k8ordo/i18nの現在のロケールの辞書の文言になります。ReasoningとToolInvocationの開閉、Message.Feedbackの値は、制御と非制御のどちらでも使えます。
Conversation.Root
children- Type:
ReactNode - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
Conversation.Messages
children- Type:
ReactNode - Default: -
isStreaming?- Type:
boolean - Default:
false label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
isStreaming? | boolean | false |
label? | string | - |
Conversation.ScrollButton
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
label? | string | - |
Message.Root
children- Type:
ReactNode - Default: -
from- Type:
'user'|'assistant' - Default: -
avatar?- Type:
ReactNode - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
from | 'user'|'assistant' | - |
avatar? | ReactNode | - |
継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>
Message.Content
children- Type:
ReactNode - Default: -
isStreaming?- Type:
boolean - Default:
false
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
isStreaming? | boolean | false |
継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>
Message.Actions
children- Type:
ReactNode - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
label? | string | - |
Message.Action
children- Type:
ReactNode - Default: -
label- Type:
string - Default: -
disabled?- Type:
boolean - Default: -
onAction?- Type:
() => void | Promise<void> - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
label | string | - |
disabled? | boolean | - |
onAction? | () => void | Promise<void> | - |
Message.Copy
value- Type:
string - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
value | string | - |
label? | string | - |
Message.Regenerate
onAction- Type:
() => void | Promise<void> - Default: -
disabled?- Type:
boolean - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
onAction | () => void | Promise<void> | - |
disabled? | boolean | - |
label? | string | - |
Message.Feedback
defaultValue?- Type:
MessageFeedback|null - Default:
null onChange?- Type:
(value: MessageFeedback | null) => void - Default: -
value?- Type:
MessageFeedback|null - Default: -
| Prop | Type | Default |
|---|---|---|
defaultValue? | MessageFeedback|null | null |
onChange? | (value: MessageFeedback | null) => void | - |
value? | MessageFeedback|null | - |
PromptInput.Root
children- Type:
ReactNode - Default: -
accept?- Type:
string - Default: -
defaultValue?- Type:
string - Default:
'' maxFiles?- Type:
number - Default: -
onChange?- Type:
(value: string) => void - Default: -
onStop?- Type:
() => void - Default: -
onSubmit?- Type:
(message: string, files: FileList) => void - Default: -
status?- Type:
ChatStatus - Default:
'ready' value?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
accept? | string | - |
defaultValue? | string | '' |
maxFiles? | number | - |
onChange? | (value: string) => void | - |
onStop? | () => void | - |
onSubmit? | (message: string, files: FileList) => void | - |
status? | ChatStatus | 'ready' |
value? | string | - |
PromptInput.Attachments
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
label? | string | - |
PromptInput.Attach
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
label? | string | - |
PromptInput.Textarea
children?- Type:
ReactNode - Default: -
placeholder?- Type:
string - Default: -
ref?- Type:
Ref<HTMLTextAreaElement> - Default: -
| Prop | Type | Default |
|---|---|---|
children? | ReactNode | - |
placeholder? | string | - |
ref? | Ref<HTMLTextAreaElement> | - |
継承する属性(内部で固定するものを除く): TextareaHTMLAttributes<HTMLTextAreaElement>
PromptInput.Submit
sendLabel?- Type:
string - Default: -
stopLabel?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
sendLabel? | string | - |
stopLabel? | string | - |
Suggestion.List
children- Type:
ReactNode - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
label? | string | - |
Suggestion.Item
value- Type:
string - Default: -
children?- Type:
ReactNode - Default: -
onSelect?- Type:
(value: string) => void - Default: -
| Prop | Type | Default |
|---|---|---|
value | string | - |
children? | ReactNode | - |
onSelect? | (value: string) => void | - |
Response
children- Type:
string - Default: -
isStreaming?- Type:
boolean - Default:
false
| Prop | Type | Default |
|---|---|---|
children | string | - |
isStreaming? | boolean | false |
継承する属性(内部で固定するものを除く): StreamdownProps
Reasoning
children- Type:
ReactNode - Default: -
defaultOpen?- Type:
boolean - Default:
false isOpen?- Type:
boolean - Default: -
isStreaming?- Type:
boolean - Default:
false onChange?- Type:
(isOpen: boolean) => void - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
defaultOpen? | boolean | false |
isOpen? | boolean | - |
isStreaming? | boolean | false |
onChange? | (isOpen: boolean) => void | - |
ToolInvocation
name- Type:
string - Default: -
state- Type:
ToolState - Default: -
approval?- Type:
ToolApproval - Default: -
defaultOpen?- Type:
boolean - Default:
false errorText?- Type:
string - Default: -
input?- Type:
unknown - Default: -
isOpen?- Type:
boolean - Default: -
onApprovalResponse?- Type:
(response: ToolApprovalResponse) => void | PromiseLike<void> - Default: -
onChange?- Type:
(isOpen: boolean) => void - Default: -
output?- Type:
ReactNode - Default: -
| Prop | Type | Default |
|---|---|---|
name | string | - |
state | ToolState | - |
approval? | ToolApproval | - |
defaultOpen? | boolean | false |
errorText? | string | - |
input? | unknown | - |
isOpen? | boolean | - |
onApprovalResponse? | (response: ToolApprovalResponse) => void | PromiseLike<void> | - |
onChange? | (isOpen: boolean) => void | - |
output? | ReactNode | - |
Attachment.List
children- Type:
ReactNode - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
label? | string | - |
Attachment.Item
mediaType- Type:
string - Default: -
url- Type:
string - Default: -
filename?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
mediaType | string | - |
url | string | - |
filename? | string | - |
Source.List
children- Type:
ReactNode - Default: -
label?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
children | ReactNode | - |
label? | string | - |
Source.Item
href?- Type:
string - Default: -
title?- Type:
string - Default: -
| Prop | Type | Default |
|---|---|---|
href? | string | - |
title? | string | - |