分页查询智能任务列表
功能介绍
分页查询智能任务列表,包括“智能标注”和“自动分组”两大类智能任务。可通过指定“type”参数来单独查询某类任务的列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/datasets/{dataset_id}/tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dataset_id |
是 |
String |
数据集ID。 |
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
exist_running_deploy_task |
Boolean |
该数据集是否存在正在运行(包括初始化)的一键模型上线任务。可选值如下: |
tasks |
Array of RunningTask objects |
任务列表。 |
total_count |
Integer |
任务总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
annotated_sample_count |
Integer |
已标注样本数量。 |
code |
String |
错误码。 |
config |
SmartTaskConfig object |
任务配置。 |
create_time |
String |
任务创建时间。 |
dataset_id |
String |
数据集ID。 |
elapsed_time |
Long |
执行时间。 |
error_code |
String |
错误码。 |
error_detail |
String |
错误详情。 |
error_msg |
String |
错误信息。 |
message |
String |
错误信息。 |
model_id |
String |
模型ID。 |
model_name |
String |
模型名称。 |
model_version |
String |
模型版本。 |
progress |
Float |
任务当前进度百分比。 |
result |
Result object |
任务结果。 |
status |
Integer |
任务状态。 |
task_id |
String |
任务ID。 |
task_name |
String |
任务名称。 |
total_sample_count |
Integer |
样本总数量。 |
type |
Integer |
任务类型。 |
unconfirmed_sample_count |
Integer |
待确认样本数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
algorithm_type |
String |
自动标注的算法类型。可选值如下: |
ambiguity |
Boolean |
是否通过图片模糊度来聚类。 |
annotation_output |
String |
主动学习标注结果输出路径。 |
collect_rule |
String |
样本收集规则,默认为全量收集规则“all”。当前仅支持全量收集规则“all”。 |
collect_sample |
Boolean |
是否启用样本收集。可选值如下: |
confidence_scope |
String |
关键样本置信度范围,用中划线隔开最小值和最大值。比如:“0.10-0.90”。 |
description |
String |
任务描述。 |
engine_name |
String |
引擎名称。 |
export_format |
Integer |
导出的目录格式。可选值如下: |
export_params |
ExportParams object |
导出数据集任务的参数。 |
flavor |
Flavor object |
训练资源规格。 |
image_brightness |
Boolean |
是否通过图片亮度来聚类。 |
image_colorfulness |
Boolean |
是否通过图片色彩来聚类。 |
inf_cluster_id |
String |
专属集群ID,默认为空,不使用专属集群;使用专属集群部署服务时需确保集群状态正常;配置此参数后,则使用集群的网络配置,vpc_id参数不生效。 |
inf_config_list |
Array of InfConfig objects |
运行推理任务需要的配置列表,可选填,默认为空。 |
inf_output |
String |
主动学习中推理的输出路径。 |
infer_result_output_dir |
String |
样本预测结果输出OBS目录,可以不输入,默认使用output_dir目录下的{service_id}-infer-result子目录。 |
key_sample_output |
String |
主动学习中难例的输出路径。 |
log_url |
String |
训练作业的日志OBS输出路径URL,默认为空。 |
manifest_path |
String |
manifest路径,给训练、推理作为输入。 |
model_id |
String |
模型ID。 |
model_name |
String |
模型名称。 |
model_parameter |
String |
模型参数。 |
model_version |
String |
模型版本。 |
n_clusters |
Integer |
聚类数。 |
name |
String |
任务名称。 |
output_dir |
String |
样本输出路径,格式:数据集输出路径+数据集名称+“-”+数据集ID+“/annotation/auto-deploy/”。例如:“/test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/”。 |
parameters |
Array of TrainingParameter objects |
训练作业的运行参数列表。 |
pool_id |
String |
资源池ID。 |
property |
String |
属性名。 |
req_uri |
String |
批量任务中调用的推理路径。 |
result_type |
Integer |
自动分组结果处理方式。可选值如下: |
samples |
Array of SampleLabels objects |
需要进行自动标注的样本标注信息列表。 |
stop_time |
Integer |
超时等待时间(单位是分钟),默认15分钟,此参数仅视频自动标注场景使用。 |
time |
String |
主动学习中的时间戳。 |
train_data_path |
String |
已有训练数据集路径。 |
train_url |
String |
训练作业的输出文件OBS路径URL,默认为空。 |
version_format |
String |
数据集版本格式。可选值如下: |
worker_server_num |
Integer |
训练作业worker的个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
clear_hard_property |
Boolean |
是否清空难例属性。可选值如下: |
export_dataset_version_format |
String |
导出数据集版本的格式。 |
export_dataset_version_name |
String |
导出数据集版本的名称。 |
export_dest |
String |
数据集导出类型。可选值如下: |
export_new_dataset_name |
String |
导出新数据集的名称。 |
export_new_dataset_work_path |
String |
导出新数据集的工作目录。 |
ratio_sample_usage |
Boolean |
指定切分比例后,是否按指定比例随机分配训练-验证集。可选值如下: |
sample_state |
String |
样本状态。可选样本状态如下: |
samples |
Array of strings |
导出的样本ID列表。 |
search_conditions |
Array of SearchCondition objects |
导出的筛选条件,多个条件之间是或(OR)关系。 |
train_sample_ratio |
String |
指定发布版本时训练集-验证集的切分比例,默认为1.00,即全部分为训练集。 |
参数 |
参数类型 |
描述 |
---|---|---|
coefficient |
String |
根据难度系数筛选。 |
frame_in_video |
Integer |
视频中某帧。 |
hard |
String |
样本级别是否难例。可选值如下: |
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上的最后修改时间(精确到天)建立索引,此处可以根据此时间进行搜索。可选值如下: |
score |
String |
根据置信度筛选。 |
slice_thickness |
String |
DICOM层厚,通过层厚筛选样本。 |
study_date |
String |
DICOM扫描时间。 |
time_in_video |
String |
视频中某个时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
labels |
Array of SearchLabel objects |
标签搜索条件列表。 |
op |
String |
如要搜索多个标签,则op需要有值;如果只搜索一个标签,则无需指定op的值。可选值如下: |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
标签名。 |
op |
String |
多个属性之间的操作类型。可选值如下: |
property |
Map<String,Array<String>> |
标签属性,是Object格式,存放任意的键值对;key是属性名称,value是取值列表,如value为null表示不根据值搜索,否则搜索的值满足列表中任意一个即可。 |
type |
Integer |
标签类型。可选值如下: |
参数 |
参数类型 |
描述 |
---|---|---|
op |
String |
多个属性值之间的关系。可选值如下: |
props |
Map<String,Array<String>> |
属性的搜索条件,可以有多个属性条件。 |
参数 |
参数类型 |
描述 |
---|---|---|
envs |
Map<String,String> |
运行模型需要的环境变量键值对,可选填,默认为空。为确保您的数据安全,在环境变量中,请勿输入敏感信息。 |
instance_count |
Integer |
模型部署的实例数,即计算节点的个数。 |
model_id |
String |
模型ID。 |
specification |
String |
在线服务的资源规格。详见部署服务 |
weight |
Integer |
权重百分比,分配到此模型的流量权重;仅当infer_type为real-time时需要配置,多个权重相加必须等于100。 |
参数 |
参数类型 |
描述 |
---|---|---|
annotated_sample_count |
Integer |
已标注样本数量。 |
confidence_scope |
String |
置信度范围,取值范围为[0,1]。 |
dataset_name |
String |
数据集名称,名称只能是中文、字母、数字、下划线或中划线组成的合法字符串,长度为1-100位。 |
dataset_type |
String |
数据集类型。可选值如下: |
description |
String |
描述。 |
dlf_model_job_name |
String |
DLF模型推理作业名称。 |
dlf_service_job_name |
String |
DLF在线服务作业名称。 |
dlf_train_job_name |
String |
DLF训练作业名称。 |
events |
Array of Event objects |
事件。 |
hard_example_path |
String |
难例的存放路径。 |
hard_select_tasks |
Array of HardSelectTask objects |
难例筛选作业列表。 |
manifest_path |
String |
manifest文件的存放路径。 |
model_id |
String |
模型ID。 |
model_name |
String |
模型名称。 |
model_version |
String |
模型版本。 |
samples |
Array of SampleLabels objects |
视频在线服务推理结果。 |
service_id |
String |
在线服务ID。 |
service_name |
String |
在线服务名称。 |
service_resource |
String |
用户绑定的在线服务资源ID。 |
total_sample_count |
Integer |
样本总数量。 |
train_data_path |
String |
训练数据的存放路径。 |
train_job_id |
String |
训练作业ID。 |
train_job_name |
String |
训练作业名称。 |
unconfirmed_sample_count |
Integer |
待确认样本数量。 |
version_id |
String |
数据集版本ID。 |
version_name |
String |
数据集版本名称。 |
workspace_id |
String |
工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
Long |
事件创建时间。 |
description |
String |
描述。 |
elapsed_time |
Long |
时间执行时间。 |
error_code |
String |
错误码。 |
error_message |
String |
错误信息。 |
events |
Array of Event objects |
子事件列表。 |
level |
Integer |
事件级别。 |
name |
String |
事件名称。 |
ordinal |
Integer |
排序序号。 |
parent_name |
String |
上层事件名称。 |
status |
String |
状态。可选值如下: |
参数 |
参数类型 |
描述 |
---|---|---|
create_at |
Long |
创建时间。 |
dataset_id |
String |
数据集ID。 |
dataset_name |
String |
数据集名称。 |
hard_select_task_id |
String |
难例筛选任务ID。 |
task_status |
String |
任务状态。 |
time |
Long |
执行时间。 |
update_at |
Long |
更新时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
labels |
Array of SampleLabel objects |
样本标签列表,为空表示删除样本的所有标签。 |
metadata |
SampleMetadata object |
样本metadata属性键值对。 |
sample_id |
String |
样本ID。 |
sample_type |
Integer |
样本类型。可选值如下: |
sample_usage |
String |
样本用处。可选值如下: |
source |
String |
样本数据源地址,通过调用样本列表接口获取。 |
worker_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[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]。列表中的第一个数字为宽度(像素),第二个数字为高度(像素),第三个数字为深度(深度可以没有,默认为3),如[100,200,3]和[100,200]均合法。 说明:只有当样本的标签列表包含物体检测标签时,此字段必选。 |
请求示例
分页查询智能标注或自动分组任务列表
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks?offset=0&limit=10
响应示例
状态码: 200
OK
{ "tasks" : [ { "dataset_id" : "OBegCXHxTJ2JHRAZWr0", "task_id" : "14cyxyu6UXaNT3lrPFl", "type" : 1, "create_time" : "2020-11-03 15:22:39", "status" : 3, "code" : "ModelArts.4996", "message" : "prelabel task execute successfully.", "elapsed_time" : 531, "result" : { "service_id" : "ee2ade80-0967-4ef3-b6da-e8c873017b9a", "service_name" : "prelabel_infer_1604388201993_xubo_cls_snt9_2_993", "hard_select_tasks" : [ { "hard_select_task_id" : "86711ab3-8ceb-4b0e-bd52-8545b184a2a7", "dataset_id" : "OBegCXHxTJ2JHRAZWr0", "dataset_name" : "xubo_cls_snt9_2", "task_status" : "import_dataset_completed", "time" : 262, "create_at" : 0, "update_at" : 0 } ] }, "progress" : 100.0, "total_sample_count" : 246, "annotated_sample_count" : 38, "unconfirmed_sample_count" : 208, "model_id" : "c717a39f-c64f-45df-a9d3-be9ed79cdcb4", "model_name" : "auto-deploy-50041602581620628", "model_version" : "0.0.1", "config" : { "ambiguity" : false, "name" : "5fXxR01TyUoiobqNEd9", "worker_server_num" : 0, "inf_config_list" : [ { "specification" : "modelarts.vm.cpu.2u", "weight" : 0, "instance_count" : 1 } ], "collect_sample" : false, "confidence_scope" : "0.0-0.5", "algorithm_type" : "supervisory", "image_brightness" : false, "image_colorfulness" : false } }, { "dataset_id" : "OBegCXHxTJ2JHRAZWr0", "task_id" : "5QPy73VwnwHi5NqvbcP", "type" : 0, "create_time" : "2020-10-31 16:11:37", "status" : 3, "code" : "ModelArts.4996", "message" : "task executed successfully.", "elapsed_time" : 397, "result" : { "train_job_name" : "BNFURaEyftGNMITaBiv", "train_job_id" : "74679", "version_id" : "89745" }, "progress" : 100.0, "total_sample_count" : 246, "annotated_sample_count" : 38, "unconfirmed_sample_count" : 198, "model_name" : "Supervisory", "model_version" : "0.0.1", "config" : { "ambiguity" : false, "worker_server_num" : 0, "collect_sample" : false, "algorithm_type" : "fast", "image_brightness" : false, "image_colorfulness" : false } } ], "total_count" : 2, "exist_running_deploy_task" : false }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。