简介
人脸检索功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于人脸检索的相关 API 概览以及 SDK 示例代码。
注意:
API | 操作描述 |
人脸检索 |
人脸检索
功能说明
从数据集中搜索与指定图片最相似的前N张图片并返回人脸坐标可对数据集内文件进行一个或多个人员的人脸识别。
方法原型
public DatasetFaceSearchResponse datasetFaceSearch(DatasetFaceSearchRequest customRequest)
请求示例
DatasetFaceSearchRequest request = new DatasetFaceSearchRequest();request.setAppId("1234567890");// 设置数据集名称,同一个账户下唯一。;是否必传:是request.setDatasetName("test");// 设置资源标识字段,表示需要建立索引的文件地址。;是否必传:是request.setURI("cos://examplebucket-1250000000/test.jpg");// 设置输入图片中检索的人脸数量,默认值为1(传0或不传采用默认值),最大值为10。;是否必传:否request.setMaxFaceNum(1);// 设置检索的每张人脸返回相关人脸数量,默认值为10,最大值为100。;是否必传:否request.setLimit(10);// 设置限制返回人脸的最低相关度分数,只有超过 MatchThreshold 值的人脸才会返回。默认值为0,推荐值为80。 例如:设置 MatchThreshold 的值为80,则检索结果中仅会返回相关度分数大于等于80分的人脸。;是否必传:否request.setMatchThreshold(10);DatasetFaceSearchResponse response = client.datasetFaceSearch(request);
参数说明
Request: 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
AppId | String | 是 | |
datasetName | 数据集名称,同一个账户下唯一。 | String | 是 |
uRI | 资源标识字段,表示需要建立索引的文件地址。 | String | 是 |
maxFaceNum | 输入图片中检索的人脸数量,默认值为1(传0或不传采用默认值),最大值为10。 | Integer | 否 |
limit | 检索的每张人脸返回相关人脸数量,默认值为10,最大值为100。 | Integer | 否 |
matchThreshold | 限制返回人脸的最低相关度分数,只有超过 MatchThreshold 值的人脸才会返回。默认值为0,推荐值为80。 例如:设置 MatchThreshold 的值为80,则检索结果中仅会返回相关度分数大于等于80分的人脸。 | Integer | 否 |
响应参数说明:
DatasetFaceSearchResponse 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
faceResult | 人脸检索识别结果信息列表。 | Container Array |
requestId | 请求 ID。 | String |
FaceResult 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
faceInfos | 相关人脸信息列表。 | Container Array |
inputFaceBoundary | 输入图片的人脸框位置。 | Container |
FaceBoundary 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
height | 人脸高度。 | Integer |
width | 人脸宽度。 | Integer |
left | 人脸框左上角横坐标。 | Integer |
top | 人脸框左上角纵坐标。 | Integer |
FaceInfos 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
personId | 自定义人物 ID。 | String |
faceBoundary | 相关人脸框位置。 | Container |
faceId | 人脸 ID。 | String |
score | 相关人脸匹配得分。 | Integer |
uRI | 资源标识字段,表示需要建立索引的文件地址。 | String |
返回结果说明
成功:返回 DatasetFaceSearchResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。