7.7.1 AllParam
功能介绍
涉及到的所有参数类型的详细说明。
参数说明
表7-49 结果格式说明表
名称 类型 说明
project_id String 项目ID，获取方法请参见获取项目ID/账号
名/AK/SK。
image_url String 图片的URL路径，目前仅支持华为云上OBS的 URL，且人脸识别服务有权限读取该OBS桶的 数据。开通读取权限的操作请参见服务授权。
image_file File 本地图片文件，图片不能超过8MB，建议小于 1MB。上传文件时，请求格式为multipart。
image_base64 String 图像数据，Base64编码，要求：
● Base64编码后大小不超过8MB，建议。
● 图片为JPG/JPEG/BMP/PNG格式。
similarity Double 人脸相似度，1表示最大，0表示最小，值越大 表示越相似。一般情况下超过0.93即可认为是 同一个人。
face_set_name String 人脸库名称。1位到64位之间，可以包含字 母、数字、中划线或者下划线，不能包含其他 的特殊字符。
face_set_capacity Integer 人脸库最大的容量，填写1万整数倍的数字，例 如30000。默认为100000，最大值为100000，
可通过创建新的人脸库进行扩容，每个用户可 使用10个人脸库，每个人脸库容量为10万个人 脸特征。如需扩容单个人脸库规模，请联系华 为云客服确认扩容规模与价格。
face_id String 导入人脸时，系统返回的人脸编号，为8个随机 生成的大小写字母组成。
external_image_id String 用户指定的图片外部ID，与当前图像绑定。用 户没提供，系统会生成一个。该ID长度范围为1
～36位，可以包含字母、数字、中划线或者下 划线，不包含其他的特殊字符。
名称 类型 说明
external_fields Json 根据用户自定义数据类型，填入相应的数值。
创建人脸库时，定义该字段。json字符串不校 验重复性，具体参见自定义字段。
top_n Integer 返回查询到最相似的N张人脸，N默认为10。
如果返回前5个，则该变量N的值为5。
取值范围1～1000。
threshold Double 人脸相似度阈值，低于这个阈值则不返回，取 值范围0~1，一般情况下建议取值0.93，默认 为0。
offset Integer 从第几条数据读起，默认为0。
limit Integer 读取多少条，默认为5。
video_url String 视频的URL路径，目前仅支持华为云上OBS的 URL，且人脸识别服务有权限读取该OBS桶的 数据。开通读取权限的操作请参见服务授权。
视频要求：
● 视频Base64编码后大小不超过8MB。
● 限制视频时长1～15秒。
● 建议帧率10fps～30fps。
● 封装格式：mp4、avi、flv、webm、asf、
mov。
● 视频编码格式： h261、h263、h264、
hevc、vc1、vp8、vp9、wmv3。
video_file File 本地视频文件。上传文件时，请求格式为 multipart。视频要求：
● 视频文件大小不超过8MB，建议客户端压缩 到200KB~2MB。
● 限制视频时长1～15秒。
● 建议帧率10fps～30fps。
● 封装格式：mp4、avi、flv、webm、asf、
mov。
● 视频编码格式： h261、h263、h264、
hevc、vc1、vp8、vp9、wmv3。
名称 类型 说明
video_base64 String 视频数据，Base64编码，要求：
● Base64编码后大小不超过8MB，建议客户 端压缩到200KB~2MB。
● 限制视频时长1～15秒。
● 建议帧率10fps～30fps。
● 封装格式：mp4、avi、flv、webm、asf、
mov。
● 视频编码格式： h261、h263、h264、
hevc、vc1、vp8、vp9、wmv3。
actions String 动作代码顺序列表，英文逗号（,）分隔。建议 单动作，目前支持的动作有：
● 1：左摇头
● 2：右摇头
● 3：点头
● 4：嘴部动作
action_time String 该参数为动作时间数组拼接的字符串，数组的 长度和actions的数量一致，每一项代表了对应 次序动作的起始时间和结束时间，单位为距视 频开始的毫秒数。
error_code String 调用失败时的错误码。
error_msg String 调用失败时的错误信息。
attributes String 是否返回人脸属性，希望获取的属性列表，多 个属性用逗号隔开。目前支持的属性有：
● 0：人脸姿态
● 2：年龄
● 3：人脸关键点
● 4：装束（帽子、眼镜）
● 5：笑脸
7.7.2 DetectFace
功能介绍
人脸检测以及人脸比对返回的人脸结构。
参数说明
表7-50 结构格式说明表
名称 类型 说明
bounding_box
BoundingBox
object 人脸在图像中的位置。
BoundingBox结构见
BoundingBox。
landmark
Landmark object
人脸关键点位置，人脸比对没有此 值。Landmark结构见Landmark。
7.7.3 Landmark
功能介绍
人脸关键点结构。
参数说明
表7-51 结构格式说明表
名称 类型 说明
nose_contour List [Point] 鼻子轮廓，Point为轮廓坐标值。
mouth_contour List [Point] 嘴巴轮廓，Point为轮廓坐标值。
eyebrow_contour List [Point] 眉毛轮廓，Point为轮廓坐标值。
eyes_contour List [Point] 眼睛轮廓，Point为轮廓坐标值。
face_contour List [Point] 人脸轮廓，Point为轮廓坐标值。
7.7.4 Attributes
功能介绍
人脸属性结构。
参数说明
表7-52 结构格式说明表
名称 类型 说明
age Integer 年龄
dress List of strings 包含glass和hat两个属性结果。
glass String 是否戴眼镜：
● yes：戴眼镜
● none：未戴眼镜
● unknown：未知
hat String 是否戴帽子：
● yes：戴帽子
● none：未戴帽子
● unknown：未知
mask String 是否戴口罩：
● yes：戴口罩
● none：未戴口罩
● unknown：未知
hair String 发型：
● long：长发
● short：短发
● unknown：未知
beard String 胡须：
● yes：有胡须
● none：无胡须
● unknown：未知 phototype String 图片类型：
● idcard：证件照
● monitor：摄像头监控
● internet photo：网络图片
smile String 笑脸
quality FaceQuality 图片中人脸的遮挡度、模糊度、光照强 度、姿态角度。
expression FaceExpression 人脸表情，包括中性、高兴、害怕、惊 讶、伤心、生气、厌恶。
名称 类型 说明
face_angle Integer 人脸图片旋转角（顺时针偏转角度），支 持0°、90°、180°和270°图片旋转。
dress List of strings 包含glass和hat两个属性结果。
glass String 是否带眼镜：
● yes：带眼镜
● dark：带墨镜
● none：未戴眼镜
● unknown：未知
hat String 是否带帽子：
● yes：带帽子
● none：未戴帽子
● unknown：未知 headpose List of doubles 人脸轮廓坐标值。
pitch_angle Double 围绕X轴旋转，俯仰角，范围 [-180,180]。
roll_angle Double 围绕Z轴旋转，翻滚角，范围 [-180,180]。
yaw_angle Double 围绕Y轴旋转，偏航角，范围 [-180,180]。
7.7.5 FaceQuality
功能介绍
人脸质量结构。
参数说明
表7-53 结构格式说明表
名称 类型 说明
total_score Double 人脸质量总分，取值范围[0-1]，分值越 大质量越高。
blur Double 模糊度，取值范围[0-1]，分值越大模糊 问题越严重。
pose Double 姿态，取值范围[0-1]，分值越大姿态问 题越严重。
名称 类型 说明
occlusion Double 遮挡，取值范围[0-1]，分值越大遮挡问 题越严重。
illumination Double 光照，取值范围[0-1]，分值越大光照问 题越严重。
7.7.6 FaceExpression
功能介绍
人脸表情结构。
参数说明
表7-54 结构格式说明表
名称 类型 说明
type String 人脸表情类型
● neutral：中性
● happy：高兴
● fear：害怕
● surprise：惊讶
● sad：伤心
● angry：生气
● disgust：厌恶
● unknown：图片质量问题导致未识别 probability Double 表情置信度，取值范围[0-1]。
7.7.7 FaceSetFace
功能介绍
人脸库当中的人脸结构。
参数说明
表7-55 结构格式说明表
名称 类型 说明
bounding_box
BoundingBox
object 人脸在图像中的位置。
BoundingBox结构见BoundingBox。
face_id String 人脸ID，由系统内部生成的唯一ID。
external_image_id String 人脸所在的外部图片ID。
external_fields Json 用户添加的额外字段。
7.7.8 SearchFace
功能介绍
人脸搜索返回的人脸结构。
参数说明
表7-56 结构格式说明表
名称 类型 说明
bounding_box
BoundingBox
object 人脸在图像中的位置。
BoundingBox结构见
BoundingBox。
face_id String 人脸ID，由系统内部生成的唯一 ID。
external_image_id String 人脸所在的外部图片ID。
similarity Double 人脸搜索时用于被检索的相似度。
external_fields Json 用户添加的额外自定义字段。
7.7.9 FaceSetInfo
功能介绍
人脸库的基本信息。
参数说明
表7-57 结构格式说明表
名称 类型 说明
face_set_name String 人脸库名称。
face_set_id String 人脸库ID，随机生成的包 含八个字符的字符串。
create_date String 创建时间。
face_set_capacity Integer 人脸库最大的容量。
face_number Integer 人脸库当中的人脸数量。
external_fields Json 用户的自定义字段。
7.7.10 BoundingBox
功能介绍
人脸在图像中的位置，坐标系的原点（0,0）在左上角。
参数说明
表7-58 结构格式说明表
名称 类型 说明
top_left_x Integer 矩形框左上角横坐标。
top_left_y Integer 矩形框左上角纵坐标。
width Integer 矩形框宽度。
height Integer 矩形框高度。
7.7.11 VideoDetectResult
功能介绍
视频活体检测结果结构体。
参数说明
表7-59 结构格式说明表
名称 类型 说明
alive Boolean 是否是活体。
picture String 检测出最大人脸的图片base64。
actions List 动作列表。详细参数请参见表 字段要素
说明。
表7-60 actions 字段要素说明
名称 类型 说明
action Integer 动作编号，取值范围：[1,2,3,4]，其中：
● 1：左摇头
● 2：右摇头
● 3：点头
● 4：嘴部动作
confidence Double 置信度，取值范围0～1。
7.7.12 LivelessDetectResult
功能介绍
静默活体检测结果结构体。
结构格式说明
表7-61 结构格式说明表
名称 类型 说明
alive Boolean 是否是活体。
picture String 检测出最大人脸的图片base64字符串。
confidence Double 置信度，取值范围0～1。
7.7.13 ServiceInfo
功能介绍
记录子服务信息。
参数说明
表7-62 结构格式说明表
名称 类型 说明
subscribe_status Boolean 是否开通该子服务。
create_time String 开通该子服务时间。
7.7.14 WarningList
功能介绍
视频活体检测警告信息。
参数说明
表7-63 结构格式说明
名称 类型 说明
warningCode Integer 警告ID。
warningMsg String 警告消息。
表7-64 错误提示
warningCode warningMsg
1 人脸没有朝向前方。
4 两个人脸。
5 没有人脸。
6 动作幅度太小。
7 视频质量差或者视频拍摄不是真人。
8 选择不出优选图片。
101 整体人脸质量过低。
warningCode warningMsg
102 人脸模糊。
103 人脸姿态太大。
104 人脸有遮挡。
105 图片太暗，光照不够。
106 图片中包含多张人脸。