1.1.1. 开放平台接口定义文档(http版) - 语音识别

Table of Contents

• 前言
• 文档版本
• 服务地址
• 协议地址
• 协议概述
• 认证
  • 说明
• 语音识别
  • 请求
  • 响应
• 示例

1.1.2. 前言

此文档正在开发中，后续可能会有变动，请参照使用。

1.1.3. 文档版本

0.1

1.1.4. 服务地址

https://apigwws.open.rokid.com/api/v2/asr/uid 其中 uid 是客户端指定的代表此次语音交互请求的唯一id

1.1.5. 协议地址

• 外部 github

1.1.6. 协议概述

此文档用于定义开放平台上云端应用接口开发协议，协议遵循 http 协议。

认证

• 详见 认证设备

语音识别

请求

1. 需要带包含认证信息的 Authorization 的 http header
2. 使用 HTTP POST 方式
3. 其中 Content-Type 为 multipart/form-data
4. 第一段 Content-Disposition: form-data; name="voice-config"，内容为 json 数据，格式如下：

1. 后续段的 Content-Disposition: form-data; name="xxx"，其中 name 可以任意，其Content-Type 应为 application/octet-stream，内容为语音内容
2. 语音段可以有多个，如将每 30ms 的语音组织成一段，云端会将所有段的数据组织到一起作识别

3. 一次完整的语音交互序列包含多个语音数据时，需要发送如下序列的多个 http post 请求：

   1. 第一个请求的 type 设置为 START，并设置好其它参数，此请求可带上语音数据
   2. 后面的多个请求设置 type 为 VOICE，并带上语音数据
   3. 最后一个请求设置 type 为 END 包表示交互结束，此请求可带上语音数据
   4. 以上请求需要使用相同的 url，即相同的 uid，id 为递增的数值
4. 一次完整的语音交互序列只包含一个语音数据时，只需发送一个 http post 请求，其中 type 设置为 ONESHOT，并带上语音数据

响应

1. 包含多个语音数据的语音交互时，仅当是最后一个请求即 type 为 END 的包有以上响应
2. 只包含一个语音数据的语音交互时，即 type 为 ONESHOT 的请求同样也有以上响应
3. 其余请求返回为空
4. 所有请求成功与否由 result 决定：SUCCESS 为成功，其余的为失败

result 取值

1.1.7. 示例

• 可直接使用 curl 命令构造请求：

curl -X POST \
    -H 'Authorization:key=xxx;device_type_id=xxx;device_id=xxx;time=xxx;sign=xxx;' \
    -F 'voice-config=@voice-config.json' \
    -F 'voice=@test.pcm' \
    https://apigwws.open.rokid.com/api/v2/asr/your-uid-fill-here

其中：

1. xxx 需要由实际值替代
2. voice-config.json内容为：

   {"id": 1,"type": "START","options": {"lang": "ZH","codec": "PCM","voiceTrigger": "若琪"}}
   

3. test.pcm 为16k 16位 单通道 pcm 格式的语音文件

4. 请求 http 内容：

POST /api/v2/asr/your-uid-fill-here HTTP/1.1
Host: apigwws.open.rokid.com
Accept: */*
Content-Length: 307
Content-Type: multipart/form-data; boundary=----------------------------77bb6bb36e97
Expect: 100-continue
User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.27.1 zlib/1.2.3 libidn/1.18 libssh2/1.4.2

------------------------------77bb6bb36e97
Content-Disposition: form-data; name="voice-config"

{}
------------------------------77bb6bb36e97
Content-Disposition: form-data; name="voice"; filename="test.pcm"
Content-Type: application/octet-stream

语音的二进制数据

------------------------------77bb6bb36e97--

• 返回 http 内容

HTTP/1.1 200 OK
Server: nginx/1.12.0
Date: Mon, 22 Oct 2018 08:56:56 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 85
Connection: keep-alive

{id":12345,"type":"FINISH","result":"SUCCESS","asr":"","asrScores":[0,-6.496677,-0]}

• 一个完整语音交互的示例

=>  {"id": 1,"type": "START","options": {"lang": "ZH","codec": "PCM","voiceTrigger": "若琪"}}
无内容返回

=>  {"id": 2,"type": "VOICE"}
无内容返回

=>  {"id": 3,"type": "END"}

{"id":1540952889,"asr":"若琪今天天气怎么样若琪今天天气怎么样","asrScores":[-0.0019035237,1.8807955,-0.93645704],"result":"SUCCESS","type":"FINISH"}