人脸识别服务 FRS-人脸搜索:请求参数
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 |
Content-Type |
是 |
String |
发送的实体的MIME类型,参数值为“application/json”。 |
Enterprise-Project-Id |
否 |
String |
企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。
说明:
创建企业项目后,在传参时,有以下三类场景。
|
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|
image_url |
String |
与image_file、image_base64、face_id四选一 |
图片的URL路径,目前仅支持华为云上OBS的URL,使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 |
image_file |
File |
与image_url、image_base64、face_id四选一 |
本地图片文件,图片不能超过8MB,建议小于1MB。上传文件时,请求格式为multipart。 |
image_base64 |
String |
与image_file、image_url、face_id四选一 |
图像数据,Base64编码,要求:
|
face_id |
String |
与image_file、image_base64、image_url四选一 |
导入人脸时,系统返回的人脸编号,即人脸ID。 |
top_n |
Integer |
否 |
返回查询到的最相似的N张人脸,N默认为10,取值范围[0,1000]。 N张人脸按照置信度降序排序,置信度越大越靠前。 |
threshold |
Double |
否 |
人脸相似度阈值,低于这个阈值则不返回,取值范围[0,1],一般情况下建议取值0.93,默认为0。 |
sort |
JsonArray |
否 |
支持字段排序,参考sort语法。 |
filter |
String |
否 |
过滤条件,参考filter语法。 |
return_fields |
JsonArray |
否 |
指定返回的自定义字段。 |