Rate this page:

VoiceDSPParameters

Agentic.VoiceDSP parameters. Can be passed as arguments to the Agentic.createVoiceDSP method.

Props

asr
Optional
Copy URL
asr: 

ASR

Optional. ASR instance used internally for transcription-based start strategies; the latest transcript snapshot is included on Agentic.VoiceDSPEvents.TurnStopped. Live transcription should be handled via ASREvents on the scenario ASR instance.

asrGraceTimeout
Optional
Copy URL
asrGraceTimeout: 

number

Optional. ASR grace period in seconds after Agentic.VoiceDSPEvents.TurnInferenceTriggered. When Agentic.VoiceDSPParameters.asr is configured, Agentic.VoiceDSPEvents.TurnStopped waits up to this duration for a final transcript; a final transcript ends the wait immediately. Default 0.3 - shorter than typical ASR final latency, so Agentic.VoiceDSPEvents.TurnStopped does not wait for ASR final by default. Start LLM inference on Agentic.VoiceDSPEvents.TurnInferenceTriggered. When the timer expires, Agentic.VoiceDSPEvents.TurnStopped uses the latest snapshot (including interim text).

noiseSuppressionParameters
Optional
Copy URL
noiseSuppressionParameters: 

NoiseSuppressionParameters

Optional. Hush noise suppression configuration forwarded to the bundled voice DSP connector (server-side processing). Same parameter shape as Hush.NoiseSuppressionParameters. NOTE: if this field is omitted, the connector does not run noise suppression.

onWebSocketClose
Optional
Copy URL
onWebSocketClose: 

(event: WebSocketEvents.CLOSE) => void

Optional. A callback function that is called when the WebSocket connection is closed.

privacy
Optional
Copy URL
privacy: 

boolean

Optional. Whether to enable the privacy functionality.

If privacy is enabled, the logging for the WebSocket connection is disabled.

NOTE: the default value is false.

startStrategies
Optional
Copy URL
startStrategies: 

Start[]

Optional. Strategies that determine when a user's turn starts. Multiple strategies can be provided; the first one to trigger signals the start. Use Agentic.VoiceDSPStrategies factories (for example Agentic.VoiceDSPStrategies.createVADStart).

statistics
Optional
Copy URL
statistics: 

boolean

Optional. Enables statistics functionality.

stopStrategies
Optional
Copy URL
stopStrategies: 

Stop[]

Optional. Strategies that determine when a user's turn ends. Use Agentic.VoiceDSPStrategies factories (for example Agentic.VoiceDSPStrategies.createTurnDetectorStop). If Agentic.VoiceDSPStrategies.TurnDetectorStop is configured, it is authoritative; Agentic.VoiceDSPStrategies.SpeechTimeoutStop does not pre-empt it. One turn always finalizes with a single strategy. NOTE: If no stop strategies are provided, Agentic.VoiceDSPStrategies.createTurnDetectorStop is used as the default. Omit Agentic.VoiceDSPStrategies.TurnDetectorStop to disable ML Predict (for tests or ASR-only stop logic); Agentic.VoiceDSPEvents.TurnInferenceTriggered and Agentic.VoiceDSPEvents.TurnStopped then never report strategy 'turn_detector'.

trace
Optional
Copy URL
trace: 

boolean

Optional. Whether to enable the tracing functionality.

If tracing is enabled, a URL to the trace file appears in the 'websocket.created' message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigate issues.

turnDetectorParameters
Optional
Copy URL
turnDetectorParameters: 

TurnDetectorParameters

Optional. Turn detector configuration forwarded to the bundled voice DSP connector (server-side processing).

userTurnIdleTimeout
Optional
Copy URL
userTurnIdleTimeout: 

number

Optional. User idle timeout in seconds (mirrors Pipecat UserIdleController.user_idle_timeout). After Agentic.VoiceDSP.signalAssistantTurnEnded, if the user remains inactive for this duration, Agentic.VoiceDSPEvents.TurnIdle is emitted. 0 disables idle detection. The default value is 0.

userTurnStopTimeout
Optional
Copy URL
userTurnStopTimeout: 

number

Optional. Pipecat user_turn_stop_timeout (seconds). Counts silence while a user turn is active; the timer resets on new speech and on ASR updates. If no stop strategy finalizes the turn within this silence, Agentic.VoiceDSPEvents.TurnStopTimeout is emitted with reason controller_timeout, then Agentic.VoiceDSPEvents.TurnStopped. strategy on Agentic.VoiceDSPEvents.TurnInferenceTriggered and Agentic.VoiceDSPEvents.TurnStopped is the pending stop strategy, or the configured fallback if none is pending (never 'turn_detector' unless Agentic.VoiceDSPStrategies.TurnDetectorStop is configured). Default 5.0. Set 0 to disable.

vadParameters
Optional
Copy URL
vadParameters: 

VADParameters

Optional. VAD configuration forwarded to the bundled voice DSP connector (server-side processing).

Rate this page: