> Discover all available pages from the documentation index: https://mastra.zisheng.pro/llms.txt
# toAISdkV5Messages()
将输入格式的消息转换为 AI SDK V5(及更高版本)UI 消息格式。此函数接受多种格式的消息(字符串、AI SDK V4/V5 消息、Mastra DB 消息等),并将其规范化为 AI SDK V5+ `UIMessage` 格式,适合与 `useChat()` 等 AI SDK UI 组件配合使用。
## 使用示例
```typescript
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 (
{messages.map(message => (
{message.role}: {message.parts.map(part => (part.type === 'text' ? part.text : null))}
))}
)
}
```
## 参数
**messages** (`MessageListInput`): 要转换的消息。可以是字符串、字符串数组、单个消息对象,或采用任意受支持格式的消息对象数组。
## 返回值
返回具有以下结构的 AI SDK V5+ `UIMessage` 对象数组:
**id** (`string`): 消息的唯一标识符。
**role** (`'user' | 'assistant' | 'system'`): 消息发送者的 role。
**parts** (`UIMessagePart[]`): UI part 数组,包括文本、Tool 结果、文件、推理、来源和 step 标记。
**metadata** (`Record`): 可选 metadata,包括 createdAt、threadId、resourceId 和自定义字段。
## 示例
### 转换文本消息
```typescript
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 加载消息
```typescript
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)
```