Paraformer录音文件识别RESTful API

模型名

模型简介

paraformer-v2

推荐使用。Paraformer最新多语种语音识别模型。

• 适用场景：直播、会议等场景的多语种识别

• 支持的采样率：任意

• 支持的语种：中文（包含中文普通话和各种方言）、英文、日语、韩语、德语、法语、俄语

  支持的中文方言（单击查看详情）

  上海话、吴语、闽南语、东北话、甘肃话、贵州话、河南话、湖北话、湖南话、江西话、宁夏话、山西话、陕西话、山东话、四川话、天津话、云南话、粤语

• 核心能力：

  • 支持标点符号预测

  • 支持逆文本正则化（ITN）

• 特色功能：

  • 指定语种：通过language_hints参数能够指定待识别语种，提升识别效果

  • 支持定制热词

paraformer-8k-v2

推荐使用。Paraformer最新中文语音识别模型，模型结构升级，具有更好的识别效果。

• 适用场景：电话客服、语音信箱等场景的中文识别

• 支持的采样率：8kHz

• 支持的语种：中文

• 核心能力：

  • 支持标点符号预测

  • 支持逆文本正则化（ITN）

• 特色功能：

  • 支持定制热词

paraformer-v1

Paraformer中英文语音识别模型。

• 适用场景：访谈、讲座等中英文混合场景

• 支持的采样率：任意

• 支持的语种：中文、英文

• 核心能力：

  • 支持标点符号预测

  • 支持逆文本正则化（ITN）

• 特色功能：

  • 支持定制热词（参见Paraformer语音识别热词定制与管理）

paraformer-8k-v1

Paraformer中文语音识别模型。

• 适用场景：电话客服、语音信箱等8kHz采样率音频处理

• 支持的采样率：8kHz

• 支持的语种：中文

• 核心能力：

  • 支持标点符号预测

  • 支持逆文本正则化（ITN）

• 特色功能：

  • 支持定制热词（参见Paraformer语音识别热词定制与管理）

paraformer-mtl-v1

Paraformer多语言语音识别模型。

• 适用场景：国际会议、访谈等多语种交替发言场景

• 支持的采样率：16kHz及以上

• 支持的语种：中文普通话、中文方言（粤语、吴语、闽南语、东北话、甘肃话、贵州话、河南话、湖北话、湖南话、宁夏话、山西话、陕西话、山东话、四川话、天津话）、英语、日语、韩语、西班牙语、印尼语、法语、德语、意大利语、马来语

• 核心能力：

  • 支持标点符号预测

  • 支持逆文本正则化（ITN）

• 特色功能：

  • 支持定制热词（参见Paraformer语音识别热词定制与管理）

接口描述

提交语音识别任务。

URL

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

请求方法

POST

请求头

Authorization: Bearer {api-key} // 需替换为您自己的API Key
Content-Type: application/json
X-DashScope-Async: enable

消息体

包含所有请求参数的消息体如下，对于可选字段，在实际业务中可根据需求省略：

{
    "model":"paraformer-v2", //模型名，必选
    "input":{
        "file_urls":[
            "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_female2.wav",
            "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_male2.wav"
        ] //待识别文件，必选
    },
    "resources": [
        {
            "resource_id": "xxxxxxxxxxxx", //旧版热词ID，可选
            "resource_type": "asr_phrase"  //固定值“asr_phrase”，和resource_id搭配使用
        }
    ],
    "parameters":{
        "vocabulary_id":"vocab-Xxxx", //最新热词ID，可选
        "channel_id":[
            0
        ], //音轨索引，可选
        "disfluency_removal_enabled":false, //过滤语气词开关，可选
        "timestamp_alignment_enabled": false, //是否启用时间戳校准功能，可选
        "special_word_filter": "xxx", //敏感词，可选
        "language_hints":[
            "zh",
            "en"
        ],
        "diarization_enabled":false, //自动说话人分离，可选
        "speaker_count": 2 //说话人数量参考，可选
    }
}

参数

类型

默认值

是否必须

说明

model

string

-

是

指定用于音视频文件转写的Paraformer模型名。参见模型列表。

file_urls

array[string]

-

是

音视频文件转写的URL列表，支持HTTP / HTTPS协议，单次请求最多支持100个URL。

vocabulary_id

string

-

否

最新热词ID，支持最新v2系列模型并配置语种信息，此次语音识别中生效此热词ID对应的热词信息。默认不启用。使用方法请参考定制热词。

resource_id

string

-

否

热词ID，此次语音识别中生效此热词ID对应的热词信息。默认不启用。

注：resource_id对应SDK中的phrase_id字段，phrase_id为v1版本模型热词方案，不支持v2及后续系列模型。支持该方式热词的模型列表请参考Paraformer语音识别热词定制与管理。

