数据结构

最近更新时间:2024-04-15 01:44:50

我的收藏

AttributeItem

人脸属性信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Type Integer 属性值
Probability Float Type识别概率值,[0,1],代表判断正确的概率。

Candidate

识别出的最相似候选人

被如下接口引用:SearchFaces, SearchFacesReturnsByGroup, SearchPersons, SearchPersonsReturnsByGroup。

名称 类型 描述
PersonId String 人员ID
示例值:person1
FaceId String 人脸ID,仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。人员搜索类接口采用融合特征方式检索,该字段无意义
示例值:3820314501007076807
Score Float 候选者的匹配得分。

1万大小人脸底库下,误识率百分之一对应分数为70分,误识率千分之一对应分数为80分,误识率万分之一对应分数为90分;
10万大小人脸底库下,误识率百分之一对应分数为80分,误识率千分之一对应分数为90分,误识率万分之一对应分数为100分;
30万大小人脸底库下,误识率百分之一对应分数为85分,误识率千分之一对应分数为95分。

一般80分左右可适用大部分场景,建议分数不要超过90分。您可以根据实际情况选择合适的分数。
示例值:50
PersonName String 人员名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:hello
Gender Integer 人员性别
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
PersonGroupInfos Array of PersonGroupInfo 包含此人员的人员库及描述字段内容列表
注意:此字段可能返回 null,表示取不到有效值。

DenseFaceShape

稠密关键点详细信息

被如下接口引用:AnalyzeDenseLandmarks。

名称 类型 描述
X Integer 人脸框左上角横坐标。
Y Integer 人脸框左上角纵坐标。
Width Integer 人脸框宽度。
Height Integer 人脸框高度。
LeftEye Array of Point 描述左侧眼睛轮廓的 XX 点。
RightEye Array of Point 描述右侧眼睛轮廓的 XX 点。
LeftEyeBrow Array of Point 描述左侧眉毛轮廓的 XX 点。
RightEyeBrow Array of Point 描述右侧眉毛轮廓的 XX 点。
MouthOutside Array of Point 描述外嘴巴轮廓的 XX 点, 从左侧开始逆时针返回。
MouthInside Array of Point 描述内嘴巴轮廓的 XX 点,从左侧开始逆时针返回。
Nose Array of Point 描述鼻子轮廓的 XX 点。
LeftPupil Array of Point 左瞳孔轮廓的 XX 个点。
RightPupil Array of Point 右瞳孔轮廓的 XX 个点。
CentralAxis Array of Point 中轴线轮廓的 XX 个点。
Chin Array of Point 下巴轮廓的 XX 个点。
LeftEyeBags Array of Point 左眼袋的 XX 个点。
RightEyeBags Array of Point 右眼袋的 XX 个点。
Forehead Array of Point 额头的 XX 个点。

Eye

眼睛信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Glass AttributeItem 识别是否佩戴眼镜。
AttributeItem对应的Type为 —— 0:无眼镜,1:普通眼镜,2:墨镜
EyeOpen AttributeItem 识别眼睛的睁开、闭合状态。
AttributeItem对应的Type为 —— 0:睁开,1:闭眼
EyelidType AttributeItem 识别是否双眼皮。
AttributeItem对应的Type为 —— 0:无,1:有。
EyeSize AttributeItem 眼睛大小。
AttributeItem对应的Type为 —— 0:小眼睛,1:普通眼睛,2:大眼睛。

Eyebrow

眉毛信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
EyebrowDensity AttributeItem 眉毛浓密。
AttributeItem对应的Type为 —— 0:淡眉,1:浓眉。
EyebrowCurve AttributeItem 眉毛弯曲。
AttributeItem对应的Type为 —— 0:不弯,1:弯眉。
EyebrowLength AttributeItem 眉毛长短。
AttributeItem对应的Type为 —— 0:短眉毛,1:长眉毛。

FaceAttributesInfo

人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息,最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 FaceAttributesInfo 不具备参考意义。

被如下接口引用:DetectFace。

