toAISdkMessages()

各種入力形式のメッセージを AI SDK の UI メッセージ形式に変換します。toAISdkMessages() では、既存の AI SDK v5 のデフォルト動作が維持されます。アプリが AI SDK v6 に対して型付けされている場合は、version: 'v6' を渡してください。

version: 'v6' では、MessageList の AI SDK v6 UI 出力パスが使用されます。MessageList の入力検出と取り込みは変更されません。

使用例

app/chat/page.tsx

import { toAISdkMessages } 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: toAISdkMessages(storedMessages, { version: 'v6' }),
  })

  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

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

options.version?:

'v5' | 'v6'

返す AI SDK のメッセージ型を選択します。既存のデフォルト動作を使用するには、省略するか 'v5' を渡します。アプリが AI SDK v6 の useChat() メッセージ型に対して型付けされている場合は、'v6' を渡します。

戻り値

選択したバージョンに対応する型の AI SDK UIMessage オブジェクトの配列を返します。

id:

string

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

role:

'user' | 'assistant' | 'system'

メッセージ送信者のロール。

parts:

UIMessagePart[]

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

metadata?:

Record<string, unknown>

createdAt、threadId、resourceId、カスタムフィールドを含む任意のメタデータ。

例

デフォルトの AI SDK v5 型を使用する

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

const messages = toAISdkMessages(['Hello', 'How can I help you today?'])

AI SDK v6 のメッセージ型を返す

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

const messages = toAISdkMessages(['Hello', 'How can I help you today?'], {
  version: 'v6',
})

Mastra クライアントでメッセージを読み込む

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

const client = new MastraClient()

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

関連項目

• toAISdkStream()
• toAISdkV5Messages()
• toAISdkV4Messages()