查询数据集标签列表
功能介绍
查询数据集下所有标签列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
数据集ID。 |
|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
version_id |
否 |
String |
数据集版本ID。 |
|
offset |
否 |
Integer |
分页列表的起始页，默认为0。 |
|
limit |
否 |
Integer |
指定每一页返回的最大条目数，取值范围[1,100000]，默认为100000。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
labels |
Array of Label objects |
标签列表。 |
|
total_number |
Integer |
标签数量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attributes |
Array of LabelAttribute objects |
标签的多维度属性，如标签为“音乐”，可能包含属性“风格”、“歌手”等。 |
|
name |
String |
标签名称。 |
|
property |
LabelProperty object |
标签基本属性键值对，如颜色、快捷键等。 |
|
type |
Integer |
标签类型。可选值如下：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
default_value |
String |
标签属性默认值。 |
|
id |
String |
标签属性ID。可通过调用标签列表查询。 |
|
name |
String |
标签属性名称。不能超过64个字符，不能包含字符!<>=&"'。 |
|
type |
String |
标签属性类型。可选值如下：
|
|
values |
Array of LabelAttributeValue objects |
标签属性值列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
@modelarts:color |
String |
内置属性：标签展示的颜色，为色彩的16进制代码，默认为空。例如：“#FFFFF0”。 |
|
@modelarts:default_shape |
String |
内置属性：物体检测标签的默认形状（物体检测标签专用属性），默认为空。可选值如下：
|
|
@modelarts:from_type |
String |
内置属性：三元组关系标签的起始实体类型，创建关系标签时必须指定，该参数仅文本三元组数据集使用。 |
|
@modelarts:rename_to |
String |
内置属性：重命名后的标签名。 |
|
@modelarts:shortcut |
String |
内置属性：标签快捷键，默认为空。例如：“D”。 |
|
@modelarts:to_type |
String |
内置属性：三元组关系标签的指向实体类型，创建关系标签时必须指定，该参数仅文本三元组数据集使用。 |
请求示例
查询数据集下所有标签列表
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels
响应示例
状态码： 200
OK
{
"total_number" : 2,
"labels" : [ {
"name" : "Rabbits",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
}
}, {
"name" : "Bees",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
