分页查询团队标注任务下的样本列表
功能介绍
分页查询团队标注任务下的样本列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
dataset_id | 是 | String | 数据集ID。 |
project_id | 是 | String | 用户项目ID。获取方法请参见获取项目ID和名称。 |
workforce_task_id | 是 | String | 团队标注任务ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
label_name | 否 | String | 标签名。 |
label_type | 否 | Integer | 标注类型。可选值如下: |
limit | 否 | Integer | 指定每一页返回的最大条目数,取值范围[1,100],默认为10。 |
locale | 否 | String | 语言。可选值如下:
|
offset | 否 | Integer | 分页列表的起始页,默认为0。 |
process_parameter | 否 | String | 图像缩略设置,同OBS缩略图设置,详见OBS缩略图设置。如:image/resize,m_lfit,h_200表示等比缩放目标缩略图并设置高度为200像素。 |
sample_state | 否 | String | 样本状态。可选样本状态如下: |
search_conditions | 否 | String | URL编码后的多维筛选条件(多个SearchCondition之间为and的关系)。 |
请求参数
无
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
sample_count | Integer | 样本数量。 |
samples | Array of DescribeSampleResp objects | 样本列表。 |
参数 | 参数类型 | 描述 |
|---|---|---|
check_accept | Boolean | 是否验收通过,用于团队标注。可选值如下: |
check_comment | String | 验收意见,用于团队标注。 |
check_score | String | 验收评分,用于团队标注。 |
deletion_reasons | Array of strings | 样本的删除原因,用于医疗。 |
hard_details | Map<String,HardDetail> | 疑难详情,包括:疑难描述,疑难原因,疑难建议。 |
labelers | Array of Worker objects | 样本分配的标注人列表,记录这张样本分给了哪些团队成员,用于团队标注。 |
labels | Array of SampleLabel objects | 样本标签列表。 |
metadata | SampleMetadata object | 样本metadata属性键值对。 |
review_accept | Boolean | 是否审核通过,用于团队标注。可选值如下: |
review_comment | 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 | 样本状态。可选样本状态如下: |
sample_time | Long | 样本时间,OBS最后修改时间。 |
sample_type | Integer | 样本类型。可选值如下: |
score | String | 综合评分,用于团队标注。 |
source | String | 样本数据源地址。 |
sub_sample_url | String | 子样本URL,用于医疗。 |
worker_id | String | 团队标注人员的ID,用于团队标注。 |
参数 | 参数类型 | 描述 |
|---|---|---|
create_time | Long | 创建时间。 |
description | String | 标注成员描述,长度为0-256位,不能包含^!<>=&"'特殊字符。 |
String | 标注成员邮箱。 | |
role | Integer | 角色。可选值如下: |
status | Integer | 标注成员的当前登录状态。可选值如下: |
update_time | Long | 更新时间。 |
worker_id | String | 标注成员ID。 |
workforce_id | String | 所属标注团队ID。 |
参数 | 参数类型 | 描述 |
|---|---|---|
annotated_by | String | 视频标注途径,用于区分标签是人工标注的还是自动标注的。可选值如下: |
id | String | 标签ID。 |
name | String | 标签名。 |
property | SampleLabelProperty object | 样本标签的属性键值对,如物体形状、形状特征等。 |
score | Float | 置信度,取值范围为[0,1] |
type | Integer | 标签类型。可选值如下: |
参数 | 参数类型 | 描述 |
|---|---|---|
@modelarts:content | String | 语音标签(包含语音内容和语音起止点)专用内置属性:语音文本内容。 |
@modelarts:end_index | Integer | 命名实体标签专用内置属性:文本的结束位置,但不包括end_index所指的字符。例如: |
@modelarts:end_time | String | 语音起止点标签专用内置属性:语音的结束时间,格式“hh:mm:ss.SSS”(其中hh表示小时,mm表示分钟,ss表示秒,SSS表示毫秒)。 |
@modelarts:feature | Object | 物体检测标签专用内置属性:形状特征,类型为List。以图片的左上角为坐标原点[0, 0],每个坐标点的表示方法为[x, y],x表示横坐标,y表示纵坐标(x和y均>=0)。每种形状的格式如下: |
@modelarts:from | String | 三元组关系标签专用内置属性:三元组关系标签的起始实体ID。 |
@modelarts:hard | String | 内置属性:标签级别是否难例。可选值为: |
@modelarts:hard_coefficient | String | 内置属性:标签级别难度系数。范围为[0,1]。 |
@modelarts:hard_reasons | String | 内置属性:标签级别难例原因。通过中划线间隔单个难例原因ID,例如:“3-20-21-19”。难例原因ID可选值如下: |
@modelarts:shape | String | 物体检测标签专用内置属性:物体形状,默认为空。可选值如下: |
@modelarts:source | String | 语音起止点标签专用内置属性:语音来源(例如说话人/旁白等)。 |
@modelarts:start_index | Integer | 命名实体标签专用内置属性:文本的起始位置,值从0开始,包括start_index所指的字符。 |
@modelarts:start_time | String | 语音起止点标签专用内置属性:语音的起始时间,格式“hh:mm:ss.SSS”(其中hh表示小时,mm表示分钟,ss表示秒,SSS表示毫秒)。 |
@modelarts:to | String | 三元组关系标签专用内置属性:三元组关系标签的指向实体ID。 |
参数 | 参数类型 | 描述 |
|---|---|---|
@modelarts:import_origin | Integer | 内置属性:样本来源。 |
@modelarts:hard | Double | 内置属性:样本级别是否难例。可选值为: |
@modelarts:hard_coefficient | Double | 内置属性:样本级别难度系数。范围为[0,1]。 |
@modelarts:hard_reasons | Array of integers | 内置属性:样本级别难例原因ID列表。难例原因ID可选值如下: |
@modelarts:size | Array of objects | 内置属性:图像尺寸(图像的宽度、高度、深度),类型为List<Integer>。列表中的第一个数字为宽度(像素),第二个数字为高度(像素),第三个数字为深度(深度可以没有,默认为3),如[100,200,3]和[100,200]均合法。 说明:只有当样本的标签列表包含物体检测标签时,此字段必选。 |
请求示例
分页查询团队标注任务下的样本列表
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples 响应示例
状态码: 200
OK
{
"sample_count" : 2,
"samples" : [ {
"sample_id" : "26c6dd793d80d3274eb89349ec76d678",
"sample_type" : 0,
"labels" : [ ],
"source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000016.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtCa6W_J4DxT0nYIfx...",
"metadata" : {
"@modelarts:import_origin" : 0,
"@modelarts:size" : [ 1242, 375, 3 ]
},
"sample_time" : 1598263639997,
"sample_status" : "UN_ANNOTATION",
"worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
"labelers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "afdda13895bc66322ffbf36ae833bcf0",
"role" : 0
} ]
}, {
"sample_id" : "2971815bbb11a462161b48dddf19344f",
"sample_type" : 0,
"labels" : [ ],
"source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000011.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtC...",
"metadata" : {
"@modelarts:import_origin" : 0,
"@modelarts:size" : [ 1242, 375, 3 ]
},
"sample_time" : 1598263639997,
"sample_status" : "UN_ANNOTATION",
"worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
"labelers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "305595e1901a526017d2e11f3ab0ffe1",
"role" : 0
} ]
} ]
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
错误码
请参见错误码。

