{ "openapi": "3.0.3", "info": { "title": "腾讯云-人脸识别", "description": "可应用于智慧零售、智慧社区、智慧楼宇、在线身份认证等多种应用场景，充分满足各行业客户的人脸属性识别及用户身份确认等需求。", "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2", "version": "1.0.0" }, "servers": [ { "url": "https://route.showapi.com" } ], "paths": { "/1948-31": { "x-pointCode": 31, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 5, "post": { "summary": "人员库-人员查重", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": {}, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_31_POST", "parameters": [ { "name": "GroupIds.0", "in": "query", "description": "待整理的人员库1。", "required": false, "schema": { "type": "string" } }, { "name": "GroupIds.1", "in": "query", "description": "待整理的人员库2。", "required": false, "schema": { "type": "string" } }, { "name": "GroupIds.2", "in": "query", "description": "待整理的人员库3。", "required": false, "schema": { "type": "string" } }, { "name": "UniquePersonControl", "in": "query", "description": "人员查重整理力度的控制。\n1：力度较高的档案整理，能够消除更多的重复身份，对应稍高的非重复身份误清除率；\n2：力度较低的档案整理，非重复身份的误清除率较低，对应稍低的重复身份消除率。", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string" } }, "required": [ "ds_id" ] } } } } } }, "/1948-30": { "x-pointCode": 30, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 5, "post": { "summary": "人员库-库升级任务列表", "description": "获取人员库升级任务列表", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "JobInfos": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "number", "description": "0表示升级中，1表示升级完毕，2表示回滚完毕，3表示升级失败。" }, "JobId": { "type": "string", "description": "人员库升级任务ID，用于查询、获取升级的进度和结果。" }, "IsCheckMode": { "type": "boolean" }, "FromFaceModelVersion": { "type": "string", "description": "当前算法模型版本。" }, "StartTime": { "type": "number", "description": "目标算法模型版本。" }, "GroupId": { "type": "string", "description": "人员库ID。" }, "ToFaceModelVersion": { "type": "string", "description": "目标算法模型版本。" } } }, "description": "人员库升级任务信息列表。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "JobNum": { "type": "number", "description": "升级任务总数量。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_30_POST", "parameters": [ { "name": "Offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string" } } } } } } } }, "/1948-29": { "x-pointCode": 29, "x-mode": "mapping", "x-read-timeout": 15, "x-connect-timeout": 10, "post": { "summary": "人脸静态活体检测（高精度版）", "description": "脸静态活体检测（高精度版）可用于对用户上传的静态图片进行防翻拍活体检测，以判断是否是翻拍图片。\n\n相比现有静态活体检测服务，高精度版在维持高真人通过率的前提下，增强了对高清屏幕、裁剪纸片、3D面具等攻击的防御能力，攻击拦截率约为业内同类型产品形态4-5倍。同时支持多场景人脸核验，满足移动端、PC端各类型场景的图片活体检验需求，适用于各个行业不同的活体检验应用。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "FaceModelVersion": { "type": "string", "description": "人脸识别所用的算法模型版本。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Score": { "type": "number", "description": "活体打分，取值范围 [0,100]，根据活体分数对应的阈值区间来判断是否为翻拍。目前阈值可分为[5,10,40,70,90]，其中推荐阈值为40。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_29_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Image": { "type": "string", "description": "图片 base64 数据，base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n图片的宽高比请接近 3:4，手机拍摄比例最佳。\n人脸尺寸大于100X100像素。\n图片格式支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url 。对应图片 base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\nUrl、Image必须提供一个，如果都提供，只使用 Url。\n图片的宽高比请接近 3:4，手机拍摄比例最佳。\n人脸尺寸大于100X100像素。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。\n图片格式支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "FaceModelVersion": { "type": "string", "description": "人脸识别服务所用的算法模型版本。目前入参支持“3.0“。" }, "ds_id": { "type": "string" } }, "required": [ "FaceModelVersion" ] } } } } } }, "/1948-28": { "x-pointCode": 28, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 10, "post": { "summary": "人员库-升级库结果查询", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Status": { "type": "number", "description": "0表示升级中，1表示升级完毕，2表示回滚完毕，3表示升级失败。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "IsCheckMode": { "type": "boolean" }, "FromFaceModelVersion": { "type": "string", "description": "当前算法模型版本。" }, "EndTimestamp": { "type": "number", "description": "人员升级任务预估结束时间。 StartTimestamp的值是自 Unix 纪元时间到人员查重任务预估结束的毫秒数。\nUnix 纪元时间是 1970 年 1 月 1 日星期四，协调世界时 (UTC) 00:00:00。\n如果为0表示这个任务已经执行完毕。" }, "StartTime": { "type": "number", "description": "升级起始时间。\nStartTime的值是自 Unix 纪元时间到Group创建时间的毫秒数。\nUnix 纪元时间是 1970 年 1 月 1 日星期四，协调世界时 (UTC) 00:00:00。\n有关更多信息，请参阅 Unix 时间。" }, "GroupId": { "type": "string", "description": "人员库ID。" }, "FailedFacesUrl": { "type": "string", "description": "无法升级的人脸Id信息，文件格式" }, "Progress": { "type": "number", "description": "升级任务完成进度。取值[0.0，100.0]。" }, "ToFaceModelVersion": { "type": "string", "description": "目标算法模型版本。" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_28_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "JobId": { "type": "string", "description": "升级任务ID，用于查询、获取人员库升级的进度和结果，调用【升级人员库】成功后能获得该ID" }, "ds_id": { "type": "string" } }, "required": [ "JobId", "ds_id" ] } } } } } }, "/1948-27": { "x-pointCode": 27, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 10, "post": { "summary": "人员库-升级人员库", "description": "升级人员库。升级过程中，人员库仍然为原算法版本，人员库相关操作仍然支持。升级完成后，人员库为新算法版本。单个人员库有且仅支持一次回滚操作。\n\n升级是一个耗时的操作，执行时间与人员库的人脸数相关，升级的人员库中的人脸数越多，升级的耗时越长。升级接口是个异步任务，调用成功后返回JobId，通过【人员库升级结果查询】查询升级进度和结果。如果升级成功，人员库版本将切换到新版本。如果想回滚到旧版本，可以调用【人员库版本回滚】进行回滚。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "JobId": { "type": "string", "description": "升级任务ID，用于查询、获取升级的进度和结果。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_27_POST", "parameters": [ { "name": "GroupId", "in": "query", "description": "需要升级的人员库ID。", "required": false, "schema": { "type": "string" } }, { "name": "FaceModelVersion", "in": "query", "description": "需要升级至的算法模型版本。默认为最新版本。建议升级到3.0版本", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string" } }, "required": [ "ds_id" ] } } } } } }, "/1948-26": { "x-pointCode": 26, "x-mode": "mapping", "x-read-timeout": 15, "x-connect-timeout": 9, "post": { "summary": "基于人员库-人员验证", "description": "给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考人员库管理相关接口。本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。\n\n和人脸比对相关接口不同的是，人脸验证相关接口用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对相关接口用于判断两张人脸的相似度。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "FaceModelVersion": { "type": "string", "description": "人脸识别所用的算法模型版本" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "IsMatch": { "type": "boolean", "description": "是否为同一人的判断。" }, "Score": { "type": "number", "description": "给定的人脸照片与 PersonId 对应的相似度。若 PersonId 下有多张人脸（Face），会融合多张人脸信息进行验证。\nIsMatch\tBoolean\t是否为同一人的判断。" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_26_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。" }, "Image": { "type": "string", "description": "图片 base64 数据。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。。\n图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-25": { "x-pointCode": 25, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 10, "post": { "summary": "戴口罩人脸对比", "description": "对两张图片中的人脸进行相似度比对，返回人脸相似度分数。\n\n戴口罩人脸比对接口可在查询照人脸戴口罩情况下使用，口罩遮挡程度最高可以遮挡鼻尖。\n\n如图片人脸不存在戴口罩情况，建议使用人脸比对服务。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "FaceModelVersion": { "type": "string", "description": "人脸识别所用的算法模型版本。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Score": { "type": "number", "description": "两张图片中人脸的相似度分数。\n不同算法版本返回的相似度分数不同。\n若需要验证两张图片中人脸是否为同一人，3.0版本误识率千分之一对应分数为40分，误识率万分之一对应分数为50分，误识率十万分之一对应分数为60分。一般超过50分则可认定为同一人。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_25_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源id" }, "ImageA": { "type": "string", "description": "A 图片 base64 数据，base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ImageB": { "type": "string", "description": "B 图片 base64 数据，base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "UrlA": { "type": "string", "description": "A 图片的 Url ，对应图片 base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\nA 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "UrlB": { "type": "string", "description": "B 图片的 Url ，对应图片 base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\nB 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" } }, "required": [ "ds_id" ] } } } } } }, "/1948-24": { "x-pointCode": 24, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 10, "post": { "summary": "五官稠密点", "description": "对请求图片进行五官定位（也称人脸关键点定位），获得人脸的精准信息，返回多达888点关键信息，对五官和脸部轮廓进行精确定位。阿里原接口订购地址：https://cloud.tencent.com/product/facerecognition", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "FaceModelVersion": { "type": "string", "description": "人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "ImageWidth": { "type": "number", "description": "请求的图片宽度。" }, "DenseFaceShapeSet": { "type": "array", "items": { "type": "object", "properties": { "MouthOutside": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "x坐标" } } }, "description": "描述外嘴巴轮廓的 XX 点，从左侧开始逆时针返回。" }, "Forehead": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "额头的 XX 个点。" }, "LeftEye": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述左侧眉毛轮廓的 XX 点。" }, "RightEye": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述右侧眼睛轮廓的 XX 点。" }, "Height": { "type": "number", "description": "人脸框高度。" }, "LeftEyeBrow": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述左侧眉毛轮廓的 XX 点。" }, "RightEyeBrow": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述右侧眉毛轮廓的 XX 点。" }, "RightPupil": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "右瞳孔轮廓的 XX 个点。" }, "LeftPupil": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "左瞳孔轮廓的 XX 个点。" }, "RightEyeBags": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "右眼袋的 XX 个点。" }, "MouthInside": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述内嘴巴轮廓的 XX 点，从左侧开始逆时针返回" }, "CentralAxis": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "CentralAxis" }, "LeftEyeBags": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "左眼袋的 XX 个点。" }, "Chin": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "下巴轮廓的 XX 个点。" }, "Nose": { "type": "array", "items": { "type": "object", "properties": { "Y": { "type": "number", "description": "Y坐标" }, "X": { "type": "number", "description": "X坐标" } } }, "description": "描述鼻子轮廓的 XX 点。" }, "Width": { "type": "number", "description": "人脸框宽度。" }, "Y": { "type": "number", "description": "人脸框左上角纵坐标。" }, "X": { "type": "number", "description": "人脸框左上角横坐标。" } } }, "description": "稠密人脸关键点具体信息。" }, "ImageHeight": { "type": "number", "description": "请求的图片高度。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_24_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Mode": { "type": "number", "description": "检测模式。0 为检测所有出现的人脸， 1 为检测面积最大的人脸。\n默认为 0。\n最多返回 5 张人脸的五官定位（人脸关键点）具体信息。" }, "Image": { "type": "string", "description": "图片 base64 数据，base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url 。对应图片 base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\nUrl、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string" } }, "required": [ "ds_id" ] } } } } } }, "/1948-23": { "x-pointCode": 23, "x-mode": "mapping", "x-read-timeout": 10, "x-connect-timeout": 10, "post": { "summary": "人脸检测与属性分析", "description": "检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。阿里原接口订购地址：https://cloud.tencent.com/product/facerecognition", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "FaceModelVersion": { "type": "string", "description": "人脸识别所用的算法模型版本。\n注意：此字段可能返回 null，表示取不到有效值。" }, "FaceDetailInfos": { "type": "array", "items": { "type": "object", "properties": { "FaceRect": { "type": "object", "properties": { "Height": { "type": "number", "description": "人脸高度" }, "Width": { "type": "number", "description": "人脸宽度" }, "Y": { "type": "number", "description": "人脸框左上角纵坐标。\n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。\n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" }, "X": { "type": "number", "description": "人脸框左上角横坐标。\n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。\n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" } } }, "FaceDetailAttributesInfo": { "type": "object", "properties": { "Age": { "type": "number", "description": "年龄 [0,65]，其中65代表“65岁及以上”。\nFaceAttributesType 不为含Age 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "HeadPose": { "type": "object", "properties": { "Roll": { "type": "number", "description": "平面旋转[-180,180]。" }, "Yaw": { "type": "number", "description": "左右偏移[-30,30]。" }, "Pitch": { "type": "number", "description": "上下偏移[-30,30]。" } }, "description": "姿态信息，包含人脸的上下偏移、左右偏移、平面旋转信息。\nFaceAttributesType 不含Headpose 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Skin": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "肤色信息。\nAttributeItem对应的Type为 —— 0：黄色皮肤，1：棕色皮肤，2：黑色皮肤，3：白色皮肤。\nFaceAttributesType 不含 Skin 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Eye": { "type": "object", "properties": { "EyelidType": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "识别是否双眼皮。\nAttributeItem对应的Type为 —— 0：无，1：有。" }, "EyeSize": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "眼睛大小。\nAttributeItem对应的Type为 —— 0：小眼睛，1：普通眼睛，2：大眼睛。" }, "Glass": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "识别是否佩戴眼镜。\nAttributeItem对应的Type为 —— 0：无眼镜，1：普通眼镜，2：墨镜" }, "EyeOpen": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "识别眼睛的睁开、闭合状态。\nAttributeItem对应的Type为 —— 0：睁开，1：闭眼" } }, "description": "眼睛信息" }, "Beauty": { "type": "number", "description": "魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Emotion": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "情绪，可识别自然、高兴、惊讶、生气、悲伤、厌恶、害怕。\nAttributeItem对应的Type为 —— 0：自然，1：高兴，2：惊讶，3：生气，4：悲伤，5：厌恶，6：害怕" }, "Hair": { "type": "object", "properties": { "Bang": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "刘海信息。\nAttributeItem对应的Type为 —— 0：无刘海，1：有刘海。" }, "Length": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "头发长度信息。\nAttributeItem对应的Type为 —— 0：光头，1：短发，2：中发，3：长发，4：绑发。" }, "Color": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "头发颜色信息。\nAttributeItem对应的Type为 —— 0：黑色，1：金色，2：棕色，3：灰白色。" } }, "description": "头发信息" }, "Mask": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "口罩佩戴信息。\nAttributeItem对应的Type为 —— 0: 无口罩， 1: 有口罩不遮脸，2: 有口罩遮下巴，3: 有口罩遮嘴，4: 正确佩戴口罩。\nFaceAttributesType 不含Mask 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Shape": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "脸型信息。\nAttributeItem对应的Type为 —— 0：方脸，1：三角脸，2：鹅蛋脸，3：心形脸，4：圆脸。" }, "Moustache": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "胡子信息。\nAttributeItem对应的Type为 —— 0：无胡子，1：有胡子。\nFaceAttributesType 不含 Moustache 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Gender": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "性别信息。\nAttributeItem对应的Type为 —— 0：男性，1：女性。\nFaceAttributesType 不含Gender 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Hat": { "type": "object", "properties": { "Style": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "帽子佩戴状态信息。\nAttributeItem对应的Type为 —— 0：不戴帽子，1：普通帽子，2：头盔，3：保安帽。" }, "Color": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "帽子颜色。\nAttributeItem对应的Type为 —— 0：不戴帽子，1：红色系，2：黄色系，3：蓝色系，4：黑色系，5：灰白色系，6：混色系子。" } }, "description": "帽子信息" }, "Eyebrow": { "type": "object", "properties": { "EyebrowLength": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "眉毛长短。\nAttributeItem对应的Type为 —— 0：短眉毛，1：长眉毛。" }, "EyebrowDensity": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "眉毛浓密。\nAttributeItem对应的Type为 —— 0：淡眉，1：浓眉。" }, "EyebrowCurve": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "眉毛弯曲。\nAttributeItem对应的Type为 —— 0：不弯，1：弯眉。" } }, "description": "眉毛信息" }, "Nose": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "鼻子信息。\nAttributeItem对应的Type为 —— 0：朝天鼻，1：鹰钩鼻，2：普通，3：圆鼻头\nFaceAttributesType 不含 Nose 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Smile": { "type": "number", "description": "微笑程度，[0,100]。\nFaceAttributesType 不含 Smile 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Mouth": { "type": "object", "properties": { "MouthOpen": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Type识别概率值，【0,1】,代表判断正确的概率。" }, "Type": { "type": "number", "description": "属性值" } }, "description": "是否张嘴信息。\nAttributeItem对应的Type为 —— 0：不张嘴，1：张嘴。" } }, "description": "嘴巴信息，可识别是否张嘴、嘴唇厚度。\nFaceAttributesType 不含 Mouth 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" } }, "description": "脸属性信息，根据 FaceAttributesType 输入的类型，返回年龄（Age）、颜值（Beauty）情绪（Emotion）、眼睛信息（Eye）、眉毛（Eyebrow）、性别（Gender）头发（Hair）、帽子（Hat）、姿态（Headpose）、口罩（Mask）、嘴巴（Mouth）、胡子（Moustache）鼻子（Nose）、脸型（Shape）、肤色（Skin）、微笑（Smile）等人脸属性信息。\n若 FaceAttributesType 没有输入相关类型，则FaceDetaiAttributesInfo返回的细项不具备参考意义。" } } } }, "RequestId": { "type": "string" }, "ImageWidth": { "type": "number" }, "ImageHeight": { "type": "number" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_23_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Image": { "type": "string", "description": "图片 base64 数据，base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url 。\n对应图片 base64 编码后大小不可超过5M。\njpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。\nUrl、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string" }, "FaceAttributesType": { "type": "string", "description": "是否返回年龄、性别、情绪等属性。\n合法值为（大小写不敏感）：None、Age、Beauty、Emotion、Eye、Eyebrow\nGender、Hair、Hat、Headpose、Mask、Mouth、Moustache、Nose、Shape、Skin、Smile。\nNone为不需要返回。默认为 None。\n需要将属性组成一个用逗号分隔的字符串，属性之间的顺序没有要求。" } }, "required": [ "ds_id" ] } } } } } }, "/1948-22": { "x-pointCode": 22, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-复制人员", "description": "将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "SucGroupNum": { "type": "number", "description": "成功加入的人员库数量" }, "SucGroupIds": { "type": "array", "items": { "type": "string" }, "description": "成功加入的人员库列表" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_22_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "GroupId": { "type": "string", "description": "待加入的人员库列表" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "GroupId", "ds_id" ] } } } } } }, "/1948-21": { "x-pointCode": 21, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-删除人脸", "description": "删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "SucDeletedNum": { "type": "number", "description": "删除成功的人脸数量" }, "SucFaceIds": { "type": "array", "items": { "type": "string" }, "description": "删除成功的人脸ID列表" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_21_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "FaceId": { "type": "string", "description": "待删除的人脸ID\n注意：\n最大支持删除5张\n例子：\n[\"46456444\",\"464343434\",\"467494\"]" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "FaceId", "ds_id" ] } } } } } }, "/1948-20": { "x-pointCode": 20, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-增加人脸", "description": "将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "RetCode": { "type": "array", "items": { "type": "string" }, "description": "每张人脸图片添加结果，-1101 代表未检测到人脸，-1102 代表图片解码失败，其他非 0 值代表算法服务异常。" }, "SucFaceIds": { "type": "array", "items": { "type": "string" }, "description": "加入成功的人脸ID列表" }, "SucFaceNum": { "type": "number", "description": "加入成功的人脸数量" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_20_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID。" }, "Image": { "type": "string", "description": "图片 base64 数据。人员人脸总数量\n不可超过5张。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。 \n人员人脸总数量不可超过5张。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。\n\n例子：\n[\"https://i04picsos.sogoucdn.com/61dc50b36b99ced8\",\"https://i02picsos.sogoucdn.com/ccc3eba7fe35273d\"]" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-19": { "x-pointCode": 19, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-修改人员描述信息", "description": "修改指定人员库人员描述内容。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_19_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "人员库ID" }, "PersonId": { "type": "string", "description": "人员ID" }, "PersonExDescriptionInfos": { "type": "array", "items": {}, "description": "需要修改的人员描述字段内容，key-value\n\nPersonExDescriptionIndex（参数类型为Integer）：人员库自定义描述字段Index，从0开始\nPersonExDescription（参数类型为String）：需要更新的人员库自定义描述字段内容\n\n例子\n[{\nPersonExDescriptionIndex:1,\nPersonExDescription:\"修改后测试描述\"\n}]\n" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupId", "PersonId", "PersonExDescriptionInfos", "ds_id" ] } } } } } }, "/1948-18": { "x-pointCode": 18, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-修改人员基础信息", "description": "修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_18_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "PersonName": { "type": "string", "description": "需要修改的人员名称" }, "Gender": { "type": "number", "description": "需要修改的人员性别,0代表未填写，1代表男性，2代表女性。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-17": { "x-pointCode": 17, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-获取人员归属信息", "description": "获取指定人员的信息，包括加入的人员库、描述内容等。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "GroupNum": { "type": "number", "description": "人员库总数量\n注意：此字段可能返回 null，表示取不到有效值。" }, "PersonGroupInfos": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "包含此人员的人员库ID" }, "PersonExDescriptions": { "type": "array", "items": { "type": "string" }, "description": "人员描述字段内容" } } } } }, "description": "包含此人员的人员库及描述字段内容列表" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_17_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "Offset": { "type": "number", "description": "起始序号，默认值为0" }, "Limit": { "type": "number", "description": "返回数量，默认值为10，最大值为100" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-16": { "x-pointCode": 16, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-获取人员基础信息", "description": "获取指定人员的信息，包括姓名、性别、人脸等。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "FaceIds": { "type": "array", "items": { "type": "string" }, "description": "包含的人脸图片列表" }, "Gender": { "type": "number", "description": "人员性别" }, "PersonName": { "type": "string", "description": "人员名称" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_16_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-15": { "x-pointCode": 15, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-获取人员列表长度", "description": "获取指定人员库中人员数量。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": {}, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_15_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "人员库ID" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupId", "ds_id" ] } } } } } }, "/1948-14": { "x-pointCode": 14, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-获取人员列表", "description": "获取指定人员库中的人员列表。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "FaceNum": { "type": "number", "description": "该人员库的人脸数量\n注意：此字段可能返回 null，表示取不到有效值。" }, "PersonInfos": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "FaceIds": { "type": "array", "items": { "type": "string" }, "description": "包含的人脸照片列表" }, "Gender": { "type": "number", "description": "人员性别" }, "PersonExDescriptions": { "type": "array", "items": { "type": "string" }, "description": "人员描述字段内容" }, "PersonId": { "type": "string", "description": "人员Id" }, "PersonName": { "type": "string", "description": "人员名称" } } } } }, "description": "返回的人员信息" }, "PersonNum": { "type": "number", "description": "该人员库的人员数量\n注意：此字段可能返回 null，表示取不到有效值。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_14_POST", "parameters": [ { "name": "GroupId", "in": "query", "description": "人员库ID", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "description": "起始序号，默认值为0", "required": true, "schema": { "type": "number" } }, { "name": "Limit", "in": "query", "description": "返回数量，默认值为10，最大值为1000", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/1948-13": { "x-pointCode": 13, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-人员库删除人员", "description": "从某人员库中删除人员，此操作仅影响该人员库。若该人员仅存在于指定的人员库中，该人员将被删除，其所有的人脸信息也将被删除。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_13_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "GroupId": { "type": "string", "description": "人员库ID" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "GroupId", "ds_id" ] } } } } } }, "/1948-12": { "x-pointCode": 12, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-删除人员", "description": "删除该人员信息，此操作会导致所有人员库均删除此人员。同时，该人员的所有人脸信息将被删除。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_12_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-11": { "x-pointCode": 11, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-创建人员", "description": "创建人员，添加人脸、姓名、性别及其他相关信息。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "FaceId": { "type": "string", "description": "人脸图片唯一标识。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_11_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "待加入的人员库ID。" }, "PersonName": { "type": "string", "description": "人员名称。[1，60]个字符，可修改，可重复。" }, "PersonId": { "type": "string", "description": "人员ID，单个腾讯云账号下不可修改，不可重复。支持英文、数字、-%@#&_，长度限制64B。" }, "Image": { "type": "string", "description": "图片 base64 数据。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Gender": { "type": "number", "description": "0代表未填写，1代表男性，2代表女性。" }, "PersonExDescriptionInfos": { "type": "array", "items": {}, "description": "人员描述字段内容，key-value。[0，60]个字符，可修改，可重复。\n\nPersonExDescriptionIndex（参数类型为Integer）：人员库自定义描述字段Index，从0开始\nPersonExDescription（参数类型为String）：需要更新的人员库自定义描述字段内容\n\n例子\n[{\nPersonExDescriptionIndex:1,\nPersonExDescription:\"修改后测试描述\"\n}]\n" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupId", "PersonName", "PersonId", "ds_id" ] } } } } } }, "/1948-10": { "x-pointCode": 10, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-修改人员库", "description": "修改人员库名称、备注、自定义描述字段名称。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_10_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "人员库ID、唯一的。" }, "GroupName": { "type": "string", "description": "人员库名称，唯一的。" }, "Tag": { "type": "string", "description": "人员库信息备注" }, "GroupExDescriptionInfos": { "type": "array", "items": {}, "description": "需要修改的人员库自定义描述字段\nGroupExDescriptionIndex（参数类型为Integer）：人员库自定义描述字段Index，从0开始\nGroupExDescription（参数类型为String）：需要更新的人员库自定义描述字段内容\n\n例子\n[{\nGroupExDescriptionIndex:1,\nGroupExDescription:\"修改后测试描述\"\n}]\n" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupId", "ds_id" ] } } } } } }, "/1948-9": { "x-pointCode": 9, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-获取人员库列表", "description": "获取人员库列表。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "GroupInfos": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "GroupExDescriptions": { "type": "array", "items": { "type": "string" }, "description": "Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。 \nUnix 纪元时间是 1970 年 1 月 1 日星期四，协调世界时 (UTC) 00:00:00。有关更多信息，请参阅 Unix 时间。\n注意：此字段可能返回 null，表示取不到有效值。" }, "GroupId": { "type": "string", "description": "人员库ID" }, "GroupName": { "type": "string", "description": "人员库名称" }, "Tag": { "type": "object", "properties": {}, "description": "人员库信息备注\n注意：此字段可能返回 null，表示取不到有效值。" } } } } }, "description": "返回的人员库信息" }, "GroupNum": { "type": "number", "description": "人员库总数量\n注意：此字段可能返回 null，表示取不到有效值。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_9_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Offset": { "type": "number", "description": "起始序号，默认值为0" }, "Limit": { "type": "number", "description": "返回数量，默认值为10，最大值为1000" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "Offset", "Limit", "ds_id" ] } } } } } }, "/1948-8": { "x-pointCode": 8, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-删除人员库", "description": "删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除。\n\n注：删除人员库的操作为异步执行，删除单张人脸时间约为10ms，即一小时内可以删除36万张。删除期间，无法向该人员库添加人员。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_8_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupId": { "type": "string", "description": "人员库ID。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupId", "ds_id" ] } } } } } }, "/1948-7": { "x-pointCode": 7, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人员库-创建人员库", "description": "用于创建一个空的人员库，如果人员库已存在返回错误。可根据需要创建自定义描述字段，用于辅助描述该人员库下的人员信息。1个APPID下最多创建2万个人员库（Group）、最多包含1000万张人脸（Face），单个人员库（Group）最多包含100万张人脸（Face）。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string", "description": "返回说明！" }, "ret_code": { "type": "number", "description": "0为成功，其余为失败" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_7_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupName": { "type": "string", "description": "人员库名称，[1,60]个字符，可修改，不可重复。" }, "GroupId": { "type": "string", "description": "人员库 ID，不可修改，不可重复。支持英文、数字、-%@#&_，长度限制64B。" }, "Tag": { "type": "string", "description": "人员库信息备注，[0，40]个字符。" }, "GroupExDescriptions": { "type": "array", "items": {}, "description": "人员库自定义描述字段，用于描述人员库中人员属性，该人员库下所有人员将拥有此描述字段。 \n最多可以创建5个。 \n每个自定义描述字段支持[1,30]个字符。 \n在同一人员库中自定义描述字段不可重复。 \n例：设置某人员库“自定义描述字段”为[\"学号\",\"工号\",\"手机号\"]， \n则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段， \n可在对应人员描述字段中填写内容，登记该人员的学号、工号、手机号等信息。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupName", "GroupId", "ds_id" ] } } } } } }, "/1948-6": { "x-pointCode": 6, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人脸静态活体检测", "description": "用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。\n\n静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用人脸核身·云智慧眼产品。\n\n图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Score": { "type": "number", "description": "活体打分，取值范围 [0,100]，分数一般落于[80, 100]区间内，0分也为常见值。推荐相大于 87 时可判断为活体。可根据具体场景自行调整阈值。" } } }, "remark": { "type": "string", "description": "返回说明！" }, "ret_code": { "type": "number", "description": "返回标识，0为成功，其余为失败！" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_6_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Image": { "type": "string", "description": "图片 base64 数据（图片的宽高比请接近3:4，不符合宽高比的图片返回的分值不具备参考意义）。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url 。图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n（图片的宽高比请接近 3:4，不符合宽高比的图片返回的分值不具备参考意义） \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/1948-5": { "x-pointCode": 5, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "基于人员库-人脸验证", "description": "给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考人员库管理相关接口。和人脸比对接口不同的是，人脸验证用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对用于判断两张人脸的相似度。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Score": { "type": "number", "description": "给定的人脸图片与 PersonId 对应人脸的相似度。若 PersonId 下有多张人脸（Face），返回相似度最大的分数。" }, "IsMatch": { "type": "array", "items": { "type": "boolean" }, "description": "是否为同一人的判断。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_5_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。" }, "Image": { "type": "string", "description": "图片 base64 数据。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url 。图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "PersonId", "ds_id" ] } } } } } }, "/1948-4": { "x-pointCode": 4, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "基于人员库-人脸搜索", "description": "用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，识别结果按照相似度从大到小排序。单次搜索的人员库人脸总数量不得超过 100 万张。此接口需与人员库管理相关接口结合使用。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "Candidates": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "PersonId": { "type": "string", "description": "人员ID" }, "FaceId": { "type": "string", "description": "人脸ID" }, "Score": { "type": "number", "description": "候选者的匹配得分。 \n10万大小人脸库，若人脸均为类似抓拍照（人脸质量较差）， \n误识率百分之一对应分数为70分，误识率千分之一对应分数为80分，误识率万分之一对应分数为90分； \n若人脸均为类似自拍照（人脸质量较好）， \n误识率百分之一对应分数为60分，误识率千分之一对应分数为70分，误识率万分之一对应分数为80分。 \n建议分数不要超过90分。您可以根据实际情况选择合适的分数。" } } } } }, "description": "识别出的最相似候选人" }, "FaceRect": { "type": "object", "properties": { "X": { "type": "number", "description": "人脸框左上角横坐标。 \n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。 \n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" }, "Y": { "type": "number", "description": "人脸框左上角纵坐标。 \n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。 \n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" }, "Width": { "type": "number", "description": "人脸宽度" }, "Height": { "type": "number", "description": "人脸高度" } }, "description": "检测出的人脸框位置" } } } } }, "description": "识别结果。" }, "FaceNum": { "type": "number", "description": "搜索的人员库中包含的人脸数。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_4_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GroupIds": { "type": "array", "items": {}, "description": "希望搜索的人员库列表，上限100个。\n" }, "Image": { "type": "string", "description": "图片 base64 数据。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url、Image必须提供一个，如果都提供，只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "MaxFaceNum": { "type": "number", "description": "最多处理的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 \nMaxFaceNum用于，当待识别图片包含多张人脸时，要搜索的人脸数量。 \n当 MaxFaceNum 不为1时，设MaxFaceNum=M，则实际上是 M:N 的人脸搜索（N为待搜索的人脸数）。" }, "MinFaceSize": { "type": "number", "description": "人脸长和宽的最小尺寸，单位为像素。默认为80。低于40将影响搜索精度。建议设置为80。" }, "MaxPersonNum": { "type": "number", "description": "被检测到的人脸，对应最多返回的最相似人员数目。默认值为5，最大值为10。 \n例，设MaxFaceNum为3，MaxPersonNum为5，则最多可能返回3*5=15个人员。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "GroupIds", "ds_id" ] } } } } } }, "/1948-3": { "x-pointCode": 3, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人脸比对", "description": "对两张图片中的人脸进行相似度比对，返回人脸相似度分数。阿里原接口订购地址：https://cloud.tencent.com/product/facerecognition\n\n若您需要判断 “此人是否是某人”，即验证某张图片中的人是否是已知身份的某人，如常见的人脸登录场景，建议使用人脸验证接口。\n\n若您需要判断图片中人脸的具体身份信息，如是否是身份证上对应的人，建议使用人脸核身·云智慧眼产品。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Score": { "type": "number", "description": "两张图片中人脸的相似度分数。 \n若需要验证两张图片中人脸是否为同一人，则误识率千分之一对应分数为70分，误识率万分之一对应分数为80分，误识率十万分之一对应分数为90分。 \n一般超过80分则可认定为同一人。 \n若需要验证两张图片中的人脸是否为同一人，建议使用人脸验证接口。" } } }, "remark": { "type": "string", "description": "返回说明！" }, "ret_code": { "type": "number", "description": "返回标识，0为成功，其余为失败" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_3_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ImageA": { "type": "string", "description": "A 图片 base64 数据。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ImageB": { "type": "string", "description": "B 图片 base64 数据。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "UrlA": { "type": "string", "description": "A 图片的 Url 。A 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "UrlB": { "type": "string", "description": "B 图片的 Url 。B 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸，只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/1948-2": { "x-pointCode": 2, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "五官定位", "description": "对请求图片进行五官定位（也称人脸关键点定位），计算构成人脸轮廓的 90 个点，包括眉毛（左右各 8 点）、眼睛（左右各 8 点）、鼻子（13 点）、嘴巴（22 点）、脸型轮廓（21 点）、眼珠[或瞳孔]（2点）。阿里原接口订购地址：https://cloud.tencent.com/product/facerecognition", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "FaceShapeSet": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "FaceProfile": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number", "description": "x坐标" }, "Y": { "type": "number", "description": "Y坐标" } } } } }, "description": "描述脸型轮廓的 21 点。" }, "LeftEye": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述左侧眼睛轮廓的 8 点。" }, "LeftEyeBrow": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述左侧眉毛轮廓的 8 点。" }, "LeftPupil": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "左瞳孔轮廓的 1 个点。" }, "Mouth": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述嘴巴轮廓的 22 点。" }, "Nose": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述鼻子轮廓的 13 点。" }, "RightEye": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述右侧眼睛轮廓的 8 点。" }, "RightEyeBrow": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "描述右侧眉毛轮廓的 8 点。" }, "RightPupil": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "X": { "type": "number" }, "Y": { "type": "number" } } } } }, "description": "右瞳孔轮廓的 1 个点。" } } } } }, "description": "五官定位（人脸关键点）具体信息。" }, "ImageHeight": { "type": "number", "description": "请求的图片高度。" }, "ImageWidth": { "type": "number", "description": "请求的图片宽度。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_2_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Image": { "type": "string", "description": "图片 base64 数据。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/1948-1": { "x-pointCode": 1, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "人脸检测与分析", "description": "检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。阿里原接口订购地址：https://cloud.tencent.com/product/facerecognition\n\n其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括：\n\n1）人员库创建人员/增加人脸：保证人员人脸信息的质量，便于后续的业务处理。\n\n2）人脸搜索：保证输入的图片质量，快速准确匹配到对应的人员。\n\n3）人脸验证：保证人脸信息的质量，避免明明是本人却认证不通过的情况。\n\n4）人脸融合：保证上传的人脸质量，人脸融合的效果更好。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "FaceInfos": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "object", "properties": { "FaceAttributesInfo": { "type": "object", "properties": { "Age": { "type": "number", "description": "年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Beauty": { "type": "number", "description": "魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Expression": { "type": "number", "description": "微笑[0(normal，正常)~50(smile，微笑)~100(laugh，大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "EyeOpen": { "type": "object", "properties": {}, "description": "双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼，就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Gender": { "type": "number", "description": "性别 [0(female，女性)~100(male，男性)]。 NeedFaceAttributes 不为 1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Glass": { "type": "object", "properties": {}, "description": "是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。" }, "Hair": { "type": "object", "properties": { "Bang": { "type": "number", "description": "0：有刘海，1：无刘海\n注意：此字段可能返回 null，表示取不到有效值。" }, "Color": { "type": "number", "description": "0：黑色，1：金色，2：棕色，3：灰白色\n注意：此字段可能返回 null，表示取不到有效值。" }, "Length": { "type": "number", "description": "0：光头，1：短发，2：中发，3：长发，4：绑发\n注意：此字段可能返回 null，表示取不到有效值。" } }, "description": "头发信息，包含头发长度（length）、有无刘海（bang）、头发颜色（color）。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Hat": { "type": "object", "properties": {}, "description": "是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Mask": { "type": "object", "properties": {}, "description": "是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Pitch": { "type": "number", "description": "上下偏移[-30,30]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。 \n建议：人脸入库选择[-10,10]的图片。" }, "Roll": { "type": "number", "description": "平面旋转[-180,180]。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。 \n建议：人脸入库选择[-20,20]的图片。" }, "Yaw": { "type": "number", "description": "左右偏移[-30,30]。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时，此参数仍返回，但不具备参考意义。 \n建议：人脸入库选择[-10,10]的图片。" } }, "description": "人脸属性信息，包含性别( gender )、年龄( age )、表情( expression )、 \n魅力( beauty )、眼镜( glass )、口罩（mask）、头发（hair）和姿态 (pitch，roll，yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。" }, "FaceQualityInfo": { "type": "object", "properties": { "Brightness": { "type": "number", "description": "光照分：[0,100]，评价图片光照程度，分数越高越亮。 \n参考范围： [0,30]偏暗，[30,70]光照正常，[70,100]偏亮。 \n建议：人脸入库选取[30,70]的图片。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Completeness": { "type": "object", "properties": { "Cheek": { "type": "number", "description": "脸颊的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围：[0,70]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Chin": { "type": "number", "description": "下巴的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围：[0,70]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Eye": { "type": "number", "description": "眼睛的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围：[0,80]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Eyebrow": { "type": "number", "description": "眉毛的遮挡分数[0,100]，分数越高遮挡越少。 \n参考范围：[0,80]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Mouth": { "type": "number", "description": "嘴巴的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围：[0,50]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Nose": { "type": "number", "description": "鼻子的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围：[0,60]表示发生遮挡。\n注意：此字段可能返回 null，表示取不到有效值。" } } }, "Score": { "type": "number", "description": "质量分: [0,100]，综合评价图像质量是否适合人脸识别，分数越高质量越好。 \n参考范围：[0,40]较差，[40,60] 一般，[60,80]较好，[80,100]很好。 \n建议：人脸入库选取70以上的图片。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Sharpness": { "type": "number", "description": "清晰分：[0,100]，评价图片清晰程度，分数越高越清晰。 \n参考范围：[0,40]特别模糊，[40,60]模糊，[60,80]一般，[80,100]清晰。 \n建议：人脸入库选取80以上的图片。\n注意：此字段可能返回 null，表示取不到有效值。" } }, "description": "人脸质量信息，包含质量分（score）、模糊分（sharpness）、光照分（brightness）、遮挡分（completeness）。只有当NeedFaceDetection设为1时才返回有效信息。\n注意：此字段可能返回 null，表示取不到有效值。" }, "Height": { "type": "number", "description": "人脸框高度。" }, "Width": { "type": "number", "description": "人脸框宽度。" }, "X": { "type": "number", "description": "人脸框左上角横坐标。\n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。 \n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" }, "Y": { "type": "number", "description": "人脸框左上角纵坐标。 \n人脸框包含人脸五官位置并在此基础上进行一定的扩展，若人脸框超出图片范围，会导致坐标负值。 \n若需截取完整人脸，可以在完整分completess满足需求的情况下，将负值坐标取0。" } } } } }, "description": "人脸信息列表。" }, "ImageHeight": { "type": "number", "description": "请求的图片高度。" }, "ImageWidth": { "type": "number", "description": "请求的图片宽度。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string", "description": "返回说明！" }, "ret_code": { "type": "number", "description": "返回标识。0为成功，其余为失败" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "1948_1_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Image": { "type": "string", "description": "图片 base64 数据。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "Url": { "type": "string", "description": "图片的 Url、Image必须提供一个，如果都提供，只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。" }, "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } } }, "components": { "securitySchemes": { "AppKeyAuth": { "type": "apiKey", "in": "query", "name": "appKey", "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp" } }, "schemas": { "ShowapiResEnvelope": { "type": "object", "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）", "properties": { "showapi_res_code": { "type": "integer", "description": "API 返回的状态码" }, "showapi_res_error": { "type": "string", "description": "API 返回的错误信息" }, "showapi_res_id": { "type": "string", "description": "API 请求的唯一标识" }, "showapi_fee_num": { "type": "integer", "description": "API 调用计费次数" } } } } }, "security": [ { "AppKeyAuth": [] } ], "externalDocs": { "url": "https://www.showapi.com/apiGateway/view/1948?tab=book" }, "x-apiCode": "1948", "x-is-own": false, "x-is-op": true }