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'，即可使用現有的預設行為。請傳入 'v6'，以便搭配 AI SDK v6 useChat() 訊息型別使用。

傳回值

傳回一個 AI SDK UIMessage 物件陣列，其型別取決於選取的版本。

id:

string

唯一的訊息識別碼。

role:

'user' | 'assistant' | 'system'

訊息傳送者的角色。

parts:

UIMessagePart[]

UI 部分的陣列，包含文字、Tool 結果、檔案、推理、來源及步驟標記。

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()