接口列表

本节包含AI智能-人脸识别、人脸对比、人脸搜索等相关接口

以下接口，返回数据中 msg、 data 不是一定会返回的，但 requestId、 code 是必定会返回

接口列表如下：

序号 接口功能 描述
1 创建人脸集合 创建人脸集合
2 删除人脸集合 删除人脸集合
3 人脸检测 人脸检测
4 人脸注册 人脸注册
5 人脸注销 人脸注销
6 人脸比对 人脸比对
7 人脸搜索 人脸搜索
  • 公共返回码:
code msg 备注
200 操作成功
10001 参数错误
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10007 调用次数超限
10013 无权限调用
10029 接口调用太频繁
49999 操作异常 接口调用异常
50000 服务器异常
60200 非法的服务名
60201 确实必传参数或参数校验错误
60202 参数解析错误
60203 未开通相关服务
60204 服务已开通
60205 服务内部错误
60206 并发数超限
60210 图片数据错误
60211 图片尺寸错误(太大或太小)
60212 图片大小超过2M限制
60213 下载图片失败
60220 setToken不存在
60221 setToken数量超过10个
60222 faceToken数量超过10个
60223 faceToken不存在
60404 找不到人脸
60405 图片地址错误
60406 仅支持一张人脸
60507 服务超时
60508 服务器繁忙
60509 该功能暂时不支持

创建人脸集合

  • 接口功能

    该接口用于创建人脸识别的人脸集合,可设置人脸集合在人脸识别中的模式、阈值、优先级等信息

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/set/create

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
setName String 集合名称, 长度不大于 50 字节,不能包含特殊字符 Y
  • HTTP请求报文
