Prometheus Entity Management API
    Preparing search index...

    Interface CreatePrometheusA2uiRuntimeOptions<Implementation>

    interface CreatePrometheusA2uiRuntimeOptions<
        Implementation extends
            ComponentApi = PrometheusA2uiComponentImplementation,
    > {
        actionPolicy?: A2uiActionPolicy;
        catalogs?: readonly Catalog<Implementation, FunctionImplementation>[];
        limits?: Partial<PrometheusA2uiLimits>;
        onActionDecision?: (decision: A2uiActionDecision) => void | Promise<void>;
        onActionEnvelope?: (
            envelope: PrometheusA2uiActionEnvelope,
        ) => void | Promise<void>;
        onConflict?: (conflict: PrometheusA2uiDataConflict) => void;
        onFunctionCall?: (
            call: {
                callFunction: {
                    args?: Record<string, unknown>;
                    call: string;
                    catalogId?: string;
                    [key: string]: unknown;
                };
                functionCallId: string;
                version: "v1.0";
                wantResponse?: boolean;
            },
        ) => unknown;
        onProducerFault?: (fault: PrometheusA2uiProducerFault) => void;
        onRendererMessage?: (
            message: PrometheusA2uiRendererMessage,
        ) => void | Promise<void>;
        onResyncNeeded?: (request: PrometheusA2uiResyncRequest) => void;
    }

    Type Parameters

    Index
    actionPolicy?: A2uiActionPolicy

    Defaults to a deny-all policy; applications must install authority.

    catalogs?: readonly Catalog<Implementation, FunctionImplementation>[]

    Explicit catalogs advertised to and accepted from agents.

    limits?: Partial<PrometheusA2uiLimits>

    Resource limits for agent-generated UI. Unspecified limits use DEFAULT_PROMETHEUS_A2UI_LIMITS; enforcement is on by default.

    onActionDecision?: (decision: A2uiActionDecision) => void | Promise<void>

    Receives the auditable outcome of every official client action.

    onActionEnvelope?: (
        envelope: PrometheusA2uiActionEnvelope,
    ) => void | Promise<void>

    Receives an executed user action as an envelope ready to send to the agent: envelope.forwardedProps goes into the next AG-UI run input. Called only for actions the action policy executed; a denied action never leaves the runtime. Use runtime.retryAction(actionId) to resend one under the same id.

    onConflict?: (conflict: PrometheusA2uiDataConflict) => void

    Receives each data leaf the producer changed while the user had also changed it. The producer's value was written; this is the notice, so the host can warn the user. It should not throw.

    onFunctionCall?: (
        call: {
            callFunction: {
                args?: Record<string, unknown>;
                call: string;
                catalogId?: string;
                [key: string]: unknown;
            };
            functionCallId: string;
            version: "v1.0";
            wantResponse?: boolean;
        },
    ) => unknown

    Application-owned implementation for v1.0 agent-initiated function calls.

    onProducerFault?: (fault: PrometheusA2uiProducerFault) => void

    Receives each producer fault (an input the runtime refused and left every surface unchanged for). Called synchronously before the rejection is thrown; it should not throw.

    onRendererMessage?: (
        message: PrometheusA2uiRendererMessage,
    ) => void | Promise<void>

    Receives A2UI v1.0 renderer-to-agent action/function/error messages.

    onResyncNeeded?: (request: PrometheusA2uiResyncRequest) => void

    Called when the runtime cannot continue a surface without help: a delta built on a version that never arrived, a full delta buffer, or a batch the runtime refused. Send request.held upstream (see buildA2uiForwardedProps) so the agent resends what is missing. It should not throw.