获取数据集列表
更新时间：2024-12-23
接口描述
本接口用于获取符合特定查询条件的数据集列表。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
- 完全控制千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataFullControlAccessPolicy
- 运维操作千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataOperateAccessPolicy
- 只读访问千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataReadAccessPolicy
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/dataset?Action=DescribeDatasets HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "",
"maxKeys": 10,
"pageReverse":true,
"filter":{
"dataFormatList": ["PromptResponse", "PromptImage"]
}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeDatasets |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| marker | string | 否 | 本次查询的起始位置，第一条查询该字段设为空 |
| maxKeys | int | 否 | 请求列表长度，最大为100，默认值是10，如果指定的值大于100，按100操作 |
| pageReverse | bool | 否 | 是否倒序，默认否，即按照版本创建时间顺序排列 |
| filter | map | 否 | 筛选条件，此处支持对于数据集名称或数据格式进行筛选，如果根据数据格式筛选：对应Key为dataFormatList示例：{"dataFormatList": ["PromptResponse", "PromptImage"]} |
| filter.datasetName | string | 否 | 根据数据集名称进行模糊匹配 |
| filter.dataFormatList | List<string> | 否 | 根据数据集数据格式进行筛选，可选值如下： · PromptResponse：表示Prompt+Response · Role：表示Role(user+assistant) · Text：表示纯文本 · DPO_PromptChosenRejected：表示DPO或SimPO数据格式 · KTO_PromptChosenRejected：表示KTO数据格式 · PromptSortedresponses：表示Prompt+多Response排序 · Prompt：表示Prompt集 · PromptImage：表示Prompt+图片 · PromptImageResponse：表示Prompt+Image+Response |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果，请求成功时返回 |
| code | string | 错误码，错误时返回 |
| message | string | 错误信息，请求失败时返回 |
result说明
| 名称 | 类型 | 说明 |
|---|---|---|
| pageInfo | object | 分页信息 |
| datasets | List<dataset> | 数据集列表 |
pageInfo说明
| 名称 | 类型 | 说明 |
|---|---|---|
| marker | string | 本次查询的起始位置第一次为空 |
| maxKeys | int | 请求返回的数量 |
| isTruncated | bool | 指明是否只返回了部分数据，说明： · false：表示本次已经返回所有结果， · true：表示本次还没有返回所有结果 |
| nextMarker | string | 当isTruncated为true时，才返回此项，作为下次查询marker的值 |
| pageReverse | bool | 是否倒序，默认否，即按照版本创建时间顺序排列 |
dataset说明
| 名称 | 类型 | 说明 |
|---|---|---|
| datasetId | string | 数据集ID |
| datasetName | string | 数据集名称 |
| dataFormat | string | 数据格式，可选值如下： · PromptResponse：表示Prompt+Response · Role：表示Role(user+assistant) · Text：表示纯文本 · DPO_PromptChosenRejected：表示DPO或SimPO数据格式 · KTO_PromptChosenRejected：表示KTO数据格式 · PromptSortedresponses：表示Prompt+多Response排序 · Prompt：表示Prompt集 · PromptImage：表示Prompt+图片 · PromptImageResponse：表示Prompt+Image+Response |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/dataset?Action=DescribeDatasets'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44axxxxx4525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker": "",
"maxKeys": 10,
"pageReverse":true,
"filter":{
"dataFormatList": ["PromptResponse", "PromptImage"]
}
}'响应示例
{
"requestId": "b4f5f3f2-307e-41d6-5afc-a6708cfa286b",
"result": {
"pageInfo": {
"marker": "",
"maxKeys": 2,
"isTruncated": false,
"nextMarker": "dg-xxx", // 下次查询请求的marker参数
"pageReverse": false
},
"datasets": [
{
"datasetId": "dg-xxx",
"datasetName": "helloDatasetList1",
"dataFormat": "PromptResponse"
},
{
"datasetId": "dg-xxx",
"datasetName": "helloDatasetList2",
"dataFormat": "PromptImage"
}
]
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。