查看数据增强任务详情

更新时间：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_augmenting_task_info("task-n1zkqgn42bqbmj2g")
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/detail", "",
    // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    map[string]interface{}{
                "taskId": "task-n1zkqgn42bqbmj2g",
    })
    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/detail")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
                .body(CollUtils.mapOf(
                    "taskId", "task-n1zkqgn42bqbmj2g"
                ))
                .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/detail', data: {
    "taskId": "task-n1zkqgn42bqbmj2g"
    }
  });    
    
  console.log(res);
}

main();

返回示例

QfResponse(
    code=200,
    headers={...},
    body={
        "log_id": "7hiag46agqbdd6ri",
        "result": {
            "id": 10,
            "strId": "task-n1zkqgn42bqbmj2g",
            "sourceDatasetId": 1,
            "destDatasetId": 2,
            "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
            "destDatasetStrId": "ds-xum4fiskwyggrk3c",
            "sourceDatasetName": "xx-V1",
            "destDatasetName": "xxx-V1",
            "labelIds": "",
            "status": 2,
            "area": 0,
            "entityCount": 708,
            "strategy": 0,
            "operations": "",
            "retStr": "已保存1条增强处理后的文本",
            "startTime": "2023-11-24 15:34:57",
            "finishTime": "2023-11-24 15:38:45",
            "isSelfInstruct": True,
            "name": "aug_sdk_1",
            "serviceName": "ERNIE-Bot",
            "appName": "xxxxx",
            "userName": "xx",
            "numSeedFewshot": 1,
            "numInstancesToGenerate": 1,
            "similarityThreshold": 0.5,
        },
        "status": 200,
        "success": True,
    },
)

{
    "log_id": "cg7tfntkmkwevpgs",
    "result": {
        "id": 234,
        "strId": "task-n1zkqgn42bqbmj2g",
        "sourceDatasetId": 1902,
        "destDatasetId": 2325,
        "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
        "destDatasetStrId": "ds-xum4fiskwyggrk3c",
        "sourceDatasetName": "augment_0922_1-V1",
        "destDatasetName": "54-V5",
        "labelIds": "",
        "status": 4,
        "area": 0,
        "entityCount": 651,
        "strategy": 0,
        "operations": "",
        "retStr": "对象存储访问异常",
        "startTime": "2023-11-02 14:55:12",
        "finishTime": "2023-11-02 14:56:05",
        "isSelfInstruct": true,
        "name": "augment_1102_2",
        "serviceName": "ERNIE-Bot",
        "appName": "文心xxx123",
        "userName": "百里xx",
        "numSeedFewshot": 6,
        "numInstancesToGenerate": 20,
        "similarityThreshold": 0.6
    },
    "status": 200,
    "success": true
}

{
    "log_id": "cg7tfntkmkwevpgs",
    "result": {
        "id": 234,
        "strId": "task-n1zkqgn42bqbmj2g",
        "sourceDatasetId": 1902,
        "destDatasetId": 2325,
        "sourceDatasetStrId": "ds-czwtph4s9frc5ap3",
        "destDatasetStrId": "ds-xum4fiskwyggrk3c",
        "sourceDatasetName": "augment_0922_1-V1",
        "destDatasetName": "54-V5",
        "labelIds": "",
        "status": 4,
        "area": 0,
        "entityCount": 651,
        "strategy": 0,
        "operations": "",
        "retStr": "对象存储访问异常",
        "startTime": "2023-11-02 14:55:12",
        "finishTime": "2023-11-02 14:56:05",
        "isSelfInstruct": true,
        "name": "augment_1102_2",
        "serviceName": "ERNIE-Bot",
        "appName": "文心xxx123",
        "userName": "百里xx",
        "numSeedFewshot": 6,
        "numInstancesToGenerate": 20,
        "similarityThreshold": 0.6
    },
    "status": 200,
    "success": true
}

{
    log_id: 'cg7tfntkmkwevpgs',
    result: {
        id: 234,
        strId: 'task-n1zkqgn42bqbmj2g',
        sourceDatasetId: 1902,
        destDatasetId: 2325,
        sourceDatasetStrId: 'ds-czwtph4s9frc5ap3',
        destDatasetStrId: 'ds-xum4fiskwyggrk3c',
        sourceDatasetName: 'augment_0922_1-V1',
        destDatasetName: '54-V5',
        labelIds: '',
        status: 4,
        area: 0,
        entityCount: 651,
        strategy: 0,
        operations: '',
        retStr: '对象存储访问异常',
        startTime: '2023-11-02 14:55:12',
        finishTime: '2023-11-02 14:56:05',
        isSelfInstruct: true,
        name: 'augment_1102_2',
        serviceName: 'ERNIE-Bot',
        appName: '文心xxx123',
        userName: '百里xx',
        numSeedFewshot: 6,
        numInstancesToGenerate: 20,
        similarityThreshold: 0.6
    },
    status: 200,
    success: true
}

请求参数

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

Python SDK请求参数说明

名称	类型	必填	描述
task_id	string	是	数据增强任务ID，说明：（1）通过以下任一方式获取该字段值 · 方式一，通过调用创建数据增强任务接口，返回的增强任务ID字段enhanceTaskId获取 · 方式二，通过调用查看增强任务列表接口，返回的增强任务strId字段获取 · 方式三，在控制台-数据处理-数据增强页面查看，选择任务，点击详情查看，如下图所示：（2）该字段新增支持string类型，如果之前使用的是int类型，建议变更为string类型，后续可能将逐步废弃int类型；例如之前是通过调用查看增强任务列表接口，返回的id字段获取，请替换为接口返回的strId字段获取

其它SDK请求参数说明

名称	类型	必填	描述
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	相似度阈值

创建数据增强任务

查看增强任务列表

百度智能云

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

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

查看数据增强任务详情

功能介绍

注意事项

使用说明

SDK调用

调用示例

返回示例

请求参数

返回参数