AIUI文档中心
AIUI平台说明
什么是AIUI
AIUI平台能力介绍
AIUI交互流程说明
AIUI快速入门
AIUI应用管理说明
应用接入和配置
应用后处理
敏感词
AIUI开发接入
AIUI接入概述
声学接入
交互接入
SDK接入
SDK介绍
参数配置
消息事件
交互状态
结果解析
WebSocketAPI接入
精简协议接入
常用功能
交互控制
语音唤醒
语音合成
用户个性化
自定义参数
离线命令词
翻译模式
流式识别
语义VAD
发音人列表
关键词过滤
情景模式
错误码
星火交互认知大模型说明
大模型概述
开发接入
SDK接入
API接入
大模型API服务鉴权
特色能力
超拟人合成
声音复刻
大模型功能
大模型错误码
软硬件产品接入
RK3328 降噪板
RK3328降噪板白皮书
RK3328降噪板使用手册
RK3328降噪板规格书
RK3328降噪板协议手册
RK3328 AIUI评估板开发套件
RK3328评估板白皮书
RK3328评估板使用手册
RK3328评估板规格书
RK3328评估板开发手册
RK3588 AIUI多模态开发套件
RK3588一体机多模态产品规格书
RK3588多模态套件使用手册
视频传输协议
串口通信协议
音频传输协议
ZG803 离线语音识别套件
ZG803 产品白皮书
USB声卡套件
USB声卡产品白皮书
USB声卡使用指南
AC7911 AIUI语音开发套件
AC7911-产品白皮书
AC7911-快速体验指南
AC7911-开发指南
AC7911-协议手册
AC7911-硬件参数
AIUI评估板接入
集成方式
软件包说明
AIUIServiceKitSDK
串口SDK
评估板参数配置
调试升级
技能工作室
技能概述
名词解析
技能
意图和语料
实体
动态实体
模糊匹配
填槽对话
技能设计规范
语音技能设计规范
开放技能接入审核规范
开放技能图标图片规范
技能开发
创建技能和意图
意图配置
技能测试
技能发布
技能后处理
技能导入导出
云函数APIv2.1
云函数APIv2.0
问答库开发
语句问答
关键词问答
文档问答
设备人设开发
技能协议
语义协议:重要字段和通用字段
技能后处理协议:标准请求
技能后处理协议:请求校验
技能后处理协议:Request_v2.1协议
技能后处理协议:Response_v2.1协议
技能资源限制
硬件设计参考
常见问题
AIUI常见问题
评估板常见问题
动态实体常见问题
联系方式
服务条款
AIUI开放平台服务协议
AIUI开放平台隐私政策
小飞在家用户协议
小飞在家隐私政策
小飞在家开源软件使用许可
讯飞账号隐私政策
讯飞账号用户协议
讯飞带屏音箱用户协议
讯飞带屏音箱隐私政策
AIUI SDK隐私政策
AIUI SDK合规使用说明
本文档使用 MrDoc 发布
-
+
首页
技能后处理协议:Response_v2.1协议
注意 协议v2.1比v2.0协议,存在字段增删,和支持取值的增加。 在你处理完技能发送的请求后,你需要给用户发送回复。回复可以是: - 技能请求处理完成回复用户TTS - 播放一些和技能相关的提示音 <!-- - 在用户等待时间太长时提示用户正在处理,降低用户对处理延时的感觉 --> ## HTTP头 ```js HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: ``` ## body示例 ```json { "version": "2.1", "sessionAttributes": { "key": "value" }, "response": { "outputSpeech": { "type": "PlainText", "text": "Plain text String to speak" }, "reprompt": { "outputSpeech": { "type": "PlainText", "text": "Plain text String to speak" } }, "card": { "type": "Standard", "title": { "size":"LARGE|SMALL", "text":"20~32℃" }, "content":"2018-08-27 | 广州", "imageUrl":"https://carfu.com/resources/card-images/race-car-small.png", "link": { "url":"example.iflyos.cn/", "text":"点击查看" } }, "directives": [ { "type": "AudioPlayer.Play", "playBehavior": "ENQUEUE", "audioItem": { "stream": { "type": "AUDIOH", "url": "https://example.com/audiofile.mp3", "token": "S0wiXQZ1rVBkov...", "expectedPreviousToken": "f78b7d68...", "offsetInMilliseconds": 0 }, "metadata": { "title": "《十年》", "subtitle": "陈奕迅", "art": { "sources": [ { "url": "https://example.com/brie-album-art.png" } ] } } } } ], "expectSpeech": true, "shouldEndSession": true } } ``` 响应正文参数说明 | 参数 | 描述 | 类型 | 必须出现 | | ----------------- | ------------------------------------------------------------------------------ | ------ | -------- | | version | 版本,取值2.1 | String | 是 | | sessionAttributes | 需要放入下一次请求的`session{attributes{}}`中回传至技能的属性。包含key, value | Object | 否 | | response | 返回内容。 | Object | 是 | ### 标准响应中的对象 | 参数 | 描述 | 类型 | 必须出现 | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -------- | | outputSpeech | 操作返回的语音文本<br>- type: 输出语音类型,**取值:**`PlainText`,纯文本<br>- text: 文本内容,type取值为`PlainText`时需要出现该字段。<br> | Object | 否 | | reprompt | 若该技能回复需要打开录音收听用户的语音回复,当用户在8秒内没有说话时,设备将推送该语音文本,用于再次提示用户输入。<br>推送后设备再打开录音8s。若用户依旧没有说话,则会话结束。<br>- type: 输出语音类型,**取值:**`PlainText`,纯文本<br>- text: 文本内容,type取值为`PlainText`时需要出现该字段。 | Object | 否 | | card | 用于向设备的关联APP推送消息。支持三种卡片类型:Simple、Standard、List。<br>- [点击查看详情](./display_card.md) | Object | 否 | | directives | 一组指令,用于指定使用特定接口进行设备级别的操作。目前支持以下指令:<br>- AudioPlayer指令 <br>- Playback指令 <br>- Dialog指令<br>- Display指令 | Array | 否 | | expectSpeech | 该返回是否需要设备打开麦克风进行追问。true代表要追问,默认取值为false | Boolean | 否 | | shouldEndSession | 该返回是否为会话的终点。true表示会话在响应后结束;false表示会话保持活动状态。如果未提供,则默认为true。我们约定:若回复中包含`AudioPlayer`,且技能没有过多交互,此处取值必须为`true` | Boolean | 否 | ### 针对不同请求的响应 | request | response格式 | | -- | -- | | [LaunchRequest](https://aiui-doc.xf-yun.com/project-1/doc-71/) | 标准响应中的所有内容的均可根据业务需求选择包含 | | [TextRequest](https://aiui-doc.xf-yun.com/project-1/doc-71/) | 标准响应中的所有内容的均可根据业务需求选择包含 | | [IntentRequest](https://aiui-doc.xf-yun.com/project-1/doc-71/) | 标准响应中的所有内容的均可根据业务需求选择包含 | | [SessionEndedRequest](https://aiui-doc.xf-yun.com/project-1/doc-71/) | - 若`reason`为`USER_INITIATED`,可以回复。回复内容中只能包括`outputSpeech`,且`ShouldEndSession`取值必须为`true`。<br> - 若`reason`为`ERROR`,不可回复。 | <IflyHeader />
admin
2023年10月12日 18:16
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码