Lime Web Components API Documentation - v7.11.0
    Preparing search index...

    Interface AIActionWithoutApprovalAlpha

    An AIAction that runs as soon as the AI asks for it.

    interface AIActionWithoutApproval {
        description: string;
        id: string;
        inputSchema: JsonSchema;
        needsApproval?: false;
        run(input: JsonValue): Promise<AIActionResult>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description id inputSchema needsApproval?

    Methods

    run

    Properties

    description: string

    Tells the AI what the action does and when to use it.

    id: string

    Identifies the action, e.g. 'limeobject.update' or 'explorer.filter'.

    Use a stable id that is unique on the page. The AI asks for an action by this id.

    inputSchema: JsonSchema

    Describes the input the action takes, as a schema for a JSON object.

    needsApproval?: false

    Discriminant. The action runs without asking the user.

    Methods

    • Alpha

      Run the action.

      The input comes from the AI and has not been checked against inputSchema. The action checks it, because it knows rules a schema cannot express, such as access rights and which objects exist, and the registry carries no JSON Schema validator.

      Parameters

      Returns Promise<AIActionResult>

      What happened. Resolve with an AIActionFailed rather than rejecting when the action could not be done, including when the input is not valid.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods