获取数据增强任务详情

更新时间：2025-07-16

功能介绍

用于获取数据增强任务详情。

使用说明

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

权限说明

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

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

SDK调用

调用示例

import os
from qianfan  import resources

# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"


resp = resources.console.utils.call_action(
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/dataprocessing", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeTextAugmentTask", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "taskId":"task-xxx"
    }
)

print(resp.body)

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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/dataprocessing",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeTextAugmentTask",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]interface{}{
      "taskId":"task-xxx"
    })
    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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/dataprocessing")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeTextAugmentTask")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                  "taskId","task-xxx"
                ))
                .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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数

      const res = await consoleAction({base_api_route: '/v2/dataprocessing', action: 'DescribeTextAugmentTask', data:     {
      "taskId":"task-xxx"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "requestId": "45645ae2-9cb3-49f9-aca5-8d2c7a865429",
    "result": {
        "taskId": "task-xxx",
        "taskName": "promptxxx",
        "srcDatasetVersionId": "ds-xxx",
        "dstDatasetVersionId": "ds-xxx",
        "creator": "xxx",
        "createTime": "2025-07-09 21:07:49",
        "status": "Stopped",
        "promptAgument": True,
        "responseAgument": False,
        "promptModel": "ERNIE-4.5-Turbo-128K",
        "promptContext": "xxx",
        "promptIteration": {
            "enable": True,
            "maxIterations": 6
        },
        "promptEvol": {
            "addConst": 3,
            "genType": 1,
            "genWord": 2,
            "transFocus": 5,
            "transScene": 4
        },
        "similarityThreshold": 0,
        "responseModel": "",
        "responseSampleRange": "",
        "responseFormat": {
            "type": "",
            "jsonSchema": null
        }
    }
}

{
    "requestId": "45645ae2-9cb3-49f9-aca5-8d2c7a865429",
    "result": {
        "taskId": "task-xxx",
        "taskName": "promptxxx",
        "srcDatasetVersionId": "ds-xxx",
        "dstDatasetVersionId": "ds-xxx",
        "creator": "xxx",
        "createTime": "2025-07-09 21:07:49",
        "status": "Stopped",
        "promptAgument": true,
        "responseAgument": false,
        "promptModel": "ERNIE-4.5-Turbo-128K",
        "promptContext": "xxx",
        "promptIteration": {
            "enable": true,
            "maxIterations": 6
        },
        "promptEvol": {
            "addConst": 3,
            "genType": 1,
            "genWord": 2,
            "transFocus": 5,
            "transScene": 4
        },
        "similarityThreshold": 0,
        "responseModel": "",
        "responseSampleRange": "",
        "responseFormat": {
            "type": "",
            "jsonSchema": null
        }
    }
}

{
    "requestId": "45645ae2-9cb3-49f9-aca5-8d2c7a865429",
    "result": {
        "taskId": "task-xxx",
        "taskName": "promptxxx",
        "srcDatasetVersionId": "ds-xxx",
        "dstDatasetVersionId": "ds-xxx",
        "creator": "xxx",
        "createTime": "2025-07-09 21:07:49",
        "status": "Stopped",
        "promptAgument": true,
        "responseAgument": false,
        "promptModel": "ERNIE-4.5-Turbo-128K",
        "promptContext": "xxx",
        "promptIteration": {
            "enable": true,
            "maxIterations": 6
        },
        "promptEvol": {
            "addConst": 3,
            "genType": 1,
            "genWord": 2,
            "transFocus": 5,
            "transScene": 4
        },
        "similarityThreshold": 0,
        "responseModel": "",
        "responseSampleRange": "",
        "responseFormat": {
            "type": "",
            "jsonSchema": null
        }
    }
}

{
    requestId: '45645ae2-9cb3-49f9-aca5-8d2c7a865429',
    result: {
        taskId: 'task-xxx',
        taskName: 'promptxxx',
        srcDatasetVersionId: 'ds-xxx',
        dstDatasetVersionId: 'ds-xxx',
        creator: 'xxx',
        createTime: '2025-07-09 21:07:49',
        status: 'Stopped',
        promptAgument: true,
        responseAgument: false,
        promptModel: 'ERNIE-4.5-Turbo-128K',
        promptContext: 'xxx',
        promptIteration: {
            enable: true,
            maxIterations: 6
        },
        promptEvol: {
            addConst: 3,
            genType: 1,
            genWord: 2,
            transFocus: 5,
            transScene: 4
        },
        similarityThreshold: 0,
        responseModel: '',
        responseSampleRange: '',
        responseFormat: {
            type: '',
            jsonSchema: null
        }
    }
}

请求参数

名称	类型	必填	描述
taskId	String	是	增强任务ID，通过以下方式获取字段值： · 方式一，通过调用创建数据增强任务接口，返回的enhanceTaskId字段获取 · 方式二，通过调用获取增强任务列表接口，返回的taskId字段获取 · 方式三，在控制台-数据管理-数据洞察与处理页面，点击数据增强，在任务列表查看：

返回参数

名称	类型	描述
requestId	string	请求ID，可用于排查问题
code	string	错误码，错误时返回
message	string	错误信息，请求失败时返回
taskId	string	增强任务id
taskName	string	增强任务名称
status	string	增强任务状态，说明： · 进行中：Running · 已终止：Stopped · 已完成：Succeeded · 任务异常：Failed
taskType	string	增强任务类型，文本数据增强：text
srcDatasetVersionId	string	增强前的源数据集版本ID
dstDatasetVersionId	string	增强后的目标数据集版本ID
creator	string	创建人
createTime	string	创建时间
promptAgument	boolean	是否开启Prompt生成
responseAgument	boolean	是否开启Response生成
promptModel	string	用于Prompt生成的模型ID，当开启Prompt生成返回该字段
promptContext	string	Prompt生成的业务场景描述参数，当开启Prompt生成返回该字段，说明：（1）在增强过程中，此描述会作为业务场景信息拼接至增强指令，填写该参数有助于生成与业务需求精准适配的Prompt （2）建议采用【行业+业务+目标问题】的结构描述，示例如下： · “家电行业，业务为智能洗碗机制造，产品功能缺陷和使用体验问题引发的客户投诉” · “在线教育，业务为K12编程培训APP，家长对课程质量的质疑与退费诉求”
promptEvol	object	Prompt生成进化增强方向的字典，说明：（1）至少需要填写一个增强方向，且生成样本数大于0 （2）示例格式：`{"genType": 100, "genWord": 200}`
promptIteration	object	Prompt生成的迭代增强配置，当开启Prompt生成返回该字段
similarityThreshold	double	Prompt生成的过滤相似度阈值，当开启Prompt生成返回该字段，说明：只有生成样本的ROUGE-L小于阈值的样本才会添加到种子池，阈值越低，样本重复概率越低取值范围：[0.5, 1]
responseModel	string	用于Response生成的模型ID，当开启Response生成返回该字段
responseSampleRange	string	Response生成的增强样本范围，当开启Response生成返回该字段，说明： · unlabeled：仅无标注样本 · all：全部样本
responseFormat	object	Response生成的输出格式要求，当开启Response生成返回该字段

promptEvol说明

名称	类型	说明
genType	int	同类泛化生成样本数，说明：（1）同类泛化：问题类型不变，变换发生的场景和情境（2）取值范围[1,1000]
genWord	int	同义泛化生成样本数，说明：（1）同义泛化：语义不变，调整词汇、句式、语气等表达方式（2）取值范围[1,1000]
addConst	int	增加约束生成样本数，说明：（1）增加约束：针对问题，增加时间、顺序、范围等若干约束条件（2）取值范围[1,1000]
transScene	int	复杂场景变换生成样本数，说明：（1）复杂场景变换：基于相似的问题，引入更加具体、复杂的生活场景或行业背景（2）取值范围[1,1000]
transFocus	int	考察方向变换生成样本数，说明：（1）考察方向变换：基于相同的背景信息，变换提问方式、考察方向、考察范围等（2）取值范围[1,1000]
transCtx	int	前提条件变换生成样本数，说明：（1）前提条件变换：基于相似的问题，改变前提条件的取值范围、关键信息、逻辑关系等（2）取值范围[1,1000]

promptIteration说明

名称	类型	说明
enable	boolean	是否开启迭代增强功能，默认false，说明：如果打开迭代增强，最小迭代次数默认为1，需设置最大迭代次数
maxIterations	int	最大迭代次数，说明：（1）enable为true时生效（2）取值范围：[1, 10]，默认为5

responseFormat说明

名称	类型	说明
type	string	指定响应内容的格式，说明： · text：以文本格式返回，默认为text · json_object：以json格式返回，可能出现不满足效果情况 · json_schema：以json_scheam规定的格式返回
jsonSchema	object	当type为json_schema时，该参数为规定的格式

获取增强任务列表

删除数据增强任务