文档

ListFaceGroups - 获取一个媒体集中的人脸分组列表

更新时间:

调用ListFaceGroups接口获取一个媒体集中的人脸分组列表。

接口说明

  • 此接口已不再维护,建议使用新版(2020-09-30 版本)接口 QueryFigureClusters 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

  • 如果需要根据标记信息等查询人脸分组,必须已调用 UpdateFaceGroup 接口为人脸分组配置相应信息。

说明 接口公测中,如有任何使用问题,请使用钉钉搜索钉钉群号 31690030817 加入钉钉群进行反馈。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immimagetest
SetIdstring

媒体集的唯一标识。

set001
Markerstring

从 Marker 开始按字典序返回人脸分组信息列表。如果不设置此参数,则从头开始返回人脸分组信息。

CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==
Limitinteger

返回人脸分组的最大个数,默认值为 20,取值范围为 1~100。

5
Orderstring

排序方式,默认值为 DESC。

  • ASC:升序
  • DESC:降序
DESC
OrderBystring

排序字段,默认值为 FaceCount。

  • CreateTime:人脸分组的创建时间。
  • ModifyTime:人脸分组的修改时间。
  • FaceCount:人脸分组中的人脸数量。
FaceCount
RemarksAQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
RemarksBQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
RemarksCQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
RemarksDQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
RemarksArrayAQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
RemarksArrayBQuerystring

标记信息查询条件,包括如下四种查询方式,可根据实际选择其中若干项条件进行查询。

  • PREFIX:前缀匹配。
  • NOT-PREFIX:非前缀匹配。
  • IN:全字匹配,必须完全符合 IN 中指定的任意一个字符串。
  • NOT-IN:全字匹配,必须不符合 NOT-IN 中指定的任意一个字符串。
{"PREFIX": "start-with-this","NOT-PREFIX": "not-start-with-this","IN": ["ONE","OF","THIS"],"NOT-IN": ["NONE","FROM","THOSE"]}
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。查询类型为精确匹配。

externalId001

返回参数

名称类型描述示例值
object
RequestIdstring

当次请求的 Request ID。

6CD6F064-6999-4B64-B057-5FBD09E48C46
NextMarkerstring

下一次列出人脸分组信息时以此值为 Marker,将未返回的结果返回。

当人脸分组未全部返回时,此参数才有值。

CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==
FaceGroupsobject []

人脸分组信息列表。

Genderstring

人脸的性别。

MALE
CreateTimestring

人脸分组的创建时间。

2021-01-11T02:18:26.174Z
RemarksCstring

人脸分组的标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

浙江省杭州市
GroupCoverFaceobject

人脸分组封面图信息。

FaceIdstring

人脸分组封面图的 FaceId,可以使用媒体集图片处理相关接口(例如 GetImage、ListImages 等)获得该 FaceId。

FaceId 必须为同一分组 (即 GroupId 相同)中的人脸 ID。

b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594
ImageUristring

图片的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

oss://imm-test/testcases/face1.jpg
FaceBoundaryobject

人脸位置框信息。

Topinteger

顶点 Y 坐标,距离顶端距离。单位为 px。

49
Widthinteger

人脸位置框宽度。单位为 px。

46
Heightinteger

人脸位置框高度。单位为 px。

45
Leftinteger

顶点 X 坐标,距离左端距离。单位为 px。

80
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3
ImageHeightlong

图片高度。

374
ImageWidthlong

图片宽度。

739
FaceCountinteger

人脸分组中的人脸数量。

5
RemarksArrayBstring

标记信息列表,格式为数组。

["remarksb1","remarksb2"]
RemarksDstring

人脸分组的标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

浙江省杭州市
MaxAgefloat

人脸分组中人脸的最大年龄。

28
GroupIdstring

人脸分组的唯一标识。

Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130
GroupNamestring

人脸分组名称。

facegrouptest
RemarksAstring

人脸分组的标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

oss://imm-test/testcases/
AverageAgefloat

人脸分组中人脸的平均年龄。

26.4
RemarksArrayAstring

标记信息列表,格式为数组。

["remarksa1","remarksa2"]
MinAgefloat

人脸分组中人脸的最小年龄。

23
ImageCountinteger

人脸分组中的图片数量。

5
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

externalIdtest
RemarksBstring

人脸分组的标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

face1.jpg
ModifyTimestring

人脸分组的修改时间。

2021-01-11T02:18:26.174Z

示例

正常返回示例

JSON格式

{
  "RequestId": "6CD6F064-6999-4B64-B057-5FBD09E48C46",
  "NextMarker": "CAESEQoPCg0KCUZhY2VDb3VudBABGAEirQEKCQAFAAAAAAAAAAqfAQOaAAAAMVMzMTM3MzQzNjM0MzkzNTM4MzUzNzM2MzAzMjM3MzQzNTNhNjk2ZDZkNjk2ZDYxNjc2NTNhNzM2NTc0NzQ2NTczNzQuUzQ3NzI2Zjc1NzAyZDM0Mzg2NjY0NjQzNDYyNjQyZDM2MzI2MzMzMmQzNDY0NjE2MTJkNjE2NDM5MzgyZDYxNjUzNjYxMzQzMTM3MzM2MTMxMzMzMA==",
  "FaceGroups": [
    {
      "Gender": "MALE",
      "CreateTime": "2021-01-11T02:18:26.174Z",
      "RemarksC": "浙江省杭州市",
      "GroupCoverFace": {
        "FaceId": "b30a7a36997ce986965680fed90c397fc70a533af511346f819976c6a138c594",
        "ImageUri": "oss://imm-test/testcases/face1.jpg",
        "FaceBoundary": {
          "Top": 49,
          "Width": 46,
          "Height": 45,
          "Left": 80
        },
        "ExternalId": "61e24632982b3e7598f74d4a95a2706cb11b3408#61e2463254140e7b68044db1aeca52771ae6bdb3",
        "ImageHeight": 374,
        "ImageWidth": 739
      },
      "FaceCount": 5,
      "RemarksArrayB": "[\"remarksb1\",\"remarksb2\"]",
      "RemarksD": "浙江省杭州市",
      "MaxAge": 28,
      "GroupId": "Group-48fdd4bd-62c3-4daa-ad98-ae6a4173a130",
      "GroupName": "facegrouptest",
      "RemarksA": "oss://imm-test/testcases/",
      "AverageAge": 26.4,
      "RemarksArrayA": "[\"remarksa1\",\"remarksa2\"]",
      "MinAge": 23,
      "ImageCount": 5,
      "ExternalId": "externalIdtest",
      "RemarksB": "face1.jpg",
      "ModifyTime": "2021-01-11T02:18:26.174Z"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