查看增强任务列表
更新时间:2025-05-16
功能介绍
用于查看增强任务列表。
注意事项
(1)通过API查看增强任务列表,和千帆控制台页面展示字段不同:
- 本文API参数有的字段,可能在千帆控制台页面无
- 千帆控制台页面的部分字段,可能在本文API参数中无
- 后续会持续完善API功能,请关注API文档更新
(2)权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
- 只读访问千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataReadAccessPolicy
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9
10
11resp = resources.console.utils.call_action(
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
13 "/wenxinworkshop/enhance/list", "",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "offset": 0,
17 "pageSize": 2,
18 "word": "",
19 "isSelfInstruct": True,
20 "sortField": "startTime",
21 "sortBy": "desc"
22 }
23
24)
25
26print(resp.body)
1package main
2import (
3 "context"
4 "fmt"
5 "os"
6 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
7)
8func main() {
9 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
11 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
12
13 ca := qianfan.NewConsoleAction()
14
15 res, err := ca.Call(context.TODO(),
16 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
17 "/wenxinworkshop/enhance/list", "",
18 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
19 map[string]interface{}{
20 "offset": 0,
21 "pageSize": 2,
22 "word": "",
23 "isSelfInstruct": true,
24 "sortField": "startTime",
25 "sortBy": "desc",
26 })
27 if err != nil {
28 panic(err)
29 }
30 fmt.Println(string(res.Body))
31
32}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/wenxinworkshop/enhance/list")
15 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
16 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
17 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
18 .body(CollUtils.mapOf(
19 "offset", 0,
20 "pageSize", 2,
21 "word", "",
22 "isSelfInstruct", true,
23 "sortField", "startTime",
24 "sortBy", "desc"
25 ))
26 .execute();
27
28 System.out.println(Json.serialize(response));
29 }
30}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
10 const res = await consoleAction({base_api_route: '/wenxinworkshop/enhance/list', data: {
11 "offset": 0,
12 "pageSize": 2,
13 "word": "",
14 "isSelfInstruct": true,
15 "sortField": "startTime",
16 "sortBy": "desc"
17 }
18 });
19
20 console.log(res);
21}
22
23main();
返回示例
1{
2 "log_id": "x5bnzd1g2fi3iiz9",
3 "result": {
4 "total": 45,
5 "items": [
6 {
7 "id": 241,
8 "strId": "task-n1zkqgn42bqbmj2g",
9 "projectType": 20,
10 "sourceDatasetId": 2343,
11 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
12 "sourceDatasetName": "sys_bos数据集1106-V1",
13 "destDatasetId": 2431,
14 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
15 "destDatasetName": "werwrewrwe-V2",
16 "area": 0,
17 "status": 4,
18 "strategy": 0,
19 "operations": "",
20 "startTime": "2023-11-08 10:44:21",
21 "finishTime": "2023-11-08 10:44:56",
22 "failReason": "对象存储访问异常",
23 "isSelfInstruct": True,
24 "name": "3334",
25 "modelName": "ERNIE-xxx"
26 },
27 {
28 "id": 240,
29 "strId": "task-e3bc1a9951da4178",
30 "projectType": 20,
31 "sourceDatasetId": 2324,
32 "sourceDatasetStrId": "ds-xzipgehxzikh98jy",
33 "sourceDatasetName": "3-V2",
34 "destDatasetId": 2343,
35 "destDatasetStrId": "ds-n2m88kdjd4e0n4fw",
36 "destDatasetName": "sys_bos数据集1106-V1",
37 "area": 0,
38 "status": 3,
39 "strategy": 0,
40 "operations": "",
41 "startTime": "2023-11-08 10:43:55",
42 "finishTime": "2023-11-08 10:44:02",
43 "failReason": "",
44 "isSelfInstruct": True,
45 "name": "357",
46 "modelName": "ERNIE-Bot"
47 }
48 ]
49 },
50 "status": 200,
51 "success": True
52}
1{
2 "log_id": "x5bnzd1g2fi3iiz9",
3 "result": {
4 "total": 45,
5 "items": [
6 {
7 "id": 241,
8 "strId": "task-n1zkqgn42bqbmj2g",
9 "projectType": 20,
10 "sourceDatasetId": 2343,
11 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
12 "sourceDatasetName": "sys_bos数据集1106-V1",
13 "destDatasetId": 2431,
14 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
15 "destDatasetName": "werwrewrwe-V2",
16 "area": 0,
17 "status": 4,
18 "strategy": 0,
19 "operations": "",
20 "startTime": "2023-11-08 10:44:21",
21 "finishTime": "2023-11-08 10:44:56",
22 "failReason": "对象存储访问异常",
23 "isSelfInstruct": true,
24 "name": "3334",
25 "modelName": "ERNIE-xxx"
26 },
27 {
28 "id": 240,
29 "strId": "task-e3bc1a9951da4178",
30 "projectType": 20,
31 "sourceDatasetId": 2324,
32 "sourceDatasetStrId": "ds-xzipgehxzikh98jy",
33 "sourceDatasetName": "3-V2",
34 "destDatasetId": 2343,
35 "destDatasetStrId": "ds-n2m88kdjd4e0n4fw",
36 "destDatasetName": "sys_bos数据集1106-V1",
37 "area": 0,
38 "status": 3,
39 "strategy": 0,
40 "operations": "",
41 "startTime": "2023-11-08 10:43:55",
42 "finishTime": "2023-11-08 10:44:02",
43 "failReason": "",
44 "isSelfInstruct": true,
45 "name": "357",
46 "modelName": "ERNIE-Bot"
47 }
48 ]
49 },
50 "status": 200,
51 "success": true
52}
1{
2 "log_id": "x5bnzd1g2fi3iiz9",
3 "result": {
4 "total": 45,
5 "items": [
6 {
7 "id": 241,
8 "strId": "task-n1zkqgn42bqbmj2g",
9 "projectType": 20,
10 "sourceDatasetId": 2343,
11 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
12 "sourceDatasetName": "sys_bos数据集1106-V1",
13 "destDatasetId": 2431,
14 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
15 "destDatasetName": "werwrewrwe-V2",
16 "area": 0,
17 "status": 4,
18 "strategy": 0,
19 "operations": "",
20 "startTime": "2023-11-08 10:44:21",
21 "finishTime": "2023-11-08 10:44:56",
22 "failReason": "对象存储访问异常",
23 "isSelfInstruct": true,
24 "name": "3334",
25 "modelName": "ERNIE-xxx"
26 },
27 {
28 "id": 240,
29 "strId": "task-e3bc1a9951da4178",
30 "projectType": 20,
31 "sourceDatasetId": 2324,
32 "sourceDatasetStrId": "ds-xzipgehxzikh98jy",
33 "sourceDatasetName": "3-V2",
34 "destDatasetId": 2343,
35 "destDatasetStrId": "ds-n2m88kdjd4e0n4fw",
36 "destDatasetName": "sys_bos数据集1106-V1",
37 "area": 0,
38 "status": 3,
39 "strategy": 0,
40 "operations": "",
41 "startTime": "2023-11-08 10:43:55",
42 "finishTime": "2023-11-08 10:44:02",
43 "failReason": "",
44 "isSelfInstruct": true,
45 "name": "357",
46 "modelName": "ERNIE-xxx"
47 }
48 ]
49 },
50 "status": 200,
51 "success": true
52}
1{
2 log_id: 'x5bnzd1g2fi3iiz9',
3 result: {
4 total: 45,
5 items: [
6 {
7 id: 241,
8 strId: 'task-n1zkqgn42bqbmj2g',
9 projectType: 20,
10 sourceDatasetId: 2343,
11 sourceDatasetStrId: 'ds-czwtph4s9frc5ap3',
12 sourceDatasetName: 'sys_bos数据集1106-V1',
13 destDatasetId: 2431,
14 destDatasetStrId: 'ds-xum4fiskwyggrk3c',
15 destDatasetName: 'werwrewrwe-V2',
16 area: 0,
17 status: 4,
18 strategy: 0,
19 operations: '',
20 startTime: '2023-11-08 10:44:21',
21 finishTime: '2023-11-08 10:44:56',
22 failReason: '对象存储访问异常',
23 isSelfInstruct: true,
24 name: '3334',
25 modelName: 'ERNIE-xxx'
26 },
27 {
28 id: 240,
29 strId: 'task-e3bc1a9951da4178',
30 projectType: 20,
31 sourceDatasetId: 2324,
32 sourceDatasetStrId: 'ds-xzipgehxzikh98jy',
33 sourceDatasetName: '3-V2',
34 destDatasetId: 2343,
35 destDatasetStrId: 'ds-n2m88kdjd4e0n4fw',
36 destDatasetName: 'sys_bos数据集1106-V1',
37 area: 0,
38 status: 3,
39 strategy: 0,
40 operations: '',
41 startTime: '2023-11-08 10:43:55',
42 finishTime: '2023-11-08 10:44:02',
43 failReason: '',
44 isSelfInstruct: true,
45 name: '357',
46 modelName: 'ERNIE-xxx'
47 }
48 ]
49 },
50 status: 200,
51 success: true
52}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
isSelfInstruct | bool | 是 | 现在只支持自监督,固定值为true |
offset | int | 否 | 分页偏移,默认0 |
pageSize | int | 否 | 分页大小,范围[1,20] |
word | string | 否 | 关键字搜索,匹配数据集名称或数据集版本id |
sortField | string | 否 | 排序字段,说明: · 如果使用该字段,需同时和sortBy字段使用,且该字段值固定值为startTime,表示按启动时间排序。 · 如果不使用该字段,默认按增强任务ID排序。 |
sortBy | string | 否 | 排序规则,说明: · 如果使用该字段,需同时和sortField字段使用,且可选值为asc或desc · 如果不使用该字段,默认为desc |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | object | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
total | int | 增强任务总数 |
items | List<object> | 增强任务列表 |
items说明
名称 | 类型 | 描述 |
---|---|---|
id | int | 数据增强任务ID,注意: 如果使用了此字段,建议变更为strId字段,后续将逐步废弃此字段 |
strId | string | 数据增强任务ID(字符串类型),注意: 如果使用了id字段,建议变更为此字段,后续将逐步废弃id字段 |
projectType | int | 标注类型,说明: · 20:文本对话 · 401:泛文本无标注 · 402:query问题集 · 705:文生图 |
sourceDatasetId | int | 源数据集版本id,注意: 如果使用了此字段,建议变更为sourceDatasetStrId字段,后续将逐步废弃此字段 |
sourceDatasetStrId | string | 源数据集版本id(字符串) |
sourceDatasetName | string | 源数据集名称 |
destDatasetId | int | 目标数据集版本id,注意: 如果使用了此字段,建议变更为destDatasetStrId字段,后续将逐步废弃此字段 |
destDatasetStrId | string | 目标数据集版本id(字符串),注意: 如果使用了destDatasetId字段,建议变更为此字段,后续将逐步废弃destDatasetId字段 |
destDatasetName | string | 目标数据集名称 |
area | int | 增强的区域,说明: ·0:全局 ·1:全局以及标注框局部 |
status | int | 任务状态,说明: · -1:无状态,表示没有任务 · 0:准备中 · 1:进行中 · 2:已完成 · 3 :已终止 · 4:任务异常 |
strategy | int | 算法策略,说明: · 1:串行叠加 · 2:并行遍历 |
operations | string | 增强方式,示例:"随机mask,随机删除",有以下增强方式: · 随机mask · 随机删除 · 同词性替换 · 近义词替换 · 同音词替换 |
startTime | string | 开始时间 |
finishTime | string | 结束时间 |
failReason | string | 错误原因 |
isSelfInstruct | bool | 是否self-instruct自监督 |
name | string | 增强任务名称 |
modelName | string | 服务名称,目前支持以下: · ERNIE-Bot · ERNIE-Bot-turbo |