跳至主要內容

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[]
UI 部分的陣列,包括文字、Tool 結果、檔案、推理、來源及步驟標記。

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 client 載入訊息
使用 Mastra client 載入訊息 的直接連結

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)