名称 类型 描述
Gender Integer 性别[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Age Integer 年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Expression Integer 微笑[0(normal,正常))~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Glass Boolean 是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Pitch Integer 上下偏移[-30,30],单位角度。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
建议:人脸入库选择[-10,10]的图片。
Yaw Integer 左右偏移[-30,30],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
建议:人脸入库选择[-10,10]的图片。
Roll Integer 平面旋转[-180,180],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
建议:人脸入库选择[-20,20]的图片。
Beauty Integer 魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Hat Boolean 是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
注意:此字段可能返回 null,表示取不到有效值。
Mask Boolean 是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
注意:此字段可能返回 null,表示取不到有效值。
Hair FaceHairAttributesInfo 头发信息,包含头发长度(length)、有无刘海(bang)、头发颜色(color)。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
注意:此字段可能返回 null,表示取不到有效值。
EyeOpen Boolean 双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼,就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
注意:此字段可能返回 null,表示取不到有效值。

FaceDetailAttributesInfo

人脸属性信息,根据 FaceAttributesType 输入的类型,返回年龄(Age)、颜值(Beauty)
情绪(Emotion)、眼睛信息(Eye)、眉毛(Eyebrow)、性别(Gender)
头发(Hair)、帽子(Hat)、姿态(Headpose)、口罩(Mask)、嘴巴(Mouse)、胡子(Moustache)
鼻子(Nose)、脸型(Shape)、肤色(Skin)、微笑(Smile)等人脸属性信息。
若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Age Integer 年龄 [0,65],其中65代表“65岁及以上”。
FaceAttributesType 不含Age 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Beauty Integer 美丑打分[0,100]。
FaceAttributesType 不含 Beauty 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Emotion AttributeItem 情绪,可识别自然、高兴、惊讶、生气、悲伤、厌恶、害怕。
AttributeItem对应的Type为 —— 0:自然,1:高兴,2:惊讶,3:生气,4:悲伤,5:厌恶,6:害怕
FaceAttributesType 不含Emotion 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Eye Eye 眼睛相关信息,可识别是否戴眼镜、是否闭眼、是否双眼皮和眼睛大小。
FaceAttributesType 不含Eye 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Eyebrow Eyebrow 眉毛相关信息,可识别眉毛浓密、弯曲、长短信息。
FaceAttributesType 不含Eyebrow 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Gender AttributeItem 性别信息。
AttributeItem对应的Type为 —— 0:男性,1:女性。
FaceAttributesType 不含Gender 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Hair Hair 头发信息,包含头发长度、有无刘海、头发颜色。
FaceAttributesType 不含Hair 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Hat Hat 帽子信息,可识别是否佩戴帽子、帽子款式、帽子颜色。
FaceAttributesType 不含Hat 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
HeadPose HeadPose 姿态信息,包含人脸的上下偏移、左右偏移、平面旋转信息。
FaceAttributesType 不含Headpose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Mask AttributeItem 口罩佩戴信息。
AttributeItem对应的Type为 —— 0: 无口罩, 1: 有口罩不遮脸,2: 有口罩遮下巴,3: 有口罩遮嘴,4: 正确佩戴口罩。
FaceAttributesType 不含Mask 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Mouth Mouth 嘴巴信息,可识别是否张嘴、嘴唇厚度。
FaceAttributesType 不含 Mouth 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Moustache AttributeItem 胡子信息。
AttributeItem对应的Type为 —— 0:无胡子,1:有胡子。
FaceAttributesType 不含 Moustache 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Nose AttributeItem 鼻子信息。
AttributeItem对应的Type为 —— 0:朝天鼻,1:鹰钩鼻,2:普通,3:圆鼻头
FaceAttributesType 不含 Nose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Shape AttributeItem 脸型信息。
AttributeItem对应的Type为 —— 0:方脸,1:三角脸,2:鹅蛋脸,3:心形脸,4:圆脸。
FaceAttributesType 不含 Shape 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Skin AttributeItem 肤色信息。
AttributeItem对应的Type为 —— 0:黄色皮肤,1:棕色皮肤,2:黑色皮肤,3:白色皮肤。
FaceAttributesType 不含 Skin 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Smile Integer 微笑程度,[0,100]。
FaceAttributesType 不含 Smile 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。

FaceDetailInfo

人脸信息列表。

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
FaceRect FaceRect 检测出的人脸框位置。
FaceDetailAttributesInfo FaceDetailAttributesInfo 人脸属性信息,根据 FaceAttributesType 输入的类型,返回年龄(Age)、颜值(Beauty)
情绪(Emotion)、眼睛信息(Eye)、眉毛(Eyebrow)、性别(Gender)
头发(Hair)、帽子(Hat)、姿态(Headpose)、口罩(Mask)、嘴巴(Mouth)、胡子(Moustache)
鼻子(Nose)、脸型(Shape)、肤色(Skin)、微笑(Smile)等人脸属性信息。
若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。

FaceHairAttributesInfo

人脸属性中的发型信息。

被如下接口引用:DetectFace。

名称 类型 描述
Length Integer 0:光头,1:短发,2:中发,3:长发,4:绑发
注意:此字段可能返回 null,表示取不到有效值。
Bang Integer 0:有刘海,1:无刘海
注意:此字段可能返回 null,表示取不到有效值。
Color Integer 0:黑色,1:金色,2:棕色,3:灰白色
注意:此字段可能返回 null,表示取不到有效值。

FaceInfo

人脸信息列表。

被如下接口引用:DetectFace。

名称 类型 描述
X Integer 人脸框左上角横坐标。
人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Y Integer 人脸框左上角纵坐标。
人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Width Integer 人脸框宽度。
Height Integer 人脸框高度。
FaceAttributesInfo FaceAttributesInfo 人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
FaceQualityInfo FaceQualityInfo 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
注意:此字段可能返回 null,表示取不到有效值。

FaceQualityCompleteness

五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。

被如下接口引用:DetectFace。

名称 类型 描述
Eyebrow Integer 眉毛的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,80]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。
Eye Integer 眼睛的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,80]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。
Nose Integer 鼻子的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,60]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。
Cheek Integer 脸颊的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,70]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。
Mouth Integer 嘴巴的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,50]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。
Chin Integer 下巴的遮挡分数[0,100],分数越高遮挡越少。
参考范围:[0,70]表示发生遮挡。
注意:此字段可能返回 null,表示取不到有效值。

