VoiceAgentAPIClientParameters
QwenCloud.VoiceAgentAPIClient parameters. Can be passed as arguments to the QwenCloud.createVoiceAgentAPIClient method.
Props
apiKey: string
The Qwen Cloud API key. Sent as Authorization: Bearer.
model: string
Optional. The realtime model. https://www.qwencloud.com/models/qwen-audio-3.1-realtime-plus. Note: The default value is qwen-audio-3.1-realtime-plus.
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
Optional. A callback function that is called when the WebSocket connection is closed.
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: boolean
Optional. Enables statistics functionality.
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.
workspace: string
Optional. Qwen Cloud workspace id. Sent as the X-DashScope-WorkSpace header.