Alibaba Cloud Model Studio:Qwen-Audio-ASR-Filetrans non-real-time speech recognition iOS SDK

url

String

Yes

Service endpoints:

• wss://dashscope.aliyuncs.com/api/v1/services/audio/asr/transcription

• China (Beijing): wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/asr/transcription

• Singapore: wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/transcription

Replace {WorkspaceId} with your actual Workspace ID.

apikey

String

Yes

The API Key.

service_mode

String

Yes

The run mode. Fixed to "1" for non-real-time speech recognition.

device_id

String

Yes

A unique string that identifies the end user. Set it to an in-app user ID or a device identifier generated by the client. This ID is used mainly for log tracing and troubleshooting.

debug_path

String

No

The storage path for the log file.

This parameter takes effect only when save_log is set to YES when you call the nui_initialize interface. In that case, you must set the log file path; otherwise, an error is returned.

A maximum of two log files are kept locally.

max_log_file_size

int

No

The maximum size of the log file, in bytes.

This parameter takes effect only when save_log is set to YES when you call the nui_initialize interface.

Default value: 104857600 (100 * 1024 * 1024 bytes, that is, 100 MiB).

log_track_level

int

No

Controls the filter level of the log content sent out through the log callback (onFileTransLogTrackCallback).

Default value: 2.

Valid values:

• 0: LOG_LEVEL_VERBOSE

• 1: LOG_LEVEL_DEBUG

• 2: LOG_LEVEL_INFO

• 3: LOG_LEVEL_WARNING

• 4: LOG_LEVEL_ERROR

• 5: LOG_LEVEL_NONE (disables this feature)

Note: log_track_level and level (set through the nui_initialize interface) together determine which logs are ultimately sent to the callback. A log's level value must be greater than or equal to both log_track_level and level before it is sent to the callback. For example, if log_track_level is set to 2 (INFO) and level is set to 3 (WARNING), only logs at WARNING or higher (value >= 3) are sent to the callback.

file_urls

array[string]

Yes

A list of URLs of the audio or video files to transcribe. HTTP and HTTPS are supported. A single request supports only one URL. For input requirements such as supported audio formats, file size limits, and duration limits, see Audio specifications.

If the recording is stored in Alibaba Cloud OSS, the RESTful API supports temporary URLs prefixed with oss://, whereas the SDK does not support oss://-prefixed temporary URLs.

async_request

boolean

No

Whether the speech recognition request is asynchronous.

Default value: false.

Valid values:

• true: asynchronous request
• false: synchronous request

apikey

string

No

If the apikey in Connection and control parameters is a temporary API Key, you can update it here to prevent it from expiring.

nls_config

object

Yes

The core speech recognition configuration object. It contains key parameters such as model selection and recognition effect controls.

nls_config.model

string

Yes

The model name.

nls_config.special_word_filter

object

No

The sensitive words to process during speech recognition. You can set a different handling method for each sensitive word. For details, see Sensitive word filtering.

nls_config.channel_id

array[integer]

No

The index of the audio tracks to recognize in a multi-track audio file. The index starts at 0. For example, [0] recognizes the first track, and [0, 1] recognizes the first and second tracks at the same time. If you omit this parameter, only the first track is processed.

Default value: [0].

nls_config.diarization_enabled

boolean

No

Whether to enable speaker diarization. Disabled by default.

Applies only to mono audio. Multi-channel audio does not support speaker diarization.

When enabled, the recognition result includes a speaker_id field that distinguishes different speakers.

Default value: false.

For an example of speaker_id, see Recognition result description.

nls_config.speaker_count

integer

No

A reference value for the number of speakers. The valid range is an integer from 2 to 100 (inclusive).

By default, the number of speakers is detected automatically. If you set this value, it only guides the algorithm to output the specified count when possible and does not guarantee that exact count.

No default value.

nls_config.vocabulary_id

string

No

The ID of a precompiled hot word list.

Generate this ID in advance by calling the create hot word list API. Pass the ID during recognition to use the hot words in the list.

Suitable for scenarios where the vocabulary is known and relatively stable, and where you need to reuse the same word list across requests.

For usage details, see Precompiled hotwords.

nls_config.input_context

array

No

A list of messages containing optional conversation context to improve recognition accuracy.

[
  {
    "role": "user",
    "content": [
      {
        "type": "input_text",
        "text": "你好啊，我是通义千问，有什么可以帮助你的？"
      }
    ]
  }
]

nls_config.instant_vocabulary

object

No

Instant hotwords, passed as key-value pairs. Each key is the hotword text (string), and each value is its weight (integer). No precompiled hotword list is required. Use this parameter for temporary, session-level hotwords.

Valid weights are integers from 1 to 5, or 50. A higher weight from 1 to 5 makes the model more likely to output the hotword. A weight of 50 defines a super hotword and significantly improves recall. You can specify up to 50 super hotwords.

If you also configure precompiled hotwords, the two sets are merged. If the merged set exceeds 2000 hotwords, 2000 are selected at random. For usage, see Instant hotwords.

{
  "张三": 5,
  "李四": 5
}

nls_config.language_hints

array[string]

No

The language codes to recognize. If you can't determine the language in advance, leave it unset and the model detects the language automatically.

You can set up to 4 values. If you set more, only the first 4 take effect.

parameters

char*

A JSON string that contains the authentication, connection, and debugging parameters. See Connection and control parameters.

level

NuiSdkLogLevel

Controls the print level of the SDK's own logs.

save_log

BOOL

Whether to save logs locally. If set to YES, you must specify a path through debug_path in Connection and control parameters, and you can set the file size through max_log_file_size.

params

char*

The nls_config parameter in Speech recognition effect parameters. Parameters other than nls_config cannot be set through this method.

Example:

{
    "nls_config": {
        "model":"qwen-audio-3.0-asr-flash-filetrans",
        "diarization_enabled": false
    }
}

params

char*

Speech recognition effect parameters.

Example:

{
    "file_urls": [
        "{YOUR_AUDIO_URL}"
    ],
    "async_request": false,
    "nls_config": {
        "model":"qwen-audio-3.0-asr-flash-filetrans",
        "diarization_enabled": false
    }
}

task_id

char*

The task ID. The SDK generates a random string internally and returns the task_id when this interface is called successfully.

task_id

char*

The ID of the task to query, obtained from the EVENT_FILE_TRANS_UPLOADED event.

task_id

char*

The ID of the task to cancel, obtained from the EVENT_FILE_TRANS_UPLOADED event.

nuiEvent

NuiCallbackEvent

The callback event.

asr_result

char*

The speech recognition result.

task_id

char*

The task ID.

finish

BOOL

Indicates whether this round of recognition has finished.

code

int

Valid only when the EVENT_ASR_ERROR event occurs.

EVENT_FILE_TRANS_CONNECTED

Connected to the service successfully.

EVENT_FILE_TRANS_UPLOADED

The audio file to recognize was uploaded successfully. You can now obtain the task_id of the current task.

EVENT_FILE_TRANS_QUERY_RESULT

The query task result.

EVENT_FILE_TRANS_RESULT

The final recognition result.

EVENT_ASR_ERROR

An error occurred during speech recognition.