Class: TokenLimitError

Error thrown when a block mode limit has been exceeded.

Examples

try {
  await AI.chat(options)
} catch (error) {
  if (error instanceof TokenLimitError) {
    console.warn(error.displayMessage)
  }
}

tokenLedger.configure({
  limits: { perModel: { 'gpt-4o': { window: 'day', maxTokens: 10_000, mode: 'block' } } }
})

tokenLedger.configure

new TokenLimitError(context): TokenLimitError

Parameter	Type	Description
`context`	`TokenLimitErrorContext`	Details describing the breached rule and usage metadata.

Error.constructor

Property	Modifier	Type	Description
`model`	`readonly`	`string`	Model that exceeded the limit.
`rule`	`readonly`	`TokenLimitRule`	Rule that caused the error to be thrown.
`usageKind?`	`readonly`	`string`	Optional usage classification for context.
`window`	`readonly`	`TokenSummaryWindow`	Window in which the error was triggered.
`windowKey`	`readonly`	`string`	Window key describing the offending period.

get displayMessage(): string

Message suitable for end-user display.

string