接口详情
GTS Engine的所有接口都是HTTP POST请求，同时也提供了一个python SDK版本，本节列出了GTS Engine各个任务的详细接口：
文本分类任务
接口详情
创建任务
create_task(self, task_name: str, task_type: str, engine_type: str)
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
task_name |
str | 任务名称，需要不同于其他已有的任务 |
engine_type |
str | 引擎类型 - qiankunding：乾坤鼎 - bagualu: 八卦炉 |
task_type |
str | 根据engine_type选择其支持的任务类型： qiankunding支持三种任务类型 - classification：文本分类 - similarity：句子相似度 - nli：推理任务 bagualu支持的三种任务类型 - classification：文本分类 - ie：信息抽取 - summary：摘要生成 |
输出参数
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：创建成功 - -100：创建失败 |
task_id |
str | 任务对应的id，全局唯一 |
message |
str | 其他返回提示消息 |
列出任务列表
输入参数:空
* 输出参数
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：返回成功 - -200：返回失败，任务信息文件不存在 - -100：返回失败 |
tasks |
str | 返回任务的列表 |
message |
str | 其他返回提示消息 |
查看任务状态
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
输出参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
retcode |
int | 返回码： - 0：初始化 - 1：训练中 - 2：训练成功 - 3：训练失败 - 4：训练停止 - 5：开启预测 - -100：返回失败 - -200：返回失败 |
taskid |
str | 任务id |
message |
str | 其他返回提示消息 |
删除任务
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
| * 输出参数 |
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：返回成功 - -100：返回失败 |
message |
str | 其他返回提示消息 |
上传文件
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
filename |
str | 需要上传的文件路径 |
| * 输出参数 |
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：返回成功 - -100：返回失败 |
message |
str | 其他返回提示消息 |
开始训练
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
train_data |
str | 训练数据的文件名 |
val_data |
str | 验证数据的文件名 |
test_data |
str | 测试数据的文件名 |
label_data |
str | 标签数据的文件名 |
unlabeled_data |
str | 无标签数据的文件名 |
train_mode |
str | 训练模式，以下两种方式可选： - standard：标准模式 - advanced：高级模式 |
seed |
int | 随机种子 |
max_num_epoch |
int | 最大训练轮次 |
min_num_epoch |
int | 最小训练轮次 |
gpuid |
int | 指定训练的GPU |
| * 输出参数 |
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：启动训练成功 - -100：启动训练失败 - -102：返回失败 - -101：返回失败 |
message |
str | 其他返回提示消息 |
终止训练
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
| * 输出参数 |
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：停止成功 - -100：停止失败 - -101：停止失败 - -102：停止失败 |
message |
str | 其他返回提示消息 |
开始推理
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
| * 输出参数 |
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：推理模型启动成功 - -100：推理模型启动失败 |
message |
str | 其他返回提示消息 |
| #### 推理 |
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
samples |
list | list中每个元素是待预测样本 |
输出参数
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：推理成功 - -100：未启动推理服务 |
predictions |
list | 推理结果的标签列表 |
probabilities |
list | 推理结果的概率分布 |
message |
str | 其他返回提示消息 |
| #### 终止推理 |
输入参数
| 参数名 | 参数类型 | 释义 |
|---|---|---|
taskid |
str | 任务id |
samples |
list | list中每个元素是待预测样本 |
| * 输出参数 |
函数的返回值是一个字典，字典中包含如下字段：
| 参数名 | 参数类型 | 释义 |
|---|---|---|
ret_code |
int | 返回码： - 200：推理模型停止成功 - -100：推理模型停止失败 |
message |
str | 其他返回提示消息 |