资源API说明

更新时间：2019-11-22

前言：
文档中提到的接入微信相关内容均基于指通过扫描微信开放平台二维码方式所实现的和微信的对接，开发者也可自行搭建server实现和微信对接。

整体结构

说明

UNIT开发者完成BOT配置及训练后，可以将BOT模型运行后的对话效果直接发布至DuerOS技能开放平台或微信公众平台中供业务中使用。
在调用逻辑中，UNIT第三方平台接入层首先会调用BOT模型，然后根据BOT回复的动作类型判断是否调用开发者提供的资源API：
- 当模型回复的动作类型为文本内容的答复或澄清时，UNIT第三方平台接入层会将内容直接返回DuerOS技能开放平台或微信公众平台等第三方平台，此时第三方平台会直接拿到文本内容答复或澄清时的回复结果；
- 当模型回复的动作类型为执行函数的答复时，UNIT第三方平台接入层会携带BOT回复的结果调用资源API以获取要呈献第三方平台的内容；最终UNIT第三方平台接入层将资源API的返回的结果发给DuerOS技能开放平台或微信公众平台等第三方平台，此时第三方平台会拿到资源API返回的结果；
若已将回复内容配置在UNIT的BOT内，则无需配置资源API。
部分平台支持二次开发，开发者根据需要配置更加灵活的对话逻辑，也可获取资源、处理自定义指令等。如有需要请移步相关平台：
- DuerOS技能开放平台：查看文档；
- 微信公众号：受微信开放平台的限制，暂不支持对话效果二次开发；
暂时无法支持引导（含引导至对话意图和引导至问答意图）动作类型。

资源API协议

请求说明

请求示例

HTTP 方法：POST
请求URL：需要开发者提供可访问地址，推荐使用HTTPS协议。
body中放置请求参数，具体内容参见《UNIT2.0对话接口文档》中返回参数说明部分。

说明：

from参数代表展示平台，其中
- 1 为DuerOS技能开放平台；
- 2 为微信公众平台。
bot_id 透传的bot_id

返回说明

通用返回参数

字段	是否必选	类型	说明
error_code	是	int	0为正常，其他为错误
error_msg	否	string	错误描述
result	否	object	对象

result说明

字段	是否必选	类型	说明
type	是	string	现在仅支持纯文本返回text，其他预留
content	是	string	当返回是text类型时，content为返回话术

具体示例

实例说明

UNIT下配置好星座运势查询的场景，当意图满足时触发指令search_luck_data，此时会携带时间和星座词槽调用资源API。

交互过程

用户问：明天处女座运势怎么样?
BOT（通过第三方平台）回复：处女座明天会运势很旺哦～

请求内容示例

{
  "from": 2,
  "log_id": "7758521",
  "response": {
    "schema": {
      "intent_confidence": 0,
      "slots": [],
      "domain_confidence": 0,
      "intent": ""
    },
    "qu_res": {
      "candidates": [],
      "qu_res_chosen": "",
      "sentiment_analysis": {
        "pval": 0,
        "label": "1"
      },
      "lexical_analysis": [
        {
          "basic_word": [
            "明天"
          ],
          "weight": 0,
          "term": "明天",
          "type": "32"
        },
        {
          "basic_word": [
            "处女",
            "座"
          ],
          "weight": 0,
          "term": "处女座",
          "type": "21"
        },
        {
          "basic_word": [
            "运势"
          ],
          "weight": 0,
          "term": "运势",
          "type": "21"
        },
        {
          "basic_word": [
            "怎么",
            "样"
          ],
          "weight": 0,
          "term": "怎么样",
          "type": "30"
        },
        {
          "basic_word": [
            "?"
          ],
          "weight": 0,
          "term": "?",
          "type": "37"
        }
      ],
      "raw_query": "明天处女座运势怎么样?",
      "status": 0,
      "timestamp": 0
    },
    "action_list": [
      {
        "action_id": "fail_action",
        "refine_detail": {
          "option_list": [],
          "interact": "",
          "clarify_reason": ""
        },
        "confidence": 0,
        "custom_reply": "search_luck_data",
        "say": "我不知道应该怎么答复您。",
        "type": "failure"
      }
    ]
  },
  "bot_session": "",
  "interaction_id": "interaction-1525336753134-677023095-8013-42",
  "version": "2.0",
  "bot_id": "1706"
}

返回内容示例

{  
    "error_code": 0,
    "error_msg": "",
    "result": {
	    "type": "text",
	    "content": "处女座明天会运势很旺哦～"
    }
}