Skip to navigation

QwenCloud

View as Markdown

Classes

Enums

  • Events — Add the following line to your scenario code to use the events: require(Modules.QwenCloud);
  • VoiceAgentAPIEvents — Add the following line to your scenario code to use the events: require(Modules.QwenCloud);

Functions

createVoiceAgentAPIClient

Creates a new QwenCloud.VoiceAgentAPIClient instance.

createVoiceAgentAPIClient(parameters: VoiceAgentAPIClientParameters): Promise<QwenCloud.VoiceAgentAPIClient>

Parameters

parameters
VoiceAgentAPIClientParametersRequired

Types

VoiceAgentAPIClientParameters

Extends: _VoiceAIClientParameters

QwenCloud.VoiceAgentAPIClient parameters. Can be passed as arguments to the QwenCloud.createVoiceAgentAPIClient method.

apiKey
string

The Qwen Cloud API key. Sent as Authorization: Bearer.

model
string

optional

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.

workspace
string

optional

Optional. Qwen Cloud workspace id. Sent as the X-DashScope-WorkSpace header.

Inherited fields

onWebSocketClose
(event: _WebSocketCloseEvent) => void

_optional, inherited from VoiceAIClientParameters

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

privacy
boolean

_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.

statistics
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Enables statistics functionality.

trace
boolean

_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 investigate issues.