更新时间:2024-05-30 GMT+08:00

查询数据集的版本列表

功能介绍

查询指定数据集的版本列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/datasets/{dataset_id}/versions

表1 路径参数

参数

是否必选

参数类型

描述

dataset_id

String

数据集ID。

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

表2 Query参数

参数

是否必选

参数类型

描述

status

Integer

数据集版本状态。可选值如下:

  • 0:创建中

  • 1:运行中

  • 2:删除中

  • 3:已删除

  • 4:错误

train_evaluate_ratio

String

根据版本切分比例筛选版本。根据逗号分隔最小和最大切分比例,筛选出切分比例在此范围内的版本,例如:“0.0,1.0”。说明:如果参数值为空或无该参数,系统默认不根据版本切分比例筛选数据集。

version_format

Integer

数据集版本格式。可选值如下:

  • 0:默认格式

  • 1:Carbon格式(仅表格数据集支持)

  • 2:CSV格式

offset

Integer

分页列表的起始页,默认为0。

limit

Integer

指定每一页返回的最大条目数,取值范围[1,1000],默认为1000。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total_number

Integer

数据集版本总数。

versions

Array of DatasetVersion objects

数据集版本列表。

表4 DatasetVersion

参数

参数类型

描述

add_sample_count

Integer

新增样本数量。

analysis_cache_path

String

特征分析的缓存路径。

analysis_status

Integer

特征分析任务的当前状态。可选值如下:

  • 0:初始化

  • 1:运行中

  • 2:完成

  • 3:失败

analysis_task_id

String

特征分析的任务ID。

annotated_sample_count

Integer

版本已标注样本的数量。

annotated_sub_sample_count

Integer

已标注的子样本数量。

clear_hard_property

Boolean

发布时是否清空难例属性。可选值如下:

  • true:清空难例属性(默认值)

  • false:不清空难例属性

code

String

旋转裁剪等预处理任务的状态码。

create_time

Long

版本创建时间。

crop

Boolean

是否对图片进行裁剪,只对标注框形状为bndbox的物体检测数据集有效。可选值如下:

  • true:对图片进行裁剪

  • false:不对图片进行裁剪(默认值)

crop_path

String

裁剪后的文件存放路径。

crop_rotate_cache_path

String

旋转裁剪任务执行的临时目录。

data_analysis

Map<String,Object>

特征分析结果,json格式。

data_path

String

数据保存路径。

data_statistics

Map<String,Object>

数据集的样本统计信息,包括样本元信息的统计,json格式。

data_validate

Boolean

发布前数据是否经过校验算法校验。可选值如下:

  • true:数据经过校验

  • false:数据未经过校验

deleted_sample_count

Integer

已删除的样本数量。

deletion_stats

Map<String,Integer>

删除原因统计信息。

description

String

版本描述信息。

export_images

Boolean

发布时是否导出图片到版本输出目录。可选值如下:

  • true:导出图片到版本输出目录

  • false:不导出图片到版本输出目录(默认值)

extract_serial_number

Boolean

发布时是否需要解析子样本序号,用于医疗数据集。可选值如下:

  • true:解析子样本序号

  • false:不解析子样本序号(默认值)

include_dataset_data

Boolean

发布时是否包含数据集源数据。可选值如下:

  • true:包含数据集源数据

  • false:不包含数据集源数据

is_current

Boolean

是否为数据集当前版本。可选值如下:

  • true:数据集当前版本

  • false:非数据集当前版本

label_stats

Array of LabelStats objects

发布版本的各标签统计信息列表。

label_type

String

发布版本的标签类型。可选值如下:

  • multi:表示含有多标签样本

  • single:表示所有样本均为单标签

manifest_cache_input_path

String

版本发布时的manifest文件缓存输入路径。

manifest_path

String

版本发布的manifest文件保存路径。

message

String

发布时记录的任务信息(如:错误信息等)。

modified_sample_count

Integer

已修改的样本数量。

previous_annotated_sample_count

Integer

父版本的已标注样本数量。

previous_total_sample_count

Integer

父版本的样本总数。

previous_version_id

String

父版本ID。

processor_task_id

String

旋转裁剪等预处理任务ID。

processor_task_status

Integer

旋转裁剪等预处理任务状态。当前可选值如下:

  • 0:初始化

  • 1:运行中

  • 2:完成

  • 3:失败

  • 4:停止

  • 5:超时

  • 6:删除失败

  • 7:停止失败

remove_sample_usage

Boolean

发布时是否清除数据集已有的usage信息。可选值如下:

  • true:清除数据集已有的usage信息(默认值)

  • false:不清除数据集已有的usage信息

rotate

Boolean

是否对图片进行旋转。可选值如下:

  • true:对图片进行旋转

  • false:不对图片进行旋转(默认值)

rotate_path

String

旋转后的文件存放路径。

sample_state

String

样本状态。可选样本状态如下:

  • __ALL__:已标注

  • __NONE__:未标注

  • __UNCHECK__:待验收

  • __ACCEPTED__:验收通过

  • __REJECTED__:已驳回

  • __UNREVIEWED__:待审核

  • __REVIEWED__:已审核

  • __WORKFORCE_SAMPLED__:已采样

  • __WORKFORCE_SAMPLED_UNCHECK__:采样待验收

  • __WORKFORCE_SAMPLED_CHECKED__:采样已验收

  • __WORKFORCE_SAMPLED_ACCEPTED__:采样已通过

  • __WORKFORCE_SAMPLED_REJECTED__:采样已驳回

  • __AUTO_ANNOTATION__:待确认

start_processor_task

Boolean

发布时是否启动数据分析任务。可选值如下:

  • true:发布时启动特征分析任务

  • false:发布时不启动特征分析任务(默认值)

