Bluestep JS Documentation
    Preparing search index...

    Interface AiConfigureOptions

    Budget configuration for B.ai.configure(). maxIterations is required and positive on every call; maxSpendMicros is required and positive when enabling and may be omitted when enable: false; the rest are optional.

    interface AiConfigureOptions {
        budgetSchedule?: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "LIFETIME";
        enable?: boolean;
        flag?: string;
        maxIterations: number;
        maxSpendMicros?: number;
        unitId?: string;
        utcOffsetMinutes?: number;
    }
    Index
    budgetSchedule? enable? flag? maxIterations maxSpendMicros? unitId? utcOffsetMinutes?
    budgetSchedule?: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "LIFETIME"

    Budget window: Defaults to LIFETIME (cumulative cap).

    enable?: boolean

    Whether the budget is enabled. Defaults to true when omitted.

    flag?: string

    Custom tracking flag to scope the limit to. Omit (with unitId) to target the tenant-wide default.

    maxIterations: number

    Maximum agent iterations permitted per call. Required and positive.

    maxSpendMicros?: number

    Maximum spend permitted within the budget window, in micro-dollars (1_000_000 = $1.00). Required and positive when enabling; omit it while disabling for an uncapped-but-metered scope.

    unitId?: string

    Operating Unit seqnum to scope the limit to. Omit (with flag) to target the tenant-wide default — a null wildcard on that dimension.

    utcOffsetMinutes?: number

    Anchors windowed schedules to the tenant's local calendar. Defaults to 0.

    Settings
    Member Visibility

    On This Page
    experimental