单字
该文档是开发者在产品功能集成阶段 使用的中文单字，词语，成语跟读题型的技术说明文档
题型描述
支持字，词语，成语跟读评测，支持多音字。
反馈总分，每个字的得分，每个拼音的声韵母得分，声调得分，以及用户音频地址。
测评请求参数
字段 | 类型 | 可选 | 说明 |
coreType | String | 必选 | cn.word.score表示中文单字评测 |
refText | String | 必选 | 评分参考文本: 数(shu3) |
rank | int | 可选 | 评分分制，这个值可以任意设置,最终会根据与100的比例重新计算 |
precision | double | 可选 | 设置打分精度，0.1、0.5或者1，默认为1 |
attachAudioUrl | int | 可选 | 评测结果中是否返回音频url |
outputPhones | int | 可选 | 输出结果包含字的声、韵母得分信息 可设置为1或2，默认值为1，开启此功能 (1：返回的声韵母字符需要经过映射才能与实际对应； 2：返回实际的声韵母信息。 列如：当outputPhones为1时，{"chn_char":"友","char":"you","phn":0,"overall":0,"pron":0,"tone":3,"tonescore":0,"confidence":[0,0,0,0,0],"score":0,"dp_type":1,"start":0,"end":0,"dur":0,"fluency":0,"phone":[{"char":"ii","score":0},{"char":"iu","score":0}]}, 当outputPhones为2时，{"chn_char":"友","char":"you","phn":0,"overall":0,"pron":0,"tone":3,"tonescore":0,"confidence":[0,0,0,0,0],"score":0,"dp_type":1,"start":0,"end":0,"dur":0,"fluency":0,"phone":[{"char":"y","score":0},{"char":"ou","score":0}]} ) |
symbol | int | 可选 | 如果单字前有多个连续标点，只显示第一个标点；如果单字结尾有多个连续标点，只输出靠近结尾单字最近的三个标点； 只有设置0或1，默认值为0，不开启此功能 |
typeThres | int | 可选 | 打分松紧度（分数越高影响越小）：1表示严格，2表示宽松，3表示非常严格，4非常宽松，0为默认值（不启用此功能） |
use_cws | int | 可选 | 启用分词功能（可更好支持多音字及数字）; 只有设置0或1，0为默认值（不启用此功能） |
参数示例
{
"coreType": "cn.word.score",
"refText": "数（shu3）",
"rank": 100,
"precision": 1,
"outputPhones":1,
"attachAudioUrl":1
}
返回结果示例
{
"tokenId": "6124bfae88bf5b0000010001", //用户请求的唯一标识
"applicationId": "a148", //授权的Appkey
"dtLastResponse": "2021-08-24 17:45:20:300",
"audioUrl": "http:\/\/files.cloud.ssapi.cn:8080\/a148\/11ec01828d53e9a1808aa148v2618ae7", //用户音频地址
"connect": { //内部参数节点不需要关注
"param": {
"app": {
"timestamp": "1629798318",
"applicationId": "a148",
"sig": "bbce9709c2315ba2feddef73de75f4aa2f1b726a"
},
"sdk": {
"os": "6.2(9200)1",
"product": "",
"source": 7,
"protocol": 1,
"os_version": "6.2(9200)",
"arch": "586",
"version": 16778752
}
},
"cmd": "connect"
},
"params": {
"app": { //内部参数节点不需要关注
"timestamp": "1629798318",
"userId": "ssound_text",
"sig": "bbce9709c2315ba2feddef73de75f4aa2f1b726a",
"connect_id": "6124bfae88bf5b0000030002",
"clientId": "",
"applicationId": "a148"
},
"audio": { //音频参数节点
"sampleBytes": 2, //每采样字节数，支持单字节和双字节
"audioType": "ogg", //音频格式类型
"sampleRate": 16000, //采样率
"channel": 1 //单声道，评测仅支持单声道
},
"request": { //请求评分，客户端传入参数
"request_id": "6124bfae88bf5b0000020001",
"tokenId": "6124bfae88bf5b0000010001",
"rank": 100,
"precision": 1,
"coreType": "cn.word.score", //题型类型
"refText": "数(shu3)" //评测文本
"rank": 100,
"precision": 1,
"outputPhones":1,
"attachAudioUrl":1
}
},
"recordId": "11ec04bffc5c410d8ceca148c2619a1a",
"refText": "数(shu3)",
"result": {
"overall": 67, //总分
"wavetime": 1990, //音频时长，单位ms
"precision": 1, //评测请求时设置的打分精度，只支持0.1、0.5或者1，默认值为1（如果设置的值不是0.1或0.5则按1处理）
"forceout": 0,
"phn": 85, //不带声调的发音分
"res": "chn.wrd.online.1.0", //评测使用的资源名称
"details": [ //单个字的使用情况
{
"dp_type": 2,0：表示正常发音，一般不显示 1：表示漏读此单词 2：表示重复读 3：表示这个字不参与评分，起到注释作用
"pron": 67, //发音得分
"dur": 300, //单字发音时间
"chn_char": "数", //评测的 中文单字
"phn": 85,
"confidence": [ //置信度，里面的值依次表示这个字对应的声调为：轻声、一声、二声、三声、四声 的概率。
0,
3,
97,
0,
0
],
"overall": 67, //总分
"tone": 3, //单个拼音或声韵母声调,0~4分别对应轻声、一声、二声、三声、四声
"char": "shu", //单个拼音或声韵母
"score": 67,
"tonescore": 20, //单字的声调得分
"phone": [ //详细声韵母打分信息
{
"char": "sh", //声韵母
"score": 93, //声韵母得分
"end": 400,
"start": 260
},
{
"char": "u",
"score": 78,
"end": 410,
"start": 400
}
],
"end": 820,
"start": 520
}
],
"pretime": 6,
"info": {
"tipId": 0,
"clip": 0,
"snr": 31.557388,
"volume": 84
},
"rank": 100,
"delaytime": 49,
"systime": 2528,
"version": "0.0.80.2021.7.24.00:01:28",
"tone": 20,
"pron": 67
},
"eof": 1,
"cloud_platform": {
"origin_audio_length": 7807
}
}返回结果说明
键 | 类型 | 说明 | 使用建议 |
recordId | string | 音频文件的唯一标识 | 可供参考 |
tokenId | string | 用户请求的唯一标识 | 可供参考 |
applicationId | string | 授权的评测账号，即Appkey | 内部参数 |
dtLastResponse | string | 云端响应的时间点 | 内部参数 |
audioUrl | string | 用户音频下载地址： | |
eof | int | 内部参数 | |
refText | string | 传入的评测文本 | 可供参考 |
params | object | 回显客户端传入的评测请求参数 | |
- app | object | ||
- - applicationId | string | 授权的评测账号，即Appkey | |
- - userId | string | 自定义字符串，建议一个用户设置一个，方便定位问题 | |
- - timestamp | string | start时间 | |
- - sig | string | 校验码 | |
- request | object | ||
- - coreType | string | 使用题型 | |
- - tokenId | string | 用户请求唯一标识 | |
- - refText | string | 评分参考文本 | |
- audio | object | ||
- - sampleRate | int | 采样率 | |
- - channel | int | 声道 | |
- - sampleBytes | int | 每采样字节数，支持单字节和双字节 | |
- - audioType | string | 音频格式 | |
result | object | 评测结果 | |
- version | string | 引擎的版本，包含发布时间 | 内部参数 |
- rank | int | 评分分制 | 内部参数 |
- res | string | 评测本题型时，使用的资源名称 | 内部参数 |
- forceout | int | 内部参数 | |
- pretime | int | 云端调用Start接口本身耗时，单位ms | 内部参数 |
- delaytime | int | 云端从feed音频结束到获取结果的耗时，单位ms | 内部参数 |
- systime | int | 评测整个过程的总耗时，单位ms | |
- wavetime | int | 音频时长，单位ms | 可供参考 |
- overall | float | 总分 | 建议字段 |
- tone | float | 句子升降调得分(0-100) | |
- pron | float | 单字发音分 | |
- phn | float | 音素发音得分 | |
- precision | float | 评分精度 | |
- details | array | ||
- - pron | int | 带声调的发音分 | 可供参考 |
- - confidence | array | 置信度 | 里面的值依次表示这个字对应的声调为：轻声、一声、二声、三声、四声 的概率。 |
- - dur | int | 单字在音频中的结束时间，单位为毫秒（ms） | |
- - chn_char | string | 单字 | |
- - phn | int | 不带声调的发音分 | |
- - overall | int | 单字总分 | |
- - tone | int | 单字对应的声调 | 0~4分别对应轻声、一声、二声、三声、四声 |
- - char | string | 单字对应的拼音 | |
- - tonescore | int | 单字的声调得分 | |
- - end | int | 单字发音时间,单位为毫秒（ms） | |
- - start | int | 单字在音频中的起始时间，单位为毫秒（ms） | |
- - dp_type | int | 表示增漏读 | 0：表示正常发音，一般不显示 1：表示漏读此单词 2：表示重复读 3：表示这个字不参与评分，起到注释作用 |
- - phone | array | 详细声韵母打分信息 | |
- - - char | string | 声韵母 | 可供参考 |
- - - score | int | 声韵母得分 | 可供参考 |
- info | object | ||
- - snr | float | 信噪比 | 可供参考 |
- - clip | float | 内部参数 | |
- - volume | int | 录音音量 | 可供参考 |
- - tipId | int | 音频质量 | 建议字段 |
返回结果说明
维度 | 说明 | 详细 |
overall | 单字总分 | 对单字的整体评分 |
pron | 发音得分 | |
details.score | 单字得分 | 具体的某个单字评分。获取之前要进行非空判断 |
details.phn | 不带声调的发音分 | |
details.phone.score | 声韵母得分 | 对单字对应的声韵母评分 |
评测失败时的返回结果
如果返回的评测结果中result结构为空，说明评测失败。
通过返回结果可以获取 errId 和 error，产品端可以根据相应错误码做续判断和处理。
错误码
错误码参考：评测错误码