获取数据集版本详情

更新时间：2025-01-17

功能介绍

本接口用于获取特定数据集版本的详情信息，如数据集名称、数据类型、版本信息等。

使用说明

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

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

main();

返回示例

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

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

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

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

请求参数

名称	类型	必填	描述
versionId	string	是	数据集版本ID，示例：ds-xxx，可以通过以下任一方式获取该字段值： · 方式一，通过调用创建数据集接口，返回的versionId字段获取 · 方式二，在千帆控制台-数据集管理列表页面查看，如下图所示：

返回参数

名称	类型	描述
requestId	string	请求ID
result	object	请求结果，请求成功时返回
code	string	错误码，错误时返回
message	string	错误信息，请求失败时返回

result说明

名称	类型	描述
datasetId	string	数据集ID
versionId	string	数据集版本ID
versionNumber	int	数据集版本序号
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
description	string	版本描述
storageType	string	存储类型，说明： · BOS：表示对象存储BOS · sysStorage：表示平台共享存储
storagePath	string	存储类型为对象存储BOS时，对应的完整存储路径
sizeMB	float	数据集大小，单位为MB，例：0.01
sampleCount	int	样本数
characterCount	int	字符数
annotationProgress	string	数据集标注进度，示例：1/10
importStatus	string	导入状态，说明： · 新建：Created · 导入中：Importing · 导入完成：ImportFinished · 导入失败：ImportFailed
publishStatus	string	发布状态，说明： · 未发布：Unpublished · 发布中：Publishing · 已发布：Published · 发布失败：PublishFailed
publishProgress	String	发布进度，说明： · 未发布：该字段值为0 · 发布中：该字段值为当前进度，如XX % · 已发布：该字段值为100% · 发布失败：该字段值为0
creator	string	创建人
createTime	string	创建时间，格式：YYYY-MM-DD hh:mm:ss
modifyTime	string	更新时间，格式：YYYY-MM-DD hh:mm:ss

获取数据集版本列表

删除数据集版本