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
kolaworld 62c19edce7
fix(ai): preserve AG-UI fields across conversions (#1204)
* fix(ai): preserve AG-UI timestamps and tool results

* fix(ai): preserve ModelMessage fields in AG-UI serialization

* fix(ai): restore UI parts from message snapshots

* fix(ai): preserve message metadata through persistence

* fix(ai): preserve AG-UI tool errors through snapshots

* chore: update AG-UI conversion changeset

* fix(ai): preserve timestamp and resource identity

* ci: apply automated fixes

* fix(ai): restore name and UI parts across AG-UI round-trips

* test(ai): address CodeRabbit nits on createdAt and ui-resource fixtures

* test(ai): keep MCP widgets out of model content, not persistence metadata

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com>
2026-08-25 13:29:09 +00:00

2.2 KiB

id title
TanStackMessageMetadata TanStackMessageMetadata

Interface: TanStackMessageMetadata

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

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


model?

optional model?: string;

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


signature?

optional signature?: string;

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

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


structuredOutput?

optional structuredOutput?: object;

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

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";

toolCallMetadata?

optional toolCallMetadata?: Record<string, unknown>;

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

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

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