@threadplane/content/a2uiInterfacev0.0.0

A2uiActionMessage

Unpublished development API. This package is under development and is not available as a published release.

A v0.9 client-to-agent action: which component fired, on which surface, with its context resolved to plain values.

View sourceView Markdown
import type { A2uiActionMessage } from '@threadplane/content/a2ui';

Declaration

export interface A2uiActionMessage  {
  readonly action: {
        readonly name: string;
        readonly surfaceId: string;
        readonly sourceComponentId: string;
        readonly timestamp: string;
        readonly context: {
            readonly [key: string]: A2uiValue;
        };
        readonly label?: string;
    };
  readonly metadata?: {
        readonly a2uiClientDataModel: {
            readonly surfaces: {
                readonly [surfaceId: string]: A2uiValue;
            };
        };
    };
  readonly version: 'v0.9';
}

Members

action

readonly action: {
        readonly name: string;
        readonly surfaceId: string;
        readonly sourceComponentId: string;
        readonly timestamp: string;
        readonly context: {
            readonly [key: string]: A2uiValue;
        };
        readonly label?: string;
    };

metadata

Present only when the surface was created with sendDataModel: true.

readonly metadata?: {
        readonly a2uiClientDataModel: {
            readonly surfaces: {
                readonly [surfaceId: string]: A2uiValue;
            };
        };
    };

version

readonly version: 'v0.9';