Interface: ISTTProvider
Makaio Framework / contracts / ISTTProvider
Interface: ISTTProvider
Section titled “Interface: ISTTProvider”Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:77
Speech-to-text capability provider.
Providers implement audio transcription for the voice pipeline. Register via the capability registry so the runtime can resolve the active provider at session start.
Extends
Section titled “Extends”Properties
Section titled “Properties”capabilities
Section titled “capabilities”
readonlycapabilities:STTProviderCapabilities
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:84
Structured capabilities for provider selection.
capabilityId
Section titled “capabilityId”
readonlycapabilityId:"stt"
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:79
Discriminant that identifies the STT 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
runtime
Section titled “runtime”
readonlyruntime:ProviderRuntime
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:82
Where this provider runs. Server providers receive audio via WebSocket; client providers run locally in the browser/app.
Methods
Section titled “Methods”isAvailable()
Section titled “isAvailable()”isAvailable():
Promise<boolean>
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:97
Check whether this provider is ready to accept requests.
Returns
Section titled “Returns”Promise<boolean>
true when the underlying adapter is initialised and reachable
transcribe()
Section titled “transcribe()”transcribe(
request):Promise<{confidence?:number;language:string;text:string; }>
Defined in: ../../../packages/contracts/src/capabilities/voice/types.ts:91
Transcribe a raw audio buffer into text.
Parameters
Section titled “Parameters”request
Section titled “request”Audio data and transcription options
Returns
Section titled “Returns”Promise<{ confidence?: number; language: string; text: string; }>
Transcription result with detected language and optional confidence
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