ChatA2uiInputs

The inputs <chat> sets on a ChatA2uiRenderer component.

import type { ChatA2uiInputs } from '@threadplane/angular/chat';

Declaration

export interface ChatA2uiInputs  {
  readonly emitEvent: (event: RenderEvent, messageIndex: number, surfaceId: string) => void;
  readonly handlers: Record<string, (params: Record<string, unknown>) => unknown | Promise<unknown>>;
  readonly messageIndex: number;
  readonly options: unknown;
  readonly source: string;
  readonly submitAction: (message: object) => void;
}

Members

emitEvent

Forwards a surface's render event to the chat's (renderEvent) output.

readonly emitEvent: (event: RenderEvent, messageIndex: number, surfaceId: string) => void;

handlers

The chat's [handlers], for actions a surface runs locally.

readonly handlers: Record<string, (params: Record<string, unknown>) => unknown | Promise<unknown>>;

messageIndex

The message's index in the transcript, passed back with each event.

readonly messageIndex: number;

options

The renderer's own options.

readonly options: unknown;

source

The message content after its ---a2ui_JSON--- marker. It grows while the message streams.

readonly source: string;

submitAction

Sends an A2UI action message to the agent as a user turn.

readonly submitAction: (message: object) => void;