Member Junction
    Preparing search index...

    Interface RealtimeChannelDescriptor

    The complete, self-describing contract of one realtime channel. Returned by BaseRealtimeChannelClient.GetDescriptor(); goes to the agent verbatim (as a catalog entry) and drives scoping, dispatch and validation.

    interface RealtimeChannelDescriptor {
        DefaultAvailability: RealtimeChannelAvailability;
        DisplayName: string;
        DisplayPolicy: RealtimeChannelDisplayPolicy;
        Events?: RealtimeChannelEventSpec[];
        Inputs?: JSONObject;
        Instructions: string;
        Key: string;
        MaxExposure: RealtimeChannelExposure;
        MultiInstance?: boolean;
        Nouns: RealtimeChannelNoun[];
        Output?: JSONObject;
        OwningPackage?: string;
        Verbs: RealtimeChannelVerb[];
        Version: string;
    }
    Index

    Properties

    DefaultAvailability DisplayName DisplayPolicy Events? Inputs? Instructions Key MaxExposure MultiInstance? Nouns Output? OwningPackage? Verbs Version

    Properties

    DefaultAvailability: RealtimeChannelAvailability

    Whether the channel is in a session by default.

    DisplayName: string

    Human-readable name.

    DisplayPolicy: RealtimeChannelDisplayPolicy

    How the channel appears in a session.

    Events?: RealtimeChannelEventSpec[]

    What the channel streams back.

    Inputs?: JSONObject

    What the agent may pass when opening the channel (seed data).

    Instructions: string

    Natural language for the agent: what the channel is, how to use it, rules of etiquette.

    Key: string

    Stable channel key (e.g. 'Whiteboard', 'InteractiveComponent'); the target.channel an agent addresses.

    MaxExposure: RealtimeChannelExposure

    The most the channel can expose to the model; policy may only lower it.

    MultiInstance?: boolean

    Whether the agent may hold more than one live instance (e.g. two components).

    Nouns: RealtimeChannelNoun[]

    The things the channel holds and the schema of their state.

    Output?: JSONObject

    What the channel hands back when it completes.

    OwningPackage?: string

    The npm package that owns the channel (e.g. '@mj-biz-apps/forms-ng').

    Verbs: RealtimeChannelVerb[]

    The actions the channel accepts.

    Version: string

    Semver of the channel contract this plugin implements (see REALTIME_CHANNEL_CONTRACT_VERSION).

    Settings

    Member Visibility

    On This Page

    Properties