メインコンテンツへ移動

toAISdkV5Messages()

さまざまな入力形式のメッセージを、AI SDK V5 以降の UI メッセージ形式に変換します。この関数は、文字列、AI SDK V4/V5 メッセージ、Mastra DB メッセージなど、複数の形式のメッセージを受け取り、AI SDK V5 以降の UIMessage 形式に正規化します。この形式は、useChat() などの AI SDK UI コンポーネントでの使用に適しています。

使用例
使用例への直接リンク

app/chat/page.tsx
import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'
import { useChat } from 'ai/react'

// Stored messages from your database, memory or API
const storedMessages = [
{ id: '1', role: 'user', content: 'Hello', parts: [{ type: 'text', text: 'Hello' }] },
{
id: '2',
role: 'assistant',
content: 'Hi there!',
parts: [{ type: 'text', text: 'Hi there!' }],
},
]

export default function Chat() {
const { messages } = useChat({
initialMessages: toAISdkV5Messages(storedMessages),
})

return (
<div>
{messages.map(message => (
<div key={message.id}>
{message.role}: {message.parts.map(part => (part.type === 'text' ? part.text : null))}
</div>
))}
</div>
)
}

パラメーター
パラメーターへの直接リンク

messages:

MessageListInput
変換するメッセージ。文字列、文字列の配列、単一のメッセージオブジェクト、またはサポートされている任意の形式のメッセージオブジェクト配列を指定できます。

戻り値
戻り値への直接リンク

次の構造を持つ AI SDK V5 以降の UIMessage オブジェクトの配列を返します。

id:

string
メッセージの一意な識別子。

role:

'user' | 'assistant' | 'system'
メッセージ送信者のロール。

parts:

UIMessagePart[]
テキスト、Tool の結果、ファイル、推論、ソース、ステップマーカーを含む UI パーツの配列。

metadata?:

Record<string, unknown>
createdAt、threadId、resourceId、カスタムフィールドを含む任意のメタデータ。

例への直接リンク

テキストメッセージの変換
テキストメッセージの変換への直接リンク

import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'

const messages = toAISdkV5Messages(['Hello', 'How can I help you today?'])
// Returns array of UIMessage objects with user role

Mastra クライアントを使用したメッセージの読み込み
Mastra クライアントを使用したメッセージの読み込みへの直接リンク

import { MastraClient } from '@mastra/client-js'
import { toAISdkV5Messages } from '@mastra/ai-sdk/ui'

const client = new MastraClient()

const { messages } = await client.listThreadMessages('thread-id', { agentId: 'myAgent' })
const uiMessages = toAISdkV5Messages(messages)