功能描述
查询人脸样本列表能力用于查询人脸数据库中的人脸样本列表。
这两张图片展示了列出人脸实体接口的请求参数和返回数据结构。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| DbName | String | 是 | default | 数据库名称 |
| Offset | Integer | 否 | 1 | 起始记录，取值范围0~2000 |
| Limit | Integer | 否 | 50 | 每页最多显示的样本数目，取值范围1~200 |
| Token | String | 否 | 2 | 当查询结果超过2000条时，需用上一次请求返回的Token作为请求下一页的参数 |
| Labels | String | 否 | 鹿班 | 标签，最多支持10个，多个标签以英文逗号分割 |
| EntityIdPrefix | String | 否 | U1 | 样本ID前缀，包含数字、字母和下划线 |
| Order | String | 否 | asc | 排列方式，包括asc（升序）和desc（降序） |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2 | 请求ID |
| Data | Object | - | 返回的结果数据内容 |
| Token | String | 2 | 当查询结果超过2000条时，可使用Token查询下一页数据 |
| TotalCount | Integer | 200 | 人脸样本的总数量 |
| Entities | Array of Entity | - | 查询到的实体数据 |
| DbName | String | default | 人脸样本所在的数据库名称 |
| EntityId | String | 222 | 实体ID，如员工编号 |
| Labels | String | 鹿班 | 查询到的人脸数据标签 |
| CreatedAt | Long | 1589203871832 | 人脸样本的创建时间 |
| FaceCount | Integer | 3 | 人脸样本包含的人脸数量 |
| UpdatedAt | Long | 1589203871832 | 人脸样本的更新时间 |
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2",
"Data" : {
"Token" : "2",
"TotalCount" : "200",
"Entities" : [ {
"DbName" : "default",
"EntityId" : "222",
"FaceCount" : "3",
"Labels" : "鹿班",
"CreatedAt" : "1589203871832",
"UpdatedAt" : "1589203871832"
} ]
}
}
评论 (0)