批量更新样本标签
功能介绍
批量更新样本标签,包括添加、修改和删除样本标签。当请求体中单个样本的“labels”参数传空列表时,表示删除该样本的标签。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dataset_id |
是 |
String |
数据集ID。 |
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
|
否 |
String |
团队标注成员邮箱。 |
samples |
否 |
Array of SampleLabels objects |
更新的样本列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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]均合法。 说明:只有当样本的标签列表包含物体检测标签时,此字段必选。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
操作失败的错误码。 |
error_msg |
String |
操作失败的错误信息。 |
results |
Array of BatchResponse objects |
批量更新样本标签的响应结果列表。 |
success |
Boolean |
操作是否执行成功。可选值如下:
|
请求示例
批量更新样本标签
{ "samples" : [ { "sample_id" : "8b583c44bf249f8ba43ea42c92920221", "labels" : [ { "name" : "yunbao" } ] }, { "sample_id" : "b5fe3039879660a2e6bf18166e247f68", "labels" : [ { "name" : "yunbao" } ] } ] }
响应示例
状态码: 200
OK
{ "success" : true }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。