gbox-sdk
    Preparing search index...

    Interface ActionAI

    interface ActionAI {
        background?: string;
        instruction: string;
        options?: Omit<
            undefined
            | GboxClient.V1.Boxes.ActionCommonOptions,
            "screenshot",
        > & ActionOptionsOverride;
        screenshotDelay?:
            | `${number}h`
            | `${number}m`
            | `${number}s`
            | `${number}ms`;
        settings?: Settings;
        stream?: boolean;
    }

    Hierarchy

    Index

    Properties

    background?: string

    The background of the UI action to perform. The purpose of background is to let the action executor to understand the context of why the instruction is given including important previous actions and observations

    instruction: string

    Direct instruction of the UI action to perform (e.g., 'click the login button', 'input username in the email field', 'scroll down', 'swipe left')

    options?: Omit<
        undefined
        | GboxClient.V1.Boxes.ActionCommonOptions,
        "screenshot",
    > & ActionOptionsOverride

    Action common options

    screenshotDelay?: `${number}h` | `${number}m` | `${number}s` | `${number}ms`
    settings?: Settings

    AI action settings

    stream?: boolean

    Whether to stream progress events using Server-Sent Events (SSE). When true, the API returns an event stream. When false or omitted, the API returns a normal JSON response.