tbd-前端接口

查表对话系统

备注

2019.7.28

阶段一首先实现两个表的获取接口和四个表的上传接口（获取表的名字，获取表的缩略，上传表，上传表的描述，上传表的联合主键，上传表的操作类型），用户使用默认用户进行测试, token字段不进行额外的验证，直接使用固定值

对话部分

前端寻找对话机器人

• 请求地址:GET:/dialog/find
  
  • 请求内容

{
    domain:'' //请求的机器人名字
}

• 回复内容

{
    status:1/0 //系统状态，1表示正常，0表示错误
    exist:false/true //是否存在这个机器人
}

前端发送对话内容

• 请求地址:POST:/dialog/chat,
• 请求内容

{
    message:'',//当前用户说的话
    session:'',//当前对话的session，第一次开启谈话时为空
    app_name:''
}

• 回复内容

{
    status:1/0 //系统状态，1表示正常，0表示错误
    response:'',//当前系统的回复
    session:''//当前对话的session，第一次开启谈话时需要后台生成一个新的session
    hasTable:true/false //本次回复是否需要回复表格
    table:[{col1:value,col2:value},{...}] //如果需要回复表格，表格的内容
    log:{'slu':[],'dm':[]}
}

用户管理部分

注册

• 请求地址:POST:/user/register
• 请求内容:

{
    usn:'',//注册的用户名
    password:''//密码
}

• 回复内容

{
    status:1/0/-1 //1表示成功，0表示系统出错，-1表示用户名已被占用
    user_id:'' //如果注册成功，返回用户的唯一标识。注册失败时为空
}

登录

• 请求地址:POST/user/login
• 请求内容

{
    usn:''//登录的用户名
    password:'' //密码
}

• 返回内容

{
    status:1/0/-1,//1表示成功，0表示系统错误，-1表示密码错误
    user_id:'',登录成功时返回用户唯一标识
    token:''//用于身份验证的token，涉及到用户的请求都会附带token
}

应用管理部分

新建一个机器人

• 请求地址:POST:/app/add
• 请求内容

{
    app_name:'',//创建的app名字
    user_id:''//创建者的id（唯一标识）
    token:''//创建者的token
}

• 回复内容

{
    status:1/0/-1/-2,//-1表示新建失败，比如该用户有重名的app。-2表示token验证失败
    app_id: 新建成功时，返回app唯一标识
}

删除一个机器人

• 请求地址:GET:/app/delete
• 请求内容

{
    user_id:'',//用户唯一标识
    token:'' // 身份验证
    app_id:''
}

• 回复内容

{
    status:1/0/-1/-2, //-1表示删除失败,-2表示token验证失败
}

获取机器人列表

• 请求地址:GET:/app/list
• 请求内容：

{
    user_id:''//请求获得列表的用户唯一标识
    token:'' //身份验证
}

• 回复内容

{
    status:1/0/-1/-2, 
    app_list:[{app_name:'',app_id:''}] //用户的app列表
}

修改机器人名字

• 请求地址:POST:/app/editName
• 请求内容

{
    app_name:'',//修改后的app名字
    app_id:'', //app的唯一标识
    user_id:''//创建者的id（唯一标识）
    token:''//创建者的token
}

• 回复内容

{
    status:1/0/-1/-2,//-1表示修改失败，比如该用户有重名的app。-2表示token验证失败
}

获取表的名字

• 请求地址:GET:/app/getTableName
• 请求内容

{
    app_id:'',
    user_id:'',
    token:'',
}

• 回复内容

{
    status:0/1/-1/-2,
    name:'' //当前应用的表的名字
}

上传表格

• 请求地址:POST:/app/uploadTable
• 请求内容

Content-type:multipart/form-data
{
    user_id:'',
    app_id:'',
    token:'',
    file_name:'',
    file:''
}

• 回复内容

 {
    status:1/0/-1/-2
 }

获得当前的表头别名

• 请求地址:GET:/app/getTableHeader
• 请求内容

{
    user_id:'',
    token:'',
    app_id:''
}

• 回复内容

 {
    status:-1/0/1/-2,
    header:[{
        col:'col1',//指定对应的列,col1 col2是用户上传的表的header
        alias:['alias1','alias2'],
        description:''//列的自然语言描述
    },{...}]
 }

上传表头别名

• 请求地址POST:/app/tableHeader
• 请求内容:

 {
    user_id:'',
    token:'',
    app_id:'',
    header:[{
        col:'col1',//指定对应的列,col1 col2是用户上传的表的header
        alias:['alias1','alias2'],
        description:''//列的自然语言描述
    },{...}} 
 }

