错误码
4.3 数据集版本管理
4.3.1 查询数据集的版本列表
}}
状态码
状态码 描述
200 OK
401 Unauthorized 403 Forbidden 404 Not Found
错误码
请参见错误码。
4.3 数据集版本管理
4.3.1 查询数据集的版本列表
功能介绍
查询指定数据集的版本列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/datasets/{dataset_id}/versions
表4-81 路径参数
参数 是否必选 参数类型 描述
dataset_id 是 String 数据集ID。
project_id 是 String 用户项目ID。获取方法请参见获 取项目ID。
表4-82 Query 参数
参数 是否必选 参数类型 描述
status 否 Integer 数据集版本状态。可选值如下：
● 0：创建中
● 1：运行中
● 2：删除中
● 3：已删除
● 4：错误 train_evaluate
_ratio 否 String 根据版本切分比例筛选版本。根
据逗号分隔最小和最大切分比 例，筛选出切分比例在此范围内 的版本，例如：“0.0,1.0”。说 明：如果参数值为空或无该参 数，系统默认不根据版本切分比 例筛选数据集。
version_forma
t 否 Integer 数据集版本格式。可选值如下：
● 0：默认格式
● 1：Carbon格式（仅表格数 据集支持）
● 2：CSV格式
offset 否 Integer 分页列表的起始页，默认为0。
limit 否 Integer 指定每一页返回的最大条目数，
取值范围[1,1000]，默认为 1000。
请求参数
无
响应参数
状态码： 200
表4-83 响应 Body 参数
参数 参数类型 描述
total_number Integer 数据集版本总数。
versions Array of DatasetVersi on objects
数据集版本列表。
表4-84 DatasetVersion
参数 参数类型 描述
add_sample_c
ount Integer 新增样本数量。
analysis_cach
e_path String 特征分析的缓存路径。
analysis_statu
s Integer 特征分析任务的当前状态。可选值如下：
● 0：初始化
● 1：运行中
● 2：完成
● 3：失败 analysis_task_
id String 特征分析的任务ID。
annotated_sa
mple_count Integer 版本已标注样本的数量。
annotated_su b_sample_cou nt
Integer 已标注的子样本数量。
clear_hard_pr
operty Boolean 发布时是否清空难例属性。可选值如下：
● true：清空难例属性（默认值）
● false：不清空难例属性
code String 旋转裁剪等预处理任务的状态码。
create_time Long 版本创建时间。
crop Boolean 是否对图片进行裁剪，只对标注框形状为bndbox 的物体检测数据集有效。可选值如下：
● true：对图片进行裁剪
● false：不对图片进行裁剪（默认值）
crop_path String 裁剪后的文件存放路径。
参数 参数类型 描述 crop_rotate_c
ache_path String 旋转裁剪任务执行的临时目录。
data_analysis Map<String,O
bject> 特征分析结果，json格式。
data_path String 数据保存路径。
data_statistics Map<String,O
bject> 数据集的样本统计信息，包括样本元信息的统 计，json格式。
data_validate Boolean 发布前数据是否经过校验算法校验。可选值如 下：
● true：数据经过校验
● false：数据未经过校验 deleted_samp
le_count Integer 已删除的样本数量。
deletion_stats Map<String,In
teger> 删除原因统计信息。
description String 版本描述信息。
export_image
number Boolean 发布时是否需要解析子样本序号，用于医疗数据 集。可选值如下：
● true：解析子样本序号
● false：不解析子样本序号（默认值）
include_datas
et_data Boolean 发布时是否包含数据集源数据。可选值如下：
● true：包含数据集源数据
● false：不包含数据集源数据
is_current Boolean 是否为数据集当前版本。可选值如下：
● true：数据集当前版本
● false：非数据集当前版本 label_stats Array of
LabelStats objects
发布版本的各标签统计信息列表。
label_type String 发布版本的标签类型。可选值如下：
● multi：表示含有多标签样本
● single：表示所有样本均为单标签
参数 参数类型 描述 manifest_cach
e_input_path String 版本发布时的manifest文件缓存输入路径。
manifest_path String 版本发布的manifest文件保存路径。
message String 发布时记录的任务信息（如：错误信息等）。
modified_sam
ple_count Integer 已修改的样本数量。
previous_ann otated_sampl e_count
Integer 父版本的已标注样本数量。
previous_total _sample_coun t
Integer 父版本的样本总数。
previous_versi
on_id String 父版本ID。
processor_tas
k_id String 旋转裁剪等预处理任务ID。
processor_tas
k_status Integer 旋转裁剪等预处理任务状态。当前可取值如下：
● 0：初始化
● 1：运行中
● 2：完成
● 3：失败
● 4：停止
● 5：超时
● 6：删除失败
● 7：停止失败 remove_samp
le_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_processo
r_task Boolean 发布时是否启动数据分析任务。可选值如下：
● true：发布时启动特征分析任务
● false：发布时不启动特征分析任务（默认值）
status Integer 数据集版本状态。可选值如下：
● 0：创建中
● 1：运行中
● 2：删除中
● 3：已删除
● 4：错误 tags Array of
strings 版本关键标识列表，标注任务发布版本时将标注 类型作为默认标签。如：["图片","物体检测"]。
task_type Integer 发布版本的标注任务类型，同数据集类型。
total_sample_
count Integer 版本样本总数。
total_sub_sam
ple_count Integer 从父样本生成的子样本总数。
train_evaluate
_sample_ratio String 发布版本时切分训练验证比例，默认为1.00，即 全部分为训练集。
update_time Long 版本更新时间。
参数 参数类型 描述 version_forma
t String 数据集版本格式。可选值如下：
● Default：默认格式
● CarbonData：Carbon格式（仅表格数据集支 持）
● CSV：CSV格式 version_id String 数据集版本ID。
version_name String 数据集版本名称。
with_column_
header Boolean 发布的CSV文件的第一行是否为列名，对于表格 数据集有效。可选值如下：
● true：发布的CSV文件的第一行是列名
● false：发布的CSV文件的第一行不是列名
表4-85 LabelStats
参数 参数类型 描述
attributes Array of LabelAttribut e objects
标签的多维度属性，如标签为“音乐”，可能包 含属性“风格”、“歌手”等。
count Integer 该标签的打标数量。
name String 标签名称。
property LabelPropert
y object 标签基本属性键值对，如颜色、快捷键等。
sample_count Integer 包含该标签的样本数量。
type Integer 标签类型。可选值如下：
● 0：图像分类
● 1：物体检测
● 3: 图像分割
● 100：文本分类
● 101：命名实体
● 102：文本三元组关系标签
● 103：文本三元组实体标签
● 200：语音分类
● 201：语音内容
● 202：语音分割
● 600：视频标注
表4-86 LabelAttribute
参数 参数类型 描述
default_value String 标签属性默认值。
id String 标签属性ID。
name String 标签属性名称。
type String 标签属性类型。可选值如下：
● text：文本
● select：单选下拉列表 values Array of
LabelAttribut eValue objects
标签属性值列表。
表4-87 LabelAttributeValue
参数 参数类型 描述
id String 标签属性值ID。
value String 标签属性值。
表4-88 LabelProperty
参数 参数类型 描述
@modelarts:c
olor String 内置属性：标签展示的颜色，为色彩的16进制代 码，默认为空。例如：“#FFFFF0”。
@modelarts:d
efault_shape String 内置属性：物体检测标签的默认形状（物体检测 标签专用属性），默认为空。可选值如下：
● bndbox：矩形。
● polygon：多边形。
● circle：圆形。
● line：直线。
● dashed：虚线。
● point：点。
● polyline：折线。
@modelarts:fr
om_type String 内置属性：三元组关系标签的起始实体类型，创 建关系标签时必须指定，该参数仅文本三元组数 据集使用。
参数 参数类型 描述
@modelarts:r
ename_to String 内置属性：重命名后的标签名。
@modelarts:s
hortcut String 内置属性：标签快捷键，默认为空。例如：
“D”。
@modelarts:t
o_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
错误码
您可以在API Explorer中调试该接口。