Interface: IVocabularyProvider
Makaio Framework / contracts / IVocabularyProvider
Interface: IVocabularyProvider
Section titled “Interface: IVocabularyProvider”Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:198
Provides context-derived vocabulary terms for ASR bias.
Implementations extract terms from open files, codebase indexes, or agent/session metadata. Used by VoiceService to merge with user-managed vocabulary before transcription.
Register via the capability registry with
capabilityId: 'voice-vocabulary' so VoiceService can discover
and query all active providers at transcription time.
Extends
Section titled “Extends”Properties
Section titled “Properties”capabilityId
Section titled “capabilityId”
readonlycapabilityId:"voice-vocabulary"
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:200
Discriminant that identifies the vocabulary capability slot in the registry.
displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: ../../../packages/contracts/src/capability/types.ts:11
Human-readable name for display in UI
Inherited from
Section titled “Inherited from”ICapabilityProvider.displayName
readonlyid:string
Defined in: ../../../packages/contracts/src/capability/types.ts:9
Unique identifier for this provider instance
Inherited from
Section titled “Inherited from”providerKey?
Section titled “providerKey?”
readonlyoptionalproviderKey?:string
Defined in: ../../../packages/contracts/src/capability/types.ts:17
Stable provider identity used for joins across registries.
Unlike id, this should remain stable across runtime re-registration.
Inherited from
Section titled “Inherited from”ICapabilityProvider.providerKey
Methods
Section titled “Methods”getTerms()
Section titled “getTerms()”getTerms(
sessionId):Promise<string[]>
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:207
Get vocabulary terms relevant to the current session context.
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
The active session
Returns
Section titled “Returns”Promise<string[]>
Domain-specific terms to bias ASR toward
validate()?
Section titled “validate()?”
optionalvalidate():Promise<{error?:string;valid:boolean; }>
Defined in: ../../../packages/contracts/src/capability/types.ts:22
Optional validation method to check provider configuration/credentials.
Returns
Section titled “Returns”Promise<{ error?: string; valid: boolean; }>
Validation result with optional error message