开放平台接口定义文档

文档版本:V0.2

简介

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

认证

采用grpc的调用证书方案，约定如下：

参数	类型	描述	默认值
key	string	开放接口Key,在管理平台获取	无，必填
device_type	string	设备类型	无，必填
device_id	string	设备ID	无，必填
service	string	asr,nlp,tts	无，必填
version	string	接口版本号	无，必填
time	string	unix时间戳	无，必填
sign	string	由以上几项+secret按约定的加密方式生成	无，必填

sign的生成加密方式：

key={key}&device_type={device_type}&device_id={device_id}&service={service}&version={version}&time={time}&secret={secret}

的utf8字符串的md5值

其中{xxx}由xxx的值替代

key及secret由开发方通过管理平台获取，并保管。

Speech 接口

protobuf 定义

syntax = "proto3";

package rokid.speech;

import "google/rpc/status.proto";

service Speech {
  rpc asr(stream AsrRequest) returns (stream AsrResponse) { }
  rpc nlp(NlpRequest) returns (NlpResponse) { }
  rpc tts(TtsRequest) returns (stream TtsResponse) { }

  // rpc speechv(stream VoiceSpeechRequest) returns (stream VoiceSpeechResponse) { }
  // rpc speecht(TextSpeechRequest) returns (TextSpeechResponse) { }
}


message AsrRequest {
  oneof request_content {
    AsrHeader header      = 1;
    bytes voice           = 2;
  }
}

message AsrHeader {
  int32 id                = 1;
  string lang             = 2;
  string codec            = 3;
  // vt = voice trigger
  string vt               = 4;
}

message AsrResponse {
  string asr              = 1;
}

message NlpRequest {
  NlpHeader header        = 1;
  string asr              = 2;
}

message NlpHeader {
	int32 id              = 1;
	string lang           = 2;
	string cdomain        = 3;
}

message NlpResponse {
  string nlp              = 1;
}

message TtsRequest {
  TtsHeader header        = 1;
  string text             = 2;
}

message TtsHeader {
	int32 id              = 1;
	string declaimer      = 2;
	string codec          = 3;
}

message TtsResponse {
  string text             = 1;
  bytes voice             = 2;
}

AsrRequest

一个请求一个AsrRequest{AsrHeader}后跟多个AsrRequest{voice}。

参数	类型	描述	默认值
header	AsrHeader	帮助识别voice语音流的参数配置	无
voice	bytes	需要识别的voice语音流	无

AsrHeader

参数	类型	描述	默认值
id	int32	唯一标识，用于跟踪一个完整的请求，处理及响应事件。	0
lang	string	语音流的语言，目前支持zh-CN，en-US。	zh-CN
codec	string	语音流的编码，目前支持PCM，OPU，OPU2。	PCM
vt	string	激活词，即用于唤醒设备的名字，如"若琪"。	空

AsrResponse

参数	类型	描述
asr	string	asr实时识别的结果

NlpRequest

参数	类型	描述	默认值
header	NlpHeader	帮助识别voice语音流的NlpHeader	无
asr	string	需要识别的asr文本	无

NlpHeader

参数	类型	描述	默认值
id	int32	唯一标识，用于跟踪一个完整的请求，处理及响应事件。	0
lang	string	语音流的语言，目前支持zh-CN，en-US。	zh-CN
cdomain	string	设备当前应用对应的domain	空

NlpResponse

参数	类型	描述
nlp	string	nlp识别的结果

TtsRequest

参数	类型	描述	默认值
header	TtsHeader	配置如何将text转换成voice语音流	无
text	string	需要转换的text文本	无

TtsHeader

参数	类型	描述	默认值
id	int32	唯一标识，用于跟踪一个完整的请求，处理及响应事件。	0
declaimer	string	发音者，如"zh","zhangsan","rose"	"zh"
codec	string	语音流的编码，目前支持PCM，OPU，OPU2。	PCM

TtsResponse

参数	类型	描述
text	string	voice语音中包含的文字
voice	bytes	合成的voice语音

OpenAPI 接口

protobuf 定义

详见各具体的protobuf的文档