查看增强任务列表

更新时间：2024-12-23

接口描述

用于查看增强任务列表。

注意事项

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

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

（2）权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
完全控制千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataFullControlAccessPolicy
运维操作千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataOperateAccessPolicy
只读访问千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataReadAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /wenxinworkshop/enhance/list HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "offset": 0,
    "pageSize": 2,
    "word": "",
    "isSelfInstruct": true,
    "sortField": "startTime",
    "sortBy": "desc"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Body参数

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

请求示例

bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/enhance/list' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "offset": 0,
    "pageSize": 2,
    "word": "",
    "isSelfInstruct": true,
    "sortField": "startTime",
    "sortBy": "desc"
}'

响应示例

JSON

{
    "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
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
code	错误码
message	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "code": 500001,
  "message": "param invalid"
}

更多错误码，请查看错误码说明。

删除数据增强任务

数据标注V1