更新时间:2024-05-30 GMT+08:00

创建数据集标签

功能介绍

创建数据集标签。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels

表1 路径参数

参数

是否必选

参数类型

描述

dataset_id

String

数据集ID。

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

labels

Array of Label objects

待创建的标签列表。

表3 Label

参数

是否必选

参数类型

描述

attributes

Array of LabelAttribute objects

标签的多维度属性,如标签为“音乐”,可能包含属性“风格”、“歌手”等。

name

String

标签名称。

property

LabelProperty object

标签基本属性键值对,如颜色、快捷键等。

type

Integer

标签类型。可选值如下:

  • 0:图像分类

  • 1:物体检测

  • 3: 图像分割

  • 100:文本分类

  • 101:命名实体

  • 102:文本三元组关系标签

  • 103:文本三元组实体标签

  • 200:语音分类

  • 201:语音内容

  • 202:语音分割

  • 600:视频标注

表4 LabelAttribute

参数

是否必选

参数类型

描述

default_value

String

标签属性默认值。

id

String

标签属性ID。可通过调用标签列表查询。

name

String

标签属性名称。不能超过64个字符,不能包含字符!<>=&"'。

type

String

标签属性类型。可选值如下:

  • text:文本

  • select:单选下拉列表

values

Array of LabelAttributeValue objects

标签属性值列表。

表5 LabelAttributeValue

参数

是否必选

参数类型

描述

id

String

标签属性值ID。

value

String

标签属性值。

表6 LabelProperty

参数

是否必选

参数类型

描述

@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

内置属性:三元组关系标签的指向实体类型,创建关系标签时必须指定,该参数仅文本三元组数据集使用。

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

error_code

String

操作失败的错误码。

error_msg

String

操作失败的错误信息。

results

Array of BatchResponse objects

创建标签响应体。

success

Boolean

操作是否执行成功。可选值如下:

  • true:执行成功

  • false:执行失败

表8 BatchResponse

参数

参数类型

描述

error_code

String

操作失败的错误码。

error_msg

String

操作失败的错误信息。

success

Boolean

操作是否执行成功。可选值如下:

  • true:执行成功

  • false:执行失败

请求示例

创建数据集标签。设置标签名称为“Cat”,物体检测标签的默认形状为“bndbox”。

{
  "labels" : [ {
    "name" : "Cat",
    "property" : {
      "@modelarts:color" : "#3399ff",
      "@modelarts:default_shape" : "bndbox"
    }
  } ]
}

响应示例

状态码: 200

OK

{
  "success" : true
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码