Skip to content

前后端接口细节

Quin Bay edited this page Dec 6, 2017 · 25 revisions

MongoDB数据库结构

数据集名称:annotaiton_data

annotation_data
{
    uuid: a unique uuid for a sentence,
    text: the original text for a sentence,
    label: the classify label for a sentence make by user,
}

接口

数据导入接口

请求地址: /upload_remote_file 请求类型: HTTP
请求方式: POST
数据类型: multipart/form-data
响应类型: JSON
功能: 将请求中的文件的内容存入MongoDB
请求参数:

参数名称 是否必须 类型 描述
file true file 需要导入到数据库中的数据文件

响应数据:无特殊数据返回

load 获取没有打label 的数据的接口

请求地址: /load_single_unlabeled 请求类型: HTTP
请求方式: GET
数据类型:
响应类型: JSON
功能: 将请求中的文件的内容存入MongoDB
请求参数:无 响应数据:

参数名称 是否必须 类型
message false string

TaskCenter Interface

请求地址: /full_train
请求类型:HTTP
请求方式:POST
响应类型:JSON
功能:使用已标注数据进行全量训练
请求参数:

{
    dataset_id, //数据集id(int)
    user_id, //用户id(int)
    task_type, //任务类型(classify, ner)(string)
    max_train_num, //任务最大样本数(可省略,默认-1,无限制)(int)
    min_train_num, //任务最小样本数(可省略,默认4)(int)
}

参数示例:

{
    dataset_id:"1234",
    user_id:"1234",
    task_type:"ner",
    max_train_num: -1,
    min_train_num" 4,
}

返回参数:

{
    ret_code, //状态码,int, 0标识提交成功,1标识提交失败
    msg, //详细信息,string, 如用户id不存在,dataset不存在,或者dataset标注数据不满足约束条件
}