Agentic
Classes
- VoiceDSP — Agentic voice DSP is a composite connector working with underlying Silero.VAD and Pipecat.TurnDetector.
Enums
Sub-namespaces
Functions
createVoiceDSP
Creates an Agentic.VoiceDSP instance.
Parameters
Types
NoiseSuppressionParameters
Extends: Hush.NoiseSuppressionParameters
Hush.NoiseSuppressionParameters based. Can be passed as Agentic.VoiceDSPParameters.noiseSuppressionParameters to Agentic.createVoiceDSP.
TurnDetectorParameters
Extends: Pipecat.TurnDetectorParameters
Pipecat.TurnDetectorParameters based. Can be passed as Agentic.VoiceDSPParameters.turnDetectorParameters to Agentic.createVoiceDSP.
optional
Optional. Mirrors Pipecat SmartTurnParams.stop_secs parameter. If the turn analyzer classifies the turn as incomplete, silence must continue for this many seconds before the turn is finalized. The default value is 3.0.
Inherited fields
optional, inherited from Pipecat.TurnDetectorParameters
Optional. Maximum segment duration in seconds. The default value is 8.
optional, inherited from Pipecat.TurnDetectorParameters
Optional. Milliseconds of audio to include before speech starts. The default value is 0.
_optional, inherited from WebSocketBasedClientParameters
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.
_optional, inherited from WebSocketBasedClientParameters
Optional. Enables statistics functionality.
optional, inherited from Pipecat.TurnDetectorParameters
Optional. The probability threshold above which we detect the end of the turn (in the range [0.0, 1.0]). The default value is 0.5.
_optional, inherited from WebSocketBasedClientParameters
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 investigating issues.
VADParameters
Extends: Silero.VADParameters
Silero.VADParameters forwarded to the bundled Agentic.VoiceDSP connector (server-side VAD). Can be passed as Agentic.VoiceDSPParameters.vadParameters to Agentic.createVoiceDSP.
Inherited fields
optional, inherited from Silero.VADParameters
Optional. The duration of silence (in milliseconds) to wait for each speech segment before separating it. The default value is 300.
_optional, inherited from WebSocketBasedClientParameters
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.
optional, inherited from Silero.VADParameters
Optional. The padding to add to speech segments to avoid aggressive cutting. The default value is 0.
_optional, inherited from WebSocketBasedClientParameters
Optional. Enables statistics functionality.
optional, inherited from Silero.VADParameters
Optional. The probability threshold above which we detect speech. The default value is 0.5.
_optional, inherited from WebSocketBasedClientParameters
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 investigating issues.
VoiceDSPParameters
Extends: _VoiceAIClientParameters
Agentic.VoiceDSP parameters. Can be passed as arguments to the Agentic.createVoiceDSP method.
optional
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).
optional
Optional. Noise suppression configuration forwarded to the bundled voice DSP connector (server-side processing). NOTE: if the parameters are NOT provided, the voice DSP connector will NOT use the noise suppression.
optional
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).
optional
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’.
optional
Optional. Turn detector configuration forwarded to the bundled voice DSP connector (server-side processing).
optional
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.
optional
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.
optional
Optional. VAD configuration forwarded to the bundled voice DSP connector (server-side processing).
Inherited fields
_optional, inherited from VoiceAIClientParameters
Optional. A callback function that is called when the WebSocket connection is closed.
_optional, inherited from WebSocketBasedClientParameters
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.
_optional, inherited from WebSocketBasedClientParameters
Optional. Enables statistics functionality.
_optional, inherited from WebSocketBasedClientParameters
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 investigating issues.