RouterCandidate
Auto-generated API reference for RouterCandidate.
Interface: RouterCandidate
Defined in: adapters/src/router.ts:10
#Properties
#adapter
adapter:
AdapterFactory
Defined in: adapters/src/router.ts:12
#capabilities?
optionalcapabilities?:AdapterCapabilities
Defined in: adapters/src/router.ts:27
Capability override. Defaults to adapter.capabilities.
Used to reject candidates missing required features
(e.g. tools, multiModal).
#cost?
optionalcost?:number
Defined in: adapters/src/router.ts:19
Relative cost hint (lower wins for policy='cheapest'). Only relative values matter β use $/1M tokens or any consistent unit.
#gCO2PerKtok?
optionalgCO2PerKtok?:number
Defined in: adapters/src/router.ts:36
Estimated grid CO2 intensity (gCO2eq per 1k tokens) for this
adapter+region. Lower wins for policy='greenest'. Use
applyCarbonTable() to populate from DEFAULT_CARBON_TABLE or
a custom table.
#id
id:
string
Defined in: adapters/src/router.ts:11
#latencyMs?
optionallatencyMs?:number
Defined in: adapters/src/router.ts:21
Typical latency in ms. Lower wins for policy='fastest'.
#region?
optionalregion?:DataRegion
Defined in: adapters/src/router.ts:14
Data residency region for this adapter endpoint.
#tags?
optionaltags?:string[]
Defined in: adapters/src/router.ts:29
Free-form tags used by classifier routing (e.g. 'fast', 'coding').