Skip to content

UIMessage

Namespace: Vercel.AI.Ui

public sealed class UIMessage

A message shown in a chat UI, made of parts. Maps to UIMessage.

Inheritance: object

View source

UIMessage(UIMessageRole, IReadOnlyList<UIMessagePart>)

Section titled “UIMessage(UIMessageRole, IReadOnlyList<UIMessagePart>)”
public UIMessage(UIMessageRole role, IReadOnlyList<UIMessagePart> parts)

Creates a UI message.

Parameters

Name Type Description
role UIMessageRole
parts IReadOnlyList<UIMessagePart>

View source

public string Id { get; init; }

A unique identifier for the message.

Value: string

View source

public JsonElement? Metadata { get; init; }

The metadata of the message.

Value: JsonElement?

View source

public IReadOnlyList<UIMessagePart> Parts { get; }

The parts of the message.

Value: IReadOnlyList<UIMessagePart>

View source

public UIMessageRole Role { get; }

The role of the message.

Value: UIMessageRole

View source

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