人脸检索图像

华为 人脸识别 连接器基于华为云 人脸识别服务 集成开发，包含“人脸检测”、“人脸比对”、“人脸搜索”和“活体检测”等执行动作。

接口功能及调用方法请参考人脸比对。

• 输入参数

  用户配置人脸比对执行动作，相关参数说明如表5所示。

  表5 人脸比对输入参数说明

  参数	说明
  图片1的URL路径	图片的URL路径，当前仅支持OBS路径。
  图像数据1	图像数据，Base64编码，要求：Base64编码后大小不超过8MB，建议小于1MB。图片为JPG/JPEG/BMP/PNG格式。
  图片1的URL路径	图片的URL路径，当前仅支持OBS路径。
  图像数据2	图像数据，Base64编码，要求：Base64编码后大小不超过8MB，建议小于1MB。图片为JPG/JPEG/BMP/PNG格式。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表6。

  表6 人脸比对输出参数说明

  参数	说明
  人脸相似度	人脸相似度，1表示最大，0表示最小，值越大表示越相似。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

接口功能及调用方法请参考人脸搜索。

• 输入参数

  用户配置人脸搜索执行动作，相关参数说明如表11所示。

  表11 人脸搜索输入参数说明

  参数	必填	说明
  人脸库名称	是	人脸库名称。
  人脸ID	人脸ID，图片文件，图像数据三选一	导入人脸时，系统返回的人脸编号，即人脸ID。
  图片文件	人脸ID，图片文件，图像数据三选一	本地图片文件，图片不能超过8MB，建议小于1MB。上传文件时，请求格式为multipart。
  图像数据	人脸ID，图片文件，图像数据三选一	图像数据，Base64编码，要求：Base64编码后大小不超过8MB，建议小于1MB。图片为JPG/JPEG/BMP/PNG格式。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表12。

  表12 人脸搜索输出参数说明

  参数	说明
  人脸集合	查找的人脸集合。
  相似度	人脸搜索时用于被检索的相似度。
  外部图片ID	人脸所在的外部图片ID。
  人脸ID	人脸ID，由系统内部生成的唯一ID。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表14。

  表14 创建人脸库输出参数说明

  参数	说明
  人脸库最大的容量	人脸库当中的人脸数量。
  人脸库ID	人脸库ID，随机生成的包含八个字符的字符串。
  人脸库名称	人脸库名称。
  创建时间	创建时间。
  人脸库最大的容量	人脸库最大的容量。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表15。

  表15 查询所有人脸库输出参数说明

  参数	说明
  人脸库信息集合	人脸库信息集合。
  人脸库当中的人脸数量	人脸库当中的人脸数量。
  人脸库ID	人脸库ID，随机生成的包含八个字符的字符串。
  人脸库名称	人脸库名称。
  创建时间	创建时间。
  人脸库最大的容量	人脸库最大的容量。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输入参数

  用户配置查询人脸库执行动作，相关参数说明如表16所示。

  表16 查询人脸库输入参数说明

  参数	必填	说明
  人脸库名称	是	人脸库的名称。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表17。

  表17 查询人脸库输出参数说明

  参数	说明
  人脸数量	人脸库当中的人脸数量。
  人脸库ID	人脸库ID，随机生成的包含八个字符的字符串。
  人脸库名称	人脸库名称。
  创建时间	创建时间。
  人脸库最大的容量	人脸库最大的容量。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表19。

  表19 删除人脸库输出参数说明

  参数	说明
  人脸库名称	人脸库的名称。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输入参数

  用户配置添加人脸执行动作，相关参数说明如表20所示。

  表20 添加人脸输入参数说明

  参数	必填	说明
  人脸库名称	是	人脸库的名称。
  视频的URL路径	与图片文件，图像数据三选一	视频的URL路径，目前仅支持OBS的URL。
  图片文件	与视频的URL路径，图像数据三选一	本地图片文件，图片不能超过8MB，建议小于1MB。上传文件时，请求格式为multipart。
  图像数据	与视频的URL路径，图像数据三选一	图像数据，Base64编码，要求：Base64编码后大小不超过8MB，建议小于1MB。图片为JPG/JPEG/BMP/PNG格式。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表21。

  表21 添加人脸输出参数说明

  参数	说明
  人脸库ID	人脸库ID，随机生成的包含八个字符的字符串。
  人脸库名称	人脸库的名称。
  人脸结构	人脸库当中的人脸结构。
  外部图片ID	人脸所在的外部图片ID。
  人脸ID	人脸ID，由系统内部生成的唯一ID。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表23。

  表23 查询人脸输出参数说明

  参数	说明
  人脸库ID	人脸库ID，随机生成的包含八个字符的字符串。
  人脸库名称	人脸库的名称。
  人脸结构	人脸库当中的人脸结构。
  外部图片ID	人脸所在的外部图片ID。
  人脸ID	人脸ID，由系统内部生成的唯一ID。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表25。

  表25 更新人脸输出参数说明

  参数	说明
  更新的人脸数量	更新的人脸数量。 调用失败时无此字段。
  人脸库ID	人脸库ID，调用失败时无此字段。
  人脸库名称	人脸库的名称，调用失败时无此字段。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输入参数

  用户配置删除人脸执行动作，相关参数说明如表26所示。

  表26 删除人脸输入参数说明

  参数	必填	说明
  人脸库名称	是	人脸库的名称。
  按条件删除的字段名	是	按条件删除的字段名，支持固定字段（external_image_id和face_id），以及用户的自定义字段（不支持空字符串和null值删除）。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表27。

  表27 删除人脸输出参数说明

  参数	说明
  删除的人脸数量	删除的人脸数量。 调用失败时无此字段。
  人脸库ID	人脸库ID，调用失败时无此字段。
  人脸库名称	人脸库的名称，调用失败时无此字段。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。

• 输入参数

  用户配置批量删除人脸执行动作，相关参数说明如表28所示。

  表28 批量删除人脸输入参数说明

  参数	必填	说明
  人脸库名称	是	人脸库的名称。
  过滤条件	是	过滤条件，具体参见filter语法。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表29。

  表29 批量删除人脸输出参数说明

  参数	说明
  删除的人脸数量	删除的人脸数量。 调用失败时无此字段。
  人脸库ID	人脸库ID，调用失败时无此字段。
  人脸库名称	人脸库的名称，调用失败时无此字段。
  错误码	调用失败时的错误码，调用成功时无此字段。
  错误信息	调用失败时的错误信息，调用成功时无此字段。