Paraformer non-real-time speech recognition HarmonyOS SDK

Yes

The endpoint. This is fixed at wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/asr/transcription. Replace {WorkspaceId} with your actual workspace ID.

Yes

The API key. We recommend using a more secure temporary API key with a short validity period to reduce the risk of leaking a long-term key.

Yes

The operating mode. For non-real-time speech recognition, this is fixed at "1".

Yes

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

No

The storage path for log files. This parameter takes effect only if you set save_log to true when you call initializeFileTrans. In this case, you must specify a log file path. Otherwise, an error occurs. A maximum of two log files are retained locally.

No

Sets the maximum size of a log file in bytes. This parameter takes effect only if you set save_log to true when you call initializeFileTrans. Default value: 104857600 (100 * 1024 * 1024 bytes, or 100 MiB).

Yes

A list of URLs for the audio or video files to transcribe. HTTP and HTTPS are supported. A single request supports only 1 URL. If an audio file is stored in Alibaba Cloud OSS, the SDK does not support a temporary URL that uses the oss:// prefix. - Audio formats: aac, amr, avi, flac, flv, m4a, mkv, mov, mp3, mp4, mpeg, ogg, opus, wav, webm, wma, and wmv.

- Audio sample rates vary by model: - paraformer-v2 supports any sample rate. - paraformer-v1 supports any sample rate. - paraformer-8k-v2 supports only 8 kHz. - paraformer-8k-v1 supports only 8 kHz. - paraformer-mtl-v1 supports 16 kHz and higher. - Audio file size and duration: The file cannot exceed 2 GB, and its duration cannot exceed 12 hours. To process a file that exceeds these limits, preprocess it to reduce the file size. For best practices, see Preprocess video files to improve transcription efficiency for audio file recognition.

No

Specifies whether to use an asynchronous request. Default value: false. Valid values: - true: asynchronous request - false: synchronous request.

No

If apikey in Connection and control parameters is a temporary API key, update it here before it expires.

Yes

The core speech recognition configuration object, which contains key parameters for model selection and recognition effect control.

Yes

The speech recognition model.

No

Specifies language codes for the audio to recognize. This parameter applies only to paraformer-v2. Default value: ["zh", "en"]. Supported language codes: - zh: Chinese - en: English - ja: Japanese - yue: Cantonese - ko: Korean - de: German - fr: French - ru: Russian.

No

Specifies whether to remove disfluencies such as filler words. Default value: false. Valid values: - true: removes disfluencies - false: retains disfluencies.

No

Specifies whether to enable timestamp alignment. Default value: false. Valid values: - true: enabled - false: disabled.

No

Specifies sensitive words to process during speech recognition and supports different processing methods for different words. If this parameter is omitted, the built-in sensitive-word filtering logic is enabled. Words that match the Alibaba Cloud Model Studio sensitive word list are replaced with the same number of * characters. If this parameter is specified, matched words can be replaced with * characters or removed. The value is a JSON object in the following format: { "filter_with_signed": { "word_list": ["测试"] }, "filter_with_empty": { "word_list": ["开始", "发生"] }, "system_reserved_filter": true }. JSON field descriptions: - filter_with_signed: An optional object that specifies words to replace with the same number of * characters. In the preceding example, the result for “帮我测试一下这段代码” is “帮我**一下这段代码”. Its word_list field is an array of strings to replace. - filter_with_empty: An optional object that specifies words to remove from the result. In the preceding example, the result for “比赛这就要开始了吗？” is “比赛这就要了吗”. Its word_list field is an array of strings to remove. - system_reserved_filter: An optional Boolean. Default value: true. Specifies whether to enable built-in sensitive-word rules. If set to true, words matching the Alibaba Cloud Model Studio sensitive word list are replaced with the same number of * characters.

No

Specifies the indexes of audio tracks to recognize in a multitrack audio file. Indexes start from 0. For example, [0] recognizes the first track, and [0, 1] recognizes the first and second tracks. If omitted, the first track is processed.

Default value: [0].

No

Specifies whether to enable speaker diarization. This feature is disabled by default. It applies only to mono audio. Multichannel audio does not support speaker diarization. When enabled, the recognition result contains speaker_id to distinguish speakers.

For an example of speaker_id, see Recognition result descriptions.

No

A reference value for the number of speakers. To use this feature, set diarization_enabled to true. By default, the number of speakers is automatically determined. If this parameter is set, it only guides the algorithm to output the specified number and does not guarantee that number. Valid range: [2, 100]. The minimum is 2 because this feature distinguishes multiple speakers.

No

The hotword vocabulary ID, which improves the recognition accuracy of specific words. This parameter applies to v2 and later models. For more information, see Custom hotwords.

No

The hotword resource configuration for v1 models. It provides the same function as vocabulary_id but uses a different configuration method. resources is an array of objects. Each object contains resource_id and resource_type: - resource_id: A string that specifies the hotword ID. - resource_type: A string fixed at asr_phrase. Example: { "nls_config": { "resources": [ { "resource_id": "xxxxxxxxxxxx", "resource_type": "asr_phrase" } ] } }. For more information, see Create and manage hotwords for Paraformer speech recognition.

An implementation of the file transcription event and data callback interface.

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

Controls the SDK log level. Valid values are defined by the Constants.LogLevel enumeration.

Specifies whether to save local logs. If this parameter is true, use debug_path in Connection and control parameters to specify a path. You can also use max_log_file_size to set the file size.

The nls_config parameter in Speech recognition effect parameters. Parameters outside nls_config cannot be set by using this method. Example: { "nls_config": { "model":"paraformer-v2", "disfluency_removal_enabled":false, "timestamp_alignment_enabled": false } }

The speech recognition effect parameters. Example: { "file_urls": [ "{YOUR_AUDIO_URL}" ], "async_request": false, "nls_config": { "model":"paraformer-v2", "disfluency_removal_enabled":false, "timestamp_alignment_enabled": false } }

The task ID buffer. The SDK writes an internally generated random task ID string to this buffer. The buffer must be at least 33 bytes long. The example uses new ArrayBuffer(64). After a successful call, decode the buffer to obtain the task's task_id.

The ID of the task to query, obtained from the buffer written by startFileTranscriber.

The ID of the task to cancel.

The callback event.

The error code. This parameter is valid when EVENT_ASR_ERROR occurs.

Indicates whether the task has ended.

The speech recognition result.

The task ID.

The service is connected.

The audio file to recognize is uploaded.

The task query result.

The final recognition result.

An error occurs during speech recognition.

The most detailed logs.

Debug logs.

Informational logs (default).

Warning logs.

Error logs.

Disables logging.