Documentation
Framework
Version
Class References
Function References
Interface References
Type Alias References
Variable References

uiMessageToModelMessages

Function: uiMessageToModelMessages()

ts
function uiMessageToModelMessages(uiMessage): ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown>[]
  | null>[];
function uiMessageToModelMessages(uiMessage): ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown>[]
  | null>[];

Defined in: message-converters.ts:65

Convert a UIMessage to ModelMessage(s)

This conversion handles the parts-based structure:

  • Text parts → content field
  • ToolCall parts → toolCalls array
  • ToolResult parts → separate role="tool" messages

Parameters

uiMessage

UIMessage

The UIMessage to convert

Returns

ModelMessage< | string | ContentPart<unknown, unknown, unknown, unknown>[] | null>[]

An array of ModelMessages (may be multiple if tool results are present)