资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

发起数据集发布任务

注意:为提升开发者使用体验,平台升级了数据集管理接口。推荐使用数据集管理V2版本接口,功能更全面、且接口更规范,详见数据集管理API列表;V1版本相关接口不再升级,本文档于2024年8月30日迁移至历史文档;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入V2版本接口。

功能介绍

本接口用于发起数据集发布任务。

权限说明

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

  • 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
  • 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy

HTTP调用

鉴权说明

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

请求说明

  • 基本信息

请求地址: https://qianfan.baidubce.com/wenxinworkshop/dataset/release

请求方式:POST

  • Header参数
名称 类型 必填 描述
Content-Type String HTTP请求内容的类型,固定值:application/json
x-bce-date String 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z
Authorization String 用于验证请求合法性的认证信息。更多参见鉴权认证,签名工具可参考IAM签名工具
  • Body参数
名称 类型 必填 说明
datasetId string 数据集版本ID,示例:ds-7pkzh1exthpuy10n,说明:
(1)可以通过以下任一方式获取该字段值:
· 方式一,通过调用创建数据集接口,返回的datasetId字段获取
· 方式二,在控制台-数据集管理列表页面,点击详情,在版本信息页查看,如下图所示:
image.png
(2) 该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取

响应说明

名称 类型 说明
success bool 是否操作成功
result bool 发起数据集发布任务是否成功
status int 状态码
log_id string 操作记录id

请求示例

# 替换下列示例中的Authorization、x-bce-date等值
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/dataset/release' \
--header 'Authorization: bce-auth-v1/047ab241bad24166xxxxx/2023-10-10T07:48:39Z/1800/host;x-bce-date/c26e0a21944cc53773f3e7ec4xxxxxxxx' \
--header 'x-bce-date: 2023-10-10T07:48:17Z' \
--header 'Content-Type: application/json' \
--data '{
    "datasetId": "ds-7pkzh1exthpuy10n"
}'

响应示例

{
    "log_id":"pkdd55ddi1pgvu0i",
    "status":200,
    "success": true,
    "result": true
}

SDK调用

平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API,SDK调用说明文档请参考发起数据集发布任务

错误码

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

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

例如参数错误返回:

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

更多错误码,请查看错误码说明

上一篇
创建数据集
下一篇
发起数据集导入任务