# 分页查询团队标注任务下的样本列表 #### 功能介绍 分页查询团队标注任务下的样本列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListWorkforceTaskSamples)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dataset_id | 是 | String | 数据集ID。 | | project_id | 是 | String | 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 | | workforce_task_id | 是 | String | 团队标注任务ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | 语言。可选值如下： - zh-cn：中文 - en-us：英文（默认值） | | offset | 否 | Integer | 分页列表的起始页，默认为0。 | | process_parameter | 否 | String | 图像缩略设置，同OBS缩略图设置，详见[OBS缩略图设置](https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html)。如：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__：待确认 | | search_conditions | 否 | String | URL编码后的多维筛选条件（多个SearchCondition之间为and的关系）。 | #### 请求参数 无 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | sample_count | Integer | 样本数量。 | | samples | Array of [DescribeSampleResp] objects | 样本列表。 | 表4DescribeSampleResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | check_accept | Boolean | 是否验收通过，用于团队标注。可选值如下： - true：验收通过 - false：验收不通过 | | check_comment | String | 验收意见，用于团队标注。 | | check_score | String | 验收评分，用于团队标注。 | | deletion_reasons | Array of strings | 样本的删除原因，用于医疗。 | | hard_details | Map\ | 疑难详情，包括：疑难描述，疑难原因，疑难建议。 | | labelers | Array of [Worker] objects | 样本分配的标注人列表，记录这张样本分给了哪些团队成员，用于团队标注。 | | labels | Array of [SampleLabel] objects | 样本标签列表。 | | metadata | [SampleMetadata] object | 样本metadata属性键值对。 | | review_accept | Boolean | 是否审核通过，用于团队标注。可选值如下： - true：审核通过 - false：审核不通过 | | 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 | 样本状态。可选样本状态如下： - __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_url | String | 子样本URL，用于医疗。 | | worker_id | String | 团队标注人员的ID，用于团队标注。 | 表5HardDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alo_name | String | 别名。 | | id | Integer | 原因ID。 | | reason | String | 原因描述。 | | suggestion | String | 处理建议。 | 表6Worker | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | 表7SampleLabel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | annotated_by | String | 视频标注途径，用于区分标签是人工标注的还是自动标注的。可选值如下： - human：人工标注 - auto：自动标注 | | id | String | 标签ID。 | | name | String | 标签名。 | | property | [SampleLabelProperty] object | 样本标签的属性键值对，如物体形状、形状特征等。 | | score | Float | 置信度，取值范围为\[0,1\] | | type | Integer | 标签类型。可选值如下： - 0：图像分类 - 1：物体检测 - 3: 图像分割 - 100：文本分类 - 101：命名实体 - 102：文本三元组关系标签 - 103：文本三元组实体标签 - 200：语音分类 - 201：语音内容 - 202：语音分割 - 600：视频标注 | 表8SampleLabelProperty | 参数 | 参数类型 | 描述 | |:---|:---|:---| | @modelarts:content | String | 语音标签（包含语音内容和语音起止点）专用内置属性：语音文本内容。 | | @modelarts:end_index | Integer | 命名实体标签专用内置属性：文本的结束位置，但不包括end_index所指的字符。例如： - 文本内容为"Barack Hussein Obama II (born on August 4, 1961) is an attorney and politician."，则其中人名"Barack Hussein Obama II"的start_index为0，end_index为23。 - 文本内容为"截止到2018年底，本公司人员规模已经超过100"，则其中时间"2018年底"的start_index为3，end_index为9。 | | @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)。每种形状的格式如下： - 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:from | String | 三元组关系标签专用内置属性：三元组关系标签的起始实体ID。 | | @modelarts:hard | String | 内置属性：标签级别是否难例。可选值为： - 0/false：非难例 - 1/true：难例 | | @modelarts:hard_coefficient | String | 内置属性：标签级别难度系数。范围为\[0,1\]。 | | @modelarts:hard_reasons | String | 内置属性：标签级别难例原因。通过中划线间隔单个难例原因ID，例如："3-20-21-19"。难例原因ID可选值如下： - 0：未识别出任何目标物体。 - 1：置信度偏低。 - 2：基于训练数据集的聚类结果和预测结果不一致。 - 3：预测结果和训练集同类别数据差异较大。 - 4：连续多张相似图片的预测结果不一致。 - 5：图像的分辨率与训练数据集的特征分布存在较大偏移。 - 6：图像的高宽比与训练数据集的特征分布存在较大偏移。 - 7：图像的亮度与训练数据集的特征分布存在较大偏移。 - 8：图像的饱和度与训练数据集的特征分布存在较大偏移。 - 9：图像的色彩丰富程度与训练数据集的特征分布存在较大偏移。 - 10：图像的清晰度与训练数据集的特征分布存在较大偏移。 - 11：图像的目标框数量与训练数据集的特征分布存在较大偏移。 - 12：图像中目标框的面积标准差与训练数据集的特征分布存在较大偏移。 - 13：图像中目标框的高宽比与训练数据集的特征分布存在较大偏移。 - 14：图像中目标框的面积占比与训练数据集的特征分布存在较大偏移。 - 15：图像中目标框的边缘化程度与训练数据集的特征分布存在较大偏移。 - 16：图像中目标框的亮度与训练数据集的特征分布存在较大偏移。 - 17：图像中目标框的清晰度与训练数据集的特征分布存在较大偏移。 - 18：图像中目标框的堆叠程度与训练数据集的特征分布存在较大偏移。 - 19：基于gaussianblur的数据增强与原图预测结果不一致。 - 20：基于fliplr的数据增强与原图预测结果不一致。 - 21：基于crop的数据增强与原图预测结果不一致。 - 22：基于flipud的数据增强与原图预测结果不一致。 - 23：基于scale的数据增强与原图预测结果不一致。 - 24：基于translate的数据增强与原图预测结果不一致。 - 25：基于shear的数据增强与原图预测结果不一致。 - 26：基于superpixels的数据增强与原图预测结果不一致。 - 27：基于sharpen的数据增强与原图预测结果不一致。 - 28：基于add的数据增强与原图预测结果不一致。 - 29：基于invert的数据增强与原图预测结果不一致。 - 30：数据被预测为异常点。 | | @modelarts:shape | String | 物体检测标签专用内置属性：物体形状，默认为空。可选值如下： - bndbox：矩形。 - polygon：多边形。 - circle：圆形。 - line：直线。 - dashed：虚线。 - point：点。 - polyline：折线。 | | @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。 | 表9SampleMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | @modelarts:import_origin | Integer | 内置属性：样本来源。 | | @modelarts:hard | Double | 内置属性：样本级别是否难例。可选值为： - 0：非难例 - 1：难例 | | @modelarts:hard_coefficient | Double | 内置属性：样本级别难度系数。范围为\[0,1\]。 | | @modelarts:hard_reasons | Array of integers | 内置属性：样本级别难例原因ID列表。难例原因ID可选值如下： - 0：未识别出任何目标物体。 - 1：置信度偏低。 - 2：基于训练数据集的聚类结果和预测结果不一致。 - 3：预测结果和训练集同类别数据差异较大。 - 4：连续多张相似图片的预测结果不一致。 - 5：图像的分辨率与训练数据集的特征分布存在较大偏移。 - 6：图像的高宽比与训练数据集的特征分布存在较大偏移。 - 7：图像的亮度与训练数据集的特征分布存在较大偏移。 - 8：图像的饱和度与训练数据集的特征分布存在较大偏移。 - 9：图像的色彩丰富程度与训练数据集的特征分布存在较大偏移。 - 10：图像的清晰度与训练数据集的特征分布存在较大偏移。 - 11：图像的目标框数量与训练数据集的特征分布存在较大偏移。 - 12：图像中目标框的面积标准差与训练数据集的特征分布存在较大偏移。 - 13：图像中目标框的高宽比与训练数据集的特征分布存在较大偏移。 - 14：图像中目标框的面积占比与训练数据集的特征分布存在较大偏移。 - 15：图像中目标框的边缘化程度与训练数据集的特征分布存在较大偏移。 - 16：图像中目标框的亮度与训练数据集的特征分布存在较大偏移。 - 17：图像中目标框的清晰度与训练数据集的特征分布存在较大偏移。 - 18：图像中目标框的堆叠程度与训练数据集的特征分布存在较大偏移。 - 19：基于gaussianblur的数据增强与原图预测结果不一致。 - 20：基于fliplr的数据增强与原图预测结果不一致。 - 21：基于crop的数据增强与原图预测结果不一致。 - 22：基于flipud的数据增强与原图预测结果不一致。 - 23：基于scale的数据增强与原图预测结果不一致。 - 24：基于translate的数据增强与原图预测结果不一致。 - 25：基于shear的数据增强与原图预测结果不一致。 - 26：基于superpixels的数据增强与原图预测结果不一致。 - 27：基于sharpen的数据增强与原图预测结果不一致。 - 28：基于add的数据增强与原图预测结果不一致。 - 29：基于invert的数据增强与原图预测结果不一致。 - 30：数据被预测为异常点。 | | @modelarts:size | Array of objects | 内置属性：图像尺寸（图像的宽度、高度、深度），类型为List\。列表中的第一个数字为宽度(像素)，第二个数字为高度(像素)，第三个数字为深度(深度可以没有，默认为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=P19WXXXXXXXXXXXX5M5&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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。