下行Common-Action Command指令:
约束:Agent Server返回该指令时,必须先在小艺开放平台注册意图框架插件,且插件bundleName和actionName和返回的该指令中返回的bundleName和intentName值一致,否则云侧会拦截,不允许下发。
示例:
{
"payload":{
"actionResponseConfig": {
"type": "WHITE",
"resultPath":["result.items.entityId"]
},
"response":[{
"commandUserInteractionDisplayText":"找到{number}个备忘。",
"code":"0",
"commandUserInteractionSpeak":"找到{number}个备忘。"
},
{
"commandUserInteractionDisplayText":"没有找到相关的备忘录,想添加的话试试说“创建备忘录”",
"code":"1",
"commandUserInteractionSpeak":"没有找到相关的备忘录,想添加的话试试说“创建备忘录”"
}],
"executeParam":{
"executeMode":"background",
"intentName":"SearchNote",
"intentParam":{
"query":"昨天的"//槽位event
},
"actionResponse": "true",
"bundleName":"com.huawei.******"
}
},
"header":{
"namespace":"Common",
"name":"Action"
}
} Payload参数说明:
字段名称 | 类型 | 是否必填 | 字段描述 |
|---|---|---|---|
response | Response[] | 否 | 根据执行结果选择播报。 |
executeParam | ExecuteParam | 是 | 执行参数。 |
intentName | string | 是 | Action名称。 |
ExecuteParam参数说明:
字段名称 | 类型 | 是否必填 | 字段描述 |
|---|---|---|---|
actionResponse | boolean | 是 | 调用意图框架的执行结果是否需要上报云侧。 |
actionResponseConfig | ActionResponseConfig | 否 | 需要上报云侧的参数配置,如果为空表示全部上报,需要指定上报的参数或剔除某个参数时填入具体的内容。 |
executeMode | string | 是 | 调用意图框架的模式“background”、“foreground”。 |
intentName | string | 是 | 意图名称,内容由意图框架定义。 |
intentParam | object | 是 | 意图执行参数,格式由意图框架根据不同意图定义。 |
bundleName | string | 是 | 被调用方包名。 |
ActionResponseConfig参数说明:
字段名称 | 类型 | 是否必填 | 字段描述 |
|---|---|---|---|
type | string | 是 | 上报参数配置类型,BLACK:黑名单、WHITE:白名单。 |
resultPath | string[] | 是 | 具体的白名单/黑名单参数路径,路径为在意图框架返回结果里的路径,如result.items.entityId。 |
上行ActionExecutor-ActionResult对应的Event指令:
toolName:存放意图框架意图名。
responseDataList:存放意图框架工具调用结果。
{
"header": {
"namespace": "Common",
"name": "UploadExeResult"
},
"payload": {
"toolName": "NAVIGATE",
"resultCode": 0,
"responseText": "",
"responseDataList": [{
"addressName": "华为北京研究所(北门)"
},
{
"addressName": "华为北京研究所(南门)"
}]
}
} 小艺APP收到DeepLink指令,则通过DeepLink方式打开应用的指定路径。
下行DeepLink报文样例:
{
"header": {
"namespace": "Command",
"name": "Deeplink"
},
"payload": {
"url": "{{STRING}}",
"appName": "{{STRING}}",
"packageName": "{{STRING}}",
"appType": "{{STRING}}"
}
} Payload参数说明:
字段名称 | 类型 | 是否必填 | 字段描述 |
|---|---|---|---|
url | string | 是 | 要跳转到的应用页面url。 |
appName | string | 是 | 要打开的应用名,当本地没有安装,会引导到应用市场安装。 |
packageName | string | 否 | 应用包名,如果不为空则deepLink指定包名调用。 |
appType | string | 否 | DeepLink:访问的应用的类型; OpenHarmony:HarmonyOS单框应用。 |
AgentServer通过已建立的HTTP‑SSE长连接通道(message/stream RPC会话),下行Command指令向客户端获取位置信息。如:天气、打车、订餐等业务,需要获取用户的位置信息。
⚠重要说明:
下行Command报文样例(注意:下发定位服务指令时,响应报文中的final不要填true):
{
"id": "req-001",
"jsonrpc": "2.0",
"result": {
"taskId": "task-001",
"kind": "artifact-update",
"append": true,
"final": false,
"lastChunk": false,
"artifact": {
"artifactId": "art-001",
"parts": [
{
"kind": "data",
"data": {
"commands": [
{
"header": {
"namespace": "Common",
"name": "Action"
},
"payload": {
"cardParam": {},
"needUploadResult": true,
"pageControlRelated": false,
"responses": [
{
"displayText": "",
"ttsText": "",
"resultCode": ""
}
],
"executeParam": {
"permissionId": [],
"executeMode": "background",
"achieveType": "INTENT",
"actionResponse": true,
"intentName": "GetCurrentLocation",
"intentParam": {},
"bundleName": "com.huawei.******",
"needUnlock": true,
"dimension": "",
"timeOut": 5
}
}
}
]
}
}
]
}
}
} 小艺APP上报位置信息指令,将会在请求data.events里发送给AgentServer:
{
"jsonrpc": "2.0",
"method": "message/stream",
"id": "req-001",
"params": {
"id": "req-001",
"sessionId": "session-001",
"message": {
"role": "user",
"parts": [
{
"kind": "data",
"data": {
"events": [
{
"header": {
"name": "UploadExeResult",
"namespace": "Common"
},
"payload": {
"intentName": "GetCurrentLocation",
"isNeedAgentInfo": false,
"outputs": {
"accuracy": 15.6,
"additionSize": 3,
"additionsMap": {},
"altitude": 0,
"altitudeAccuracy": 0,
"direction": 0,
"directionAccuracy": 0,
"isFromMock": false,
"latitude": 31.980405, // 使用WGS84坐标系
"longitude": 118.7624709, // 使用WGS84坐标系
"sourceType": 2,
"speed": 0,
"speedAccuracy": 0,
"timeSinceBoot": 4692532845781,
"timeStamp": 1783050964476,
"uncertaintyOfTimeSinceBoot": 0
}
}
}
]
}
}
]
}
}
}