获取数据集版本详情
本接口用于获取特定数据集版本的详情信息,如数据集名称、数据类型、版本信息等。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataOperateAccessPolicy
- 只读访问千帆大模型平台数据管理(除数据标注外)的权限:QianfanDataReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
方法名称,固定值DescribeDatasetVersion
数据集版本ID,示例:ds-xxx,可以通过以下任一方式获取该字段值:
· 方式一,通过调用创建数据集接口,返回的 versionId 字段获取
· 方式二,在千帆控制台-数据集管理列表页面查看
POST /v2/dataset?Action=DescribeDatasetVersion HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"versionId": "ds-xxx"
}
示例代码
curl -i --location 'https://qianfan.baidubce.com/v2/dataset?Action=DescribeDatasetVersion'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21axxxxxxxx525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"versionId": "ds-xxx"
}'
返回响应
请求ID
请求结果,请求成功时返回
显示子属性
隐藏子属性
数据集ID
数据集版本ID
数据集版本序号
数据集名称
数据格式。数据格式,可选值如下:
· PromptResponse:表示Prompt+Response
· Role:表示Role(user+assistant)
· SFT_FIM:表示Prefix+Suffix+Middle数据格式
· Text:表示纯文本
· DPO_PromptChosenRejected:表示DPO数据格式
· KTO_PromptChosenRejected:表示KTO数据格式
· PromptSortedresponses:表示Prompt+多Response排序
· Prompt:表示Prompt集
· PromptImage:表示Prompt+图片
· PromptImageResponse:表示Prompt+Image+Response
版本描述
存储类型,说明:
· BOS:表示对象存储BOS
· sysStorage:表示平台共享存储
存储类型为对象存储BOS时,对应的完整存储路径
数据集大小,单位为MB
样本数
字符数
数据集标注进度
导入状态,说明:
· 新建:Created
· 导入中:Importing
· 导入完成:ImportFinished
· 导入失败:ImportFailed
发布状态,说明:
· 未发布:Unpublished
· 发布中:Publishing
· 已发布:Published
· 发布失败:PublishFailed
发布进度,说明:
· 未发布:该字段值为0
· 发布中:该字段值为当前进度,如XX %
· 已发布:该字段值为100%
· 发布失败:该字段值为0
创建人
创建时间,格式:YYYY-MM-DD hh:mm:ss
更新时间,格式:YYYY-MM-DD hh:mm:ss
{
"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"datasetId": "dg-xxx",
"datasetName": "ChineseMedicalDialogueData中文医疗问答数据集",
"dataFormat": "PromptResponse",
"versionId": "ds-xxx",
"versionNumber": 1,
"createTime": "2023-09-08 17:10:11",
"modifyTime": "2023-10-25 20:45:23",
"storageType": "sysStorage",
"sizeMB": 513.42,
"description": "中文医疗问答数据集第一版",
"characterCount":111,
"sampleCount": 10,
"annotationProgress": "1/10",
"importStatus": "Created",
"publishStatus": "Unpublished",
"publishProgress": "0",
"creator":"accountName",
"createTime": "2024-07-24 23:12:43",
"modifyTime": "2024-07-24 23:13:35"
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。
评价此篇文章
