TanStackMessageMetadata

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

Shape of metadata.tanstack on a message. createdAt is an ISO-8601 string.

Properties#

createdAt?#

optional createdAt?: string;

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

model?#

optional model?: string;

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

runId?#

optional runId?: string;

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

Parent chat run that produced this assistant message.

signature?#

optional signature?: string;

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

Thinking signature for a role: 'reasoning' fan-out message.

structuredOutput?#

optional structuredOutput?: object;

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

data?#

optional data?: unknown;

errorMessage?#

optional errorMessage?: string;

partial?#

optional partial?: unknown;

raw?#

optional raw?: string;

reasoning?#

optional reasoning?: string;

status?#

optional status?: "error" | "complete" | "streaming";

subagent?#

optional subagent?: SubagentWireInfo;

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

Card data on a child wire message. See uiMessagesToWire.

toolCallMetadata?#

optional toolCallMetadata?: Record<string, unknown>;

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

Per-tool-call provider metadata keyed by tool call id (e.g. Gemini thoughtSignature).

toolResult?#

optional toolResult?: object;

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

content?#

optional content?: ContentPart<unknown, unknown, unknown, unknown, unknown>[];

createdAt?#

optional createdAt?: string;

id?#

optional id?: string;

uiResources?#

optional uiResources?: UIResourcePart[];

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