0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/interfaces/TanStackMessageMetadata.md
github-actions[bot] f4f32bdcc2
docs: regenerate API documentation (#1195)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-22 08:16:20 +00:00

1.7 KiB

id title
TanStackMessageMetadata TanStackMessageMetadata

Interface: TanStackMessageMetadata

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

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:521


model?

optional model?: string;

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


signature?

optional signature?: string;

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

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


structuredOutput?

optional structuredOutput?: object;

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

errorMessage?

optional errorMessage?: string;

raw?

optional raw?: string;

status?

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

toolCallMetadata?

optional toolCallMetadata?: Record<string, unknown>;

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

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


uiResources?

optional uiResources?: UIResourcePart[];

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