接口说明

功能简介

NUI SDK提供更小的工具包和更完善的状态管理。为满足不同用户需求，NUI SDK既能提供全链路的语音能力，同时可做原子能力SDK进行使用，并保持接口的统一。

使用须知

• 输入格式：PCM编码、16bit采样位数、单声道（mono）。

• 音频采样率：8000Hz/16000Hz。

• 时长限制：语音数据时长不能超过60s。

• 设置返回结果：是否返回中间识别结果、在后处理中添加标点、将中文数字转为阿拉伯数字输出。

• 设置多语言识别：在管控台编辑项目中进行模型选择，详情请参见模型选择。

服务地址

交互流程

下图展示iOS SDK、Android SDK的交互流程。

1. 鉴权和初始化

客户端在与服务端建立WebSocket连接的时候，使用Token进行鉴权。关于Token获取请参见获取Token。

初始化参数如下。

2. 开始识别

客户端发起一句话识别请求前需要进行参数设置，各参数由SDK中setParams接口以JSON格式设置，该参数只需设置一次。各参数含义如下。

参数nls_config配置如下。

3. 发送数据

客户端循环发送语音数据，持续接收识别结果：

• 若enable_intermediate_result设置为true，SDK会持续多次通过onNuiEventCallback回调上报EVENT_ASR_PARTIAL_RESULT事件，即中间识别结果：

  {
      "header": {
          "namespace": "SpeechRecognizer",
          "name": "RecognitionResultChanged",
          "status": 20000000,
          "message_id": "e06d2b5d50ca40d5a50d4215c7c8****",
          "task_id": "4c3502c7a5ce4ac3bdc488749ce4****",
          "status_text": "Gateway:SUCCESS:Success."
      },
      "payload": {
          "result": "北京的天气"
      }
  }

  header对象参数说明：

  参数	类型	说明
  namespace	String	消息所属的命名空间。
  name	String	消息名称。RecognitionResultChanged表示获取到中间识别结果。
  status	Integer	状态码。表示请求是否成功，见服务状态码。
  message_id	String	本次消息的ID，由SDK自动生成。
  task_id	String	任务全局唯一ID，请记录该值，便于排查问题。
  status_text	String	状态消息。

  payload对象参数说明：

  参数	类型	说明
  result	String	中间识别结果。

  说明

  最后一次获取的中间识别结果与最终的识别的结果不一定相同，请以EVENT_ASR_RESULT事件的结果为最终识别结果。

• 若enable_intermediate_result设置为false，此步服务端不返回任何消息。

4. 结束识别

客户端发送停止一句话识别请求，通知服务端语音数据发送结束，停止语音识别，服务端返回最终识别结果：

{
    "header": {
        "namespace": "SpeechRecognizer",
        "name": "RecognitionCompleted",
        "status": 20000000,
        "message_id": "10490c992aef44eaa4246614838f****",
        "task_id": "4c3502c7a5ce4ac3bdc488749ce4****",
        "status_text": "Gateway:SUCCESS:Success."
    },
    "payload": {
        "result": "北京的天气。"
    }
}

header对象参数说明：

payload对象参数说明：

错误码

一句话识别的错误码信息，请参见错误码。