@butlerbot/sdk/dist/types/usage/policy.d.ts

The official ButlerBot SDK

import { AI_MODEL } from "../model";
export type PolicyRule = {
    /** When the current usage exceeds this threshold */
    whenUsageAbove: {
        type: "percentage";
        value: number;
    };
    /** When the current chosen model is equal to this model */
    whenModelEquals?: {
        value: AI_MODEL;
    };
    /** The model to overwrite the convos as, 'null' means no overwrite - use user's choice */
    model: AI_MODEL | null;
    /** When this rule is activated, this message will be sent to the user */
    switchMessage?: string;
    /** The message appended on the end of every message sent giving additional info */
    appendMessage?: string;
};
export type UsagePolicy = {
    rules: PolicyRule[];
    maxConvoLength?: number;
};
export type UsagePolicyDataUsage = {
    /** The current user's usage cost for this time period */
    usage: number;
    /** The user's limit for the time period */
    usageLimit: number;
    /** Explanation of limit for this time period */
    limitBreakdown: {
        description: string;
        addition: number;
    }[];
};
export type UsagePolicyData = {
    limit: {
        /** Current usage cost as a percentage of daily limit (0–1) */
        percentage: number;
    };
    /** Model switching info (tiered auto-downgrade) */
    modelSwitching: {
        /** Whether the model was switched from the user's request */
        switched: boolean;
        /** Originally requested model */
        requestedModel?: string;
        /** Model that was actually used */
        activeModel?: string;
    };
    /** Usage policy information */
    usagePolicy: UsagePolicy;
    /** Usage information */
    usage: {
        /** Daily usage data */
        daily: UsagePolicyDataUsage;
        /** Weekly usage data */
        weekly: UsagePolicyDataUsage;
    };
};