POST /api/lapp/intelligence/face/set/create HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p &setName=test
  • 返回数据
{
    "requestId": "2d2ef768294549349499331685a5caa7",
    "data": {
        "setToken": "5784971dSb58bE49b9Ta7d3S95e4023f18e9"
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
setToken String 人脸集合唯一标识
  • 返回码

参见 公共返回码

删除人脸集合

  • 接口功能

该接口用于提供删除人脸识别的人脸集合,需要注意人脸集合删除会将注册到此人脸集合的人脸全部注销

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/set/delete

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
setTokens String 人脸集合的唯一标识，多个以英文逗号分割,一次最多支持 10 个 Y
  • HTTP请求报文
POST /api/services/face/set/delete HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&setTokens=sdfasdf
  • 返回数据
{
    "requestId": "bbd3d01bc36f4feca51026f491a22bdb",
    "code": "200",
    "msg": "操作成功"
}
  • 返回码

参见 公共返回码

人脸检测

  • 接口功能

    该接口用于对一张图片中的人脸进行检测分析

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/analysis/detect

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
dataType int 数据类型(0：图片URL; 1:base64 编码的二进制图片数据；) Y
image String 待分析的图片数据(base64 编码格式),图片数据大小最大2M,尺寸最大: 1280*1280 Y
operation String 可以是 none 或者由逗号分割的属性列表。
可选: gender-开启性别检测, age-开启年龄检测, glass-开启是否戴眼镜检测，faceScore:人脸评分，expression：微笑检测
默认均会检测人脸位置,若检测成功则查询时faceRect均会返回，若指定了其他项则检测查询时返回对应的结果值。		 N
rol String 检测区域矩形框：{"x":0.5, "y":0, "w":0.5, "h":1.0} N
  • HTTP请求报文
POST /api/lapp/intelligence/face/analysis/detect HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&dataType=1&image=asdfgasdfasd&operation=gender,age,glass
  • 返回数据
{
    "requestId": "1111",
    "data": {
        "faces": [{
            "faceToken": "FACEc36fe299H3875I4af9K9eb2H1bc720c0f3b3",
            "location": {
                "x": 918.0,
                "y": 466.0,
                "width": 46.0,
                "height": 50.0
            },
            "age": {
                "range": 5,
                "value": 25
            },
            "gender": {
                "confidence": 0.999959,
                "value": "female"
            },
            "glass": {
                "confidence": 0.999219,
                "has": true
            },
            "smile": {
                "confidence": 0.980595,
                "value": 5
            },
            "faceIQA":       {
        "pointsQuality": 0.918001,
        "eyeDistance": 19.100906,
        "colorful": 1,
        "grayScale": 163,
        "grayMean": 157.492722,
        "grayVar": 50.257435,
        "clearity": 0.6,
        "posePitch": 14.969134,
        "poseYaw": 5.001334,
        "uncovered": 0.8,
        "totalQuality": 0.45754
      }
        }]
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
faces Array 检测出的人形列表,如果没有检测出人形则为空数组
faceToken String 人脸唯一标识
location Location 检测出的人形列表,如果没有检测出人形则为空数组
height int 人形框的高度,单位 px
width int 人形框的宽度,单位 px
x int 人形框左上角的横坐标,单位 px
y int 人形框左上角的纵坐标,单位 px
age int 年龄
range int 波动范围
value int 检查年龄
gender Object 性别
confidence double 性别置信度
value String 检测性别， 取值: female 或 male
glass Object 是否戴眼镜
confidence double 戴眼镜置信度
value String 检测是否戴眼镜
smile Object 微笑指数
confidence double 微笑置信度
value String 1中性，2高兴，3惊讶，4害怕，5厌恶，6难过，7愤怒
faceIQA Object 人脸评分
  • 人脸评分
字段名 类型 取值范围 描述
pointsQuality float 【0-1】 特征点置信度：数值越大特征点定位越准；
eyeDistance float 实际像素点 瞳距：左右眼中心距离
colorful float 【0,1】 彩色置信度：数值越高，彩色可能性越大，0表示黑白图，1表示彩图；
grayScale int 1,2,3...,256 灰阶数：全图Y通道灰阶数量，过曝和过暗都会导致灰阶数变少；
grayMean float 【0,255】 灰度均值：白色区域越多，灰度均值越大；黑色区域越多灰度均值越小；
grayVar float 【0,255】 灰度均方差：阴阳脸会导致灰度方差变大；
clearity float 【0,1】 清晰度：人脸的清晰程度，数值越大越清晰；
posePitch float 【-90,90】 俯仰角：低头为负抬头为正，绝对值越大姿态越大，0表示正面；
poseYaw float 【-90,90】 左右角：左转为负右转为正，绝对值越大姿态越大，0表示正面；
uncovered float 【0,1】 可见性评分：即不遮挡评分，数值越小标识遮挡越严重，1表示完全未遮挡；
totalQuality float 【0,1】 人脸总评分：综合所有评分项得到的人脸总评分；数值越大人脸质量越高；
  • 返回码

参见 公共返回码

人脸注册

  • 接口功能：

    该接口用于将检测的人脸注册到创建的人脸集合

  • 请求地址:

    https://open.ys7.com/api/lapp/intelligence/face/set/register

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
faceTokens String 已检测的人脸唯一标识,多个以,分割,一次最多支持 10 个 Y
setToken int 人脸集合的唯一标识 Y
  • HTTP请求报文
POST /api/lapp/intelligence/face/set/register HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&faceTokens=asdfgasdfasd&setToken=sadfasddf
  • 返回数据
{
    "requestId": "639981d93cb041d8be60d078ae1bdf6f",
    "code": "200",
    "msg": "操作成功"
}
  • 返回码

参见 公共返回码

人脸注销

  • 接口功能

    该接口用于将已注册的人脸从人脸集合中移除

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/set/remove

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
faceTokens String 已检测的人脸唯一标识,多个以,分割,一次最多支持 10 个 Y
setToken int 人脸集合的唯一标识 Y
  • HTTP请求报文
POST /api/lapp/intelligence/face/set/remove HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&faceTokens=asdfgasdfasd&setToken=sadfasddf
  • 返回数据
{
      "requestId": "639981d93cb041d8be60d078ae1bdf6f",
      "code": "200",
      "msg": "操作成功"
}
  • 返回码

参见 公共返回码

人脸比对

  • 接口功能

    该接口用于两张图片中的人脸进行检测分析与比对

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/analysis/compare

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的 access_token Y
dataType String 数据类型： 1-base64编码的二进制图片数据, 2-已检测出人脸的 faceToken Y
imageParam1 String 需要比对的 faceToken1 或图片数据1
注:单张图片中必须仅一张人脸,多张人脸的图片无法比对成功		 Y
imageParam2 String 需要比对的 faceToken2 或图片数据2
注:单张图片中必须仅一张人脸,多张人脸的图片无法比对成功		 Y

注： imageParam1 和 imageParam2 数据类型需为同一dataType.

  • HTTP请求报文
POST /api/lapp/intelligence/face/analysis/compare HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&imageParam1= asdfasddfa&imageParam2=asdfasdfa&dataType=2
  • 返回数据
{
    "requestId": "fce534349b954378992b269d2b5b6cba",
    "data": {
        "score": 0.9996836185455322
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
score double 比对得分,介于 0~1 之间,越大标识两张图片相似度越高

人脸搜索

  • 接口功能

    该接口用于根据人脸在已注册的人脸库中检索的能力,给出最相似的人脸数据

  • 请求地址

    https://open.ys7.com/api/lapp/intelligence/face/analysis/search

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的 access_token Y
dataType int 数据类型: 2-已检测出人脸的 faceToken Y
image String 需要检索的人脸 faceToken Y
operation Array 搜索选项：需要检索的人脸集合唯一标识,阈值与最大匹配次数:
[ {
          "setToken":"a66f9f63-968d-4194-9e99-731be196e6ae", /* 指定需要检索的人脸集合唯一标识*/
         "threshold":80,/*识别阈值，范围为 0~100 之间，默认 80*/
          "matchCount":1 /* 匹配成功计数，默认为 1 表示匹配成功一次后即结束识别, 0 表示需要识别集合中的所有人脸*/
} ]
检索的人脸集合可多个		 Y
topNum int 返回最相似人脸的个数,默认 1 个, 最多返回 5 个 Y
  • HTTP请求报文
POST /api/lapp/intelligence/face/analysis/search HTTP/ 1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.cggzyoek3bh32xdqb01jbzei7dymi253&dataType=2&image=FACE26e01398Hbde3I4244K91f8H988a6b618e9e&operation=
  • 返回数据
{
    "data": {
        "results": [
            {
                "faceToken": "a66f9f63-968d-4194-9e99-731be196e6ae",
                "score": 0.99
            }
        ]
    },
    "requestId": "asdfasdfb954378992b269d2b5b6cba",
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
字段名 类型 描述
results Array 检索出匹配的人脸列表信息,如果没有匹配则为空数组
faceToken String 人脸唯一标识
score double 匹配得分
  • 返回码

参见 公共返回码

results matching ""

    No results matching ""