PURISTA

Appearance

PURISTA API

PURISTA API / @purista/ai / ToAiSdkUiMessageOptions

Type Alias: ToAiSdkUiMessageOptions ​

ToAiSdkUiMessageOptions = object

Defined in: packages/ai/src/protocol/aiSdkStream.ts:47

Properties ​

emitMessageMetadata? ​

optional emitMessageMetadata: boolean

Defined in: packages/ai/src/protocol/aiSdkStream.ts:52

When true (default), non-message frames are also emitted as message-metadata. Set to false when consumers only want explicit mapped data parts.

errorMode? ​

optional errorMode: "auto" | "error-event" | "data-part"

Defined in: packages/ai/src/protocol/aiSdkStream.ts:66

Controls how protocol error frames are represented in UI-message streams.

  • auto (default): handled errors become data-agent-error parts; unhandled errors emit error.
  • error-event: always emit error and terminate stream.
  • data-part: always emit data-agent-error and keep stream lifecycle events.

mapDataParts? ​

optional mapDataParts: AiSdkUiDataPartMapper

Defined in: packages/ai/src/protocol/aiSdkStream.ts:58

Optional mapping hook to emit typed data-* parts for application-specific UI state. This is useful for custom dashboards (status, artifacts, tickets, etc.) while still using the built-in protocol conversion for text/error lifecycle events.