获取数据增强任务详情

更新时间：2025-07-16

接口描述

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

权限说明

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

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

鉴权说明

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

请求结构

Bash

POST /v2/dataprocessing?Action=DescribeTextAugmentTask HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "taskId":"task-xxx"
}

请求头域

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

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值DescribeTextAugmentTask

Body参数

名称	类型	必填	描述
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时，该参数为规定的格式

请求示例

Bash

# 替换下列示例中的Authorization值
curl -i --location 'https://qianfan.baidubce.com/v2/dataprocessing?Action=DescribeTextAugmentTask'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44axxxxx4525543'\ 
--header 'Content-Type: application/json'\ 
--data '{
    "taskId":"task-xxx"
}'

响应示例

JSON

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

错误码

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

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

例如错误返回：

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。

获取增强任务列表

删除数据增强任务