Skip to content

Interface: ChatAugmentation

Defined in: packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:78

Structured decoration an assistant turn can carry on top of its text. Returned by the augment() callback; every field is optional and maps to the matching AI-elements block.

Properties

PropertyTypeDescriptionDefined in
actions?booleanWhether to show copy/like/dislike on this turn.packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:80
attachments?ChatAttachment[]File chips shown on the turn (e.g. a real, downloadable artifact a tool produced or is about to act on). Cleared from the turn when an accompanying confirmation is approved — so "deleting" a file makes it actually disappear rather than printing an invented result.packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:87
blocks?unknownArbitrary rich content to render in this turn, beyond the curated slots above. DS-direct consumers pass React nodes; through the SDK you pass renderer block descriptors (e.g. [Card({…}), DataTable({…})]) which the host renderer resolves to React via BlockResolverContext. Note: the blocks arrive as serialized message data, so static/display blocks work; blocks whose props carry callbacks won't have those wired through.packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:97
speech?{ text: string; }Speak text aloud with the browser's on-device Web Speech API (speechSynthesis). Renders a real play/stop control + a transcript that highlights each word as it's spoken — no audio file, no network.packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:116
speech.textstring-packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:117
text?stringSeed/override the assistant text (used when no model produces it).packages/design-system/lib/assistant-ui/components/mw/Chat/index.d.ts:124

Matterway Assistant SDK Documentation