Class UsageLedger

UsageLedger accumulates usage metrics from provider responses. Usage ingestion MUST be called for final streaming chunks or any non-streaming responses.

Index

Constructors

Methods

ingestCompletionChunk ingestUsage listAllSummaries getSummariesBySession getSessionAggregate flush bootstrapFromPersistence

Constructors

constructor

new UsageLedger(options?): UsageLedger
Parameters
- options: UsageLedgerOptions = {}
Returns UsageLedger
- Defined in src/core/utils/usage/UsageLedger.ts:58

Methods

ingestCompletionChunk

ingestCompletionChunk(dim, chunk): void
Ingest a completion response chunk (streaming final or single shot) updating usage aggregates. Non-final streaming chunks are ignored unless includeInterimStreamingUsage=true.
Parameters
- dim: UsageDimensions
- chunk: ModelCompletionResponse
Returns void
- Defined in src/core/utils/usage/UsageLedger.ts:82

ingestUsage

ingestUsage(dim, usage): void
Manual ingestion for custom usage objects (e.g. embeddings).
Parameters
- dim: UsageDimensions
- usage: ModelUsage & {
  modelId?: string;
  isFinal?: boolean;
  }
Returns void
- Defined in src/core/utils/usage/UsageLedger.ts:114

listAllSummaries

listAllSummaries(): UsageBucket[]
Return all summaries.

Returns UsageBucket[]
- Defined in src/core/utils/usage/UsageLedger.ts:137

getSummariesBySession

getSummariesBySession(sessionId): UsageBucket[]
Query by session id.
Parameters
- sessionId: string
Returns UsageBucket[]
- Defined in src/core/utils/usage/UsageLedger.ts:142

getSessionAggregate

getSessionAggregate(sessionId): undefined | UsageBucket
Aggregate totals across all buckets for a session.
Parameters
- sessionId: string
Returns undefined | UsageBucket
- Defined in src/core/utils/usage/UsageLedger.ts:147

flush

flush(): Promise<void>
Persist current buckets if an adapter is configured.

Returns Promise<void>
- Defined in src/core/utils/usage/UsageLedger.ts:164

bootstrapFromPersistence

bootstrapFromPersistence(): Promise<void>
Load all buckets from persistence (merging into existing).

Returns Promise<void>
- Defined in src/core/utils/usage/UsageLedger.ts:172