# 查询团队标注任务详情 #### 功能介绍 查询团队标注任务详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=DescWorkforceTask)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} 表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_stats | 否 | Boolean | 是否返回标签统计信息。可选值如下： - true：返回标签统计信息 - false：不返回标签统计信息（默认值） | | sample_stats | 否 | Boolean | 是否返回样本统计信息。可选值如下： - true：返回样本统计信息 - false：不返回样本统计信息（默认值） | | workforce_stats | 否 | Boolean | 是否返回人员统计信息。可选值如下： - true：返回人员统计信息 - false：不返回人员统计信息（默认值） | #### 请求参数 无 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | auto_sync_dataset | Boolean | 团队标注任务的标注结果是否自动同步至数据集。可选值如下： - true：团队标注任务的标注结果自动同步至数据集 - false：团队标注任务的标注结果不自动同步至数据集 | | check_rate | Double | 团队标注任务验收比例。 | | checking_task_desc | [WorkforceSamplingTaskDesc] object | 团队标注任务当前验收任务详情。 | | create_time | Long | 标注任务创建时间。 | | dataset_id | String | 数据集ID。 | | description | String | 标注任务描述信息。 | | label_stats | Array of [LabelStats] objects | 标注任务标签统计信息。 | | pass_rate | Double | 团队标注任务验收通过率。 | | repetition | Integer | 团队标注任务每个样本可以由多少人标注，最少为1。 | | sample_search_conditions | Array of [SearchCondition] objects | 创建任务时的样本筛选条件。 | | sample_stats | [SampleStats] object | 标注任务样本统计信息。 | | score | Double | 团队标注任务平均验收审核评分。 | | status | Integer | 团队标注任务状态，可选值如下： - 0：启动中。owner/manager启动任务，此时仍在分发待标注文件，owner/manager/labeler/reviewer可见任务列表，但任务未分配完成，无法同时再启动任务。 - 1：运行中。labeler/reviewer进行标注和审核工作，owner验收，如新增、同步智能标注、导入未标注文件需再次分发新增文件。 - 2：验收中。owner发起验收任务，但并未完成验收，此时不允许发起新的验收任务，只能继续完成当前验收任务。 - 3：通过。团队标注任务已完成。 - 4：驳回。manager再次启动任务，重新修改标注和审核工作。 - 5：验收结果同步中。验收任务改为异步，新增验收结果同步中的状态，此时不允许发起新的验收任务，也不允许继续当前验收，任务名称的地方提示用户同步中。 - 6：已创建。owner创建完任务，未启动，仅owner/manager可见任务列表。 - 7：验收采样中。发起验收改为异步，新增验收采样中的状态，此时不允许发起新的验收任务，也不允许继续当前验收，任务名称的地方提示用户验收采样中。 | | synchronize_auto_labeling_data | Boolean | 团队标注任务是否同步智能标注结果。可选值如下： - true：执行完智能标注后，将待确认结果同步至团队成员。 - false：不同步智能标注结果（默认值）。 | | synchronize_data | Boolean | 团队标注任务是否同步更新新增数据。可选值如下： - true：上传文件、同步数据源、导入的未标注文件同步分配至团队成员。 - false：不同步更新新增数据（默认值）。 | | task_id | String | 标注任务ID。 | | task_name | String | 标注任务名称。 | | update_time | Long | 标注任务更新时间。 | | version_id | String | 标注任务关联的数据集版本ID。 | | worker_stats | Array of [WorkerTask] objects | 团队标注任务成员标注进展统计信息。 | | workforce_stats | [WorkforceStats] object | 团队标注任务人员统计信息。 | | workforces_config | [WorkforcesConfig] object | 团队标注任务团队信息：委托团队管理员分配，或指定团队自行分配。 | 表4WorkforceSamplingTaskDesc | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | Integer | 验收操作。可选值如下： - 0：完成验收时，通过全部样本（包括单张驳回）。 - 1：完成验收时，驳回全部样本（包括单张通过）。 - 4：完成验收时, 只通过单张验收通过的样本及未处理的样本。 - 5：完成验收时, 只驳回单张验收驳回的样本及未处理的样本。 | | checking_stats | [CheckTaskStats] object | 验收任务实时验收报告。 | | checking_task_id | String | 当前验收任务ID。 | | overwrite_last_result | Boolean | 验收时若样本已标注，是否使用验收结果覆盖已标注结果。可选值如下： - true：覆盖已标注结果 - false：不覆盖已标注结果（默认值） | | total_stats | [CheckTaskStats] object | 历史验收任务汇总后的验收报告。 | 表5CheckTaskStats | 参数 | 参数类型 | 描述 | |:---|:---|:---| | accepted_sample_count | Integer | 通过的样本数目。 | | checked_sample_count | Integer | 已验收的样本数目。 | | pass_rate | Double | 样本的通过率。 | | rejected_sample_count | Integer | 驳回的样本数目。 | | sampled_sample_count | Integer | 抽样的样本数目。 | | sampling_num | Integer | 验收任务的抽样数目。 | | sampling_rate | Double | 验收任务的抽样比例。 | | score | String | 验收评分。 | | task_id | String | 验收任务ID。 | | total_sample_count | Integer | 总的样本数目。 | | total_score | Long | 验收总分。 | | unchecked_sample_count | Integer | 未验收的样本数目。 | 表6LabelStats | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：视频标注 | 表7LabelAttribute | 参数 | 参数类型 | 描述 | |:---|:---|:---| | default_value | String | 标签属性默认值。 | | id | String | 标签属性ID。可通过调用标签列表查询。 | | name | String | 标签属性名称。不能超过64个字符，不能包含字符!\<\>=\&"'。 | | type | String | 标签属性类型。可选值如下： - text：文本 - select：单选下拉列表 | | values | Array of [LabelAttributeValue] objects | 标签属性值列表。 | 表8LabelAttributeValue | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 标签属性值ID。 | | value | String | 标签属性值。 | 表9LabelProperty | 参数 | 参数类型 | 描述 | |:---|:---|:---| | @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 | 内置属性：三元组关系标签的指向实体类型，创建关系标签时必须指定，该参数仅文本三元组数据集使用。 | 表10SearchCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | coefficient | String | 根据难度系数筛选。 | | frame_in_video | Integer | 视频中某帧。 | | hard | String | 样本级别是否难例。可选值如下： - 0：非难例样本 - 1：难例样本 | | import_origin | String | 根据数据来源筛选。 | | kvp | String | CT剂量，通过剂量来筛选。 | | label_list | [SearchLabels] object | 标签搜索条件。 | | labeler | String | 标注人。 | | metadata | [SearchProp] object | 通过样本属性搜索。 | | parent_sample_id | String | 父样本ID。 | | sample_dir | String | 根据样本所在目录搜索（目录需要以/结尾），只搜索指定目录下的样本，不支持目录递归搜索。 | | sample_name | String | 根据样本名称搜索（含后缀名）。 | | sample_time | String | 样本加入到数据集时，会根据样本在OBS上的最后修改时间(精确到天)建立索引，此处可以根据此时间进行搜索。可选值如下： - month：搜索往前30天至今天内添加的样本 - day：搜索昨天(往前1天)至今天内添加的样本 - yyyyMMdd-yyyyMMdd：搜索指定时间段内添加的样本，格式为"起始日期-结束日期"，查询天数不能超过**30**天。例如："20190901-2019091501"表示搜索2019年9月1日至2019年9月15日期间的样本。 | | score | String | 根据置信度筛选。 | | slice_thickness | String | DICOM层厚，通过层厚筛选样本。 | | study_date | String | DICOM扫描时间。 | | time_in_video | String | 视频中某个时间。 | 表11SearchLabels | 参数 | 参数类型 | 描述 | |:---|:---|:---| | labels | Array of [SearchLabel] objects | 标签搜索条件列表。 | | op | String | 如要搜索多个标签，则op需要有值；如果只搜索一个标签，则无需指定op的值。可选值如下： - OR：或操作 - AND：与操作 | 表12SearchLabel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 标签名。 | | op | String | 多个属性之间的操作类型。可选值如下： - OR：或操作 - AND：与操作 | | property | Map\\> | 标签属性，是Object格式，存放任意的键值对；key是属性名称，value是取值列表，如value为null表示不根据值搜索，否则搜索的值满足列表中任意一个即可。 | | type | Integer | 标签类型。可选值如下： - 0：图像分类 - 1：物体检测 - 3: 图像分割 - 100：文本分类 - 101：命名实体 - 102：文本三元组关系标签 - 103：文本三元组实体标签 - 200：语音分类 - 201：语音内容 - 202：语音分割 - 600：视频标注 | 表13SearchProp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | op | String | 多个属性值之间的关系。可选值如下： - AND：与关系 - OR：或关系 | | props | Map\\> | 属性的搜索条件，可以有多个属性条件。 | 表14WorkerTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_time | Long | 团队标注成员任务创建时间。 | | dataset_id | String | 成员任务关联的数据集ID。 | | dataset_type | Integer | 团队标注成员任务标注类型。 | | email | String | 团队标注成员邮箱。 | | email_status | Integer | 团队标注成员任务邮件通知状态。可选值如下： - 0：表示未发送过 - 1：表示邮箱格式错误 - 2：表示邮箱地址不可达， - 3：表示发送成功 | | last_notify_time | Long | 团队标注成员任务邮件最近一次通知时间戳。 | | pass_rate | Double | 团队标注成员任务验收审核通过率。 | | role | Integer | 团队标注成员角色。 | | sample_stats | [SampleStats] object | 团队标注成员任务样本统计信息。 | | score | Double | 团队标注成员任务样本验收审核平均评分。 | | task_id | String | 成员任务关联的团队标注任务ID。 | | task_status | Integer | 团队标注成员任务状态。可选值如下： - 6：已创建。 - 0：启动中。 - 1：运行中。 - 2：验收中。 - 3：通过，即团队标注任务已完成。 - 4：驳回，即需要重新修改标注和审核工作。 | | update_time | Long | 团队标注成员任务更新时间。 | | worker_id | String | 团队标注成员ID。 | | workforce_task_name | String | 成员任务关联的团队标注任务名称。 | 表15SampleStats | 参数 | 参数类型 | 描述 | |:---|:---|:---| | accepted_sample_count | Integer | owner验收通过样本数目。 | | auto_annotation_sample_count | Integer | 智能标注待确认样本数目。 | | deleted_sample_count | Integer | 已删除的样本数目。 | | rejected_sample_count | Integer | owner验收不通过的样本数目。 | | sampled_sample_count | Integer | 待owner验收且被抽样的样本数目。 | | total_sample_count | Integer | 样本总数量。 | | unannotated_sample_count | Integer | 未标注样本数。 | | uncheck_sample_count | Integer | reviewer审核通过待owner验收的样本数目。 | | unreviewed_sample_count | Integer | labeler标注完未被reviewer审核的样本数目。 | 表16WorkforceStats | 参数 | 参数类型 | 描述 | |:---|:---|:---| | labeler_count | Integer | 标注人员数量，不能超过100个。 | | reviewer_count | Integer | 审核人员数量，不能超过100个。 | | workforce_count | Integer | 团队数量。 | 表17WorkforcesConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | agency | String | 管理员。 | | workforces | Array of [WorkforceConfig] objects | 执行标注任务的团队列表。 | 表18WorkforceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | workers | Array of [Worker] objects | 标注成员列表。 | | workforce_id | String | 标注团队ID。 | | workforce_name | String | 标注团队名称，名称不能包含!\<\>=\&"'，长度为0-1024位。 | 表19Worker | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | #### 请求示例 查询团队标注任务详情 ``` GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} ``` #### 响应示例 **状态码： 200** OK ``` { "dataset_id" : "WxCREuCkBSAlQr9xrde", "task_id" : "iYZx7gScPUozOXner9k", "task_name" : "task-e63f", "status" : 1, "create_time" : 1606184400278, "update_time" : 1606184400278, "repetition" : 1, "workforces_config" : { "workforces" : [ { "workforce_id" : "q3ZFSwORu1ztKljDLYQ", "workers" : [ { "email" : "xxx@xxx.com", "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", "role" : 0 } ] } ] }, "synchronize_data" : false, "synchronize_auto_labeling_data" : false, "workforce_stats" : { "workforce_count" : 1, "labeler_count" : 1, "reviewer_count" : 0 }, "sample_stats" : { "total_sample_count" : 317, "unannotated_sample_count" : 310, "unreviewed_sample_count" : 0, "uncheck_sample_count" : 0, "sampled_sample_count" : 0, "rejected_sample_count" : 0, "accepted_sample_count" : 7, "auto_annotation_sample_count" : 0 }, "checking_task_desc" : { "checking_task_id" : "onSbri2oqYOmDjDyW17", "action" : 0, "overwrite_last_result" : false }, "auto_sync_dataset" : true, "worker_stats" : [ { "email" : "xxx@xxx.com", "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", "role" : 0, "task_id" : "iYZx7gScPUozOXner9k", "workforce_task_name" : "task-e63f", "dataset_id" : "WxCREuCkBSAlQr9xrde", "sample_stats" : { "total_sample_count" : 317, "unannotated_sample_count" : 310, "unreviewed_sample_count" : 0, "uncheck_sample_count" : 0, "sampled_sample_count" : 0, "rejected_sample_count" : 0, "accepted_sample_count" : 7, "auto_annotation_sample_count" : 0 }, "create_time" : 1606184400278, "update_time" : 1606184795050, "email_status" : 3, "last_notify_time" : 0 } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。