FaceQualityInfo

人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。

被如下接口引用:DetectFace。

名称 类型 描述
Score Integer 质量分: [0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。
正常情况,只需要使用Score作为质量分总体的判断标准即可。Sharpness、Brightness、Completeness等细项分仅供参考。
参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。
建议:人脸入库选取70以上的图片。
注意:此字段可能返回 null,表示取不到有效值。
Sharpness Integer 清晰分:[0,100],评价图片清晰程度,分数越高越清晰。
参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。
建议:人脸入库选取80以上的图片。
注意:此字段可能返回 null,表示取不到有效值。
Brightness Integer 光照分:[0,100],评价图片光照程度,分数越高越亮。
参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。
建议:人脸入库选取[30,70]的图片。
注意:此字段可能返回 null,表示取不到有效值。
Completeness FaceQualityCompleteness 五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。
注意:此字段可能返回 null,表示取不到有效值。

FaceRect

检测出的人脸框的位置

被如下接口引用:CreateFace, CreatePerson, DetectFaceAttributes, SearchFaces, SearchFacesReturnsByGroup, SearchPersons, SearchPersonsReturnsByGroup。

名称 类型 描述
X Integer 人脸框左上角横坐标。
人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Y Integer 人脸框左上角纵坐标。
人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Width Integer 人脸宽度
Height Integer 人脸高度

FaceShape

五官定位(人脸关键点)具体信息。
image

被如下接口引用:AnalyzeFace。

名称 类型 描述
FaceProfile Array of Point 描述脸型轮廓的 21 点。
LeftEye Array of Point 描述左侧眼睛轮廓的 8 点。
RightEye Array of Point 描述右侧眼睛轮廓的 8 点。
LeftEyeBrow Array of Point 描述左侧眉毛轮廓的 8 点。
RightEyeBrow Array of Point 描述右侧眉毛轮廓的 8 点。
Mouth Array of Point 描述嘴巴轮廓的 22 点。
Nose Array of Point 描述鼻子轮廓的 13 点。
LeftPupil Array of Point 左瞳孔轮廓的 1 个点。
RightPupil Array of Point 右瞳孔轮廓的 1 个点。

GroupCandidate

分组识别结果Item

被如下接口引用:SearchFacesReturnsByGroup, SearchPersonsReturnsByGroup。

名称 类型 描述
GroupId String 人员库ID 。
Candidates Array of Candidate 识别出的最相似候选人。

GroupExDescriptionInfo

需要修改的人员库自定义描述字段key-value

被如下接口引用:ModifyGroup。

名称 类型 必选 描述
GroupExDescriptionIndex Integer 人员库自定义描述字段Index,从0开始
GroupExDescription String 需要更新的人员库自定义描述字段内容

GroupInfo

返回的人员库信息

被如下接口引用:GetGroupList。

名称 类型 描述
GroupName String 人员库名称
GroupId String 人员库ID
GroupExDescriptions Array of String 人员库自定义描述字段
注意:此字段可能返回 null,表示取不到有效值。
Tag String 人员库信息备注
注意:此字段可能返回 null,表示取不到有效值。
FaceModelVersion String 人脸识别所用的算法模型版本。
注意:此字段可能返回 null,表示取不到有效值。
CreationTimestamp Integer Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
注意:此字段可能返回 null,表示取不到有效值。

Hair

头发信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Length AttributeItem 头发长度信息。
AttributeItem对应的Type为 —— 0:光头,1:短发,2:中发,3:长发,4:绑发。
Bang AttributeItem 刘海信息。
AttributeItem对应的Type为 —— 0:无刘海,1:有刘海。
Color AttributeItem 头发颜色信息。
AttributeItem对应的Type为 —— 0:黑色,1:金色,2:棕色,3:灰白色。

Hat

帽子信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Style AttributeItem 帽子佩戴状态信息。
AttributeItem对应的Type为 —— 0:不戴帽子,1:普通帽子,2:头盔,3:保安帽。
Color AttributeItem 帽子颜色。
AttributeItem对应的Type为 —— 0:不戴帽子,1:红色系,2:黄色系,3:蓝色系,4:黑色系,5:灰白色系,6:混色系。

HeadPose

姿态信息

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
Pitch Integer 上下偏移[-30,30]。
Yaw Integer 左右偏移[-30,30]。
Roll Integer 平面旋转[-180,180]。

Mouth

嘴巴信息。

被如下接口引用:DetectFaceAttributes。

名称 类型 描述
MouthOpen AttributeItem 是否张嘴信息。
AttributeItem对应的Type为 —— 0:不张嘴,1:张嘴。

PersonExDescriptionInfo

需要修改的人员描述字段内容,key-value

被如下接口引用:CreatePerson, ModifyPersonGroupInfo。

名称 类型 必选 描述
PersonExDescriptionIndex Integer 人员描述字段Index,从0开始
PersonExDescription String 需要更新的人员描述字段内容

PersonGroupInfo

包含此人员的人员库及描述字段内容列表

被如下接口引用:GetPersonGroupInfo, SearchFaces, SearchFacesReturnsByGroup, SearchPersons, SearchPersonsReturnsByGroup。

名称 类型 描述
GroupId String 包含此人员的人员库ID
PersonExDescriptions Array of String 人员描述字段内容

PersonInfo

返回的人员信息

被如下接口引用:GetPersonList。

名称 类型 描述
PersonName String 人员名称
PersonId String 人员Id
Gender Integer 人员性别
PersonExDescriptions Array of String 人员描述字段内容
FaceIds Array of String 包含的人脸照片列表
CreationTimestamp Integer 人员的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。

Point

坐标

被如下接口引用:AnalyzeDenseLandmarks, AnalyzeFace。

名称 类型 描述
X Integer x坐标
Y Integer Y坐标

Result

人脸的识别结果

被如下接口引用:SearchFaces, SearchPersons。

名称 类型 描述
Candidates Array of Candidate 识别出的最相似候选人
FaceRect FaceRect 检测出的人脸框位置
RetCode Integer 检测出的人脸图片状态返回码。0 表示正常。
-1601代表不符合图片质量控制要求,此时Candidate内容为空。

ResultsReturnsByGroup

识别结果。

被如下接口引用:SearchFacesReturnsByGroup, SearchPersonsReturnsByGroup。

名称 类型 描述
FaceRect FaceRect 检测出的人脸框位置。
GroupCandidates Array of GroupCandidate 识别结果。
RetCode Integer 检测出的人脸图片状态返回码。0 表示正常。
-1601代表不符合图片质量控制要求,此时Candidate内容为空。

UpgradeJobInfo

人员库升级任务信息

被如下接口引用:GetUpgradeGroupFaceModelVersionJobList。

名称 类型 描述
JobId String 人员库升级任务ID,用于查询、获取升级的进度和结果。
GroupId String 人员库ID。
FromFaceModelVersion String 当前算法模型版本。
ToFaceModelVersion String 目标算法模型版本。
StartTime Integer 升级起始时间。
StartTime的值是自 Unix 纪元时间到Group创建时间的毫秒数。
Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
有关更多信息,请参阅 Unix 时间。
Status Integer 0表示升级中,1表示升级完毕,2表示回滚完毕。