Skip to main content

Interface: TokenLimitBreach

Snapshot describing how a limit was breached.

Properties​

exceededBy​

exceededBy: number;

Tokens beyond the configured limit.

maxTokens​

maxTokens: number;

Configured maximum tokens for the window.

message?​

optional message: string;

Message defined by the rule, if any.

mode​

mode: TokenLimitMode;

Enforcement mode active for the breach.

model​

model: string;

Model that triggered the breach.

previousTotal​

previousTotal: number;

Total prior to the latest usage being recorded.

remainingBefore​

remainingBefore: number;

Tokens remaining before the latest update.

total​

total: number;

New total after recording the usage.

window​

window: TokenSummaryWindow;

Window in which the limit was exceeded.

windowKey​

windowKey: string;

Window key (e.g., ISO day or ISO week) identifying the period.