VoiceAgentClientParameters
Deepgram.VoiceAgentClient parameters. Can be passed as arguments to the Deepgram.createVoiceAgentClient method.
Props
accessToken
accessToken: string
| undefined
Optional. Deepgram access token for authentication. Use it instead of apiKey for more secure authentication.
apiKey
apiKey: string
| undefined
Optional. Deepgram API key.
onWebSocketClose
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
| undefined
Optional. A callback function that is called when the WebSocket connection is closed.
settingsOptions
settingsOptions: Object
Optional. Settings configuration for Deepgram's Voice Agent API.
statistics
statistics: false
| undefined
| true
Optional. Enables statistics functionality.
trace
trace: false
| undefined
| true
Optional. Whether to enable the tracing functionality. If tracing is enabled, an 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.