小雅OS开放平台文档

小雅OS开放平台文档

  • 快速入门
  • 客户端接入
  • 服务端接入

›概述

概述

  • 服务端接入
  • 数据回传

API

  • WebSocket 协议定义
  • HTTP 协议定义
  • 调用样例
  • API 列表
  • 技能内调用
  • 错误码

服务端接入

服务端接入提供了一套面向开发者服务器接入的API。

注意:本对接模式仅适用于具备一定自然语言处理能力的客户对接,在对接前,请通过商务联系后获得接口权限。

和客户端接入不同,服务端接入时设备端并不直接和小雅OS进行连接。

您的设备将和您的服务器进行交互,您的服务器在合适的时机将语音或文字转发到小雅OS进行处理。

交互逻辑请参考下图:

客户端与服务端交互逻辑

服务端API目前开放以下能力:

  • 用户管理
  • 数据上报
  • 语音自然语言理解(NLU)
  • TTS语音合成
  • 文字自然语言理解(NLU)
  • 技能相关接口调用

注意:TTS语音合成次数受自然语言理解次数限制,大量的TTS请求与NLU返回的response.outputSpeech字段不符,则会被限制接口使用。

接入流程

请参考接入流程,但请注意以下几个问题:

  1. 开发者认证时,请选择企业开发者。
  2. API支持HTTP协议和WebSocket协议两部分,要开发完整的交互流程,两个协议需要同时接入。
  3. 请参考账号体系,了解如何与小雅OS打通账号,并规划您的用户账号与小雅OS账号的关系。如果希望打通喜马拉雅账号登录,还要按照打通喜马拉雅账号章节进行对接。

注意:从服务端接入的情况,务必选择企业开发者认证。个人开发者无法申请服务器对接模式。

注意:接入接口后,务必完成数据回传功能,否则无法上线。

数据回传 →
  • 接入流程
北京小雅星空科技有限公司 京ICP备19010603号