UIMessageConversion

Namespace: Vercel.AI.Ui

public static class UIMessageConversion

Conversion of UI messages to model messages. Maps to convertToModelMessages.

Inheritance: object

View source

Methods

ConvertToModelMessages(IReadOnlyList<UIMessage>, ConvertToModelMessagesOptions?)

public static IReadOnlyList<ModelMessage> ConvertToModelMessages(IReadOnlyList<UIMessage> messages, ConvertToModelMessagesOptions? options = null)

Converts UI messages from a chat UI into model messages that can be used with the AI functions. A tool message upstream holds several parts. Here its parts are consecutive tool messages. Assistant file and reasoning-file parts are dropped, as assistant messages here cannot hold files.

Parameters

Name	Type	Description
messages	IReadOnlyList<UIMessage>	The UI messages to convert.
options	ConvertToModelMessagesOptions	Conversion options.

Returns: IReadOnlyList<ModelMessage> — The model messages.

View source