status

Integer

数据集版本状态。可选值如下:

  • 0:创建中

  • 1:运行中

  • 2:删除中

  • 3:已删除

  • 4:错误

tags

Array of strings

版本关键标识列表,标注任务发布版本时将标注类型作为默认标签。如:["图片","物体检测"]。

task_type

Integer

发布版本的标注任务类型,同数据集类型。

total_sample_count

Integer

版本样本总数。

total_sub_sample_count

Integer

从父样本生成的子样本总数。

train_evaluate_sample_ratio

String

发布版本时切分训练验证比例,默认为1.00,即全部分为训练集。

update_time

Long

版本更新时间。

version_format

String

数据集版本格式。可选值如下:

  • Default:默认格式

  • CarbonData:Carbon格式(仅表格数据集支持)

  • CSV:CSV格式

version_id

String

数据集版本ID。

version_name

String

数据集版本名称。

with_column_header

Boolean

发布的CSV文件的第一行是否为列名,对于表格数据集有效。可选值如下:

  • true:发布的CSV文件的第一行是列名

  • false:发布的CSV文件的第一行不是列名

表5 LabelStats

参数

参数类型

描述

attributes

Array of LabelAttribute objects

标签的多维度属性,如标签为“音乐”,可能包含属性“风格”、“歌手”等。

count

Integer

该标签的打标数量。

name

String

标签名称。

property

LabelProperty object

标签基本属性键值对,如颜色、快捷键等。

sample_count

Integer

包含该标签的样本数量。

type

Integer

标签类型。可选值如下:

  • 0:图像分类

  • 1:物体检测

  • 3: 图像分割

  • 100:文本分类

  • 101:命名实体

  • 102:文本三元组关系标签

  • 103:文本三元组实体标签

  • 200:语音分类

  • 201:语音内容

  • 202:语音分割

  • 600:视频标注

表6 LabelAttribute

参数

参数类型

描述

default_value

String

标签属性默认值。

id

String

标签属性ID。可通过调用标签列表查询。

name

String

标签属性名称。不能超过64个字符,不能包含字符!<>=&"'。

type

String

标签属性类型。可选值如下:

  • text:文本

  • select:单选下拉列表

values

Array of LabelAttributeValue objects

标签属性值列表。

表7 LabelAttributeValue

参数

参数类型

描述

id

String

标签属性值ID。

value

String

标签属性值。

表8 LabelProperty

参数

参数类型

描述

@modelarts:color

String

内置属性:标签展示的颜色,为色彩的16进制代码,默认为空。例如:“#FFFFF0”。

@modelarts:default_shape

String

内置属性:物体检测标签的默认形状(物体检测标签专用属性),默认为空。可选值如下:

  • bndbox:矩形。

  • polygon:多边形。

  • circle:圆形。

  • line:直线。

  • dashed:虚线。

  • point:点。

  • polyline:折线。

@modelarts:from_type

String

内置属性:三元组关系标签的起始实体类型,创建关系标签时必须指定,该参数仅文本三元组数据集使用。

@modelarts:rename_to

String

内置属性:重命名后的标签名。

@modelarts:shortcut

String

内置属性:标签快捷键,默认为空。例如:“D”。

@modelarts:to_type

String

内置属性:三元组关系标签的指向实体类型,创建关系标签时必须指定,该参数仅文本三元组数据集使用。

请求示例

查询指定数据集的版本列表

GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions

响应示例

状态码: 200

OK

{
  "total_number" : 3,
  "versions" : [ {
    "version_id" : "54IXbeJhfttGpL46lbv",
    "version_name" : "V003",
    "version_format" : "Default",
    "previous_version_id" : "eSOKEQaXhKzxN00WKoV",
    "status" : 1,
    "create_time" : 1605930512183,
    "total_sample_count" : 10,
    "annotated_sample_count" : 10,
    "total_sub_sample_count" : 0,
    "annotated_sub_sample_count" : 0,
    "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/V003.manifest",
    "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/data/",
    "is_current" : true,
    "analysis_status" : 3,
    "train_evaluate_sample_ratio" : "0.8",
    "remove_sample_usage" : false,
    "export_images" : false,
    "description" : "",
    "task_type" : 0,
    "extract_serial_number" : false
  }, {
    "version_id" : "eSOKEQaXhKzxN00WKoV",
    "version_name" : "V002",
    "version_format" : "Default",
    "previous_version_id" : "vlGvUqOcxxGPIB0ugeE",
    "status" : 1,
    "create_time" : 1605691027084,
    "total_sample_count" : 10,
    "annotated_sample_count" : 10,
    "total_sub_sample_count" : 0,
    "annotated_sub_sample_count" : 0,
    "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/V002.manifest",
    "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/data/",
    "is_current" : false,
    "analysis_status" : 3,
    "train_evaluate_sample_ratio" : "0.9999",
    "remove_sample_usage" : false,
    "export_images" : false,
    "description" : "",
    "task_type" : 0,
    "extract_serial_number" : false
  }, {
    "version_id" : "vlGvUqOcxxGPIB0ugeE",
    "version_name" : "V001",
    "version_format" : "Default",
    "status" : 1,
    "create_time" : 1605690687346,
    "total_sample_count" : 10,
    "annotated_sample_count" : 10,
    "total_sub_sample_count" : 0,
    "annotated_sub_sample_count" : 0,
    "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/V001.manifest",
    "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/data/",
    "is_current" : false,
    "analysis_status" : 3,
    "train_evaluate_sample_ratio" : "0.99",
    "remove_sample_usage" : false,
    "export_images" : false,
    "description" : "",
    "task_type" : 0,
    "extract_serial_number" : false
  } ]
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码