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

UIMessage.md

60 lines1.2 KB

Interface: UIMessage<TData>

Defined in: packages/ai/src/types.ts:487

UIMessage - Domain-specific message format optimized for building chat UIs Contains parts that can be text, tool calls, or tool results. Generic over the structured-output data type so useChat({ outputSchema })'s schema narrows parts.find(p => p.type === 'structured-output').data on the consumer side without manual casts.

Type Parameters

TData

TData = unknown

Properties

createdAt?

optional createdAt: Date;

Defined in: packages/ai/src/types.ts:491


id

id: string;

Defined in: packages/ai/src/types.ts:488


parts

parts: MessagePart<TData>[];

Defined in: packages/ai/src/types.ts:490


role

role: "user" | "assistant" | "system";

Defined in: packages/ai/src/types.ts:489