交互控制

## 概览

AIUI支持发送AIUIMessage和修改配置来控制交互方式。

### 录音来源

aiui.cfg的`data_source`可以指定AIUI录音来源。

**sdk**：sdk内部录音（只支持Andorid）。用`CMD_START_RECORD、CMD_STOP_RECORD`控制录音开关，录音开始抛出 `EVENT_START_RECORD`事件，录音结束抛出`EVENT_STOP_RECORD`事件

**user**：开发者自己录音后送音频给sdk，使用`CMD_WRITE、CMD_STOP_WRITE`通知AIUI数据写入和写入结束

### 数据写入
通过`CMD_WRITE`向AIUI写入数据，字段说明：

<table class="docutils">
<tbody valign="top">
<tr class="row-odd"><td>参数名称</td>
<td><div class="first last line-block">
<div class="line">说明</div>
</div>
</td>
</tr>
<tr class="row-even"><td>data_type</td>
<td><div class="first last line-block">
<div class="line">数据类型，取值：</div>
<div class="line">audio（音频）、text（文本）、image（图像，暂不支持）。</div>
</div>
</td>
</tr>
<tr class="row-odd"><td>sample_rate</td>
<td><div class="first last line-block">
<div class="line">音频采样率，固定16000</div>
</div>
</td>
</tr>
<tr class="row-even"><td>msc.lng和msc.lat</td>
<td><div class="first last line-block">
<div class="line">GPS经纬度信息。</div>
<div class="line">当使用天气等需要位置信息的语义服务时可以传GPS坐标</div>
</div>
</td>
</tr>
<tr class="row-odd"><td>rec_user_data</td>
<td><div class="first last line-block">
<div class="line">识别热词，提高特定词的识别效果。</div>
<div class="line">示例：rec_user_data=&#8221;{&#8220;recHotWords&#8221;: &#8220;播报内容|地图显示|</div>
<div class="line">路径优先&#8221;, &#8220;sceneInfo&#8221;: {}}&#8221;。</div>
</div>
</td>
</tr>
</tbody>
</table>

data\_type为text时发送文本请求语义，与正常交互一样，返回对应的[语义结果](https://aiui-doc.xf-yun.com/project-1/doc-16/#语义结果格式)。

**Android 示例代码：**
~~~ java
//写入音频
byte[] audio = xxx; //初始化
String params = "data_type=audio,sample_rate=16000";
AIUIMessage msg = new AIUIMessage(AIUIConstant.CMD_WRITE, 0, 0, params, audio);
mAIUIAgent.sendMessage(msg);

//停止写入
AIUIMessage msg = new AIUIMessage(AIUIConstant.CMD_STOP_WRITE, 0, 0, params, null);
mAIUIAgent.sendMessage(msg);

//写入文本
byte[] content= "确定预定".getBytes();
String params = "data_type=text";
AIUIMessage msg = new AIUIMessage(AIUIConstant.CMD_WRITE, 0, 0, params, content);
mAIUIAgent.sendMessage(msg);
~~~
**iOS/Linux/Windows 示例代码：**
~~~ swift
//写入音频
char audio[length] ;
Buffer* buffer = Buffer::alloc(length);
memcpy(buffer->data, audio, length);
IAIUIMessage* writeMsg=IAIUIMessage::create(AIUIConstant::CMD_WRITE, 0, 0, "data_type=audio,sample_rate=16000", buffer);
m_angent->sendMessage(writeMsg);
writeMsg->destroy();

//写入文本
string text ="确定预定";
Buffer* textData = Buffer::alloc(text.length());
text.copy((char*) textData->data(), text.length());
IAIUIMessage* writeMsg=IAIUIMessage::create(AIUIConstant::CMD_WRITE, 0, 0, "data_type=text", textData);
m_angent->sendMessage(writeMsg);
writeMsg->destroy();

//停止写入
IAIUIMessage* writeMsg=IAIUIMessage::create(AIUIConstant::CMD_STOP_WRITE, 0, 0, "data_type=audio,sample_rate=16000", buffer);
m_angent->sendMessage(writeMsg);
writeMsg->destroy();
~~~
同时写入多个文本，用tag将结果与请求一一对应。示例：
~~~ java
//写入文本
byte[] content= "你好".getBytes();
String params = "data_type=text";
AIUIMessage msg = new AIUIMessage(AIUIConstant.CMD_WRITE, 0, 0, "tag=write_data_1", content);
mAIUIAgent.sendMessage(msg);

//结果回调
private void processResult(AIUIEvent event) {
    String tag = event.data.getString("tag");
}
~~~

## 延迟休眠
持续一段时间无**有效交互**，AIUI就会休眠（[配置文件](https://aiui-doc.xf-yun.com/project-1/doc-13/)的`interact_timeout`可配置）。

**有效交互**：交互的结果有语义结果，`rc`字段的值为0或3。
1.AIUI平台关闭语义理解就没有语义结果,是无效交互。
2.第三方后处理结果中的语义难以辨别，是无效交互。

收到语义结果后5秒内发送`CMD_RESULT_VALIDATION_ACK`，设置这次结果为有效交互。

## 清除历史

AIUI可以自动补充历史信息，例：先问`合肥今天的天气`，再问`明天呢`，结合交互历史，AIUI会回答合肥明天的天气。

清除历史[配置](https://aiui-doc.xf-yun.com/project-1/doc-13/)
`auto:`休眠后自动清除历史。
`user:`用户发送`CMD_CLEAN_DIALOG_HISTORY`手动清除历史。

服务端只保存最新的5次交互历史。