错误码
4.4 样本管理
4.4.1 查询样本列表
状态码
状态码 描述
204 No Content 401 Unauthorized 403 Forbidden
错误码
请参见错误码。
4.4 样本管理
4.4.1 查询样本列表
功能介绍
分页查询样本列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
表4-99 路径参数
参数 是否必选 参数类型 描述
dataset_id 是 String 数据集ID。
参数 是否必选 参数类型 描述
project_id 是 String 用户项目ID。获取方法请参见获 取项目ID。
表4-100 Query 参数
参数 是否必选 参数类型 描述
email 否 String 标注团队成员邮箱。
high_score 否 String 置信度上界，默认为1。
label_name 否 String 标签名。
label_type 否 Integer 标注类型。可选值如下：
● 0：图像分类
● 1：物体检测
● 3: 图像分割
● 100：文本分类
● 101：命名实体
● 102：文本三元组
● 200：声音分类
● 201：语音内容
● 202：语音分割
● 400：表格数据集
● 600：视频标注
● 900：自由格式
limit 否 Integer 指定每一页返回的最大条目数，
取值范围[1,100]，默认为10。
locale 否 String 语言。可选值如下：
● en-us：英文（默认值）
● zh-cn：中文
low_score 否 String 置信度下界，默认为0。
offset 否 Integer 分页列表的起始页，默认为0。
order 否 String 指定查询的排序顺序。可选值如
下：
● asc：递增排序
● desc：递减排序（默认值）
参数 是否必选 参数类型 描述
preview 否 Boolean 是否支持预览。可选值如下：
● true：支持预览
● false：不支持预览 process_para
meter 否 String 图像缩略设置，同OBS缩略图设
置，详见OBS缩略设置。如：
image/resize,m_lfit,h_200表示 等比缩放目标缩略图并设置高度 为200像素。
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__：
待确认
sample_type 否 Integer 样本文件类型。可选值如下：
● 0：图像
ons 否 String URL编码后的多维筛选条件（多
个SearchCondition之间为and 的关系）。
version_id 否 String 数据集版本ID。
请求参数
无
响应参数
状态码： 200
表4-101 响应 Body 参数
参数 参数类型 描述
sample_count Integer 样本数量。
samples Array of DescribeSam pleResp objects
样本列表。
表4-102 DescribeSampleResp
参数 参数类型 描述
check_accept Boolean 是否验收通过，用于团队标注。可选值如下：
● true：验收通过
● false：验收不通过 check_comme
nt String 验收意见，用于团队标注。
check_score String 验收评分，用于团队标注。
deletion_reas
ons Array of
strings 样本的删除原因，用于医疗。
hard_details Map<String,H
ardDetail> 疑难详情，包括：疑难描述，疑难原因，疑难建 议。
labelers Array of Worker objects
样本分配的标注人列表，记录这张样本分给了哪 些团队成员，用于团队标注。
labels Array of SampleLabel objects
样本标签列表。
metadata SampleMeta
data object 样本metadata属性键值对。
参数 参数类型 描述
review_accept Boolean 是否审核通过，用于团队标注。可选值如下：
● true：审核通过
● false：审核不通过 review_comm
ent String 审核意见，用于团队标注。
review_score String 审核评分，用于团队标注。
sample_data Array of
strings 样本数据列表。
sample_dir String 样本所在路径。
sample_id String 样本ID。
sample_name String 样本名称。
sample_size Long 样本大小或文本长度，单位是字节。
sample_status String 样本状态。可选样本状态如下：
● __ALL__：已标注
● __NONE__：未标注
● __UNCHECK__：待验收
● __ACCEPTED__：验收通过
● __REJECTED__：已驳回
● __UNREVIEWED__：待审核
● __REVIEWED__：已审核
● __WORKFORCE_SAMPLED__：已验收采样
● __WORKFORCE_SAMPLED_UNCHECK__：采 样待验收
● __WORKFORCE_SAMPLED_CHECKED__：采 样已验收
● __WORKFORCE_SAMPLED_ACCEPTED__：采 样已通过
● __WORKFORCE_SAMPLED_REJECTED__：采 样已驳回
● __AUTO_ANNOTATION__：待确认 sample_time Long 样本时间，OBS最后修改时间。
参数 参数类型 描述
sample_type Integer 样本类型。可选值如下：
● 0：图像
● 1：文本
● 2：语音
● 4：表格
● 6：视频
● 9：自由格式
score String 综合评分，用于团队标注。
source String 样本数据源地址。
sub_sample_u
rl String 子样本URL，用于医疗。
worker_id String 团队标注人员的ID，用于团队标注。
表4-103 HardDetail
参数 参数类型 描述
alo_name String 别名。
id Integer 原因ID。
reason String 原因描述。
suggestion String 处理建议。
表4-104 Worker
参数 参数类型 描述
create_time Long 创建时间。
description String 标注成员描述，长度为0-256位，不能包含^!
<>=&"'特殊字符。
email String 标注成员邮箱。
role Integer 角色。可选值如下：
● 0：打标者
● 1：审核者
● 2：团队管理者
● 3：数据集拥有者
参数 参数类型 描述
status Integer 标注成员的当前登录状态。可选值如下：
● 0：未发送邀请邮件
● 1：已发送邀请邮件但未登录
● 2：已登录
● 3：标注成员已删除 update_time Long 更新时间。
worker_id String 标注成员ID。
workforce_id String 所属标注团队ID。
表4-105 SampleLabel
参数 参数类型 描述
annotated_by String 视频标注途径，用于区分标签是人工标注的还是 自动标注的。可选值如下：
● human：人工标注
● auto：自动标注
id String 标签ID。
name String 标签名。
property SampleLabel Property object
样本标签的属性键值对，如物体形状、形状特征 等。
score Float 置信度。
type Integer 标签类型。可选值如下：
● 0：图像分类
● 1：物体检测
● 3: 图像分割
● 100：文本分类
● 101：命名实体
● 102：文本三元组关系标签
● 103：文本三元组实体标签
● 200：语音分类
● 201：语音内容
● 202：语音分割
● 600：视频标注
表4-106 SampleLabelProperty
参数 参数类型 描述
@modelarts:c
ontent String 语音标签（包含语音内容和语音起止点）专用内 置属性：语音文本内容。
@modelarts:e
nd_index Integer 命名实体标签专用内置属性：文本的结束位置，
但不包括end_index所指的字符。例如：
● 文本内容为“Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.”，则其中人名
“Barack Hussein Obama II”的start_index 为0，end_index为23。
● 文本内容为“截止到2018年底，本公司人员规 模已经超过100”，则其中时间“2018年底”
的start_index为3，end_index为9。
@modelarts:e
nd_time String 语音起止点标签专用内置属性：语音的结束时 间，格式“hh:mm:ss.SSS”(其中hh表示小时，
mm表示分钟，ss表示秒，SSS表示毫秒)。
@modelarts:f
eature Object 物体检测标签专用内置属性：形状特征，类型为 List。以图片的左上角为坐标原点[0, 0]，每个坐 标点的表示方法为[x, y]，x表示横坐标，y表示纵 坐标(x和y均>=0)。每种形状的格式如下：
● bndbox [[0,10],[50,95]] 两个点组成，矩形的 左上角为第一个点，矩形的右下角为第二个点 (即第一个点x坐标一定小于第二个点的x坐 标，第一个点y坐标一定小于第二个点的y坐 标)。
● polygon [[0,100],[50,95],[10,60],[500,400]]
多个点组成，按顺序连接成一个多边形。
● circle [[100,100],[50]] 一个圆心点和半径组 成。
● line [[0,100],[50,95]] 两个点组成，第一个点 起始点，第二个点为终止点。
● dashed [[0,100],[50,95]] 两个点组成，第一 个点起始点，第二个点为终止点。
● point [[0,100]] 一个点组成。
● polyline [[0,100],[50,95],[10,60],[500,400]]
折线，多个点组成。
@modelarts:fr
om String 三元组关系标签专用内置属性：三元组关系标签
的起始实体ID。
@modelarts:h
ard String 内置属性：标签级别是否难例。可选值为：
● 0/false：非难例
● 1/true：难例
参数 参数类型 描述
@modelarts:h ard_coefficien t
String 内置属性：标签级别难度系数。范围为[0,1]。
参数 参数类型 描述
@modelarts:h
ard_reasons String 内置属性：标签级别难例原因。通过中划线间隔 单个难例原因ID，例如：“3-20-21-19”。难例
● 19：基于gaussianblur的数据增强与原图预测 结果不一致。
● 20：基于fliplr的数据增强与原图预测结果不一 致。
参数 参数类型 描述
● 21：基于crop的数据增强与原图预测结果不一 致。
● 22：基于flipud的数据增强与原图预测结果不 一致。
● 23：基于scale的数据增强与原图预测结果不 一致。
● 24：基于translate的数据增强与原图预测结果 不一致。
● 25：基于shear的数据增强与原图预测结果不 一致。
● 26：基于superpixels的数据增强与原图预测结 果不一致。
● 27：基于sharpen的数据增强与原图预测结果 不一致。
● 28：基于add的数据增强与原图预测结果不一 致。
● 29：基于invert的数据增强与原图预测结果不 一致。
● 30：数据被预测为异常点。
@modelarts:s
hape String 物体检测标签专用内置属性：物体形状，默认为 空。可选值如下：
● bndbox：矩形。
● polygon：多边形。
● circle：圆形。
● line：直线。
● dashed：虚线。
● point：点。
● polyline：折线。
@modelarts:s
ource String 语音起止点标签专用内置属性：语音来源(例如说 话人/旁白等)。
@modelarts:st
art_index Integer 命名实体标签专用内置属性：文本的起始位置，
值从0开始，包括start_index所指的字符。
@modelarts:st
art_time String 语音起止点标签专用内置属性：语音的起始时 间，格式“hh:mm:ss.SSS”(其中hh表示小时，
mm表示分钟，ss表示秒，SSS表示毫秒)。
@modelarts:t
o String 三元组关系标签专用内置属性：三元组关系标签
的指向实体ID。
表4-107 SampleMetadata
参数 参数类型 描述
@modelarts:h
ard Double 内置属性：样本级别是否难例。可选值为：
● 0：非难例
● 1：难例
@modelarts:h ard_coefficien t
Double 内置属性：样本级别难度系数。范围为[0,1]。
参数 参数类型 描述
@modelarts:h
ard_reasons Array of
integers 内置属性：样本级别难例原因ID列表。。难例原 因ID可选值如下：
● 19：基于gaussianblur的数据增强与原图预测 结果不一致。
● 20：基于fliplr的数据增强与原图预测结果不一 致。
● 21：基于crop的数据增强与原图预测结果不一 致。
参数 参数类型 描述
● 22：基于flipud的数据增强与原图预测结果不 一致。
● 23：基于scale的数据增强与原图预测结果不 一致。
● 24：基于translate的数据增强与原图预测结果 不一致。
● 25：基于shear的数据增强与原图预测结果不 一致。
● 26：基于superpixels的数据增强与原图预测结 果不一致。
● 27：基于sharpen的数据增强与原图预测结果 不一致。
● 28：基于add的数据增强与原图预测结果不一 致。
● 29：基于invert的数据增强与原图预测结果不 一致。
● 30：数据被预测为异常点。
@modelarts:si
ze Array of
objects 内置属性：图像尺寸（图像的宽度、高度、深 度），类型为List。列表中的第一个数字为宽度 (像素)，第二个数字为高度(像素)，第三个数字为 深度(深度可以没有，默认为3)，如[100,200,3]和 [100,200]均合法。 说明：只有当样本的标签列 表包含物体检测标签时，此字段必选。
请求示例
分页查询样本列表
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
响应示例
状态码： 200 OK
{ "sample_count" : 2, "samples" : [ {
"sample_id" : "012f99f3cf405860130b6ed2350c2228", "sample_type" : 0,
"source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/
36502.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606296688&x-image-process=image%2Fresize
%2Cm_lfit%2Ch_200&Signature=icyvHhFew9vnmy3zh1uZMP15Mbg%3D", "metadata" : {
"@modelarts:import_origin" : 0 },
"sample_time" : 1589190552106,
"sample_status" : "MANUAL_ANNOTATION", "annotated_by" : "human/test_123/test_123", "labelers" : [ {
"email" : "[email protected]",
"worker_id" : "5d8d4033b428fed5ac158942c33940a2", "role" : 0
} ] }, {
"sample_id" : "0192f3acfb000666033a0f85c21577c7", "sample_type" : 0,
"source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/
36139.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606296688&x-image-process=image%2Fresize
%2Cm_lfit%2Ch_200&Signature=RRr9r2cghLCXk%2B0%2BfHtYJi8eZ4k%3D", "metadata" : {
"@modelarts:import_origin" : 0 },
"sample_time" : 1589190543327,
"sample_status" : "MANUAL_ANNOTATION", "annotated_by" : "human/test_123/test_123", "labelers" : [ {
"email" : "[email protected]",
"worker_id" : "a2abd3f27b4e92c593c15282f8b6bd29", "role" : 0
401 Unauthorized 403 Forbidden 404 Not Found
错误码
您可以在API Explorer中调试该接口。