人机对话

一、接口描述

1. 功能描述

为开发者提供SAAS方式的可视化界面，快速帮助开发者实现某领域的自定义语义交互能力，帮助开发者对接用户所下达的指令或搜索的信息给予相对应的服务。提供两种方式：1.任务型对话管理：提供多轮对话管理引擎，让开发者能在面向任务的对话中，透过追问的多轮交互得到足够的信息去执行任务，更加拟真的人机交互，提升用户体验。2.QA型对话管理：基于问题答案库，进行信息检索的过程，从知识库中找到语义匹配的正确的回应。

2. 接口使用：

平台为每个API提供试用体验服务，您在AI市场选择“免费试用”规格下单后，即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制，如需更高性能的API服务，可以提交咨询工单，联系京东AI扩容购买。

使用接口前，需要先完成API的下单购买，然后可使用已经封装好的SDK/参照接口鉴权规则进行相应开发，整体流程详见 接入流程

二、请求说明

1. 接口地址 ：

https://aiapi.jd.com/jdai/dialog

2. 请求方式：

 post

3. 请求参数

（1）query请求参数

公共请求参数

（2）header请求参数

业务请求参数

（3）body请求参数

业务请求参数

4、请求代码示例

建议您使用我们提供的SDK进行调用，SDK获取及调用方式详见本页一接口描述中的4接口使用

三、返回说明

1、返回参数

（1）公共返回参数

（2）业务返回参数

SemanticResult字段说明

Type为1， TaskDialogResult: 任务型对话语义解析的结果

Type为2， QADialogResult: 任务型对话语义解析的结果 (answers)

2、返回示例

此处内容为通过网关后返回的结果，包含公共返回参数

1.我想打车
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": { 
        "status": 0,
        "request_id": null,
        "type": 1,
        "dialogResult": {
            "intent": {
                "name": "callTaxi",
                "slots": []
            },
            "response": "想几点出发",
            "completed": false
        }
    }
}
2.我想3点出发
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": { 
        "status": 0,
        "request_id": “xxxxxx”,
        "type": 1,
        "dialogResult": {
            "intent": {
                "name": "callTaxi",
                "slots": [
                    {
                        "name": "Fairy_Time",
                        "value": "03:00",
                        "rawValue": "3点"
                    }
                ]
            },
            "response": "你想去哪",
            "completed": false
        }
    }
}
3.我想去亦庄
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": { 
        "status": 0,
        "request_id": “xxxxx”,
        "type": 1,
        "dialogResult": {
            "intent": {
                "name": "callTaxi",
                "slots": [
                    {
                        "name": "Fairy_Time",
                        "value": "03:00",
                        "rawValue": "3点"
                    },
                    {
                        "name": "toLocation",
                        "value": "亦庄",
                        "rawValue": "亦庄"
                    }
                ]
            },
            "response": "你确认要在03:00去亦庄吗",
            "completed": false
        }
    }
}
4.确认
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": { 
        "status": 0,
        "request_id": “”,
        "type": 1,
        "dialogResult": {
            "intent": {
                "name": "callTaxi",
                "slots": [
                    {
                        "name": "Fairy_Time",
                        "value": "03:00",
                        "rawValue": "3点"
                    },
                    {
                        "name": "toLocation",
                        "value": "亦庄",
                        "rawValue": "亦庄"
                    }
                ]
            },
            "response": "本轮会话结束",
            "completed": true
        }

    }
}

5.怎样使用滴滴打车
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": { 
        "status": 0,
        "request_id": “xxxxxx”,
        "type": 2,
        "dialogResult": {
            "answer": [
                {
                    "question": "怎样使用滴滴打车",
                    "answer": "可以下载滴滴app",
                    "type": "9",
                    "score": 0.9999999999733115
                },
                {
                    "question": "怎样使用滴滴打车",
                    "answer": "可以微信小程序使用",
                    "type": "9",
                    "score": 0.9999999999733115
                }
            ]
        }
    }
}
6.我想去火星
{
    "code": "10000",
    "charge": false,
    "remainTimes": 999998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": {   
        "status": 0,
        "request_id": “xxxxxx”,
        "type": 1,
        "dialogResult": {
            "intent": null,
            "response": "听不懂你在说什么",
            "completed": false
        }
     }
}

四、错误码

1.系统级错误码

详见返回码

2.业务错误码