Skip to content

Vercel.AI.Ui

API reference

UI message conversion.

Type Summary
ConvertToModelMessagesOptions Options of ConvertToModelMessagesOptions).
CustomContentUIPart A provider-specific part. Maps to CustomContentUIPart.
DataUIPart A data part. Its type is data-{name}. Maps to DataUIPart.
FileUIPart A file part. Maps to FileUIPart.
ReasoningFileUIPart A file produced as reasoning. Maps to ReasoningFileUIPart.
ReasoningUIPart A reasoning part. Maps to ReasoningUIPart.
SourceDocumentUIPart A source that is a document. Maps to SourceDocumentUIPart.
SourceUrlUIPart A source that is a URL. Maps to SourceUrlUIPart.
StepStartUIPart Marks the start of a step. Maps to StepStartUIPart.
TextUIPart A text part. Maps to TextUIPart.
ToolUIApproval The approval of a tool call in a ToolUIPart.
ToolUIPart A tool invocation part. Its type is tool-{name}, or dynamic-tool for a tool whose name is not known up front. Maps to ToolUIPart and DynamicToolUIPart.
UIMessage A message shown in a chat UI, made of parts. Maps to UIMessage.
UIMessageConversion Conversion of UI messages to model messages. Maps to convertToModelMessages.
UIMessagePart A part of a UIMessage. Maps to UIMessagePart.
Type Summary
ToolUIPartState The state of a ToolUIPart.
UIMessageRole The role of a UIMessage.

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product