请求头#
X-App-Keystring可选appKey,签名鉴权时必填,token 鉴权时不带
X-Timestampstring可选签名鉴权时必填,当前 Unix 时间戳,单位为秒,与服务端相差不超过 300 秒
X-Noncestring可选随机串,服务端 300 秒内去重防重放,建议每次都带
X-Signaturestring可选签名鉴权时必填,被签名参数为 config 段的 JSON 原文,规则见签名与鉴权
Authorizationstring可选token 鉴权时必填,Bearer <jwt>,代替以上四个请求头
Idempotency-Keystring可选幂等键,1 到 200 个可见 ASCII 字符,也认 X-Idempotency-Key
请求体#
POST /api/v1/evaluate,Content-Type: multipart/form-data。
audio文件wav,mp3,m4a,webm,ogg 等常见格式,建议 16 kHz,16 位,单声道
image文件可选只在 coreType 为 open,taskType 为 picture 的看图说话时上传
config文本段,Content-Type: application/json评测配置,字段见下表。缺少 application/json 类型时服务端回 415
coreTypestring必填word,sentence,passage,connected,open,alpha,pinyin
referenceTextstring必填参考文本,open 时为题目,最长 1000 字
languagestring可选en-US 默认,en-GB,zh-CN。中文评测要显式传 zh-CN
includeReportbool可选生成 AI 报告,report 另含整体点评 summary 与改进建议 suggestions,默认 false
includeStandardAudiobool可选返回标准示范音地址,默认 false
includeAsrTextbool可选返回识别文本,默认 false
slackdouble可选松紧度,取值 -1 到 1,默认 0
scaleint可选分制,取值 1 到 100,默认 100
precisiondouble可选精度,取值大于 0 到 1,默认 1
agegroupint可选1 学前,2 小学,3 中学及以上,默认 3
toneWeightdouble可选保留参数,取值 0 到 1,不改变总分
refPinyinstring可选拼音,多音字与 pinyin 题使用,例如 chong2 qing4
phonemeOutputbool可选音素级输出
taskTypestring可选open 题型:picture,situational,free
paragraphNeedWordScoreint可选passage 是否返回逐字详分,1 或 0
返回#
成功时直接返回结果对象,不包信封:
{
"recordId": "eval_xxx", "eof": 1,
"result": {"overall": 85, "pronunciation": 88, "tone": 78, "fluency": 90, "rhythm": 82,
"integrity": 100, "speed": 135, "rear_tone": "fall", "duration": "4.10", "warning": [],
"words": [{"word": "北", "pinyin": "bei", "tone": "tone3",
"scores": {"overall": 100, "pronunciation": 100, "tone": 100},
"span": {"start": 120, "end": 280},
"phonemes": [{"phoneme": "B", "pronunciation": 100, "span": {"start": 120, "end": 150}}]}],
"sentences": [{"sentence": "北京你好", "index": 0, "scores": {"overall": 85}}]},
"report": {"summary": "...", "dimensions": {}, "suggestions": ["..."]},
"asrText": {"text": "北京你好", "alignment": [{"char": "北", "read_status": "correct"}]},
"standardAudio": {"url": "/audio/standard/xxx.wav", "format": "wav", "duration": "3.50"},
"warnings": [1002]
}时间单位为 10 毫秒。字段 read_status 取值 correct,mispronounced,skipped,inserted。各评测模式的取分字段见评测结果字段,报告结构化字段沿用 1.x 契约第 7 节,含 dimensionScores,dimensionEvidence,asrArbitration,rubricBackfilled,开放题另有 warning,openTaskAudit,rubricVersion。
Idempotency-Replayedstring可选值为 true 表示这是同一幂等键首次结果的重放,不再计费
状态码#
| 状态 | 错误码 | 原因 |
|---|---|---|
| 200 | 无 | 评测完成,返回结果对象 |
| 400 | 40001,1004,1005,1012,1013,1310,2012 | 参数校验失败,例如音频短于 1 秒,pinyin 题缺 refPinyin。用户或账户被禁用,锁定,冻结,余额不足,API Key 配额超限同样回 400 |
| 401 | 40100,2001 到 2011 | 未认证,签名错误,token 或 API Key 无效 |
| 403 | 40300 | 无权限,例如 API Key 未授权该 coreType |
| 409 | 40901,40902,40903 | 同一幂等键处理中,额度不足,幂等键用于不同请求 |
| 415 | 无 | config 段缺少 Content-Type: application/json |
| 429 | 42900,42901,42902,42903,3001 到 3003 | 限流,并发超限,试用层 AI 报告或沙箱当日次数用尽,带 Retry-After |
| 500 | 50000 | 服务器内部错误,可重试 |
| 502 | 50200 | 上游评测服务暂不可用,可重试 |