Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

modelMessageToUIMessage.md

39 lines843 Bytes

1---
2id: modelMessageToUIMessage
3title: modelMessageToUIMessage
4---
5​
6# Function: modelMessageToUIMessage()
7​
8```ts
9function modelMessageToUIMessage(modelMessage, id?): UIMessage;
10```
11​
12Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:385](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L385)
13​
14Convert a ModelMessage to UIMessage
15​
16This conversion creates a parts-based structure:
17- content field → TextPart
18- toolCalls array → ToolCallPart[]
19- role="tool" messages should be converted separately and merged
20​
21## Parameters
22​
23### modelMessage
24​
25[`ModelMessage`](../interfaces/ModelMessage.md)
26​
27The ModelMessage to convert
28​
29### id?
30​
31`string`
32​
33Optional ID for the UIMessage (generated if not provided)
34​
35## Returns
36​
37[`UIMessage`](../interfaces/UIMessage.md)
38​
39A UIMessage with parts