Class: SpeechProviderResolver
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:98
Central resolver for speech providers (STT, TTS, VAD, wake-word).
Resolution Algorithm
-
Registration — Providers are registered via
register()with a uniqueid, akind(stt/tts/vad/wake-word), a numericpriority, and a booleanisConfiguredflag. -
Filtering — When a consumer calls
resolveSTT(),resolveTTS(),resolveVAD(), orresolveWakeWord(), the resolver filters registrations bykind,isConfigured === trueand a registered provider instance (provider). A core catalog entry with its keys set but no instance does not resolve. -
Requirements matching — Optional ProviderRequirements further filter by
streaming,local, andfeaturescapabilities from the provider's catalog entry. -
Priority ordering — Remaining candidates are sorted by ascending
priority(lower number = tried first). Core providers default to 100, extensions to 200, and user-preferred providers get boosted to 50+. -
Fallback wrapping — When
config.stt.fallbackorconfig.tts.fallbackistrueand multiple candidates survive, they are wrapped in a FallbackSTTProxy or FallbackTTSProxy that tries each in order, emittingprovider_fallbackevents on failure.
Priority Tiers
| Tier | Priority Range | Source |
|---|---|---|
| User-preferred | 50–59 | config.stt.preferred / config.tts.preferred |
| Core | 100 | Built-in provider catalog |
| Extension | 200 | Discovered via ExtensionManager |
Events
| Event | Payload | When |
|---|---|---|
provider_registered | { id, kind, source } | A provider is registered via register() |
See
- FallbackSTTProxy for the STT fallback chain implementation
- FallbackTTSProxy for the TTS fallback chain implementation
- ProviderRequirements for available filtering criteria
Example
// SpeechRuntime builds the providers whose keys are set (DEEPGRAM_API_KEY
// for deepgram-batch) and registers them in its resolver.
const runtime = new SpeechRuntime({ env: process.env, preferredSttProviderId: 'deepgram-batch' });
await runtime.resolver.refresh(); // applies the preferred priorities
const stt = runtime.resolver.resolveSTT();
Extends
EventEmitter
Constructors
Constructor
new SpeechProviderResolver(
config?,env?):SpeechProviderResolver
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:143
Creates a new SpeechProviderResolver.
Parameters
config?
Optional resolver configuration controlling preferred providers and fallback behaviour for each provider kind.
env?
Record<string, string | undefined> = process.env
Environment variable map used to check whether a provider's
required API keys are present. Defaults to process.env so unit tests
can inject a controlled map without polluting the real environment.
Returns
SpeechProviderResolver
Example
// Production: use real env vars
const resolver = new SpeechProviderResolver({ stt: { fallback: true } });
// Testing: inject controlled env
const resolver = new SpeechProviderResolver(undefined, { OPENAI_API_KEY: 'test' });
Overrides
EventEmitter.constructor
Properties
captureRejections
staticcaptureRejections:boolean
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:425
Value: boolean
Change the default captureRejections option on all new EventEmitter objects.
Since
v13.4.0, v12.16.0
Inherited from
EventEmitter.captureRejections
captureRejectionSymbol
readonlystaticcaptureRejectionSymbol: typeofcaptureRejectionSymbol
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:418
Value: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Since
v13.4.0, v12.16.0
Inherited from
EventEmitter.captureRejectionSymbol
defaultMaxListeners
staticdefaultMaxListeners:number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:464
By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
can be used. If this value is not a positive number, a RangeError is thrown.
Take caution when setting the events.defaultMaxListeners because the
change affects all EventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over events.defaultMaxListeners.
This is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a "possible EventEmitter memory leak" has been detected. For any single
EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to
temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
The --trace-warnings command-line flag can be used to display the
stack trace for such warnings.
The emitted warning can be inspected with process.on('warning') and will
have the additional emitter, type, and count properties, referring to
the event emitter instance, the event's name and the number of attached
listeners, respectively.
Its name property is set to 'MaxListenersExceededWarning'.
Since
v0.11.2
Inherited from
EventEmitter.defaultMaxListeners
errorMonitor
readonlystaticerrorMonitor: typeoferrorMonitor
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:411
This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no
regular 'error' listener is installed.
Since
v13.6.0, v12.17.0
Inherited from
EventEmitter.errorMonitor
Methods
[captureRejectionSymbol]()?
optional[captureRejectionSymbol]<K>(error,event, ...args):void
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:103
Type Parameters
K
K
Parameters
error
Error
event
string | symbol
args
...AnyRest
Returns
void
Inherited from
EventEmitter.[captureRejectionSymbol]
addListener()
addListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:642
Alias for emitter.on(eventName, listener).
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v0.1.26
Inherited from
EventEmitter.addListener
emit()
emit<
K>(eventName, ...args):boolean
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:904
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Type Parameters
K
K
Parameters
eventName
string | symbol
args
...AnyRest
Returns
boolean
Since
v0.1.26
Inherited from
EventEmitter.emit
eventNames()
eventNames(): (
string|symbol)[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:967
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Returns
(string | symbol)[]
Since
v6.0.0
Inherited from
EventEmitter.eventNames
getMaxListeners()
getMaxListeners():
number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:819
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns
number
Since
v1.0.0
Inherited from
EventEmitter.getMaxListeners
listenerCount()
listenerCount<
K>(eventName,listener?):number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:913
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Type Parameters
K
K
Parameters
eventName
The name of the event being listened for
string | symbol
listener?
Function
The event handler function
Returns
number
Since
v3.2.0
Inherited from
EventEmitter.listenerCount
listeners()
listeners<
K>(eventName):Function[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:832
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Type Parameters
K
K
Parameters
eventName
string | symbol
Returns
Function[]
Since
v0.1.26
Inherited from
EventEmitter.listeners
listProviders()
listProviders(
kind):ProviderRegistration[]
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:205
List all registrations for a given provider kind, sorted ascending by priority (lower number = higher priority = tried first).
This returns both configured and unconfigured providers — use
.filter(r => r.isConfigured && r.provider) for the ones the resolve
methods can return (keys set and an instance registered).
Parameters
kind
The provider kind to filter by.
Returns
A new array of registrations sorted by ascending priority.
Example
const allSTT = resolver.listProviders('stt');
const ready = allSTT.filter(r => r.isConfigured && r.provider);
console.log(`${ready.length} of ${allSTT.length} STT providers ready`);
off()
off<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:792
Alias for emitter.removeListener().
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v10.0.0
Inherited from
EventEmitter.off
on()
on<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:674
Adds the listener function to the end of the listeners array for the event
named eventName. No checks are made to see if the listener has already
been added. Multiple calls passing the same combination of eventName and
listener will result in the listener being added, and called, multiple times.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v0.1.101
Inherited from
EventEmitter.on
once()
once<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:704
Adds a one-time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v0.3.0
Inherited from
EventEmitter.once
prependListener()
prependListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:931
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v6.0.0
Inherited from
EventEmitter.prependListener
prependOnceListener()
prependOnceListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:947
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v6.0.0
Inherited from
EventEmitter.prependOnceListener
rawListeners()
rawListeners<
K>(eventName):Function[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:863
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Type Parameters
K
K
Parameters
eventName
string | symbol
Returns
Function[]
Since
v9.4.0
Inherited from
EventEmitter.rawListeners
refresh()
refresh(
extensionManager?):Promise<void>
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:369
Populate the resolver by registering core providers from the static catalog, optionally discovering extension providers, and applying user-configured preferred priorities.
The refresh sequence is:
discoverExtensionProviders()— if an ExtensionManager is provided, read the speech providers it lists as active, and drop the ones an earlier refresh read from it that it no longer lists.registerCoreProviders()— register all built-in providers from the static catalog, marking each as configured/unconfigured based on env vars.- Register the providers read in step 1, at priority 200.
applyPreferredPriorities()— boost priority for providers listed in the user'sconfig.stt.preferred/config.tts.preferredarrays.
Parameters
extensionManager?
any
Optional ExtensionManager (its speech provider
registries are read through getRegistry(kind).listActive()), or any
object exposing getDescriptorsByKind(kind). Uses any type because
importing the ExtensionManager type here would create a circular dependency.
Returns
Promise<void>
Example
const runtime = new SpeechRuntime({ env: process.env });
await runtime.resolver.refresh(extensionManager);
// The manager's speech providers now resolve beside the runtime's own.
refreshVoiceAdapters()
refreshVoiceAdapters(
manager):void
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:399
Reads typed descriptors without triggering legacy environment discovery or creating providers.
Parameters
manager
getVoiceAdapters
Returns
void
register()
register(
reg):void
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:175
Register a provider, overwriting any existing registration with the same
kind and id. Re-registering at the priority the resolver shows (a preferred
boost included), as register({ ...entry, provider }) does, keeps the
priority the provider was first registered with.
Emits a provider_registered event with { id, kind, source } so that
listeners (e.g. UI dashboards, logging middleware) can track what's available.
Parameters
reg
The full registration object including the provider instance, catalog entry, priority, and configuration status.
Returns
void
Example
resolver.register({
id: 'custom-stt',
kind: 'stt',
provider: myCustomProvider,
catalogEntry: { id: 'custom-stt', kind: 'stt', label: 'Custom', envVars: [], local: false, description: '' },
isConfigured: true,
priority: 150,
source: 'extension',
});
registerVoiceAdapter()
registerVoiceAdapter(
adapter):void
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:389
Registers an explicit scoped factory. Legacy catalog metadata cannot satisfy this API.
Parameters
adapter
ScopedVoiceAdapter
Returns
void
removeAllListeners()
removeAllListeners(
eventName?):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:803
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
eventName?
string | symbol
Returns
this
Since
v0.1.26
Inherited from
EventEmitter.removeAllListeners
removeListener()
removeListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:787
Removes the specified listener from the listener array for the event named eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v0.1.26
Inherited from
EventEmitter.removeListener
resolveScopedBatch()
resolveScopedBatch<
K>(kind,providerId,rawScope,selection,budget,network?,onSupplierUsage?):Promise<OpenedVoiceAdapter<K>>
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:473
Resolves a scoped batch provider through the same registered options, credentials and request budget.
Type Parameters
K
K extends "batch-stt" | "batch-tts"
Parameters
kind
K
providerId
string
rawScope
VoiceScopeContext
selection
VoiceAdapterSelection
budget
network?
VoiceNetworkDependencies = {}
onSupplierUsage?
VoiceSupplierUsageSink
Returns
Promise<OpenedVoiceAdapter<K>>
resolveSTT()
resolveSTT(
requirements?):SpeechToTextProvider
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:238
Resolve the best STT provider matching optional ProviderRequirements.
When config.stt.fallback is true and multiple candidates exist, wraps
them in a FallbackSTTProxy that tries providers in priority order.
Otherwise returns the single highest-priority match.
Parameters
requirements?
Optional filtering criteria (streaming, local, features, preferredIds).
Returns
The resolved STT provider, possibly wrapped in a FallbackSTTProxy.
Throws
When no configured STT provider with an instance matches the requirements.
See
- FallbackSTTProxy for fallback chain behaviour
- ProviderRequirements for available filter options
Example
// Simple: best available
const stt = resolver.resolveSTT();
// With requirements
const stt = resolver.resolveSTT({ streaming: true, features: ['diarization'] });
// With explicit preference ordering
const stt = resolver.resolveSTT({ preferredIds: ['deepgram-batch', 'openai-whisper'] });
resolveTTS()
resolveTTS(
requirements?):TextToSpeechProvider
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:276
Resolve the best TTS provider matching optional ProviderRequirements.
When config.tts.fallback is true and multiple candidates exist, wraps
them in a FallbackTTSProxy that tries providers in priority order.
Otherwise returns the single highest-priority match.
Parameters
requirements?
Optional filtering criteria (streaming, local, features, preferredIds).
Returns
The resolved TTS provider, possibly wrapped in a FallbackTTSProxy.
Throws
When no configured TTS provider with an instance matches the requirements.
See
- FallbackTTSProxy for fallback chain behaviour
- ProviderRequirements for available filter options
Example
const tts = resolver.resolveTTS();
const result = await tts.synthesize('Hello!');
resolveVAD()
resolveVAD():
SpeechVadProvider
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:308
Resolve the highest-priority configured VAD provider.
VAD providers don't support fallback chains because voice activity detection is a real-time frame-by-frame operation where mid-session provider switching would cause state inconsistency.
Returns
The resolved VAD provider instance.
Throws
When no configured VAD provider with an instance is registered.
Example
const vad = resolver.resolveVAD();
const decision = vad.processFrame(audioFrame);
resolveVoicePlan()
resolveVoicePlan(
rawScope,rawAgent,options,network?):Promise<FrozenVoicePlan>
Defined in: packages/agentos/src/io/speech/SpeechProviderResolver.ts:404
Validates language, PCM format, immutable models/voices, options and every fallback before construction.
Parameters
rawScope
VoiceScopeContext
rawAgent
agentId
string = id
allowedToolRefs
string[] = ...
createdAt
number = count
endpoint
{ modelId: string; modelRevision: string; optionsRef?: string; providerId: string; } = EndpointSelectionSchema
endpoint.modelId
string = id
endpoint.modelRevision
string = revisionRef
endpoint.optionsRef?
string = ...
endpoint.providerId
string = id
language
string
limits
{ cleanupTimeoutMs: number; maxDurationSeconds: number; maxTurns: number; reconnectGraceMs: number; setupTimeoutMs: number; silenceTimeoutMs: number; } = VoiceCallLimitsSchema
limits.cleanupTimeoutMs
number = positive
limits.maxDurationSeconds
number = positive
limits.maxTurns
number = positive
limits.reconnectGraceMs
number = count
limits.setupTimeoutMs
number = positive
limits.silenceTimeoutMs
number = positive
name
string = ...
prompt
string
providerPolicy
{ fallback: "none" | "allowlisted"; mode: "provider" | "local" | "hosted"; providerIds: string[]; purposes: ("stt" | "tts" | "vad" | "endpoint" | "reasoning")[]; } = VoiceProviderPolicySchema
providerPolicy.fallback
"none" | "allowlisted" = ...
providerPolicy.mode
"provider" | "local" | "hosted" = ...
providerPolicy.providerIds
string[] = ...
providerPolicy.purposes
("stt" | "tts" | "vad" | "endpoint" | "reasoning")[] = ...
reasoning
{ attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; fallbacks: ({ attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; manifestDigest: string; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "local"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; } | { attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; credentialRef?: string; endpointRef: string; endpointRevision: number; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "registered_endpoint"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; })[]; manifestDigest: string; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "local"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; } | { attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; credentialRef?: string; endpointRef: string; endpointRevision: number; fallbacks: ({ attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; manifestDigest: string; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "local"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; } | { attemptLimits: { maxAttempts: number; perAttempt: { cached_input_token: number; input_token: number; output_token: number; reasoning_token: number; request: number; }; }; cancellation: "native_abort" | "process_exit" | "unsupported"; credentialRef?: string; endpointRef: string; endpointRevision: number; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "registered_endpoint"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; })[]; modelId: string; modelRevision: string; protocol: { id: "openai-chat-completions"; version: 1; }; provider: "registered_endpoint"; usageUnits: { cached_input_token: "token"; input_token: "token"; output_token: "token"; reasoning_token: "token"; reasoningInOutput: boolean; }; } = ReasoningConfigSchema
revision
number = positive
scopeId
string = id
state
"active" | "archived" = ...
stt
{ codec: "mp3" | "opus" | "wav" | "pcm_s16le" | "pcm_f32le"; credentialRef?: string; mode: "streaming" | "batch"; modelId: string; modelRevision: string; optionsRef?: string; providerId: string; sampleRate: number; } = SpeechSelectionSchema
stt.codec
"mp3" | "opus" | "wav" | "pcm_s16le" | "pcm_f32le" = ...
stt.credentialRef?
string = ...
stt.mode
"streaming" | "batch" = ...
stt.modelId
string = id
stt.modelRevision
string = revisionRef
stt.optionsRef?
string = ...
stt.providerId
string = id