Rhythm 2.0 Specifications

Appearance

CAP-PFM-LLM-011Inspect an organization’s AI account and request history

Markdown

CAP-PFM-LLM-011

Inspect an organization’s AI account and request history

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-LLM-04
Exercised by
FAS-PFM-LLM-04-01, FAS-PFM-LLM-04-02, FAS-PFM-LLM-04-03, FAS-PFM-LLM-04-04, FAS-PFM-LLM-04-05, JNY-PFM-LLM-001, JNY-PFM-LLM-003
Key concepts
CON-PFM-LLM-003, CON-PFM-LLM-001, CON-PFM-LLM-004
Actors
ACT-PFM-033, ACT-PFM-004
Journeys
JNY-PFM-LLM-002
Depends on
CAP-PFM-LLM-007
Related
CAP-PFM-LLM-003, CAP-PFM-LLM-008, CAP-PFM-LLM-010, CAP-PFM-LLM-012, CAP-PFM-LLM-013, CAP-PFM-LLM-014, CAP-PFM-LLM-015, CAP-PFM-LLM-016
Proved by
ATS-PFM-LLM-011

Implementation

Executable suites
TST-PFM-LLM-001, TST-PFM-LLM-002, TST-PFM-LLM-004, TST-PFM-LLM-009, TST-PFM-LLM-029, TST-PFM-LLM-033, TST-PFM-LLM-035, TST-PFM-LLM-050, TST-PFM-LLM-052

KindCapabilityProduct areaPlatformModuleAI Requests, Usage and the Jazz AI TeammateRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Inspect an organization’s AI account and request history ​

Purpose ​

Let support staff connect an organization’s current allowance position with the requests and controls behind it.

How It Works ​

A staff reader opens the organization’s AI Usage card. Its independent sections combine the current period with limits, active capacity and recent history. The reader can open the request directory and narrow it to the work they need to investigate. Request details provide attribution, attempts and the versions used for pricing. Execution details group the model requests belonging to one task. Separate lists expose grants, corrections, crossings and AI audit events. Ordinary reads show content status while keeping captured bodies behind their separate access boundary. The support role remains read-only, and authorized managers see the currently disabled action menu.

Relationships ​

  • Admit AI work against the organization’s monthly allowance supplies the prerequisite behavior for this outcome.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Support inspects an organization’s AI position from HQ.Request details expose metadata and attempts separately from captured bodies.Control history retains limits, grants, corrections and notices.
Surfaces
consoleapi
Preconditions
An existing organization is selected.
Intent sources
services-platform:docs/milestones/plans/PLAT-M1-plan.md#4. Assumptions

Controls

35 controls apply, from the corpus control catalogue.

TC-AI-006 TC-AI-007 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-CRY-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-IAM-001 TC-IAM-003 TC-IAM-006 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-003 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
hq.llm-usage.readapiglobal
hq.llm-usage.readconsoleglobal
hq.llm-usage.manageconsoleglobal

Business Rules

12 rules, 8 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
The HQ usage read key authorizes organization usage inspection for Rhythm staff, while a customer administrator cannot use that surface even for their own organization.
proved by ATS-PFM-LLM-011-01, TST-PFM-LLM-009
permissionapitest
services-platform:modules/llm/tests/e2e/llm-usage.e2e.spec.js#refuses a customer’s administrator a tenant’s usage even in their own tenant
02must prove
Proposed
Reads first resolve the named organization and scope its records accordingly, returning not found for nonexistent organizations or foreign requests and executions.
proved by ATS-PFM-LLM-010-09, ATS-PFM-LLM-011-02, ATS-PFM-LLM-011-15, TST-PFM-LLM-009, TST-PFM-LLM-033, TST-PFM-LLM-050
validationservice, databasetest
services-platform:modules/llm/tests/e2e/llm-usage.e2e.spec.js#answers 404 for a request of another tenant, the tenant policy binding the read
03must prove
Proposed
The overview independently reports the current allowance position, configured or default limits, active capacity, six recent periods, operation and model totals and twenty recent problem requests.
proved by ATS-PFM-LLM-007-14, ATS-PFM-LLM-011-03, ATS-PFM-LLM-011-10, ATS-PFM-LLM-011-14, ATS-PFM-LLM-011-18, TST-PFM-LLM-001, TST-PFM-LLM-004, TST-PFM-LLM-050
calculationserviceobserved
services-platform:modules/llm/services/usage-reports/tenant-usage.ts
04must prove
Proposed
Historical periods evaluate capacity at their last instant and the current period evaluates it now; ended and revoked grants do not count as currently active.
proved by ATS-PFM-LLM-011-04, TST-PFM-LLM-050
calculationserviceobserved
services-platform:modules/llm/services/usage-reports/tenant-usage.ts
05must prove
Proposed
The request directory is newest-first and supports period or date windows and operation, model, status, execution and caller filters, with at most one hundred rows per page and rejection of invalid filters or cursors.
proved by ATS-PFM-LLM-011-05, ATS-PFM-LLM-011-16, ATS-PFM-LLM-011-17, TST-PFM-LLM-009, TST-PFM-LLM-035, TST-PFM-LLM-052
validationapiobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts
06must prove
Proposed
Usage lists and details withhold captured bodies and storage references, exposing only their capture status.
proved by ATS-PFM-LLM-011-06, ATS-PFM-LLM-011-09, ATS-PFM-LLM-011-13, TST-PFM-LLM-002, TST-PFM-LLM-009
invariantapi, service, consoleobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts
07
Proposed
Request detail identifies the caller, feature, routing, charge, ordered attempts, pricing versions, execution and any retained refusal figures.
policyapi, consoleobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts:toInvocationDetailResponse
08
Proposed
Organization execution lists include running tasks, and each detail pairs the task totals with its associated requests.
proved by ATS-PFM-LLM-003-09
policyapiobserved
services-platform:modules/llm/aws/api/llm-usage-api-mapper.ts
09must prove
Proposed
Grant lists order by newest start and derive scheduled, active, expired or revoked state at read time, optionally showing active grants only.
proved by ATS-PFM-LLM-011-07, ATS-PFM-LLM-011-11, TST-PFM-LLM-009, TST-PFM-LLM-029
calculationservicetest
services-platform:modules/llm/tests/integration/services/overrides/allowance-overrides.integration.spec.js#answers each override with the state it has now, newest start first
10
Proposed
Limit reads distinguish defaults from configuration and show ceilings, correction reads preserve signed values, and crossing reads expose delivery time, attempt count and recipient count.
proved by ATS-PFM-LLM-008-11
policyapiobserved
services-platform:modules/llm/services/usage-reports/tenant-usage.ts
11
Proposed
The AI audit trail filters this organization’s limit, grant, revocation, correction and content-read events and orders them newest-first.
proved by ATS-PFM-LLM-011-12
policyserviceobserved
services-platform:modules/llm/services/usage-reports/tenant-usage.ts
12must prove
Proposed
Support readers receive no usage action menu or write controls, while staff with management authority receive the action menu.
proved by ATS-PFM-LLM-011-08, TST-PFM-LLM-002
permissionconsoletest
react-console:e2e/mock/hq-ai-usage.mock.spec.ts#a Support Representative reads the card but has no action menu and no write controls

Scenarios

IdGivenWhenThenProvenance
01A limited organization is opened in HQ.Support reads its usage card.The card renders allowance and reset figures, default limits, history and refusals.test
react-console:e2e/mock/hq-ai-usage.mock.spec.ts#reads the limited organization: the warning band, the limits, the history and the refusals

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