文档首页> AI开发平台ModelArts> API参考> 历史API> 数据管理（旧版）> 获取样本搜索条件
更新时间：2023-12-14 GMT+08:00
查看PDF

获取样本搜索条件

功能介绍

获取样本搜索条件。

调试

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

URI

GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-condition

表1 路径参数

参数

是否必选

参数类型

描述

dataset_id

是

String

数据集ID。

project_id

是

String

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

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

labelers

Array of strings

标注者列表。

labels

Array of Label objects

标签列表。

metadata

Map<String,Array<String>>

数据集的属性键值对。
表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

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

请求示例

获取样本搜索条件

GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/search-condition

响应示例

状态码： 200

OK

{
  "labels" : [ {
    "name" : "Rabbits",
    "type" : 0,
    "property" : {
      "@modelarts:color" : "#3399ff"
    }
  }, {
    "name" : "Bees",
    "type" : 0,
    "property" : {
      "@modelarts:color" : "#3399ff"
    }
  } ],
  "metadata" : { },
  "labelers" : [ "human/test_123/test_123", "human/xxx@xxx.com", "human/xxx@xxx.com" ]
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。