0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/ModelMessage.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

3.3 KiB

id title
ModelMessage ModelMessage

Interface: ModelMessage<TContent>

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

Type Parameters

TContent

TContent extends string | null | ContentPart[] = string | null | ContentPart[]

Properties

content

content: TContent;

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


createdAt?

optional createdAt?: Date;

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

Optional message creation timestamp. When present, message converters preserve it across persist → hydrate round-trips.


error?

optional error?: string;

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

Error reported by an AG-UI tool message.


id?

optional id?: string;

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

Optional stable message id. Providers ignore it; it exists so a persisted transcript can retain the streaming messageId and survive the persist → hydrate round-trip. When present, modelMessagesToUIMessages reuses it instead of generating a fresh id, so a hydrated message keeps the same identity as its live stream — which is what lets a mid-stream reload resume the SAME message bubble in place (see @tanstack/ai-persistence).


metadata?

optional metadata?: Record<string, any>;

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

Optional AG-UI message metadata. TanStack-owned fields live under tanstack.


name?

optional name?: string;

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


role

role: "user" | "assistant" | "tool";

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


structuredOutput?

optional structuredOutput?: StructuredOutputPart<unknown>;

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

Completed structured output represented by this assistant message. content remains the provider-facing JSON text; this field preserves the typed UI part across persistence and message conversion.


thinking?

optional thinking?: object[];

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

content

content: string;

signature?

optional signature?: string;

toolCallId?

optional toolCallId?: string;

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


toolCalls?

optional toolCalls?: ToolCall<unknown>[];

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