Class: UsageLedger
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:67
UsageLedger accumulates usage metrics from provider responses. Usage ingestion MUST be called for final streaming chunks or any non-streaming responses.
Constructors
Constructor
new UsageLedger(
options?):UsageLedger
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:71
Parameters
options?
UsageLedgerOptions = {}
Returns
UsageLedger
Methods
bootstrapFromPersistence()
bootstrapFromPersistence():
Promise<void>
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:209
Load all buckets from persistence (merging into existing).
Returns
Promise<void>
flush()
flush():
Promise<void>
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:201
Persist current buckets if an adapter is configured.
Returns
Promise<void>
getSessionAggregate()
getSessionAggregate(
sessionId):UsageBucket|undefined
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:178
Aggregate totals across all buckets for a session.
Parameters
sessionId
string
Returns
UsageBucket | undefined
getSummariesBySession()
getSummariesBySession(
sessionId):UsageBucket[]
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:173
Query by session id.
Parameters
sessionId
string
Returns
UsageBucket[]
ingestCompletionChunk()
ingestCompletionChunk(
dim,chunk):void
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:95
Ingest a completion response chunk (streaming final or single shot) updating usage aggregates. Non-final streaming chunks are ignored unless includeInterimStreamingUsage=true.
Parameters
dim
chunk
ModelCompletionResponse
Returns
void
ingestUsage()
ingestUsage(
dim,usage):void
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:138
Manual ingestion for custom usage objects (e.g. embeddings).
Parameters
dim
usage
ModelUsage & object
Returns
void
listAllSummaries()
listAllSummaries():
UsageBucket[]
Defined in: packages/agentos/src/core/utils/usage/UsageLedger.ts:168
Return all summaries.
Returns
UsageBucket[]