Rate this page:

TurnDetectorParameters

Pipecat.TurnDetector parameters. Can be passed as arguments to the Pipecat.createTurnDetector method.

Props

maxDurationSecs
Optional
Copy URL
maxDurationSecs: 

number

Optional. Maximum segment duration in seconds. The default value is 8.

preSpeechMs
Optional
Copy URL
preSpeechMs: 

number

Optional. Milliseconds of audio to include before speech starts. The default value is 0.

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.

statistics
Optional
Copy URL
statistics: 

boolean

Optional. Enables statistics functionality.

threshold
Optional
Copy URL
threshold: 

number

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.

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.

Rate this page: