1. 接口说明
语音评测接口通过智能语音技术自动对发音水平进行评价,包括:中文普通话发音水平自动评测技术、英文发音水平自动评测技术。请注意不支持自由说模式,需指定试题文本。试题格式,请点击 试题格式 查看详情。
语音评测有以下高阶功能,需开通相应的高阶权限后才可以使用。开通请到控制台-我的应用-语音评测处点击“申请购买”,与商务人员取得联系。
权限 | 开通前 | 开通后 | 使用方法 |
---|---|---|---|
篇章 | 仅可使用字词句题型 | 除字词句外,还可使用篇章题型 | category=read_chapter |
全维度 | 仅有总分或英文的音节得分 | 可获得更多评分维度详情请点击 全维度说明 查看 | extra_ability=multi_dimension |
该接口是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,即将音频一次性发送至云端,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。
2. 接口Demo
示例demo 请点击 这里 下载。目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
3. 接口要求
集成语音评测API时,需按照以下要求。
内容 | 说明 |
---|---|
请求协议 | http(s) |
请求地址 | http[s]://api.xfyun.cn/v1/service/v1/ise |
请求方式 | POST |
接口鉴权 | 签名机制,见接口描述-授权认证 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器,请在后端调用接口 |
音频属性 | 采样率16k、位长16bit、单声道 |
音频格式 | PCM、WAV、SPEEX,样例音频可点击 这里 下载 |
音频大小 | 音频数据按要求编码(base64编码后进行urlencode)后大小不超过5M(WAV格式约2分钟) |
语言种类 | 中文普通话、英文 |
试题类型 | 字、词、句、篇章,试题格式请点击 试题格式 查看详情 |
4. 接口调用流程
采用通用的接口调用流程,详细请参照 接口描述 。
接口地址示例
POST http[s]://api.xfyun.cn/v1/service/v1/ise HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
5. 接口请求参数
5.1. Header参数
在 Http Request Header 中配置授权认证参数,见【接口描述-授权认证】。其中 X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串,原始 JSON 串各字段说明如下:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
aue | string | 是 | 音频编码raw(未压缩的 pcm 格式音频)speex | raw |
speexsize | string | 否 | 标准speex解码帧的大小当aue=speex时,若传此参数,表明音频格式为标准speex;若不传,表明音频格式为讯飞定制speex注:_ 讯飞定制SPEEX编码工具请参考这里 speex编码 。 | 70 |
result_level | string | 否 | 评测结果等级entirety(默认值)simple | entirety |
language | string | 是 | 评测语种en_us(英语)zh_cn(汉语) | zh_cn |
category | string | 是 | 评测题型read_syllable(单字朗读,汉语专有)read_word(词语朗读)read_sentence(句子朗读)read_chapter(篇章朗读,需开通篇章权限) | read_sentence |
extra_ability | string | 否 | 拓展能力multi_dimension(全维度,需开通 全维度权限 ) | multi_dimension |
X-Param生成示例:
原始JSON串:
{
"aue": "raw",
"result_level": "simple",
"language": "en_us",
"category": "read_sentence"
}
BASE64编码(即X-Param):
eyJhdWUiOiAicmF3IiwicmVzdWx0X2xldmVsIjogInNpbXBsZSIsImxhbmd1YWdlIjogImVuX3VzIiwiY2F0ZWdvcnkiOiAicmVhZF9zZW50ZW5jZSJ9
5.2. Body参数
在 Http Request Body 中配置以下参数:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
audio | string | 是 | 音频数据base64 编码后进行 urlencode要求 base64 编码和 urlencode 后大小不超过5M | exSI6ICJl…… |
text | string | 是 | 评测文本(使用 utf-8 编码)需urlencode要求长度中文不超过180字符、英文不超过300字符,其格式详见 试题格式 | 天气很好。 |
注: 音频数据 base64 编码后大小会增加约1/3。
6. 接口返回参数
返回值为 json 串,各字段如下:
参数 | 类型 | 说明 |
---|---|---|
code | string | 结果码(具体见错误码) |
data | string | 语音评测结果 |
desc | string | 描述 |
sid | string | 会话ID |
其中 sid 字段主要用于追查问题,如果出现问题,可以提供 sid 给讯飞技术人员帮助确认问题。data 即评测结果,其格式及字段含义详见 语音评测结果说明 文档。
示例如下:
失败:
{
"code": "10106",
"desc": "invalid parameter|invalid X-Appid",
"data": "",
"sid": "wse0000bb3f@ch3d5c059d83b3477200"
}
成功:
{
"data":{
"read_word":{
"lan":"en",
"type":"study",
"version":"6.5.0.1011",
"rec_paper":{
"read_word":{
"except_info":"28680",
"is_rejected":"false",
"total_score":"64.725080",
"sentence":[
{
"beg_pos":"0",
"content":"apple",
"end_pos":"129",
"word":{
"beg_pos":"79",
"content":"apple",
"end_pos":"129",
"total_score":"94.963020"
}
},
{
"beg_pos":"129",
"content":"banana",
"end_pos":"163",
"word":{
"beg_pos":"163",
"content":"banana",
"end_pos":"163",
"total_score":"0.000000"
}
},
{
"beg_pos":"163",
"content":"orange",
"end_pos":"226",
"word":{
"beg_pos":"163",
"content":"orange",
"end_pos":"226",
"total_score":"99.212200"
}
},
{
"content":"banana",
"end_pos":"359",
"word":{
"beg_pos":"265",
"content":"banana",
"end_pos":"318"
},
"beg_pos":"226"
}
],
"beg_pos":"0",
"content":"apple banana orange",
"end_pos":"359"
}
}
}
},
"code":"0",
"desc":"success",
"sid":"wse00000001@ll36940e324c59000100"
}
7. 试题格式
试题格式示例及注意事项如下:
题型 | 中文示例拼音标注 | 中文示例纯文本 | 英文示例 |
---|---|---|---|
字 | <customizer:interphonic>丰feng1呈cheng2政zheng4 | 丰,呈,政 | - |
词 | <customizer:interphonic>宁可ning4|ke3非难fei1|nan4灾难zai1|nan4 | 宁可,非难,灾难 | [word]applebananaorange |
句 | <customizer:interphonic>这是中文语句评测示例。zhe4|shi4|zhong1|wen2|yu3|ju4|ping2|ce4|shi4|li4 | 这是中文语句评测示例。 | This is an example of sentence test. |
篇章 | <customizer:interphonic>大家好。这是中文篇章评测示例。da4|jia1|hao3|zhe4|shi4|zhong1|wen2|pian1|zhang1|ping2|ce4|shi4|li4 | 大家好。这是中文篇章评测示例。 | Hello, everybody. This is an example of sentence test. |
1. 中英文试题长度要求中文不超过180字符、英文不超过300字符,超出会报错10109(text is too long)。如需解除(建议中英文字词不要超过400,中文句篇不要超过2000,英文句篇不要超过1024),请到控制台-我的应用-语音评测处点击“申请购买”,与商务人员取得联系。2. 中文拼音标注试卷1)以<customizer:interphonic>开头,单独一行。2)字单独一行,紧接着的一行为字的拼音3)拼音后加数字代表声调,1-4分别代表一到四声,5表示轻声4)多个拼音之间用 “|” 隔开3. 字词纯文本试卷多个字或者词之间用逗号隔开4. 英文词一个单词占一行,首行用[word]标记,单个单词长度应不大于32字节。5. 中英文篇章(需开通篇章权限)每句不能超过100个字节。请不要遗漏标点符号,且句子之间需要有标点符号,如:分句,逗号,问号,句号,感叹号等。
8. 全维度说明
开通方法:请到控制台-我的应用-语音评测处点击“申请购买”,与商务人员取得联系。使用方法:extra_ability = multi_dimension使用说明:开通全维度权限前后可获得的结果对比如下,红色为开通全维度以后才会返回的评分维度,返回结果各字段的详细说明请点击 语音评测结果说明 查看。
题型 | 中文默认 | 中文开通全维度 | 英文默认 | 英文开通全维度 |
---|---|---|---|---|
字 | 总分(total_score) | 总分(total_score)声韵分(phone_score)调型分(tone_score) | - | - |
词 | 总分(total_score) | 总分(total_score)声韵分(phone_score)调型分(tone_score) | 总分(total_score)音节得分(syll_score) | 总分(total_score)音节得分(syll_score)准确度分(accuracy_score) |
句 | 总分(total_score) | 总分(total_score)完整度分(integrity_score)流畅度分(fluency_score)声韵分(phone_score)调型分(tone_score) | 总分(total_score)音节得分(syll_score) | 总分(total_score)音节得分(syll_score)完整度分(integrity_score)流畅度分(fluency_score)准确度分(accuracy_score) |
篇章 | 总分(total_score) | 总分(total_score)完整度分(integrity_score)流畅度分(fluency_score)声韵分(phone_score)调型分(tone_score) | 总分(total_score)音节得分(syll_score) | 总分(total_score)音节得分(syll_score)完整度分(integrity_score)流畅度分(fluency_score)准确度分(accuracy_score) |
注:中文声韵分:指声母和韵母正确率的得分。中文调型分:指声调正确率的得分。
9. 调用示例
注: 运行demo返回的结果中的 data 即评测结果,其格式及字段含义详见 语音评测结果说明
10. 试题及音频样例
注: 音频文件格式转换工具以及讯飞定制SPEEX编码工具请参考这里 音频格式说明
Copyright © iflytek.com 2018 all right reserved,powered by Gitbook该文件修订时间:2019-05-07 07:12:51