Skip to main content

Interface: IUiMessageMetadata

Defined in: entries/vercel-ui/types.ts:28

What the module adds to a UI message: the thread, the dates and model of the turns, and on a streamed answer the results of the call (citations, issues, the structured value); pause on a thread that waits for a human.

The METADATA of every TGatewayUiMessage and TGatewayUiChunk; the client merges every message-metadata chunk into it.

Properties​

citations?​

optional citations?: string[]

Defined in: entries/vercel-ui/types.ts:38

The chunk ids the answer was grounded on, as IAnswerResponse.citations. Streamed answers only.

createdAt?​

optional createdAt?: string

Defined in: entries/vercel-ui/types.ts:32

ISO date of the (first) turn of the message.

endedByTool?​

optional endedByTool?: string

Defined in: entries/vercel-ui/types.ts:44

The tool that ended the run (D86).

issues?​

optional issues?: IIssue[]

Defined in: entries/vercel-ui/types.ts:40

The warnings of the checks, as IAnswerResponse.issues; after withdrawn, the issues that withdrew it. Streamed answers only.

modelId?​

optional modelId?: string

Defined in: entries/vercel-ui/types.ts:34

Assistant messages: the model of the answer.

pause?​

optional pause?: IUiPause

Defined in: entries/vercel-ui/types.ts:48

The pause the thread waits on: what the SDK's approval card cannot show, and what AIGatewayVercelUi.resume takes.

structured?​

optional structured?: unknown

Defined in: entries/vercel-ui/types.ts:42

The parsed answer of a use case with an outputSchema. Streamed answers only.

threadId?​

optional threadId?: string

Defined in: entries/vercel-ui/types.ts:30

The thread of the message; on a streamed answer set once it is known (the finish chunk at the latest).

usage?​

optional usage?: IUsage

Defined in: entries/vercel-ui/types.ts:36

Assistant messages: the tokens of the answer.

withdrawn?​

optional withdrawn?: boolean

Defined in: entries/vercel-ui/types.ts:46

The streamed text is not kept (D74): the renderer drops or greys it.