/recognition/search

描述

给定一个Face和一个Faceset,在该Faceset内搜索最相似的Face。提示:若搜索集合需要包含超过10000张人脸,可以分成多个faceset分别调用search功能再将结果按confidence顺序合并即可。

注意,当Faceset中的信息被修改之后(增加,删除了Face等),为了保证结果与最新数据一致,Faceset应当被重新train. 见/train/search。否则调用此API时将使用最后一次train时的数据。

参数

  参数名 参数说明
必须 api_key App的Face++ API Key
  api_secret APP的Face++ API Secret
  key_face_id 待搜索的Face的face_id
  faceset_id 或 faceset_name 指定搜索范围为此Faceset
可选 count 表示一共获取不超过count个搜索结果。默认count=3
  async 如果置为true,该API将会以异步方式被调用;也就是立即返回一个session id,稍后可通过/info/get_session查询结果。默认值为false。

返回值说明

字段 类型 说明
candidates array 搜索结果,包含相应face信息与相应的置信度
session_id string 相应请求的session标识符,可用于结果查询

调用示例

https://apicn.faceplusplus.com/v2/recognition/search?api_secret=YOUR_API_SECRET&api_key=YOUR_API_KEY&key_face_id=f31f90f78c11d5ba26f67e1302a3014d&faceset_name=DemoFaceset

JSON 示例

{
    "candidate": [
        {
            "face_id": "a9cebf8d5ae6fff514d8d2d8e07fa55b", 
            "similarity": 100,
            "tag": ""
        }, 
        {
            "face_id": "7f2de0e85bede3171c839d0dcabd849f", 
            "similarity": 55.379097,
            "tag": ""
        }, 
        {
            "face_id": "40ebb31e8af7237a73dec9f242885a7e", 
            "similarity": 52.59766,
            "tag": ""
        }
    ], 
    "session_id": "670ad0f86fb809b26421003ffba1a768"
}

错误列表

错误代码 HTTP 状态代码 错误信息
1001 500 INTERNAL_ERROR
1003 403 AUTHORIZATION_ERROR
1003 403 INSUFFICIENT_PRIVILEGE_OR_QUOTA_LIMIT_EXCEEDED
1004 400 MISSING_ARGUMENTS
1005 400 INVALID_ARGUMENTS
1006 403 ILLEGAL_USE_OF_DEMO_KEY
1202 502 SERVER_TOO_BUSY
1401 441 OBJECT_UNTRAINED