• 回复内容

 {
    status:1/0/-1/-2
 }

请求表的列数据结构和可进行的操作

• 请求地址:GET:/app/getTableType
• 请求内容

{
    user_id:'',
    token:'',
    app_id:''
}

• 回复内容

 {
    status:-1/0/1/-2,
    type:[{
        col:'col1',
        type:'',
        operation:{
            min:false,
            max:false,
            sum:false,
            avg:false,
            comparable:false,
            fuzzy:false,
            search:false
        }
    },{...}]
 }

上传表的列数据结构和可进行的操作

• 请求地址POST:/app/tableType
• 请求内容:

 {
    user_id:'',
    token:'',
    app_id:'',
    type:[{
        col:'col1',
        type:'',
        operation:{
            min:false,
            max:false,
            sum:false,
            avg:false,
            comparable:false,
            fuzzy:false,
            search:false
        }
    },{...}]
 }

• 回复内容

 {
    status:1/0/-1/-2
 }

获取表的联合主键

• 请求地址:GET:/app/getJoinKeys
• 请求内容

{
    user_id:'',
    token:'',
    app_id:''
}

• 回复内容

 {
    status:-1/0/1/-2,
    keys:[[col1,col2],[col3,col],[...]]
 }

上传表的联合主键

• 请求地址POST:/app/joinKeys
• 请求内容:

 {
    user_id:'',
    token:'',
    app_id:'',
    keys:[[col1,col2],[col3,col],[...]]
 }

• 回复内容

 {
    status:1/0/-1/-2
 }

获取表的缩略

• 请求地址:GET:/app/getTable
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:''
 }

• 回复参数

{
    status:1/0/-1/-2,
    table:{
        col:[col1,col2,...],
        content:[{col1:'',col2:'',col3:'',...},{...}] // 每一行的内容是一个dict，一共3行
    }
}

获得机器人现在的运行状态

• 请求地址:GET:/app/getState
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:''
 }

• 回复参数

{
    status:1/0/-1/-2,
    state:1/0 //1表示正在运行（已发布），0表示没有运行（没有发布）
}

发布机器人

• 请求地址:POST:/app/release
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:''
 }

• 回复参数

{
    status:1/0/-1/-2
}

停止机器人

• 请求地址:POST:/app/stop
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:''
 }

• 回复参数

{
    status:1/0/-1/-2
}

上传NLG模板

• 请求地址:POST:/app/nlg
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
    nlg:['inform(...)','']
 }

• 回复参数

{
    status:1/0/-1/-2
}

获取NLG模板

• 请求地址:GET:/app/getNlg
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
 }

• 回复参数

{
    nlg:[{...}] // {...}是原始nlg规则经过转换的结果
    status:1/0/-1/-2
}

上传SLU模板

• 请求地址:POST:/app/slu
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
    slu:[{
        'col':'',
        'prefix':'',
        'postfix':'',
        'spoken_language':'',
        'words':{
            'verb':'',
            'noun':'',
            'adj':''
            }
        }
    ,{...}]
 }

• 回复参数

{
    status:1/0/-1/-2
}

获取SLU模板

• 请求地址:GET:/app/getSlu
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
 }

• 回复参数

{
    slu:[{
        'col':'',
        'prefix':'',
        'postfix':'',
        'spoken_language':'',
        'words':{
            'verb':'',
            'noun':'',
            'adj':''
            }
        }
    ,{...}],
    status:1/0/-1/-2
}

上传实体信息

• 请求地址:POST:/app/entity
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
    entity:'',
    spoken_language:'',
    entity_adj:[{'col':'','description'}]
 }

• 回复参数

{
    status:1/0/-1/-2
}

获取实体信息

• 请求地址:GET:/app/getEntity
• 请求参数:

 {
    user_id:'',
    app_id:'',
    token:'',
 }

• 回复参数

{
    entity:'',
    spoken_language:'',
    entity_adj:[{'col':'','description'}]
    status:1/0/-1/-2
}

获得当前的所有表头和别名

• 请求地址:GET:/app/getTableCol
• 请求内容

{
    user_id:'',
    token:'',
    app_id:''
}

• 回复内容

 {
    status:-1/0/1/-2,
    header:[{
        col:'col1',//指定对应的列,col1 col2是用户上传的表的header
        alias:['alias1','alias2'],
        description:''//列的自然语言描述
    },{...}]
 }