本文介绍自学习(viapi-regen)类目下的标注集列表ListLabelsets的语法及示例。

功能描述

根据数据集ID查看数据集下标注集详细数据。

说明
  • 您可以进入在线咨询获取在线人工帮助。
  • 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号:打开阿里云官网,在阿里云官网右上角,单击立即注册,按照操作提示完成账号注册。

2. 开通能力:请确保您已开通自学习服务,若未开通服务请立即开通

3. 创建AccessKey:请确保您已创建AccessKey,如果您使用的是子账号AccessKey,您需要给子账号赋予AliyunVIAPIFullAccess权限,具体操作,请参见RAM授权

4. 在线调试(可选):您可以通过OpenAPI Explorer在线调试能力,查看完整的调用示例代码及SDK依赖信息,也可以下载完整的工程。

5. 开发接入步骤:

  • SDK总览中选择您要接入使用的SDK语言。
  • 在对应语言的SDK文档中找到AI类目为自学习(viapi-regen)类目的SDK包进行安装。
  • 参考文档中提供的示例代码进行适当修改后调用。

6. 客户端直接调用:该能力常用的客户端调用方式包括以下几种。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListLabelsets

系统规定参数。取值:ListLabelsets

CurrentPage Long 1

当前页数。

PageSize Long 10

每页数据显示条数。

DatasetId Long 137

数据集ID。

Status String ["FILE_CHECKING","FILE_CHECK_SUCCESS"]

标注状态。取值如下:

  • FILE_CHECKING:文件格式校验中
  • FILE_CHECK_SUCCESS:文件格式校验成功
  • FILE_CHECK_FAIL:文件格式校验失败
  • TAG_SYSTEM_INIT:标注系统初始化中
  • TAGGING:标注中
  • TAG_FINISHED:标注完成

返回数据

名称 类型 示例值 描述
RequestId String 638E7B41-5327-0B79-A3A5-390278D7625F

每个请求分配唯一的服务器请求ID。

Data Object

出参数据实体。

CurrentPage Long 1

当前页数。

PageSize Long 10

每页数据显示条数。

TotalPage Long 1

总页数。

TotalCount Long 2

总数据量。

Elements Array of Object

标注中的数据值。

Elements字段参数说明

字段

类型

是否必须

描述

labelType

String

标注类型。取值:UPLOAD_FILE(上传标注文件),SELECT_FILE(选择标注文件),USE_LABEL_SYSTEM(选择标注系统)。

name

String

标注名称。

description

String

标注描述。

id

Long

标注集ID。

gmtCreate

Long

创建时间。

status

String

标注状态。取值:FILE_CHECKING(文件格式校验中),FILE_CHECK_SUCCESS(文件格式校验成功),FILE_CHECK_FAIL(文件格式校验失败)。

total

Long

当前标注集数据量。

tagUserList

String

需要更新打标人时,使用标注系统进行标注,仅在

LabelType=USE_LABEL_SYSTEM

下生效。

markedQuantity

Long

已标注数量。

unmarkedQuantity

Long

未标注数量。

PreLabelName

String

预标注名称。

SDK参考

阿里云视觉AI自学习类目下的标注集列表能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为自学习(viapi-regen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见SDK总览

示例

请求示例

http(s)://viapi-regen.cn-shanghai.aliyuncs.com/?Action=ListLabelsets   //更多关于访问域名(Endpoint)信息,请参见:https://help.aliyun.com/document_detail/143103.html
&CurrentPage=1
&PageSize=10
&DatasetId=137
&Status=["FILE_CHECKING","FILE_CHECK_SUCCESS"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLabelsetsResponse>
    <RequestId>638E7B41-5327-0B79-A3A5-390278D7625F</RequestId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <PageSize>10</PageSize>
        <TotalPage>1</TotalPage>
        <TotalCount>2</TotalCount>
        <Elements>
            <labelType>UPLOAD_FILE</labelType>
            <name>标注测试2</name>
            <description>标注测试2</description>
            <id>219</id>
            <gmtCreate>1633747459000</gmtCreate>
            <status>FILE_CHECK_SUCCESS</status>
            <unmarkedQuantity>0</unmarkedQuantity>
            <markedQuantity>20</markedQuantity>
            <total>20</total>
            <PreLabelName>测试时间数据集2</PreLabelName>
        </Elements>
        <Elements>
            <labelType>UPLOAD_FILE</labelType>
            <name>标注测试</name>
            <description>标注测试描述</description>
            <id>218</id>
            <gmtCreate>1633745786000</gmtCreate>
            <status>FILE_CHECK_SUCCESS</status>
            <unmarkedQuantity>0</unmarkedQuantity>
            <markedQuantity>10</markedQuantity>
            <total>10</total>
            <PreLabelName>测试时间数据集</PreLabelName>
        </Elements>
    </Data>
</ListLabelsetsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "638E7B41-5327-0B79-A3A5-390278D7625F",
  "Data" : {
    "CurrentPage" : 1,
    "PageSize" : 10,
    "TotalPage" : 1,
    "TotalCount" : 2,
    "Elements" : [ {
      "labelType" : "UPLOAD_FILE",
      "name" : "标注测试2",
      "description" : "标注测试2",
      "id" : 219,
      "gmtCreate" : 1633747459000,
      "status" : "FILE_CHECK_SUCCESS",
      "unmarkedQuantity" : 0,
      "markedQuantity" : 20,
      "total" : 20,
      "PreLabelName" : "测试时间数据集2"
    }, {
      "labelType" : "UPLOAD_FILE",
      "name" : "标注测试",
      "description" : "标注测试描述",
      "id" : 218,
      "gmtCreate" : 1633745786000,
      "status" : "FILE_CHECK_SUCCESS",
      "unmarkedQuantity" : 0,
      "markedQuantity" : 10,
      "total" : 10,
      "PreLabelName" : "测试时间数据集"
    } ]
  }
}

错误码

关于标注集列表的错误码,详情请参见常见错误码

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。