resource_type

string

-

否

固定字符串"asr_phrase"，和"resource_id"需同时使用。

channel_id

array[integer]

[0]

否

指定在多音轨文件中需要进行语音识别的音轨索引，以List的形式给出，例如[0]表示仅识别第一条音轨，[0, 1]表示同时识别前两条音轨。

disfluency_removal_enabled

boolean

false

否

过滤语气词，默认关闭。

timestamp_alignment_enabled

boolean

false

否

是否启用时间戳校准功能，默认关闭。

special_word_filter

string

-

否

敏感词过滤功能，支持开启或关闭，支持自定义敏感词。该参数可实现：

不处理（默认，即展示原文）、过滤、替换为*。

language_hints

array[string]

["zh", "en"]

否

diarization_enabled

boolean

false

否

有关speaker_id的示例，请参见识别结果说明。

speaker_count

integer

-

否

说话人数量参考值。取值范围为2至100的整数（包含2和100）。

开启说话人分离功能后（diarization_enabled设置为true）生效。

默认自动判断说话人数量，如果配置此项，只能辅助算法尽量输出指定人数，无法保证一定会输出此人数。

参数

类型

说明

task_status

string

任务状态。

task_id

string

任务ID。

接口描述

查询语音识别任务执行情况和结果。

URL

https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

请求方法

POST

请求头

Authorization: Bearer {api-key} // 需替换为您自己的API Key

消息体

无。

参数

类型

默认值

是否必须

说明

task_id

string

-

是

查询任务需指定其ID，该ID为提交任务接口被调用后返回的task_id。

参数

类型

说明

task_id

string

被查询任务的ID。

task_status

string

被查询任务的状态。

subtask_status

string

子任务状态。

file_url

string

文件转写任务中所处理的文件URL。

transcription_url

string

获取识别结果对应的链接。该链接有效期为24小时，超时后无法查询任务或通过先前查询结果中的URL下载结果。

识别结果保存为JSON文件，您可以通过上述链接下载该文件或直接通过HTTP请求读取该文件中的内容。

JSON数据中各字段含义请参见识别结果说明。

错误码（code）

原因

解决方案

SUCCESS_WITH_NO_VALID_FRAGMENT

识别结果查询接口调用成功，但是VAD模块未检测到有效语音。

此种情况下可检查：

录音文件是否包含有效语音，如果都是无效语音，例如纯静音。上述情况下没有识别结果是正常现象。

ASR_RESPONSE_HAVE_NO_WORDS

识别结果查询接口调用成功，但是最终识别结果为空。

此种情况下可检查：

录音文件是否包含有效语音，或有效语音是否都是语气词且开启了顺滑参数disfluency_removal_enabled，导致语气词被过滤。

FILE_DOWNLOAD_FAILED

文件下载失败。

检查录音文件路径是否正确，以及是否可以通过外网访问和下载。

FILE_CHECK_FAILED

文件格式错误。

检查录音文件是否是单轨/双轨的WAV格式或MP3格式。

FILE_TOO_LARGE

文件过大。

检查录音文件大小是否超过2GB，超过则需您对录音文件分段。

FILE_NORMALIZE_FAILED

文件归一化失败。

检查录音文件是否有损坏，是否可以正常播放。

FILE_PARSE_FAILED

文件解析失败。

检查录音文件是否有损坏，是否可以正常播放。

MKV_PARSE_FAILED

MKV解析失败。

检查录音文件是否损坏，是否可以正常播放。

FILE_TRANS_TASK_EXPIRED

录音文件识别任务过期。

TaskId不存在，或者已过期。

REQUEST_INVALID_FILE_URL_VALUE

请求file_link参数非法。

确认file_url参数格式是否正确。

CONTENT_LENGTH_CHECK_FAILED

content-length 检查失败。

检查下载文件时，HTTP response中的content-length与文件实际大小是否一致。

FILE_404_NOT_FOUND

需要下载的文件不存在。

检查需要下载的文件是否存在。

FILE_403_FORBIDDEN

没有权限下载需要的文件。

检查是否有权限下载录音文件。

FILE_SERVER_ERROR

请求的文件所在的服务不可用。

检查请求的文件所在的服务是否可用。

AUDIO_DURATION_TOO_LONG

请求的文件时长超过12小时。

建议将音频进行切分，分多次提交识别任务。

ffmpeg -i input_audio.wav -ss 00:10:00 -to 5:10:00 -c copy output_audio.wav

DECODER_ERROR

检测音频文件信息失败。

确认文件下载链接中文件为支持的音频格式。

INTERNAL_ERROR

受机器负载、网络等因素导致的异常，通常为偶发出现。

一般重试调用即可恢复，如无法恢复，请联系技术支持人员。