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

uiMessageToModelMessages.md

39 lines1004 Bytes

1---
2id: uiMessageToModelMessages
3title: uiMessageToModelMessages
4---
5​
6# Function: uiMessageToModelMessages()
7​
8```ts
9function uiMessageToModelMessages(uiMessage): ModelMessage<
10 | string
11 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
12 | null>[];
13```
14​
15Defined in: [activities/chat/messages.ts:62](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L62)
16​
17Convert a UIMessage to ModelMessage(s)
18​
19This conversion handles the parts-based structure:
20- Text parts → content field
21- ToolCall parts → toolCalls array
22- ToolResult parts → separate role="tool" messages
23​
24## Parameters
25​
26### uiMessage
27​
28[`UIMessage`](../interfaces/UIMessage.md)
29​
30The UIMessage to convert
31​
32## Returns
33​
34[`ModelMessage`](../interfaces/ModelMessage.md)\<
35 \| `string`
36 \| [`ContentPart`](../type-aliases/ContentPart.md)\<`unknown`, `unknown`, `unknown`, `unknown`, `unknown`\>[]
37 \| `null`\>[]
38​
39An array of ModelMessages (may be multiple if tool results are present)