查看数据增强任务详情
更新时间:2025-04-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/detail", "",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "taskId": "task-n1zkqgn42bqbmj2g"
17 }
18
19)
20
21print(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/detail", "",
18 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
19 map[string]interface{}{
20 "taskId": "task-n1zkqgn42bqbmj2g",
21 })
22 if err != nil {
23 panic(err)
24 }
25 fmt.Println(string(res.Body))
26
27}
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/detail")
15 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
16 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
17 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
18 .body(CollUtils.mapOf(
19 "taskId", "task-n1zkqgn42bqbmj2g"
20 ))
21 .execute();
22
23 System.out.println(Json.serialize(response));
24 }
25}
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/detail', data: {
11 "taskId": "task-n1zkqgn42bqbmj2g"
12 }
13 });
14
15 console.log(res);
16}
17
18main();
返回示例
1{
2 "log_id": "cg7tfntkmkwevpgs",
3 "result": {
4 "id": 234,
5 "strId": "task-n1zkqgn42bqbmj2g",
6 "sourceDatasetId": 1902,
7 "destDatasetId": 2325,
8 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
9 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
10 "sourceDatasetName": "augment_0922_1-V1",
11 "destDatasetName": "54-V5",
12 "labelIds": "",
13 "status": 4,
14 "area": 0,
15 "entityCount": 651,
16 "strategy": 0,
17 "operations": "",
18 "retStr": "对象存储访问异常",
19 "startTime": "2023-11-02 14:55:12",
20 "finishTime": "2023-11-02 14:56:05",
21 "isSelfInstruct": True,
22 "name": "augment_1102_2",
23 "serviceName": "ERNIE-Bot",
24 "appName": "文心xxx123",
25 "userName": "百里xx",
26 "numSeedFewshot": 6,
27 "numInstancesToGenerate": 20,
28 "similarityThreshold": 0.6
29 },
30 "status": 200,
31 "success": True
32}
1{
2 "log_id": "cg7tfntkmkwevpgs",
3 "result": {
4 "id": 234,
5 "strId": "task-n1zkqgn42bqbmj2g",
6 "sourceDatasetId": 1902,
7 "destDatasetId": 2325,
8 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
9 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
10 "sourceDatasetName": "augment_0922_1-V1",
11 "destDatasetName": "54-V5",
12 "labelIds": "",
13 "status": 4,
14 "area": 0,
15 "entityCount": 651,
16 "strategy": 0,
17 "operations": "",
18 "retStr": "对象存储访问异常",
19 "startTime": "2023-11-02 14:55:12",
20 "finishTime": "2023-11-02 14:56:05",
21 "isSelfInstruct": true,
22 "name": "augment_1102_2",
23 "serviceName": "ERNIE-Bot",
24 "appName": "文心xxx123",
25 "userName": "百里xx",
26 "numSeedFewshot": 6,
27 "numInstancesToGenerate": 20,
28 "similarityThreshold": 0.6
29 },
30 "status": 200,
31 "success": true
32}
1{
2 "log_id": "cg7tfntkmkwevpgs",
3 "result": {
4 "id": 234,
5 "strId": "task-n1zkqgn42bqbmj2g",
6 "sourceDatasetId": 1902,
7 "destDatasetId": 2325,
8 "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
9 "destDatasetStrId": "ds-xum4fiskwyggrk3c",
10 "sourceDatasetName": "augment_0922_1-V1",
11 "destDatasetName": "54-V5",
12 "labelIds": "",
13 "status": 4,
14 "area": 0,
15 "entityCount": 651,
16 "strategy": 0,
17 "operations": "",
18 "retStr": "对象存储访问异常",
19 "startTime": "2023-11-02 14:55:12",
20 "finishTime": "2023-11-02 14:56:05",
21 "isSelfInstruct": true,
22 "name": "augment_1102_2",
23 "serviceName": "ERNIE-Bot",
24 "appName": "文心xxx123",
25 "userName": "百里xx",
26 "numSeedFewshot": 6,
27 "numInstancesToGenerate": 20,
28 "similarityThreshold": 0.6
29 },
30 "status": 200,
31 "success": true
32}
1{
2 log_id: 'cg7tfntkmkwevpgs',
3 result: {
4 id: 234,
5 strId: 'task-n1zkqgn42bqbmj2g',
6 sourceDatasetId: 1902,
7 destDatasetId: 2325,
8 sourceDatasetStrId: 'ds-czwtph4s9frc5ap3',
9 destDatasetStrId: 'ds-xum4fiskwyggrk3c',
10 sourceDatasetName: 'augment_0922_1-V1',
11 destDatasetName: '54-V5',
12 labelIds: '',
13 status: 4,
14 area: 0,
15 entityCount: 651,
16 strategy: 0,
17 operations: '',
18 retStr: '对象存储访问异常',
19 startTime: '2023-11-02 14:55:12',
20 finishTime: '2023-11-02 14:56:05',
21 isSelfInstruct: true,
22 name: 'augment_1102_2',
23 serviceName: 'ERNIE-Bot',
24 appName: '文心xxx123',
25 userName: '百里xx',
26 numSeedFewshot: 6,
27 numInstancesToGenerate: 20,
28 similarityThreshold: 0.6
29 },
30 status: 200,
31 success: true
32}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | string | 是 | 数据增强任务ID,说明: (1)通过以下任一方式获取该字段值 · 方式一,通过调用创建数据增强任务接口,返回的增强任务ID字段enhanceTaskId获取 · 方式二,通过调用查看增强任务列表接口,返回的增强任务strId字段获取 · 方式三,在控制台-数据处理-数据增强页面查看,选择任务,点击详情查看,如下图所示: ![]() (2)该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用查看增强任务列表接口,返回的id字段获取,请替换为接口返回的strId字段获取 |
返回参数
说明:返回的部分字段如下,未说明的字段暂无需关注。
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | object | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | int | 数据增强任务ID,注意: 如果有使用此字段,建议变更为strId字段,后续将逐步废弃此字段 |
strId | string | 数据增强任务ID(字符串类型),注意: 如果有使用id字段,建议变更为此字段,后续将逐步废弃id字段 |
sourceDatasetId | int | 源数据集版本ID,注意: 如果有使用此字段,建议变更为sourceDatasetStrId字段,后续将逐步废弃此字段 |
sourceDatasetStrId | string | 源数据集版本ID(字符串类型),注意: 如果使用sourceDatasetId字段,建议变更为此字段,后续将逐步废弃sourceDatasetId字段 |
destDatasetId | int | 目标数据集版本ID,注意: 如果有使用此字段,建议变更为destDatasetStrId字段,后续将逐步废弃此字段 |
destDatasetStrId | string | 目标数据集版本ID(字符串类型),注意: 如有使用destDatasetId字段,建议变更为此字段,后续将逐步废弃destDatasetId字段 |
sourceDatasetName | string | 源数据集名称 |
destDatasetName | string | 目标数据集名称 |
labelIds | string | 增强的标签ID列表,例如"1,2,5" |
status | int | 任务状态,说明: · -1:无状态,表示没有任务 · 0:准备中 · 1:进行中 · 2:已完成 · 3 :已终止 · 4:任务异常 |
area | int | 增强的区域,说明: · 0:全局 · 1:全局以及标注框局部 |
entityCount | int | 提交的样本数量 |
strategy | int | 算法策略,说明: · 1:串行叠加 · 2:并行遍历 |
operations | string | 增强方式,示例:"随机mask,随机删除",有以下增强方式: · 随机mask · 随机删除 · 同词性替换 · 近义词替换 · 同音词替换 |
retStr | string | 增强结果 |
startTime | string | 开始时间 |
finishTime | string | 结束时间 |
isSelfInstruct | bool | 是否self-instruct自监督 |
name | string | 增强任务名称 |
serviceName | string | 服务名称 |
appName | string | 应用名称 |
userName | string | 用户名称 |
numSeedFewshot | int | 指令生成依赖样本数 |
numInstancesToGenerate | int | 生成样本数 |
similarityThreshold | float | 相似度阈值 |