Rhythm 2.0 Specifications

Appearance

DOM-PFM-LLM-004AI Usage

Markdown

DOM-PFM-LLM-004

AI Usage

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-PFM-LLM-004

Design

Owned by
SVC-PFM-LLM-llm

KindDomain objectProduct areaPlatformModuleAI Requests, Usage and the Jazz AI TeammateRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

AI Usage ​

What It Models ​

AI usage combines historical cost reporting, live allowance status and request inspection. These views have different freshness: daily totals follow reconciliation, current capacity is read directly, and request details describe individual attempts and settlement.

Identity and Attributes ​

Stored daily cells are unique for an organization, UTC day and reporting dimensions, including outcome and rate version. A global watermark tracks rollup progress. Other views calculate windows, comparisons, status, request lists and audit history as they are read.

Relationships ​

Request history supplies daily totals. Allowance records supply current capacity and status. Catalogue declarations supply feature and operation labels. Security owns control audit storage, while Queries owns datasets and reusable reports over the supplied views.

Invariants ​

Rebuilding replaces an entire organization-day within a transaction. Progress advances conservatively and stops at unfinished changes. Usage responses exclude evidence bodies and storage keys. Customer answers also exclude internal monetary and control details. Independent HQ sections can answer unavailable without failing their neighbours.

How It Is Stored and Shared ​

The reconciliation function writes daily aggregates and their watermark. The aggregate has a documented row-policy exemption for cross-organization reporting. HQ APIs use it for history and enter organizations for live detail. Customer APIs and query datasets provide scoped projections without transferring record ownership to the console.

Open Design Questions ​

UTC reporting windows differ from local allowance months. Early-warning signals, raw-record retention and the provider circuit breaker remain incomplete. An unreadable organization prevents global watermark advancement, even while other days are rebuilt. The customer dashboard has no implemented page.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-PFM-LLM-001many requests summarised into each daily row; one directory over an organization's requestsRequests retain their source facts; this relationship does not transfer request ownership.no
DOM-PFM-LLM-003one live position per organization from its allowanceThe allowance owns period accounting and configuration; linked records consume those figures.no
DOM-PFM-LLM-002usage is grouped by operation, model and feature and lists the catalogThe operation catalogue owns its definitions; related records keep references.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-PFM-LLM-004-01
Rebuilding replaces the organization’s entire UTC day from settled and refused requests in one transaction.
service, databaseobserved
services-platform:modules/llm/services/persistence/usage-rollups.ts:rebuildUsageDay
INV-DOM-PFM-LLM-004-02
Daily reporting uses request start day and excludes work still running.
servicedocumented
services-platform:docs/llm.md#The daily rollup
INV-DOM-PFM-LLM-004-03
The watermark advances monotonically behind the run start and stops at unfinished changes.
service, databaseobserved
services-platform:modules/llm/services/reconciliation/rollup-settled-invocations.ts:rollUpSettledInvocations
INV-DOM-PFM-LLM-004-04
The documented HQ reporting reader accesses daily aggregates without access to raw requests, tasks or attempts.
databasedocumented
services-platform:docs/llm.md#Reporting
INV-DOM-PFM-LLM-004-05
Usage responses expose capture state without bodies or object-storage references.
apiobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts:toInvocationDetailResponse
INV-DOM-PFM-LLM-004-06
Customer summaries contain credits and percentages while excluding prices and internal capacity details.
api, serviceobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts:toOrganizationSummaryResponse
INV-DOM-PFM-LLM-004-07
A failed section read returns unavailable independently of neighbouring sections.
serviceobserved
services-platform:modules/llm/services/usage-reports/section.ts:readSection
INV-DOM-PFM-LLM-004-08
Current switches and committed-credit figures determine status; crossings do not override available live data.
serviceobserved
services-platform:modules/llm/services/usage-reports/usage-status.ts:deriveUsageStatus

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software