查看增强任务列表

更新时间：2024-11-08

功能介绍

用于查看增强任务列表。

注意事项

通过API查看增强任务列表，和千帆控制台页面展示字段不同：

本文API参数有的字段，可能在千帆控制台页面无
千帆控制台页面的部分字段，可能在本文API参数中无
后续会持续完善API功能，请关注API文档更新

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

SDK调用

调用示例

import os
from qianfan.resources import Data

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

resp = Data.get_dataset_aug_task_list(
    keyword="aug",
    page_size=1,
    offset=0)
print(resp)

package main
import (
    "context"
    "fmt"
    "os"
    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
     // 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
    
    ca := qianfan.NewConsoleAction()
    
    res, err := ca.Call(context.TODO(),
    // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
    "/wenxinworkshop/enhance/list", "",
    // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    map[string]interface{}{
                "offset": 0,
                "pageSize": 2,
                "word": "",
                "isSelfInstruct": true,
                "sortField": "startTime",
                "sortBy": "desc",
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(string(res.Body))
    
}

import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;

public class Dome {
    public static void main(String args[]){
        // 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
        Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
        
        ConsoleResponse<Map<String, Object>> response = qianfan.console()
                // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
                .route("/wenxinworkshop/enhance/list")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
                .body(CollUtils.mapOf(
                    "offset", 0,
                    "pageSize", 2,
                    "word", "",
                    "isSelfInstruct", true,
                    "sortField", "startTime",
                    "sortBy", "desc"
                ))
                .execute();

        System.out.println(Json.serialize(response));
    }
}

import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";

// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');

async function main() {
  //base_api_route:调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
  //data:对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
  const res = await consoleAction({base_api_route: '/wenxinworkshop/enhance/list', data: {
   "offset": 0,
    "pageSize": 2,
    "word": "",
    "isSelfInstruct": true,
    "sortField": "startTime",
    "sortBy": "desc"
    }
  });    
    
  console.log(res);
}

main();

返回示例

QfResponse(
    code=200,
    headers={...},
    body={
        "log_id": "iryjukkre8rxy9dm",
        "result": {
            "total": 6,
            "items": [
                {
                    "id": 937,
                    "strId": "task-n1zkqgn42bqbmj2g",
                    "projectType": 20,
                    "sourceDatasetId": 21427,
                    "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
                    "sourceDatasetName": "augment_0922_1-V1",
                    "destDatasetId": 36582,
                    "destDatasetStrId": "ds-xum4fiskwyggrk3c",
                    "destDatasetName": "unsorted_augment_sdk_01-V1",
                    "area": 0,
                    "status": 2,
                    "strategy": 0,
                    "operations": "",
                    "startTime": "2023-11-24 15:34:57",
                    "finishTime": "2023-11-24 15:38:45",
                    "failReason": "",
                    "isSelfInstruct": True,
                    "name": "aug_sdk_1",
                    "modelName": "ERNIE-xxx",
                }
            ],
        },
        "status": 200,
        "success": True,
    },
)

{
    "log_id": "x5bnzd1g2fi3iiz9",
    "result": {
        "total": 45,
        "items": [
            {
                "id": 241,
                "strId": "task-n1zkqgn42bqbmj2g",
                "projectType": 20,
                "sourceDatasetId": 2343,
                "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
                "sourceDatasetName": "sys_bos数据集1106-V1",
                "destDatasetId": 2431,
                "destDatasetStrId": "ds-xum4fiskwyggrk3c",
                "destDatasetName": "werwrewrwe-V2",
                "area": 0,
                "status": 4,
                "strategy": 0,
                "operations": "",
                "startTime": "2023-11-08 10:44:21",
                "finishTime": "2023-11-08 10:44:56",
                "failReason": "对象存储访问异常",
                "isSelfInstruct": true,
                "name": "3334",
                "modelName": "ERNIE-xxx"
            },
            {
                "id": 240,
                "strId": "task-e3bc1a9951da4178",
                "projectType": 20,
                "sourceDatasetId": 2324,
                "sourceDatasetStrId": "ds-xzipgehxzikh98jy",
                "sourceDatasetName": "3-V2",
                "destDatasetId": 2343,
                "destDatasetStrId": "ds-n2m88kdjd4e0n4fw",
                "destDatasetName": "sys_bos数据集1106-V1",
                "area": 0,
                "status": 3,
                "strategy": 0,
                "operations": "",
                "startTime": "2023-11-08 10:43:55",
                "finishTime": "2023-11-08 10:44:02",
                "failReason": "",
                "isSelfInstruct": true,
                "name": "357",
                "modelName": "ERNIE-Bot"
            }
        ]
    },
    "status": 200,
    "success": true
}

{
    "log_id": "x5bnzd1g2fi3iiz9",
    "result": {
        "total": 45,
        "items": [
            {
                "id": 241,
                "strId": "task-n1zkqgn42bqbmj2g",
                "projectType": 20,
                "sourceDatasetId": 2343,
                "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
                "sourceDatasetName": "sys_bos数据集1106-V1",
                "destDatasetId": 2431,
                "destDatasetStrId": "ds-xum4fiskwyggrk3c",
                "destDatasetName": "werwrewrwe-V2",
                "area": 0,
                "status": 4,
                "strategy": 0,
                "operations": "",
                "startTime": "2023-11-08 10:44:21",
                "finishTime": "2023-11-08 10:44:56",
                "failReason": "对象存储访问异常",
                "isSelfInstruct": true,
                "name": "3334",
                "modelName": "ERNIE-xxx"
            },
            {
                "id": 240,
                "strId": "task-e3bc1a9951da4178",
                "projectType": 20,
                "sourceDatasetId": 2324,
                "sourceDatasetStrId": "ds-xzipgehxzikh98jy",
                "sourceDatasetName": "3-V2",
                "destDatasetId": 2343,
                "destDatasetStrId": "ds-n2m88kdjd4e0n4fw",
                "destDatasetName": "sys_bos数据集1106-V1",
                "area": 0,
                "status": 3,
                "strategy": 0,
                "operations": "",
                "startTime": "2023-11-08 10:43:55",
                "finishTime": "2023-11-08 10:44:02",
                "failReason": "",
                "isSelfInstruct": true,
                "name": "357",
                "modelName": "ERNIE-xxx"
            }
        ]
    },
    "status": 200,
    "success": true
}

{
    log_id: 'x5bnzd1g2fi3iiz9',
    result: {
        total: 45,
        items: [
            {
                id: 241,
                strId: 'task-n1zkqgn42bqbmj2g',
                projectType: 20,
                sourceDatasetId: 2343,
                sourceDatasetStrId: 'ds-czwtph4s9frc5ap3',
                sourceDatasetName: 'sys_bos数据集1106-V1',
                destDatasetId: 2431,
                destDatasetStrId: 'ds-xum4fiskwyggrk3c',
                destDatasetName: 'werwrewrwe-V2',
                area: 0,
                status: 4,
                strategy: 0,
                operations: '',
                startTime: '2023-11-08 10:44:21',
                finishTime: '2023-11-08 10:44:56',
                failReason: '对象存储访问异常',
                isSelfInstruct: true,
                name: '3334',
                modelName: 'ERNIE-xxx'
            },
            {
                id: 240,
                strId: 'task-e3bc1a9951da4178',
                projectType: 20,
                sourceDatasetId: 2324,
                sourceDatasetStrId: 'ds-xzipgehxzikh98jy',
                sourceDatasetName: '3-V2',
                destDatasetId: 2343,
                destDatasetStrId: 'ds-n2m88kdjd4e0n4fw',
                destDatasetName: 'sys_bos数据集1106-V1',
                area: 0,
                status: 3,
                strategy: 0,
                operations: '',
                startTime: '2023-11-08 10:43:55',
                finishTime: '2023-11-08 10:44:02',
                failReason: '',
                isSelfInstruct: true,
                name: '357',
                modelName: 'ERNIE-xxx'
            }
        ]
    },
    status: 200,
    success: true
}

请求参数

注意：不同语言SDK的请求参数不同，请根据实际调用选择对应参数。

Python SDK请求参数说明

名称	类型	必填	描述
offset	int	否	分页偏移，默认0
sorted_by_start_time_asc	bool	否	表示是否按启动时间排序。说明：（1）如果不传该字段，默认按增强任务ID排序（2）可选值如下： · True：按时间升序排列 · False：按时间降序排列，时间近的排序在前
page_size	int	否	分页大小，范围[1,20]
keyword	string	否	关键字搜索，匹配数据集名称或数据集版本id

其它SDK请求参数说明

名称	类型	必填	描述
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	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

查看数据增强任务详情

删除数据增强任务

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder

百度智能云千帆大模型服务与开发平台ModelBuilder

查看增强任务列表

功能介绍

注意事项

使用说明

SDK调用

调用示例

返回示例

请求参数

返回参数