Rulvar API reference

---

Rulvar API reference / @rulvar/rulvar / ProviderAdapter

Interface: ProviderAdapter

Defined in: packages/core/dist/index.d.ts

Properties

Property	Type	Description	Defined in
id	string	Stable adapter id; the left segment of ModelRef.	packages/core/dist/index.d.ts
provider?	string	Provider family for provider-raw matching and retention (committed during M4-T02). Two adapters of the same family share retained blocks and projections; default = id.	packages/core/dist/index.d.ts
scopeKey?	string	The account identity of this adapter within its provider family (RV4007): two adapters of one family serving different provider accounts declare different scopeKeys, and the retention transport then keys provider-raw blocks by (family, scopeKey) instead of family alone, so cache handles and thinking blocks minted under one account never ride a request served by another. Undeclared keeps the family-wide sharing byte for byte. Attribution and projection identity only: routing, pricing, and quota keys are untouched.	packages/core/dist/index.d.ts
usageSemantics?	string	Declares WHICH reading of the provider's usage telemetry this adapter normalizes under; the engine stamps it on usage-bearing terminal entries so a journal records not only the numbers but the semantics they were produced under (v1.20.0 review P1/P2-2). Bump the string whenever the MEANING of a reported Usage field changes, even when no pricing rate moves; a rate change is a PriceTable pricingVersion bump instead. Entries persisted before this shipped carry no stamp, which is itself information: an unstamped OpenAI entry with cache writes may predate the v1.20.0 cache-subset correction. Optional; adapters that never changed semantics can omit it.	packages/core/dist/index.d.ts

Methods

caps()

caps(model): ModelCaps;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
model	string

Returns

ModelCaps

---

countTokens()?

optional countTokens(req, opts?): Promise<number>;

Defined in: packages/core/dist/index.d.ts

Provider-side token count for the request, used to tighten the admission reserve before a spawn dispatches. The request carries the FULL prompt, so an implementation that goes over the network is egress exactly like stream and MUST honor opts.signal (RV904): the engine only calls this after a zero-egress admission feasibility check, passes the spawn's abort signal, and treats an abort as cancellation rather than falling back to the flat reserve. Hosts that must not send prompts before their own admission gates pass an explicit estCost instead, which skips this call entirely.

Parameters

Parameter	Type
req	ChatRequest
opts?	{ signal?: AbortSignal; }
opts.signal?	AbortSignal

Returns

Promise<number>

---

describeRegulatedPosture()?

optional describeRegulatedPosture(): RegulatedPostureDescriptor;

Defined in: packages/core/dist/index.d.ts

The construction-side posture attestation (RV4101): a PURE snapshot of the risk postures this adapter chose at construction (no wire, no side effects), read by compileRegulatedProfile to refuse a loosened posture and hash a tightened one. Optional: an adapter without it counts into the profile's unrecognized tally instead of being implied verified.

Returns

RegulatedPostureDescriptor

---

refreshCaps()?

optional refreshCaps(): Promise<void>;

Defined in: packages/core/dist/index.d.ts

Refresh the capability table from live model lists.

Returns

Promise<void>

---

stream()

stream(
   req, 
   signal?, 
hooks?): AsyncIterable<ChatEvent>;

Defined in: packages/core/dist/index.d.ts

Parameters

Parameter	Type
req	ChatRequest
signal?	AbortSignal
hooks?	StreamHooks

Returns

AsyncIterable<ChatEvent>