跳至主要內容

toAISdkV4Messages()

將輸入格式的訊息轉換為 AI SDK V4 UI 訊息格式。此函式接受多種格式的訊息(字串、AI SDK V4/V5 訊息、Mastra 資料庫訊息等),並將其正規化為 AI SDK V4 UIMessage 格式,適合搭配 useChat() 等 AI SDK UI 元件使用。

使用範例
「使用範例」的直接連結

app/chat/page.tsx
import { toAISdkV4Messages } from '@mastra/ai-sdk'
import { useChat } from 'ai/react' // AI SDK V4

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

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

return (
<div>
{messages.map(message => (
<div key={message.id}>
{message.role}: {message.content}
</div>
))}
</div>
)
}

參數
「參數」的直接連結

messages:

MessageListInput
要轉換的訊息。可以是字串、字串陣列、單一訊息物件,或任何受支援格式的訊息物件陣列。

傳回值
「傳回值」的直接連結

傳回一個 AI SDK V4 UIMessage 物件陣列,其結構如下:

id:

string
唯一的訊息識別碼。

role:

'user' | 'assistant' | 'system'
訊息傳送者的角色。

content:

string
訊息的文字內容。

parts:

UIMessagePart[]
UI 部分的陣列,包含文字、Tool 呼叫、檔案、推理、來源及步驟標記。

createdAt:

Date
訊息的建立時間戳記。

toolInvocations?:

ToolInvocation[]
assistant 訊息中的 Tool 呼叫陣列。

experimental_attachments?:

Attachment[]
訊息上的檔案附件。

metadata?:

Record<string, unknown>
附加至訊息的自訂中繼資料。

範例
「範例」的直接連結

轉換文字訊息
「轉換文字訊息」的直接連結

import { toAISdkV4Messages } from '@mastra/ai-sdk'

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

使用 Mastra 使用者端載入訊息
「使用 Mastra 使用者端載入訊息」的直接連結

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

const client = new MastraClient()

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