> Discover all available pages from the documentation index: https://mastra.zisheng.pro/llms.txt
# toAISdkMessages()
将输入格式的消息转换为 AI SDK UI 消息格式。`toAISdkMessages()` 保留现有的 AI SDK v5 默认行为。如果应用使用 AI SDK v6 类型,请传入 `version: 'v6'`。
`version: 'v6'` 使用 MessageList 的 AI SDK v6 UI 输出路径。MessageList 的输入检测和摄取方式保持不变。
## 使用示例
```typescript
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 (
{messages.map(message => (
{message.role}: {message.parts.map(part => (part.type === 'text' ? part.text : null))}
))}
)
}
```
## 参数
**messages** (`MessageListInput`): 要转换的消息。可以是字符串、字符串数组、单个消息对象,或采用任意受支持格式的消息对象数组。
**options.version** (`'v5' | 'v6'`): 选择要返回的 AI SDK 消息类型。省略此项或传入 'v5' 可使用现有默认行为;当应用使用 AI SDK v6 useChat() 消息类型时,传入 'v6'。
## 返回值
返回所选版本类型的 AI SDK `UIMessage` 对象数组。
**id** (`string`): 消息的唯一标识符。
**role** (`'user' | 'assistant' | 'system'`): 消息发送者的 role。
**parts** (`UIMessagePart[]`): UI part 数组,包括文本、Tool 结果、文件、推理、来源和 step 标记。
**metadata** (`Record`): 可选 metadata,包括 createdAt、threadId、resourceId 和自定义字段。
## 示例
### 使用默认的 AI SDK v5 类型
```typescript
import { toAISdkMessages } from '@mastra/ai-sdk/ui'
const messages = toAISdkMessages(['Hello', 'How can I help you today?'])
```
### 返回 AI SDK v6 消息类型
```typescript
import { toAISdkMessages } from '@mastra/ai-sdk/ui'
const messages = toAISdkMessages(['Hello', 'How can I help you today?'], {
version: 'v6',
})
```
### 使用 Mastra client 加载消息
```typescript
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()`](https://mastra.zisheng.pro/reference/ai-sdk/to-ai-sdk-stream)
- [`toAISdkV5Messages()`](https://mastra.zisheng.pro/reference/ai-sdk/to-ai-sdk-v5-messages)
- [`toAISdkV4Messages()`](https://mastra.zisheng.pro/reference/ai-sdk/to-ai-sdk-v4-messages)