智能对话应用接口

会话接口

描述

• 会话接口

URI

POST /qa/bot/sdk/talk

请求参数

返回参数

示例

请求示例

问答参数的示例代码

{
    "appkey":"用户秘钥",
    "token":"签名信息，里面包含用户请求的所有数据"
}

token签名信息中包含了请求数据，参数包括：

Token加密之前的参数结构为：

{
    "question":"用户询问的问题",
    "format":"签名信息，里面包含用户请求的所有数据",
    "language":"语言，支持zh(中文),en(英文),默认为中文",
    "app_id":"创建应用的id",
    "sessionid":"会话信息表示，当会话结果为空时，将返回sessionid"
}

响应示例

textMenu中的json对象格式为：

intentParam的json对象格式为：

intentParam内容举例：

{
    {
    "intent":"意图名称",
    "confidence":"意图得分",
    "info":"意图失败的具体原因",
    "slot":[
        {
            "slotName":"词槽名称",
            "slotValue":"词槽值"
        }
    ]
}

listTextMenu中的json对象内容：

textMenu内容举例：

{
        "endStatement":"B-返回上级菜单 Q-退出菜单",
        "beginStatement":null,
        "menuAns":null,
        "menuId":"44ddc6175ae24a0dbf40d9f241ce158b",
        "menuType":"FOLD",
        "ansId":null,
        "listTextMenu":[
            {
                "menuId":"7112a566a8a14827bda3c9cf39b850bd",
                "parentId":"44ddc6175ae24a0dbf40d9f241ce158b",
                "menuType":"FOLD",
                "menuName":"新建文字菜单",
                "answerId":null,
                "menuSequence":"2",
                "beginStatement":"ddd",
                "endStatement":"333",
                "activeStatus":"0",
                "userId":"dialog",
                "tenantId":"tenantId",
                "createTime":1527040140000,
                "updateTime":1527040952000
            },
            {
                "menuId":"b48451a6278b4f33bedcc082a7a08e84",
                "parentId":"44ddc6175ae24a0dbf40d9f241ce158b",
                "menuType":"ITEM",
                "menuName":"子菜单的内容是什么",
                "answerId":"26c72d1d9c604ecf9c346a25a59fa17f",
                "menuSequence":"2",
                "beginStatement":null,
                "endStatement":null,
                "activeStatus":"0",
                "userId":"dialog",
                "tenantId":"tenantId",
                "createTime":1527039572000,
                "updateTime":1527040952000
            }
        ]
    }

answers 中json对象参数如下：

当type值为LOCATION时，resolution的json对象参数如下：

values的json对象参数如下：

返回JSON数据结构：

{
    "question": "用户询问的问题",
    "topic": "标题",
    "format": "json",
    "lang": "zh",
    "app_id": "APP编号",
    "sessionid": "sessionid值",
    "status": "状态码",
    "reminder": "提示信息",
    "answers": [{
        "id": "答案ID编号",
        "title": "",
        "answer": "答案",
        "url": "链接",
        "type": "LOCATION",
        "resolution": {
            "values": [{
                "code": "地区编码",
                "name": "地区名称",
                "type": "地区类型",
                "longitude": "经度",
                "latitude": "纬度"
            }]
        },
        "score": "匹配得分"
    }]
}

返回JSON数据结果示例如下：

{
    "question": "泰山在哪个城市？",
    "topic": "LOCATION",
    "format": "json",
    "lang": "zh",
    "app_id": "APP-1",
    "sessionid": "SE1234567",
    "status": "200",
    "reminder": "提示信息",
    " answers ": [{
        "id": "1",
        "title": "",
        "answer": "泰安",
        "url": "https://baike.baidu.com/item/泰山/5447?fr=aladdin",
        "type": "LOCATION",
        "resolution": {
            "values": [{
                    "code": "86",
                    "name": "中国",
                    "type": "country",
                    "longitude": "116.4072154982",
                    "latitude": "39.9047253699"
                },
                {
                    "code": "370000",
                    "name": "山东省",
                    "type": "province",
                    "longitude": "117.0207380545",
                    "latitude": "36.6682454447"
                },
                {
                    "code": "370900",
                    "name": "泰安市",
                    "type": " prefecture ",
                    "longitude": "117.0884158791",
                    "latitude": "36.1999559476"
                },
                {
                    "code": "370902",
                    "name": "泰山",
                    "type": "location",
                    "longitude": "117.0884158791",
                    "latitude": "36.1999559476"
                }
            ]
        },
        "score": "0.97"
    }]
}

相似列表接口

描述

• 相似列表接口

URI

POST /qa/bot/sdk/similarities

请求参数

示例

相似列表接口请求参数示例代码

{
    "appkey":"用户秘钥",
    "token":"签名信息，里面包含用户请求的所有数据"
}

Answer的Json结构数据示例如下

{
    "question":"用户询问的问题",
    "topic":"主题",
    "format":"json",
    "lang":"zn",
    "app_id":"app编号",
    "sessionid":"会话id",
    "status":"状态码",
    "reminder":"提示信息",
    "answers":[
        {
            "score":"相似问题得分",
            "kwId":"知识Id",
            "title":"相似问题内容",
            "titleWordList":[
                "相似",
                "问题",
                "分词",
                "结果"
            ]
        },
 "answers":[
   "一级分类名","二级分类名",
]
    ]
}

媒体文件接口

描述

• 媒体文件接口

URI

POST /qa/bot/sdk/media

请求参数

返回参数

示例

媒体文件请求参数示例代码

{
    "appkey":"用户秘钥",
    "token":"签名信息，里面包含用户请求的所有数据"
}

Token加密之前的参数结构为：

{
    "mediaId":"媒体文件id",
    "sessionid":"会话信息表示，当会话结果为空时，将返回sessionid"
}

返回参数Json结构数据示例如下

{
    "mediaId":"素材ID",
    "mediaName":"素材名称",
    "mediaSummary":"素材摘要",
    "mediaType":"素材类型",
    "mediaFile":"素材文件",
    "mediaUrl":"素材链接",
    "mediaWatermark":"素材水印",
    "encode":"传输过程中的编码转化"
}