Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 3.76 KB

README.md

File metadata and controls

111 lines (83 loc) · 3.76 KB

FFASR 接入指南

  • API: wss://asr.yuzhix.com/api/DecodeAudio?[parameters]

业务流程

  1. 客户端向服务器发送带有相关验证参数的websocket请求
  2. 服务器通过验证后，保持当前连接并自行判断音频结束进行识别
  3. 服务器通过原连接返回识别结果

报文格式

为确保数据安全，服务器只接受wss请求(Websocket Secure)。请求内容包含：

  • 请求参数 （用于进行身份验证，参见 身份验证机制 ）  - 报头 （用于告知asr音频相关信息， 参见 报头信息 ）  - 二进制的报文Body（ pcm格式音频，单通道音频, 16bit, 采样率16KHz, 单次报文长度建议为6400字节 ）

报头信息

报头信息仅需包含以下字段:

  •  online true/false 是否使用在线识别模式

在线识别 指前端通过拾音设备将单通道音频实时传给ffasr进行识别； 离线识别 指发送音频文件给ffasr进行识别，离线识别将不会有VAD(Voice Activity Detection)的判断。 （为保持长连接，进行离线音频测试时，发送文件完毕后需要增加发送一段TextMessage,具体可参考离线 demo）

身份认证机制

调用FFASR前需经过严格的鉴权验证。在处理用户请求前，服务端会通过请求参数进行签名校验以确保用户请求在传输过程中没有被恶意篡改或替换。客户端将下列字段以请求参数的形式传递给服务器以便完成身份信息校验：

名称 类型 说明
access_id string 客户id
nonce_str string 32位随机字符串
request_id string 识别请求id
sign string 连接参数的md5签名，相见 签名生成规则
签名生成规则：
  1. 客户将拥有自己的access_key，按下列方式生成签名：
  2. 将参数名ASCII码从小到大排序（字典序，区分大小写），使用url键值对格式,即:
    key0=value0&key1=value1&key2=value2&…
  1. 将access_key拼接至末尾： (假设access_key为123456)
        StringA="access_id=xxxxxx&nonce_str=yyyyyy&request_id=000000"  //参数名按ascii排序
        SignTempString = StringA + "&key=123456"
  1. 生成md5签名，即:
        sign=md5hash(SignTempString)
  1. 完整url示例：
wss://asr.yuzhix.com/api/DecodeAudio?access_id=xxxxx&nonce_str=yyyyy&request_id=0000&sign=md5hash_value

识别结果返回

请求结果以application/json格式在Response Body中返回；其他的HTTP错误码表示识别失败，具体的错误消息以application/json格式在Response Body中返回。

识别成功

名称 类型 说明
request_id string 识别请求id
result string 识别结果
  • Sample
{
    "request_id":"request_sample_0",
    "result":"测试音频啊哈哈"
}

识别失败

名称 类型 说明
request_id string 识别请求id
error_code string 错误代码
error_msg string 具体错误信息
  • Sample
{
   "request_id":"request_sample_0",
   "error_code"：1,
   "error_message":"无法识别有效音频"
}
  • 错误代码定义
错误码 语义
1 无法识别有效音频
2 身份验证失败
3 调用过于频繁
4 服务器忙
5 内部错误

注意事项

  1. FFASR现处于邀请测试阶段，希望申请测试的用户请发邮件至 [email protected]
  2. 用户不宜过于频繁调用接口，现阶段支持单个access_id的调用频率不得高于1次/秒

附件

  • wav2pcm.sh 此脚本可指定目录内的所有wav文件转换成目标目录下的pcm文件