API文档目录

人脸查询

名单库人员属性检索

  • 接口说明

可根据人脸名单属性对指定人脸名单库中的人员进行检索,支持入库时间段筛选。人脸名单管理可使用【名单库管理】中的【人脸名单新增】【人脸名单修改】【人脸名单删除】接口进行新增、修改和删除。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryPersonByAttrWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回条数 20
 personLibId String true 人脸名单库ID(最大长度32)。可以从【人脸名单库查询】【人脸名单库添加】中获取。 20582e7c-f59e-4f26-bf1e-176ebf69d61d
 humanIds String false 人员名单唯一标识(“-1”为查询所有记录,多个使用”,”分割) 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
 name String false 姓名姓名(最大长度32位,只支持中文或英文和.) 张三
 registerGender String false 注册性别(male-男, female-女,unknown-未知。 最大长度为10) male
 certificateType Number false 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件) 111
 certificateNumber String false 证件号 330602201106010356
 nativeCountyCode String false 籍贯区县编号(支持模糊查询,后缀带%) 330602
 residenceCountyCode String false 居住地区县编号(支持模糊查询,后缀带%) 330602
 beginTime String false 入库开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String false 入库结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “personLibId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
   “humanIds”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”,
   “name”: “张三”,
   “registerGender”: “male”,
   “certificateType”: 111,
   “certificateNumber”: “330602201106010356”,
   “nativeCountyCode”: “330602”,
   “residenceCountyCode”: “330602”,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T00:00:00.000+08:00”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 每页返回的条数 false 20
  pageNo Number 指定第几页,从1开始 false 1
  list Array List数据 false
   list[0] Object 返回信息 false
    humanId String 人员名单id false 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
    name String 人员姓名(最大长度32位,只支持中文或英文和.) false 张三
    registerAge Number 人员年龄 false 8
    registerGender String 注册性别(male-男, female-女,unknown-未知。 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    registerGenderName String 注册性别说明 false
    certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,,337-机动车行驶证,414-护照,782-市名卡,990-其他证件。取值参考【数据字典】,typeCode为common.human_certificate_type) false 1
    certificateTypeName String 证件类型说明 false 身份证
    certificateNumber String 证件号 false 330602201106010356
    facePicUrl String 人脸URL,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?4dda40520-16e4611i4c33pb
    bornTime String 出生年月日(格式如2011-06-01) false 2011-06-10
    nativeCountyCode String 籍贯区县编号 false 330602
    residenceCountyCode String 居住地区县编号 false 330602
    personLibId String 名单库ID(最大长度32) false 951fe58e57f94c5193e492bb070d82be
    personLibName String 名单库名称(最大长度32,只支持中文、英文、数字、_、- ) false 名单库
    createDate String 入库时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: " 0",
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “humanId”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”,
         "name ": “张三”,
         "registerAge ": 8,
         “registerGender”: “male”,
         “registerGenderName”: “男”,
         “certificateType”: 1,
         “certificateTypeName”: “身份证”,
         "certificateNumber ": “330602201106010356”,
         "facePicUrl ": “http://ip:port/pic?4dda40520-16e4611i4c33pb”,
         "bornTime ": “2011-06-10”,
         “nativeCountyCode”: “330602”,
         “residenceCountyCode”: “330602”,
         “personLibId”: “951fe58e57f94c5193e492bb070d82be”,
         “personLibName”: “名单库”,
         "createDate ": “2017-06-15T00:00:00.000+08:00”
      }
    ]
  }
}

名单库以脸搜脸

  • 接口说明

用户可以根据人脸图片或人脸模型数据搜索指定名单库中的人脸名单信息;用户可以指定最小相似度、最大查询结果数量,按相似度从高到低排序。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryByImageModelWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回条数 20
 personLibId String true 人脸名单库ID(最大长度32)。可以从【人脸名单库查询】【人脸名单库添加】中获取。 951fe58e57f94c5193e492bb070d82be
 modelData String false 模型数据(模型、图片url、图片二进制三种选其一),模型数据可通过调用以下接口生成:【单张人脸图片检测建模】 AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=
 imageUrl String false 图片url(url需要进行encode编码,防止出现特殊字符。模型、图片url、图片二进制三种选其一。当直接上传图片url或者图片二进制时,默认使用公司对应的最优算法。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
 imageData String false 图片二进制数据(模型、图片url、图片二进制三种选其一。当直接上传图片url或者图片二进制时,默认使用公司对应的最优算法。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
 maxResults Number false 查询的最大结果数量(默认1000) 1000
 minSimilarity Number false 最小相似度(精确到小数点后两位, 取值范围[0,1]) 0.5
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “personLibId”: “951fe58e57f94c5193e492bb070d82be”,
   “modelData”: “AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=”,
   “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
   “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”,
   “maxResults”: 1000,
   “minSimilarity”: 0.5
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 每页返回的条数 false 20
  pageNo Number 指定第几页,从1开始 false 1
  list Array List数据 false
   list[0] Object 数据结果集 false
    humanId String 人员名单id false 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
    name String 人员姓名(最大长度32位,只支持中文或英文和.) false 张三
    registerAge Number 人员年龄 false 8
    registerGender String 注册性别(male-男, female-女,unknown-未知。 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    registerGenderName String 注册性别说明 false
    certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,,337-机动车行驶证,414-护照,782-市名卡,990-其他证件。取值参考【数据字典】,typeCode为common.human_certificate_type) false 111
    certificateTypeName String 证件类型说明 false 身份证
    certificateNumber String 证件号 false 330602201106010356
    facePicUrl String 人脸URL,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?4dda40520-16e4611i4c33pb
    bornTime String 出生年月日(格式如2011-06-01) false 2011-6-10
    nativeCountyCode String 籍贯区县编号 false 330602
    residenceCountyCode String 居住地区县编号 false 330602
    personLibId String 名单库ID(最大长度32) false 951fe58e57f94c5193e492bb070d82be
    personLibName String 名单库名称(最大长度32,只支持中文、英文、数字、_、- ) false 名单库
    similarity Number 相似度(foalt, 取值范围[0,1]) false 0.9646326899528503
    createDate String 入库时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: " 0",
   “msg”: " success",
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “humanId”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”,
         "name ": “张三”,
         "registerAge ": 8,
         “registerGender”: “male”,
         “registerGenderName”: “男”,
         “certificateType”: 111,
         “certificateTypeName”: “身份证”,
         "certificateNumber ": “330602201106010356”,
         "facePicUrl ": “http://ip:port/pic?4dda40520-16e4611i4c33pb”,
         "bornTime ": “2011-6-10”,
         “nativeCountyCode”: “330602”,
         “residenceCountyCode”: “330602”,
         “personLibId”: “951fe58e57f94c5193e492bb070d82be”,
         “personLibName”: “名单库”,
         “similarity”: 0.9646326899528503,
         “createDate”: “2017-06-15T00:00:00.000+08:00”
      }
    ]
  }
}

抓拍库人脸属性检索

  • 接口说明

可以根据姓名、性别、年龄段等人脸属性信息查询人脸抓拍信息。如需抓拍库统计信息可查阅【人脸统计】相关接口。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryDataByAttrWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回条数 20
 sort String true 排序字段(只支持按照抓拍时间captureTime排序) captureTime
 order String true 排序(desc-降序,asc-升序) desc
 cameraIndexCodes String true 监控点编号(通用唯一识别码UUID,“-1”代表所有;多个使用“,”分割,最多传2000个)。可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 name String false 姓名(支持模糊匹配),最大32位 张三
 gender String false 性别(male-男, female-女,unknown-未知, 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) male
 ageGroup String false 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】,typeCode为common.human_ageGroup) young
 certificateNumber String false 证件号码(支持模糊查询) 330221198909090356
 glass String false 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_glass) yes
 ethnic String false 是否少数民族(yes-是,no-否,取值参考【数据字典】,typeCode为common.human_ethnic) yes
 smile String false 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) yes
 linkBody String false 是否只过滤出能关联人体抓拍数据的人脸抓拍数据(yes:只查关联的…)。若填写yes,可用于以脸找人,返回的结果中linkFaceBodyId有值(一张图像中同时分析出了人脸信息和人体信息) yes
 linkFaceBodyId String false 人脸人体关联id(若该值有内容,可以作为查询条件,进行人体的属性检索,查询出对应的人体记录)。可通过调用【人体查询】中的接口获取,例如。 ECB6911A-2710-463A-9D44-0863C195C2ED
 linkVehicle String false 是否只过滤出能关联车辆抓拍数据的人脸抓拍数据(yes:只查关联的…)。若填写yes,可用于以脸找车,返回的结果中linkFaceVehicleId有值(一张图像中同时分析出了人脸信息和车辆信息) yes
 linkFaceVehicleId String false 人脸车辆关联id(若该值有内容,可以作为查询条件,进行过车的属性检索,查询出对应的过车记录)。可通过调用【车辆查询】中的接口获取,例如。 ECB6911A-2710-463A-9D44-0863C195C2ED
 plateNo String false 关联的车牌号码(若该值有内容,可以作为查询条件,进行过车的属性检索,查询出对应的过车记录) 浙A11111
 beginTime String false 抓拍开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String false 抓拍结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “sort”: “captureTime”,
   “order”: “desc”,
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   “name”: “张三”,
   “gender”: “male”,
   “ageGroup”: “young”,
   “certificateNumber”: “330221198909090356”,
   “glass”: “yes”,
   “ethnic”: “yes”,
   “smile”: “yes”,
   “linkBody”: “yes”,
   “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
   “linkVehicle”: “yes”,
   “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
   “plateNo”: “浙A11111”,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T00:00:00.000+08:00”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 每页返回的条数 false 20
  pageNo Number 指定第几页,从1开始 false 1
  list Array 人脸属性列表 false
   list[0] Object false
    id String 记录唯一标识 false 007520160324_2_165516
    name String 姓名,最大32位 false 张三
    gender String 性别(male-男, female-女,unknown-未知, 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    genderName String 性别说明 false
    glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_glass) false yes
    glassName String 是否戴眼镜说明 false
    ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】,typeCode为common.human_ageGroup) false unknown
    ageGroupName String 年龄段说明 false 未知
    ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】,typeCode为common.human_ethnic) false yes
    ethnicName String 是否少数民族说明 false
    facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
    smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
    smileName String 是否微笑说明 false
    certificateNumber String 证件号 false 330602201106010356
    cameraIndexCode String 监控点编号(通用唯一识别码UUID) false 90ad77d8057c43dab140b77361606927
    cameraName String 监控点名称,最大255字符 false Camera01
    faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
    linkFaceBodyId String 人脸人体关联id。如需查询该人脸相关的人体信息,可作为参数,调用 false ECB6911A-2710-463A-9D44-0863C195C2ED
    linkFaceVehicleId String 人脸车辆关联id。如需查询该人脸相关的车辆信息,可作为参数,调用 false ECB6911A-2710-463A-9D44-0863C195C2ED
    plateNo String 关联的车牌号码。如需查询该车牌相关的过车信息,可作为参数,调用 false 浙A11111
    captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “id”: “007520160324_2_165516”,
         "name ": “张三”,
         "gender ": “male”,
         “genderName”: “男”,
         “glass”: “yes”,
         “glassName”: “是”,
         “ageGroup”: “unknown”,
         “ageGroupName”: “未知”,
         “ethnic”: “yes”,
         “ethnicName”: “是”,
         "facePicUrl ": “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
         “smile”: “yes”,
         “smileName”: “是”,
         "certificateNumber ": “330602201106010356”,
         “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
         “cameraName”: “Camera01”,
         "faceRect ": “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
         “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “plateNo”: “浙A11111”,
         “captureTime”: "2004-05-03T17:30:08+08:00 "
      }
    ]
  }
}

抓拍库以脸搜脸

  • 接口说明

用户可以根据人脸图片或人脸模型数据搜索指定抓拍机和时间段内抓拍到的人脸信息,支持多张人脸图片或模型数据;用户可以指定最小相似度、最大查询结果数量,可以按相似度或抓拍时间排序。(该接口为同步查询接口,只支持当月数据查询)如需查询一个月以上数据,请使用异步接口【提交抓拍库以脸搜脸任务】然后通过【抓拍库以脸搜脸任务结果查询】获取结果。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryDataByImageModelWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageSize Number true 每页返回的条数 20
 pageNo Number true 指定第几页,从1开始 1
 sort String true 排序字段(similarity-按相似度排序,captureTime-按抓拍时间排序) similarity
 order String true 排序(desc-降序,asc-升序) desc
 imageInfo Object false 图片信息(支持传图片url,图片二进制数据,模型数据3种方式,三选一必填。若都填写默认按照图片url、图片二进制数据、模型数据的顺序选择参数)
  imageUrls Array false 支持传多张图片url数据(当图片中无法检测出人脸目标或者检测出多个人脸目标,会提示错误。上传多个目标图片时,条件是“或”的关系。默认使用公司最优算法进行检测建模)
   imageUrls[0] String false 图片访问地址(url需要进行encode编码,防止出现特殊字符。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
  imageDatas Array false 支持传多张图片二进制数据(当图片中无法检测出人脸目标或者检测出多个人脸目标,会提示错误。上传多个目标图片时,条件是“或”的关系。默认使用公司最优算法进行检测建模)
   imageDatas[0] String false 图片数据通过Base64编码后的字符串(图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp ) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
 model Array false 人脸检测后的人脸模型数组
  model[0] Object false
   modelData String false 模型数据(模型、图片url、图片二进制三种选其一),模型数据可通过调用以下接口生成:【单张人脸图片检测建模】 AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=
 cameraIndexCodes String true 监控点编号(通用唯一识别码UUID,“-1”代表所有;多个使用“,”分割,最多传2000个)。可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 minSimilarity Number false 模型对比最小阈值(取值范围: 0-1,精确到小数点后2位) 0.35
 maxResults Number false 模型比对结果的最大数目(以脸搜脸查询期望返回结果的最大个数,默认为1000) 8
 beginTime String true 查询开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String true 查询结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T30:00:00.000+08:00
  • 入参举例
{
   “pageSize”: 20,
   “pageNo”: 1,
   “sort”: “similarity”,
   “order”: “desc”,
   “imageInfo”: {
     “imageUrls”: [
       “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”
    ],
     “imageDatas”: [
       “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”
    ]
  },
   “model”: [
     {
       “modelData”: “AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=”
    }
  ],
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   “minSimilarity”: 0.35,
   “maxResults”: 8,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T30:00:00.000+08:00”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object false
  total Number 总条数 false 1
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array 符合条件的人脸数据列表 false
   list[0] Object false
    ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】,typeCode为common.human_ethnic) false yes
    ethnicName String 是否少数民族说明 false
    glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_glass) false yes
    glassName String 是否戴眼镜说明 false
    gender String 性别(male-男,female-女,unknown-未知,最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    genderName String 性别说明 false
    cameraIndexCode String 监控点编号(通用唯一识别码UUID) false 90ad77d8057c43dab140b77361606927
    cameraName String 监控点名称 false Camera01
    id String 记录唯一标识 false 007520160324_2_165516
    name String 姓名 false 张三
    facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
    ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】,typeCode为common.human_ageGroup) false unknown
    ageGroupName String 年龄段说明 false 未知
    certificateNumber String 证件号 false 330602201106010356
    faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
    linkFaceBodyId String 人脸人体关联id。如需查询该人脸相关的人体信息,可作为参数,调用【人体属性检索】 false ECB6911A-2710-463A-9D44-0863C195C2ED
    linkFaceVehicleId String 人脸车辆关联id。如需查询该人脸相关的车辆信息,可作为参数,调用 false ECB6911A-2710-463A-9D44-0863C195C2ED
    plateNo String 关联的车牌号码。如需查询该车牌相关的过车信息,可作为参数,调用 false 浙A11111
    similarity String 相似度(取值范围: 0-1, 精确到小数点后2位) false 0.50
    captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: " 0",
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “ethnic”: “yes”,
         “ethnicName”: “是”,
         “glass”: “yes”,
         “glassName”: “是”,
         "gender ": “male”,
         “genderName”: “男”,
         “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
         “cameraName”: “Camera01”,
         “id”: “007520160324_2_165516”,
         “name”: “张三”,
         "facePicUrl ": “http://ip:port/ facePicUrl”,
         "ageGroup ": “unknown”,
         “ageGroupName”: “未知”,
         "certificateNumber ": “330602201106010356”,
         "faceRect ": “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
         “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “plateNo”: “浙A11111”,
         “similarity”: “0.50”,
         “captureTime”: “2017-06-15T00:00:00.000+08:00”
      }
    ]
  }
}

提交抓拍库以脸搜脸任务

  • 接口说明

用于提交抓拍库以脸搜脸任务,即用户以人脸图片或人脸模型搜索指定抓拍机和时间段抓拍到的人脸数据的分析任务。支持多张人脸图片或模型。可指定最小相似度和查询最大结果数量。(该接口为异步查询接口,支持一个月以上数据查询)。
后置API:定时(如间隔2s)调用,查看任务进度。当进度返回100%时,调用【抓拍库以脸搜脸任务结果查询】

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryDataByModelWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 imageInfo Object false 图片信息(支持传图片url,图片二进制数据,模型数据3种方式,三选一必填。若都填写默认按照图片url、图片二进制数据、模型数据的顺序选择参数)。
  imageUrls Array false 支持传多张图片url数据(当图片中无法检测出人脸目标或者检测出多个人脸目标,会提示错误。上传多个目标图片时,条件是“或”的关系。默认使用公司最优算法进行检测建模)。
   imageUrls[0] String false 图片访问地址(url需要进行encode编码,防止出现特殊字符。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
  imageDatas Array false 支持传多张图片二进制数据(当图片中无法检测出人脸目标或者检测出多个人脸目标,会提示错误。上传多个目标图片时,条件是“或”的关系。默认使用公司最优算法进行检测建模)
   imageDatas[0] String false 图片数据通过Base64编码后的字符串(图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp ) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
 model Array false 人脸检测后的人脸模型数组。
  model[0] Object false
   modelData String false 模型数据(模型、图片url、图片二进制三种选其一),模型数据可通过调用以下接口生成:【单张人脸图片检测建模】 AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=
 beginTime String true 查询开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String true 查询结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T30:00:00.000+08:00
 cameraIndexCodes String true 监控点编号(通用唯一识别码UUID,“-1”代表所有;多个使用“,”分割,最多传2000个)。 可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 maxResults Number false 模型比对结果的最大数目(以脸搜脸查询期望返回结果的最大个数,默认为1000) 8
 minSimilarity String false 最小相似度(取值范围: 0-1, 精确到小数点后2位) 0.50
  • 入参举例
{
   “imageInfo”: {
     “imageUrls”: [
       “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”
    ],
     “imageDatas”: [
       “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”
    ]
  },
   “model”: [
     {
       “modelData”: “AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=”
    }
  ],
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T30:00:00.000+08:00”,
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   "maxResults ": 8,
   “minSimilarity”: “0.50”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的任务ID,最大长度为64。 可作为参数,调用相关接口,进行任务控制和状态查询。 false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

抓拍库以脸搜脸任务结果查询

  • 接口说明

调用接口后,使用任务ID调用【大数据任务状态查询】,查看任务进度。当进度返回100%时,使用任务ID调用本接口获取抓拍库以脸搜脸任务结果。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryDataByTaskWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskId String true 提交的任务ID,最大长度为64。 可调用获取 temp_301230caa5534d0d9de6f9c020936019
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 sort String true 排序字段(similarity-按相似度排序,captureTime-按抓拍时间排序) similarity
 order String true 排序(desc-降序,asc-升序) desc
  • 入参举例
{
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
   “pageNo”: 1,
   “pageSize”: 20,
   “sort”: “similarity”,
   “order”: “desc”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array 任务查询结果列表 false
   list[0] Object false
    id String 记录唯一标识 false 007520160324_2_165516
    name String 姓名,最大32位 false 张三
    facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
    gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    genderName String 性别说明 false
    glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_glass) false yes
    glassName String 是否戴眼镜说明 false
    ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】,typeCode为common.human_ageGroup) false unknown
    ageGroupName String 年龄段说明 false 未知
    cameraIndexCode String 监控点编号(通用唯一识别码UUID)。 可作为参数,调用【根据编号获取监控点详细信息】可作为参数,调用【根据监控点编号获取视频预览url】等API进行视频播放。 false 90ad77d8057c43dab140b77361606927
    cameraName String 监控点名称 false Camera01
    certificateNumber String 证件号 false 330602201106010356
    linkFaceBodyId String 人脸人体关联id。如需查询该人脸相关的人体信息,可作为参数,调用【人体属性检索】 false ECB6911A-2710-463A-9D44-0863C195C2ED
    linkFaceVehicleId String 人脸车辆关联id。如需查询该人脸相关的车辆信息,可作为参数,调用 false ECB6911A-2710-463A-9D44-0863C195C2ED
    plateNo String 关联的车牌号码。如需查询该车牌相关的过车信息,可作为参数,调用 false 浙A11111
    similarity String 相似度(取值范围: 0-1, 精确到小数点后2位) false 0.50
    captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “id”: “007520160324_2_165516”,
         "name ": “张三”,
         "facePicUrl ": “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
         "gender ": “male”,
         “genderName”: “男”,
         “glass”: “yes”,
         “glassName”: “是”,
         "ageGroup ": “unknown”,
         “ageGroupName”: “未知”,
         “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
         “cameraName”: “Camera01”,
         "certificateNumber ": “330602201106010356”,
         “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “plateNo”: “浙A11111”,
         “similarity”: “0.50”,
         “captureTime”: “2017-06-15T00:00:00.000+08:00”
      }
    ]
  }
}

根据id获取人脸抓拍记录详细信息

  • 接口说明

调用【抓拍库人脸属性检索】【抓拍库以脸搜脸】【抓拍库以脸搜脸任务结果查询】等接口后,根据返回的人脸记录id获取人脸抓拍记录详细信息。另外,本接口会额外返回该记录中人脸图片的模型数据,可直接用于人脸搜脸。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryDataById

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 id String false 记录唯一id。可通过【抓拍库人脸属性检索】【抓拍库以脸搜脸】【抓拍库以脸搜脸任务结果查询】 20180886400107_F737BDEE73A7584e31C35C86DC9A01DC
  • 入参举例
{
   “id”: “20180886400107_F737BDEE73A7584e31C35C86DC9A01DC”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  id String 记录唯一值 false 20180886400107_F737BDEE73A7584e31C35C86DC9A01DC
  name String 姓名(最大长度32位,只支持中文或英文和.) false 李四
  gender String 性别(unknown-未知,male-男性,female-女性。取值参考【数据字典】,typeCode为common.human_gender) false male
  genderName String 性别说明 false
  glass String 是否戴眼镜(unknown-未知,no-不带眼睛,yes-戴眼镜,sunglasses-戴墨镜…。取值参考【数据字典】,typeCode为common.human_glass) false yes
  glassName String 是否戴眼镜说明 false 戴眼镜
  ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年。取值参考【数据字典】,typeCode为common.human_ageGroup) false unknown
  ageGroupName String 年龄段说明 false 未知
  ethnic String 是否少数民族(yes-汉族,no-少数民族.取值参考【数据字典】,typeCode为common.human_ethnic) false yes
  ethnicName String 是否少数民族说明 false
  facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
  smile String 是否微笑(yes-微笑,no-不微笑,unknown–未知。取值参考【数据字典】,typeCode为common.human_smile) false yes
  smileName String 是否微笑说明 false 微笑
  certificateNumber String 证件号 false 330221198909090356
  cameraIndexCode String 设备编号 false 1c8d8fbd83184fcc870144393b5a547c
  cameraName String 设备名称,最大255字符 false camera1
  faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
  linkFaceBodyId String 人脸人体关联id(若该值有内容,可以作为查询条件,进行人脸的属性检索,查询出对应的人脸记录) 。可作为参数,调用【人体属性检索】 false 3d9e5a09-bda3-4d85-9374-361cb801c674
  linkFaceVehicleId String 人脸车辆关联id(若该值有内容,可以作为查询条件,进行过车的属性检索,查询出对应的人脸记录)。 可作为参数,调用 false ECB6911A-2710-463A-9D44-0863C195C2ED
  plateNo String 关联的车牌号码。可作为参数,调用 false 浙A11111
  captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  modelData String 模型数据,可以用于【名单库以脸搜脸】、【提交名单库以脸搜脸任务】、【提交抓拍库以脸搜脸任务】 false AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “id”: “20180886400107_F737BDEE73A7584e31C35C86DC9A01DC”,
     “name”: “李四”,
     “gender”: “male”,
     “genderName”: “男”,
     “glass”: “yes”,
     “glassName”: “戴眼镜”,
     “ageGroup”: “unknown”,
     “ageGroupName”: “未知”,
     “ethnic”: “yes”,
     “ethnicName”: “是”,
     “facePicUrl”: “http://ip:port/ facePicUrl”,
     “smile”: “yes”,
     “smileName”: “微笑”,
     “certificateNumber”: “330221198909090356”,
     “cameraIndexCode”: “1c8d8fbd83184fcc870144393b5a547c”,
     “cameraName”: “camera1”,
     “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
     “linkFaceBodyId”: “3d9e5a09-bda3-4d85-9374-361cb801c674”,
     “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
     “plateNo”: “浙A11111”,
     “captureTime”: “2017-06-15T00:00:00.000+08:00”,
     “modelData”: “AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=”
  }
}

人脸分析

提交找出出现频次大于阈值的人脸任务

  • 接口说明

用于提交指定时间段内经常出现在指定区域的人脸分析任务(即频繁过人任务),用户需要指定出现次数、相似度阈值和时间段区域。分析任务状态需要通过【大数据任务状态查询】。分析任务的人脸组结果和人脸组结果中的人脸详情分别通过【找出与目标人员前后出现次数大于阈值的人脸任务结果查询】【按分组编号查询出现频次大于阈值的人脸结果】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurFrequence/submitTask

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 threshold Number true 经过次数限制(不小于1的整数) 2
 minSimilarity Number true 相似度阈值(范围[0.7,1]浮点数) 0.75
 conditions Array true 任务条件(cameraIndexCodes必须相同,可传入多个时间段,按时间段划分区域,最大支持10组)
  conditions[0] Object true
   cameraIndexCodes String true 需要分析的监控点id(多个id以逗号分隔,最多传2000个)。可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52
   beginTime String true 开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
   endTime String true 结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 priority Number false 优先级(取值范围0-100整数,默认80) 80
  • 入参举例
{
   “threshold”: 2,
   “minSimilarity”: 0.75,
   “conditions”: [
     {
       “cameraIndexCodes”: “1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52”,
       “beginTime”: “2017-06-15T00:00:00.000+08:00”,
       “endTime”: “2017-06-15T00:00:00.000+08:00”
    }
  ],
   “priority”: 80
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

找出出现频次大于阈值的人脸任务结果查询

  • 接口说明

用于获取(即频繁过人分析任务)的分析结果。该结果返回的为人脸组结果和人脸组第一个人脸信息的详情。人脸组中其它人脸详情需要调用【按分组编号查询出现频次大于阈值的人脸结果】来获取

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurFrequence/queryDataByTaskIdWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过获取。 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 当前分页记录数 false 20
  pageNo Number 当前页 false 1
  list Array 现频次大于阈值的人脸任务结果列表 false
   list[0] Object false
    groupSize Number 人脸组记录大小 false 2
    groupId String 人脸组记录 false 20582e7c-f59e-4f26-bf1e-176ebf69d61d
    groupName String 人脸组名称 false 人脸组名称
    faceInfo Object 只返回人脸组第一个人脸的详情,人脸组其他人脸信息需要调用详情结果查询接口 false
     gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     genderName String 性别说明 false
     glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
     glassName String 是否戴眼镜说明 false
     id String 记录唯一值 false 007520160324_2_165516
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
     cameraIndexCode String 监控点标识值 false 90ad77d8057c43dab140b77361606927
     cameraName String 监控点名称 false 1楼大厅对南
     faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
     ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false child
     ageGroupName String 年龄段说明 false 少年
     name String 姓名,最大32位 false 张三
     ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
     ethnicName String 是否少数民族说明 false
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 居民身份证
     certificateNumber String 证件号 false 330602201106010356
     linkFaceBodyId String 人脸人体关联id(若该值有内容,可以作为查询条件,进行人脸的属性检索,查询出对应的人脸记录) false ECB6911A-2710-463A-9D44-0863C195C2ED
     linkFaceVehicleId String 人脸车辆关联id(若该值有内容,可以作为查询条件,进行过车的属性检索,查询出对应的人脸记录) false ECB6911A-2710-463A-9D44-0863C195C2ED
     plateNo String 关联的车牌号码 false 浙A11111
     captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “groupSize”: 2,
         “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
         “groupName”: “人脸组名称”,
         “faceInfo”: {
           “gender”: “male”,
           “genderName”: “男”,
           “glass”: “yes”,
           “glassName”: “是”,
           “id”: “007520160324_2_165516”,
           “facePicUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
           “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
           “cameraName”: “1楼大厅对南”,
           “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
           “ageGroup”: “child”,
           “ageGroupName”: “少年”,
           “name”: “张三”,
           “ethnic”: “yes”,
           “ethnicName”: “是”,
           “certificateType”: 111,
           “certificateTypeName”: “居民身份证”,
           “certificateNumber”: “330602201106010356”,
           “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
           “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
           “plateNo”: “浙A11111”,
           “captureTime”: “2017-06-15T00:00:00.000+08:00”
        }
      }
    ]
  }
}

按分组编号查询出现频次大于阈值的人脸结果

  • 接口说明

用于获取出现频次大于阈值的人脸任务(即频繁过人任务)人脸组结果中的人脸详情。分析任务的人脸组结果信息需要先通过获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurFrequence/queryDataByGroupIdWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 groupId String true 人脸组记录唯一标识。通过获取 20582e7c-f59e-4f26-bf1e-176ebf69d61d
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过【提交找出出现频次大于阈值的人脸任务】获取。 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageNo Number 当前分页记录数 false 1
  pageSize Number 当前页 false 20
  list Array 按分组编号查询出现频次大于阈值的人脸结果列表 false
   list[0] Object false
    gender String 性别(male-男, female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
    genderName String 性别说明 false
    glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
    glassName String 是否戴眼镜说明 false
    id String 记录唯一值 false 007520160324_2_165516
    facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
    cameraIndexCode String 监控点标识值 false 1c8d8fbd83184fcc870144393b5a547c
    cameraName String 监控点名称 false 1楼大厅对南
    faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
    ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false child
    ageGroupName String 年龄段说明 false 少年
    ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethni) false yes
    ethnicName String 是否少数民族说明 false
    certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
    certificateTypeName String 证件类型说明 false 居民身份证
    certificateNumber String 证件号 false 330602201106010356
    linkFaceBodyId String 人脸人体关联id(若该值有内容,可以作为查询条件,进行人脸的属性检索,查询出对应的人脸记录) false ECB6911A-2710-463A-9D44-0863C195C2ED
    linkFaceVehicleId String 人脸车辆关联id(若该值有内容,可以作为查询条件,进行过车的属性检索,查询出对应的人脸记录) false ECB6911A-2710-463A-9D44-0863C195C2ED
    plateNo String 关联的车牌号码 false 浙A11111
    captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         "gender ": “male”,
         “genderName”: “男”,
         “glass”: "yes ",
         “glassName”: “是”,
         “id”: “007520160324_2_165516”,
         "facePicUrl ": “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
         “cameraIndexCode”: “1c8d8fbd83184fcc870144393b5a547c”,
         “cameraName”: “1楼大厅对南”,
         “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
         "ageGroup ": “child”,
         “ageGroupName”: “少年”,
         “ethnic”: “yes”,
         “ethnicName”: “是”,
         “certificateType”: 111,
         “certificateTypeName”: “居民身份证”,
         “certificateNumber”: “330602201106010356”,
         “linkFaceBodyId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “linkFaceVehicleId”: “ECB6911A-2710-463A-9D44-0863C195C2ED”,
         “plateNo”: “浙A11111”,
         “captureTime”: “2017-06-15T00:00:00.000+08:00”
      }
    ]
  }
}

提交找出与目标人员前后出现次数大于阈值的人脸任务

  • 接口说明

用于提交指定时间段内经常目标人员同行的人脸分析任务(即同行人分析任务),用户可指定同行次数、同行间隔、最小相似度阈值、人脸聚类相似度阈值和时间段。分析任务状态需要通过【大数据任务状态查询】。分析任务的人脸组结果和人脸组结果中的人脸详情分别通过【找出与目标人员前后出现次数大于阈值的人脸任务结果查询】【按分组编号查询找出与目标人员前后出现次数大于阈值的人脸结果】.

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurTogether/submitTask

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 cameraIndexCodes String true 需要分析的监控点id(多个id以逗号分隔,最多传2000个)。可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52
 beginTime String true 查询的起始日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String true 查询的终止日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 minSimilarity Number false 模型对比最小阈值([0.7,1]浮点数,默认为0.9) 0.8
 threshold Number false 同行次数(1-100,边界包含) 20
 timeInterval Number false 同行时间间隔(单位秒 ) 20
 groupSimilarityMin Number false 人脸聚类相似度阈值([0.7,1]浮点数,当前增加阈值校验,以配置的最小值为准) 0.9
 priority Number false 碰撞任务优先级别系数(0-100整数,边界包含,默认80) 20
 modelData String false 按照图片url、图片二进制数据、模型数据的顺序选择参数,模型数据可通过调用以下接口生成:【单张人脸图片检测建模】 AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=
 imageUrl String false 图片访问地址(模型、图片url、图片二进制三种选其一。当直接上传图片url或者图片二进制时,默认使用公司对应的最优算法(Url需要进行encode编码,防止出现特殊字符)。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
 imageData String false 图片数据通过Base64编码后的字符串(模型、图片url、图片二进制三种选其一。当直接上传图片url或者图片二进制时,默认使用公司对应的最优算法。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
  • 入参举例
{
   “cameraIndexCodes”: “1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52”,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T00:00:00.000+08:00”,
   “minSimilarity”: 0.8,
   “threshold”: 20,
   “timeInterval”: 20,
   “groupSimilarityMin”: 0.9,
   “priority”: 20,
   “modelData”: “AgAAAOEAggyAL+7BYFAvsM7/8H4/n6BAAACAA=”,
   “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
   “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object false
  taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

找出与目标人员前后出现次数大于阈值的人脸任务结果查询

  • 接口说明

用于获取(即同行人分析任务)分析结果。该结果返回的为人脸组结果和人脸组第一个人脸信息的详情。人脸组中其它人脸详情需要调用【按分组编号查询找出与目标人员前后出现次数大于阈值的人脸结果】来获取

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurTogether/queryDataByTaskWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过获取 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object false
  total Number 总条数 false 1
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array List数据 false
   list[0] Object false
    groupSize Number 人脸组记录大小 false 1
    groupId String 人脸组id false 20582e7c-f59e-4f26-bf1e-176ebf69d61d
    groupName String 人脸组名称 false 人脸组名称
    faceInfo Object 只返回人脸组第一个人脸的详情,人脸组其他人脸信息需要调用详情结果查询接口 false
     id String 记录唯一值 false 007520160324_2_165516
     name String 姓名 false 李四
     gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     genderName String 性别说明 false
     glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
     glassName String 是否戴眼镜说明 false
     ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false unknown
     ageGroupName String 年龄段说明 false 未知
     ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
     ethnicName String 是否少数民族说明 false
     smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
     smileName String 是否微笑说明 false
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
     cameraIndexCode String 设备标识值 false 90ad77d8057c43dab140b77361606927
     cameraName String 设备名称 false 1楼大厅对南
     captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
     faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “groupSize”: 1,
         “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
         “groupName”: “人脸组名称”,
         “faceInfo”: {
           “id”: “007520160324_2_165516”,
           “name”: “李四”,
           “gender”: “male”,
           “genderName”: “男”,
           “glass”: “yes”,
           “glassName”: “是”,
           “ageGroup”: “unknown”,
           “ageGroupName”: “未知”,
           “ethnic”: “yes”,
           “ethnicName”: “是”,
           “smile”: “yes”,
           “smileName”: “是”,
           “certificateType”: 111,
           “certificateTypeName”: “身份证”,
           “certificateNumber”: “330602201106010356”,
           “facePicUrl”: “http://ip:port/ facePicUrl”,
           “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
           “cameraName”: “1楼大厅对南”,
           “captureTime”: "2004-05-03T17:30:08+08:00 ",
           “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”
        }
      }
    ]
  }
}

按分组编号查询找出与目标人员前后出现次数大于阈值的人脸结果

  • 接口说明

找出与目标人员前后出现次数大于阈值的人脸任务(即同行人分析任务)人脸组结果中的人脸详情。分析任务的人脸组结果信息需要先通过获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurTogether/queryDataByGroupIdWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 groupId String true 人脸组记录唯一标识。通过获取。 20582e7c-f59e-4f26-bf1e-176ebf69d61d
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过【提交找出与目标人员前后出现次数大于阈值的人脸任务】获取 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array List数据 false
   list[0] Object false
    targetPerson Object 目标人 false
     gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     genderName String 性别说明 false
     glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
     glassName String 是否戴眼镜说明 false
     id String 记录唯一值 false 007520160324_2_165516
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/face_url
     cameraIndexCode String 设备标识值 false 90ad77d8057c43dab140b77361606927
     cameraName String 设备名称,最多255字符 false 1楼大厅对南
     captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
     faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
     ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false child
     ageGroupName String 年龄段说明 false 少年
     ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
     ethnicName String 是否少数民族说明 false
     smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
     smileName String 是否微笑说明 false
     name String 姓名 false 李四
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
    peerPerson Object 同行人 false
     gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     genderName String 性别说明 false
     glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
     glassName String 是否戴眼镜说明 false
     id String 记录唯一值 false 007520160324_2_165516
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/face_url
     cameraIndexCode String 设备标识值 false 90ad77d8057c43dab140b77361606927
     cameraName String 设备名称,最多255字符 false 1楼大厅对南
     captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
     faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
     ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false child
     ageGroupName String 年龄段说明 false 少年
     ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
     ethnicName String 是否少数民族说明 false
     smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
     smileName String 是否微笑说明 false
     name String 姓名 false 李四
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “targetPerson”: {
           “gender”: “male”,
           “genderName”: “男”,
           “glass”: “yes”,
           “glassName”: “是”,
           “id”: “007520160324_2_165516”,
           “facePicUrl”: “http://ip:port/ facePicUrl”,
           “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
           “cameraName”: “1楼大厅对南”,
           “captureTime”: “2004-05-03T17:30:08+08:00”,
           “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
           “ageGroup”: “child”,
           “ageGroupName”: “少年”,
           “ethnic”: “yes”,
           “ethnicName”: “是”,
           “smile”: “yes”,
           “smileName”: “是”,
           “name”: “李四”,
           “certificateType”: 111,
           “certificateTypeName”: “身份证”,
           “certificateNumber”: “330602201106010356”
        },
         “peerPerson”: {
           “gender”: “male”,
           “genderName”: “男”,
           “glass”: “yes”,
           “glassName”: “是”,
           “id”: “007520160324_2_165516”,
           “facePicUrl”: “http://ip:port/ facePicUrl”,
           “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
           “cameraName”: “1楼大厅对南”,
           “captureTime”: “2004-05-03T17:30:08+08:00”,
           “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
           “ageGroup”: “child”,
           “ageGroupName”: “少年”,
           “ethnic”: “yes”,
           “ethnicName”: “是”,
           “smile”: “yes”,
           “smileName”: “是”,
           “name”: “李四”,
           “certificateType”: 111,
           “certificateTypeName”: “身份证”,
           “certificateNumber”: “330602201106010356”
        }
      }
    ]
  }
}

提交找出在不同时间不同地点都出现过的人脸任务

  • 接口说明

用于提交找出在不同时间不同地点都出现过的人脸分析任务(即抓拍库碰撞分析任务),用户需要指定相似度和至少两组时间段区域,通过碰撞分析可得到在指定时间段和区域都出现过的人员信息。分析任务状态可通过【大数据任务状态查询】。分析任务的人脸组结果和人脸组结果中的人脸详情分别通过【找出在不同时间不同地点都出现过的人脸任务结果查询】【按分组编号查询找出在不同时间不同地点都出现过的人脸结果】获取

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurCollision/submitTask

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 similarity Number true 人脸聚类相似度阈值(0到1之间的浮点数,如0.8,当前增加阈值校验,以配置的最小值为准) 0.8
 conditions Array true 至少需要2组,最大支持10组
  conditions[0] Object true
   cameraIndexCodes String true 需要分析的监控点id(多个id以逗号分隔,最多传2000个)。可调用中获取监控点相关API获取,如 1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52
   beginTime String true 查询的起始日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2004-05-03T17:30:08.000+08:00
   endTime String true 查询的终止日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2004-05-03T17:30:08.000+08:00
  conditions[1] Object true
   cameraIndexCodes String true 需要分析的监控点id(多个id以逗号分隔,最多传2000个)。可调用中获取监控点相关API获取,如 1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52
   beginTime String true 查询的起始日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2004-05-03T17:30:08.000+08:00
   endTime String true 查询的终止日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2004-05-03T17:30:08.000+08:00
  • 入参举例
{
   “similarity”: 0.8,
   “conditions”: [
     {
       “cameraIndexCodes”: “1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52”,
       “beginTime”: “2004-05-03T17:30:08.000+08:00”,
       “endTime”: “2004-05-03T17:30:08.000+08:00”
    },
     {
       “cameraIndexCodes”: “1c8d8fbd83184fcc870144393b5a547c,44eb64663bd14eee85e9b96acd07ed52”,
       “beginTime”: “2004-05-03T17:30:08.000+08:00”,
       “endTime”: “2004-05-03T17:30:08.000+08:00”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

找出在不同时间不同地点都出现过的人脸任务结果查询

  • 接口说明

用于获取(即抓拍库碰撞分析任务)分析结果。该结果返回的为人脸组结果和人脸组第一个人脸信息的详情。人脸组中其它人脸详情需要调用【按分组编号查询找出在不同时间不同地点都出现过的人脸结果】

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurCollision/queryDataByTaskWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过获取。 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array List数据 false
   list[0] Object false
    groupSize Number 人脸组记录大小 false 1
    groupId String 人脸组id false 20582e7c-f59e-4f26-bf1e-176ebf69d61d
    groupName String 人脸组名称 false 人脸组名称
    faceInfo Object 只返回人脸组第一个人脸的详情,人脸组其他人脸信息需要调用详情结果查询接口 false
     id String 记录唯一值 false 007520160324_2_165516
     name String 姓名 false 李四
     gender String 性别 false male
     glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
     glassName String 是否戴眼镜说明 false
     ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false unknown
     ageGroupName String 年龄段说明 false 未知
     ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
     ethnicName String 是否少数民族说明 false
     smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
     smileName String 是否微笑说明 false
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
     cameraIndexCode String 设备标识值 false 90ad77d8057c43dab140b77361606927
     cameraName String 设备名称,最多255字符 false 1楼大厅对南
     captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
     faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/ facePicUrl
     threshold Number 出现次数 false 10
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “groupSize”: 1,
         “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
         “groupName”: “人脸组名称”,
         “faceInfo”: {
           “id”: “007520160324_2_165516”,
           “name”: “李四”,
           “gender”: “male”,
           “glass”: “yes”,
           “glassName”: “是”,
           “ageGroup”: “unknown”,
           “ageGroupName”: “未知”,
           “ethnic”: “yes”,
           “ethnicName”: “是”,
           “smile”: “yes”,
           “smileName”: “是”,
           “certificateType”: 111,
           “certificateTypeName”: “身份证”,
           “certificateNumber”: “330602201106010356”,
           “facePicUrl”: “http://ip:port/ facePicUrl”,
           “cameraIndexCode”: “90ad77d8057c43dab140b77361606927”,
           “cameraName”: “1楼大厅对南”,
           “captureTime”: "2004-05-03T17:30:08+08:00 ",
           “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”,
           “threshold”: 10
        }
      }
    ]
  }
}

按分组编号查询找出在不同时间不同地点都出现过的人脸结果

  • 接口说明

用于获取找出在不同时间不同地点都出现过的人脸任务(即抓拍库碰撞分析任务)人脸组结果中的人脸详情。分析任务的人脸组结果信息需要先通过获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/occurCollision/queryDataByGroupIdWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
参数名称 数据类型 参数类型 属性描述 是否必填 示例
userId String Query 内部系统的用户id true admin
  • 请求Body定义
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 groupId String true 人脸组记录唯一标识。通过获取。 20582e7c-f59e-4f26-bf1e-176ebf69d61d
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过【提交找出在不同时间不同地点都出现过的人脸任务】获取。 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “groupId”: “20582e7c-f59e-4f26-bf1e-176ebf69d61d”,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 当前分页记录数 false 20
  pageNo Number 当前页 false 1
  list Array List数据 false
   list[0] Object false
    id String 记录唯一值 false 007520160324_2_165516
    name String 姓名(最大长度32位) false 李四
    gender String 性别(male-男,female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
    genderName String 性别说明 false
    glass String 是否戴眼镜(yes-是,no-否,unknown–未知,取值参考【数据字典】typeCode为common.human_glass) false yes
    glassName String 是否戴眼镜说明 false
    ageGroup String 年龄段(unknown-未知,child-少年,young-青年,middle-中年,old-老年,取值参考【数据字典】typeCode为common.human_ageGroup) false unknown
    ageGroupName String 年龄段说明 false 未知
    ethnic String 是否少数民族(yes-是,no-否,取值参考【数据字典】typeCode为common.human_ethnic) false yes
    ethnicName String 是否少数民族说明 false
    smile String 是否微笑(yes-是,no-否,unknown–未知,取值参考【数据字典】,typeCode为common.human_smile) false yes
    smileName String 是否微笑说明 false
    certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
    certificateTypeName String 证件类型说明 false 身份证
    certificateNumber String 证件号 false 330602201106010356
    facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/facePicUrl
    cameraIndexCode String 设备标识值 false 1c8d8fbd83184fcc870144393b5a547c
    cameraName String 设备名称,最多255字符 false 1楼大厅对南
    captureTime String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2004-05-03T17:30:08+08:00
    faceRect String 人脸矩形框,该字段具体使用方式参考【目标框位置坐标说明】 false {“height”:0.514,“width”:0.2909,“y”:0.3669,“x”:0.183}
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “id”: “007520160324_2_165516”,
         “name”: “李四”,
         "gender ": “male”,
         “genderName”: “男”,
         “glass”: "yes ",
         “glassName”: “是”,
         "ageGroup ": “unknown”,
         “ageGroupName”: “未知”,
         “ethnic”: “yes”,
         “ethnicName”: “是”,
         “smile”: “yes”,
         “smileName”: “是”,
         “certificateType”: 111,
         “certificateTypeName”: “身份证”,
         “certificateNumber”: “330602201106010356”,
         "facePicUrl ": “http://ip:port/facePicUrl”,
         “cameraIndexCode”: “1c8d8fbd83184fcc870144393b5a547c”,
         “cameraName”: “1楼大厅对南”,
         “captureTime”: "2004-05-03T17:30:08+08:00 ",
         “faceRect”: “{\“height\”:0.514,\“width\”:0.2909,\“y\”:0.3669,\“x\”:0.183}”
      }
    ]
  }
}

提交名单库相似人脸照片分析任务

  • 接口说明

用于提交名单库相似人脸照片分析任务,即对单个名单库或两个名单库之间人脸名单数据进行碰撞分析,找出人脸图片符合指定相似度的人员名单信息。分析任务状态和结果需要通过【大数据任务状态查询】和【名单库相似人脸照片分析结果查询】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/personLibsOccurCollision/submitTask

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 overlapCondition Array true 单个碰撞库的参数
  overlapCondition[0] Object true
   personLibId String true 名单库ID(最大为32位)。可通过【人脸名单库查询】获取。 951fe58e57f94c5193e492bb070d82be
   registerGender String false 人员性别(-1-无限制,unknow-未知,male-男,female-女) -1
   province String false 省份字典 33
   city String false 城市字典 05
 threshold String true 人脸相似度阈值(0到1之间的浮点数,如0.8) 0.8
 hitMale String false 碰撞性别(-1:全碰撞,0:同性别碰撞) -1
 hitAgeInterval String false 碰撞间隔年龄差(默认2,-1为不限制年龄差) -1
 hitPriority String false 碰撞任务优先级别系数(0-100,边界包含,默认80) 80
 hitBeginTime String false 碰撞任务执行的开始时间(格式如20:01:01,默认为03:30:00) 03:30:00
 hitEndTime String false 碰撞任务执行的结束时间(格式如05:01:01,默认为08:30:00) 08:30:00
 humanNum String false 碰撞任务每组人数限制(默认10) 10
  • 入参举例
{
   “overlapCondition”: [
     {
       “personLibId”: “951fe58e57f94c5193e492bb070d82be”,
       “registerGender”: “-1”,
       “province”: “33”,
       “city”: “05”
    }
  ],
   “threshold”: “0.8”,
   “hitMale”: “-1”,
   “hitAgeInterval”: “-1”,
   “hitPriority”: “80”,
   “hitBeginTime”: “03:30:00”,
   “hitEndTime”: “08:30:00”,
   “humanNum”: “10”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的任务ID(最大长度为64,通过该标识可以控制任务操作) false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

名单库相似人脸照片分析结果查询

  • 接口说明

用于获取结果,即单个名单库中或两个名单库中人脸照片符合指定相似度的名单信息。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/personLibsOccurCollision/queryDataByTaskWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 taskId String true 提交的任务ID(最大长度为64,通过该标识可以控制任务操作)。通过获取。 temp_301230caa5534d0d9de6f9c020936019
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 2
  pageNo Number 当前页 false 1
  pageSize Number 当前分页记录数 false 20
  list Array List数据 false
   list[0] Object false
    personOne Object 相似人员1信息 false
     id String 记录唯一值 false 007520160324_2_165516
     name String 姓名(最大长度32位) false 张三
     bornTime String 出生年月日(格式如2011-06-01) false 2011-06-01
     certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 居民身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
     registerGender String 注册性别(male-男, female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     registerGenderName String 注册性别说明 false
     personLibId String 人员所属的名单库Id(最大为32位) false 53c372db1ac34e94a7cf985ac489fa9a
    personTwo Object 相似的人员2信息 false
     id String 记录唯一值 false 007520160324_2_165525
     name String 姓名(最大长度32位) false 李四
     bornTime String 出生年月日(格式如2011-06-01) false 2011-06-01
     certificateType String 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件,取值参考【数据字典】typeCode为common.human_certificate_type) false 111
     certificateTypeName String 证件类型说明 false 居民身份证
     certificateNumber String 证件号 false 330602201106010356
     facePicUrl String 人脸小图url,该字段具体使用方式参考【图片访问方式说明】 false https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
     registerGender String 注册性别(male-男, female-女,unknown-未知, 最大长度为10,取值参考【数据字典】typeCode为common.human_gender) false male
     registerGenderName String 注册性别说明 false
     personLibId String 人员所属的名单库Id(最大长度32位) false 53c372db1ac34e94a7cf985ac489fa9a
    similarity String 两张照片的相似度 false 0.8
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 2,
     “pageNo”: 1,
     “pageSize”: 20,
     “list”: [
       {
         “personOne”: {
           “id”: “007520160324_2_165516”,
           “name”: “张三”,
           “bornTime”: “2011-06-01\t”,
           “certificateType”: 111,
           “certificateTypeName”: “居民身份证”,
           “certificateNumber”: “330602201106010356”,
           “facePicUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
           “registerGender”: “male”,
           “registerGenderName”: “男”,
           “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”
        },
         “personTwo”: {
           “id”: “007520160324_2_165525”,
           “name”: “李四”,
           “bornTime”: “2011-06-01\t”,
           “certificateType”: “111”,
           “certificateTypeName”: “居民身份证”,
           “certificateNumber”: “330602201106010356”,
           “facePicUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
           “registerGender”: “male”,
           “registerGenderName”: “男”,
           “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”
        },
         “similarity”: “0.8”
      }
    ]
  }
}

人脸统计

按时间段统计人脸抓拍数量

  • 接口说明

抓拍库数据统计信息查询,可查询指定时间段内,抓拍数据量、高危人员数量或新面孔数量的统计信息,可提供按日、按月、按年统计结果。抓拍库查询可查阅【人脸查询】中相关接口

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/statisticsTotalNumByTime

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 cameraIndexCodes String true 设备Id(多个Id用“,”分割,最多传2000个,TOTAL表示统计某一时段所有相机的抓拍总数)可调用【资源目录服务->API服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 humanType Number true 目标类型(0-抓拍统计,1-高危人员,2-新面孔) 1
 statisticsType Number true 统计类型(0-日报表,1-月报表,2-年报表) 1
 beginTime String true 查询的起始日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 stopTime String true 查询的终止日期(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 pageNo String true 查询结果的页码数(不能小于1,cameraIndexcodes为TOTAL时不生效) 1
 pageSize String true 查询结果每页的数量(不能小于1,cameraIndexcodes为TOTAL时不生效) 20
  • 入参举例
{
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   “humanType”: 1,
   “statisticsType”: 1,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “stopTime”: “2017-06-15T00:00:00.000+08:00”,
   “pageNo”: “1”,
   “pageSize”: “20”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 数据总数 false 1
  pageSize Number 每页返回条数 false 20
  pageNo String 指定第几页,从1开始 false 1
  list Array list数据 false
   list[0] Object false
    time String 抓拍时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
    count String 统计次数 false 54194
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: “1”,
     “list”: [
       {
         “time”: “2017-06-15T00:00:00.000+08:00”,
         “count”: “54194”
      }
    ]
  }
}

名单库管理

人脸名单库查询

  • 接口说明

用于查询人脸名单库详情和列表信息,可以根据人脸名单库ID查询人脸名单库详情,支持批量查询;无人脸名单库ID时,可以获取所有人脸名单库列表。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/faceLib/getPersonLib

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 personLibIds String false 名单库唯一标识(逗号分隔,不传时返回所有,最多100个) 53c372db1ac34e94a7cf985ac489fa9a,862bc244778447d29168c3673767108d
  • 入参举例
{
   “personLibIds”: “53c372db1ac34e94a7cf985ac489fa9a,862bc244778447d29168c3673767108d”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  list Array 名单库列表 false
   list[0] Object false
    personLibId String 名单库唯一标识(最大长度32) false 53c372db1ac34e94a7cf985ac489fa9a
    personLibName String 名单库名称(最大长度32,只支持中文、英文、数字、_、- ) false 测试名单库
    describe String 备注(最大长度64) false 名单库详细信息备注
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “list”: [
       {
         “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”,
         “personLibName”: “测试名单库”,
         “describe”: “名单库详细信息备注”
      }
    ]
  }
}

人脸名单库添加

  • 接口说明

用于新建人脸名单库。【人脸名单库添加】【人脸名单库布控任务】【名单库人员属性检索】【名单库以脸搜脸】等名单库关联接口依赖人脸名单库信息。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/faceLib/addPersonLib

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 personLibName String true 名单库名称(最大长度32,只支持中文、英文、数字、_、- ) 测试名单库
 describe String false 备注(最大长度64) 名单库详细信息备注
  • 入参举例
{
   “personLibName”: “测试名单库”,
   “describe”: “名单库详细信息备注”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  personLibId String 名单库唯一标识(最大长度32) false 53c372db1ac34e94a7cf985ac489fa9a
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”
  }
}

人脸名单库修改

  • 接口说明

用于人脸名单库信息修改,可以对人脸名单库名称和描述进行修改。已有人脸名单库信息可通过【人脸名单库查询】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/faceLib/modifyPersonLib

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 personLibId String true 名单库ID(最大长度32)。可以从【人脸名单库查询】获取 53c372db1ac34e94a7cf985ac489fa9a
 personLibName String false 名单库名称(最大长度32,只支持中文、英文、数字、_、- ) 测试名单库
 describe String false 备注(最大长度64) 名单库详细信息备注
  • 入参举例
{
   “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”,
   “personLibName”: “测试名单库”,
   “describe”: “名单库详细信息备注”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

人脸名单库删除

  • 接口说明

用于删除指定的人脸名单库,可以根据人脸名单库ID删除人脸名单库信息。已有人脸名单库信息可通过【人脸名单库查询】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/faceLib/deletePersonLib

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 personLibId String true 名单库唯一标识(最大长度32)可以从【人脸名单库查询】获取 53c372db1ac34e94a7cf985ac489fa9a
  • 入参举例
{
   “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

人脸名单新增

  • 接口说明

用于新建人脸名单,即新增人脸名单信息,包含姓名、性别、出生年月日、证件号、籍贯区县编号、居住地区编号、人员地址信息和人脸图片信息属性。新增人脸名单时需要指定需要加入的名单库,
可调用【人脸名单库添加】创建新的名单库或调用【人脸名单库查询】获取已存在的名单库

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/addPerson

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 personLibId String true 所属名单库ID(最大长度32)可调用【人脸名单库添加】新建名单库或调用【人脸名单库查询】获取已有名单库 53c372db1ac34e94a7cf985ac489fa9a
 name String true 姓名(最大长度32位,只支持中文或英文和.) 张三
 registerGender String false 注册性别(male-男, female-女,unknown-未知,最大长度为10,默认为unknown) female
 bornTime String false 出生年月日(格式如2011-06-01) 2011-06-01
 certificateType Number false 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件) 111
 certificateNumber String false 证件号 330602201106010356
 nativeCountyCode String false 籍贯区县编号 330602
 residenceCountyCode String false 居住地区县编号 330602
 address String false 人员住址信息 杭州市滨江区阡陌路
 imageUrl String false 图片访问地址(imageUrl与imageData二选一必填,但当两者都存在的时候,默认使用imageUrl(Url需要进行encode编码,防止出现特殊字符)。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
 imageData String false 图片数据通过Base64编码后的字符串(imageUrl与imageData二选一必填,但当两者都存在的时候,默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
  • 入参举例
{
   “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”,
   “name”: “张三”,
   “registerGender”: “female”,
   “bornTime”: “2011-06-01”,
   “certificateType”: 111,
   “certificateNumber”: “330602201106010356”,
   “nativeCountyCode”: “330602”,
   “residenceCountyCode”: “330602”,
   “address”: “杭州市滨江区阡陌路”,
   “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
   “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  humanId String 人员名单id(70位) false 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “humanId”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”
  }
}

人脸名单修改

  • 接口说明

用于人脸名单信息的修改,可以对姓名、性别、出生年月日、证件号、籍贯区县编号、居住地区编号、人员地址信息和人脸图片等信息进行修改。已有人脸名单信息可以通过【名单库人员属性检索】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/modifyPerson

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 humanId String true 人脸名单信息唯一标识(70位)可以从【人脸名单库查询】【人脸名单库添加】获取 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
 personLibId String true 名单库唯一标识(最大长度32) 53c372db1ac34e94a7cf985ac489fa9a
 name String false 姓名(最大长度32,只支持中文或英文和.) 张三
 registerGender String false 注册性别(male-男, female-女,unknown-未知), 最大长度为10) female
 bornTime String false 出生年月日(格式如2011-06-01) 2011-06-01
 certificateType Number false 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市民卡,990-其他证件)) 111
 certificateNumber String false 证件号 330602201106010356
 nativeCountyCode String false 籍贯区县编号 330602
 residenceCountyCode String false 居住地区县编号 330602
 address String false 人员住址信息 杭州市滨江区阡陌路
 imageUrl String false 图片访问地址(imageUrl与imageData二选一非必填,但当两者都存在的时候,默认使用imageUrl(Url需要进行encode编码,防止出现特殊字符)。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
 imageData String false 图片数据通过Base64编码后的字符串(imageUrl与imageData二选一非必填,但当两者都存在的时候,默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
  • 入参举例
{
   “humanId”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”,
   “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”,
   “name”: “张三”,
   “registerGender”: “female”,
   “bornTime”: “2011-06-01”,
   “certificateType”: 111,
   “certificateNumber”: “330602201106010356”,
   “nativeCountyCode”: “330602”,
   “residenceCountyCode”: “330602”,
   “address”: “杭州市滨江区阡陌路”,
   “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
   “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

人脸名单删除

  • 接口说明

用于人脸名单信息删除,可以根据名单ID删除指定人脸名单信息。已有人脸名单信息可以通过【人脸名单库查询】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/deletePerson

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 humanId String true 人员信息唯一标识(70位)可以从【人脸名单库查询】获取 0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85
 personLibId String true 名单库唯一标识(最大长度32) 53c372db1ac34e94a7cf985ac489fa9a
  • 入参举例
{
   “humanId”: “0599_862bc244778447d29168c3673767108d_0887866a80c749388271de4f9ae29e85”,
   “personLibId”: “53c372db1ac34e94a7cf985ac489fa9a”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

人脸布控

单张人脸图片布控

  • 接口说明

可以对单张人脸图片进行布防,用户需要指定需要布控的监控点和时间段,可以根据需要补充布控人脸图片的人员信息,支持布控报警接收手机号,支持分段报警阈值设置。
  1.实时布控告警信息可通过【按事件类型获取事件订阅信息】获取
  2.历史告警记录可通过【人脸布控报警记录查询】获取
  3.布控任务状态可通过【布控任务通用服务】来查询和控制

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/addSinglePictureControl

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 name String true 布控名称(最大长度60) 嫌犯张三_布控
 cameraIndexCodes String true 需要分析的监控点编号(通用唯一识别码UUID,多个id以逗号分隔,最多传2000个)可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927, ZPJ14883601705420002156
 personInfo Object false 人员信息
  imageUrl String false 图片URL地址(imageUrl和imageData二选一必填,当两者都存在时默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
  imageData String false 图片base64数据(imageUrl和imageData二选一必填,当两者都存在时默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA
  name String false 姓名(最大长度32,只支持中文或英文和.) 张三
  registerGender String false 注册性别(male-男, female-女,unknown-未知), 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) male
  bornTime String false 出生年月日(格式yyyy-MM-dd) 2011-06-01
  certificateType Number false 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】,typeCode为common.human_certificate_type) 111
  certificateNumber String false 证件号 330602201106010356
  nativeCountyCode String false 籍贯区县编号 330602
  residenceCountyCode String false 居住地区县编号 330602
  address String false 人员住址信息 杭州市滨江区阡陌路
 beginTime String true 布控任务自定义开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String true 布控任务自定义结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T23:59:59.000+08:00
 remark String false 布控描述(最大长度200) 本次布控目的:逮捕嫌犯张三,相似度为0.6及以上的报警告知
 phoneNos String false 报警接收的手机号码(多个号码以逗号分割,最多传20个) 13805719999
 details Array true 分时段报警阈值设置(让预警更精确,最多可设置5个时间段)
  details[0] Object true
   thresholdMin Number true 报警阈值设置(取值范围:0-1) 0.6
   startPeriod String true 报警时段开始时刻点(格式:HH:mm) 00:00
   endPeriod String true 报警时段结束时刻点(格式:HH:mm) 11:59
  • 入参举例
{
   “name”: “嫌犯张三_布控”,
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927, ZPJ14883601705420002156”,
   “personInfo”: {
     “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
     “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAA”,
     “name”: “张三”,
     “registerGender”: “male”,
     “bornTime”: “2011-06-01”,
     “certificateType”: 111,
     “certificateNumber”: “330602201106010356”,
     “nativeCountyCode”: “330602”,
     “residenceCountyCode”: “330602”,
     “address”: “杭州市滨江区阡陌路”
  },
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T23:59:59.000+08:00”,
   “remark”: “本次布控目的:逮捕嫌犯张三,相似度为0.6及以上的报警告知”,
   “phoneNos”: “13805719999”,
   “details”: [
     {
       “thresholdMin”: 0.6,
       “startPeriod”: “00:00”,
       “endPeriod”: “11:59”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的布控任务ID(最大长度为64)可作为参数,调用查询和控制任务状态。 false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

单张人脸图片布控修改

  • 接口说明

可以对单张人脸图片布控任务信息进行修改,支持布控名称、布控图片、布控监控点、人员信息、布控有效期、布控原因、报警接收手机号、分时段报警阈值等属性修改。
布控列表可通过【分页查询人脸布控信息】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/modifySinglePictureControl

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskId String true 布控任务ID(最大长度为64)。可通过【分页查询人脸布控信息】获取 temp_301230caa5534d0d9de6f9c020936019
 name String false 布控名称(最大长度60) 嫌犯张三_布控
 imageUrl String false 图片URL地址(imageUrl和imageData二选一必填,当两者都存在时默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152
 imageData String false 图片base64数据(imageUrl和imageData二选一必填,当两者都存在时默认使用imageUrl。图片像素在256*256-900w内,文件大小在128字节-4M内。图片类型限制为:png、jpg/jpeg、bmp) /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAbf1e-176ebf69d61d
 cameraIndexCodes String false 需要分析的监控点编号(通用唯一识别码UUID,多个id以逗号分隔,最多传2000个)可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 personInfo Object false 人员信息
  name String false 人员姓名(最大长度32,只支持中文或英文和.) 张三
  registerGender String false 注册性别(male-男, female-女,unknown-未知), 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) male
  bornTime String false 出生年月日(格式yyyy-MM-dd) 2011-06-01
  certificateType Number false 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,337-机动车行驶证,414-护照,782-市名卡,990-其他证件,取值参考【数据字典】,typeCode为common.human_certificate_type) 111
  certificateNumber String false 证件号 330602201106010356
  nativeCountyCode String false 籍贯区县编号 330602
  residenceCountyCode String false 居住地区县编号 330602
  address String false 人员住址信息 杭州市滨江区阡陌路
 beginTime String false 布控任务自定义开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String false 布控任务自定义结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T23:59:59.000+08:00
 remark String false 布控描述(最大长度200) 本次布控目的:逮捕嫌犯张三,相似度为0.6及以上的报警告知
 phoneNos String false 报警接收的手机号码(多个号码以逗号分割,最多传20个) 13805719999
 details Array false 分时段报警阈值设置(让预警更精确,最多可设置5个时间段)
  details[0] Object true
   thresholdMin Number false 报警阈值设置(取值范围:0-1) 0.6
   startPeriod String false 报警时段开始时刻点(格式:HH:mm) 00:00
   endPeriod String false 报警时段结束时刻点(格式:HH:mm) 11:59
  • 入参举例
{
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
   “name”: “嫌犯张三_布控”,
   “imageUrl”: “https://ip:port/kms/services/rest/CRL/getDocumentPreviewFile?token=0d65c57effffffff4c34a16891f84e7b&id=68a501a234ec4537b599706e126a5152”,
   “imageData”: “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAbf1e-176ebf69d61d”,
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   “personInfo”: {
     “name”: “张三”,
     “registerGender”: “male”,
     “bornTime”: “2011-06-01”,
     “certificateType”: 111,
     “certificateNumber”: “330602201106010356”,
     “nativeCountyCode”: “330602”,
     “residenceCountyCode”: “330602”,
     “address”: “杭州市滨江区阡陌路”
  },
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T23:59:59.000+08:00”,
   “remark”: “本次布控目的:逮捕嫌犯张三,相似度为0.6及以上的报警告知”,
   “phoneNos”: “13805719999”,
   “details”: [
     {
       “thresholdMin”: 0.6,
       “startPeriod”: “00:00”,
       “endPeriod”: “11:59”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

人脸名单库布控任务

  • 接口说明

可以对人脸名单库中的人脸名单进行布防,支持多个名单库。用户需要指定需要布控的监控点和时间段,支持布控报警接收手机号,支持分段报警阈值设置。
  1.实时布控告警信息可通过【按事件类型获取事件订阅信息】获取
  2.历史告警记录可通过【人脸布控报警记录查询】获取
  3.布控任务状态可通过【布控任务通用服务】来查询和控制

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/addPersonLibControl

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 name String true 布控名称(最大长度60) 重点人员名单库布控
 personlibIds String true 布控名单库ID(多个以英文逗号隔开,最多100个)。可通过【人脸名单库查询】获取或【人脸名单库添加】新建。 951fe58e57f94c5193e492bb070d82be
 cameraIndexCodes String true 需要分析的监控点id(多个id以逗号分隔,最多传2000个)可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 1c8d8fbd83184fcc870144393b5a547c
 beginTime String true 布控任务自定义开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String true 布控任务自定义结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 remark String false 布控描述(最大长度200) 重点人员名单库布控,张三创建
 phoneNos String false 报警接收的手机号码(多个号码以逗号分割,最多传20个) 13805719999
 details Array true 分时段报警阈值设置(让预警更精确,最多可设置5个时间段)
  details[0] Object false
   thresholdMin Number true 报警阈值设置(float,取值范围[0,1]) 0.6
   startPeriod String true 报警时段开始时刻点 00:00
   endPeriod String true 报警时段结束时刻点 23:59
  • 入参举例
{
   “name”: “重点人员名单库布控”,
   “personlibIds”: “951fe58e57f94c5193e492bb070d82be”,
   “cameraIndexCodes”: “1c8d8fbd83184fcc870144393b5a547c”,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T00:00:00.000+08:00”,
   “remark”: “重点人员名单库布控,张三创建”,
   “phoneNos”: “13805719999”,
   “details”: [
     {
       “thresholdMin”: 0.6,
       “startPeriod”: “00:00”,
       “endPeriod”: “23:59”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  taskId String 提交的布控任务ID(最大长度为64)可作为参数,调用查询和控制任务状态。 false temp_301230caa5534d0d9de6f9c020936019
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “taskId”: “temp_301230caa5534d0d9de6f9c020936019”
  }
}

人脸名单库布控任务修改

  • 接口说明

可以对人脸名单库布防任务进行修改,支持布控名称、布控名单库、布控监控点、布控有效期、布控原因、报警接收手机号、分时段报警阈值等信息修改。
布控列表可通过【分页查询人脸布控信息】获取。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/modifyPersonLibControl

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 taskId String true 布控任务ID(最大长度为64)。可通过【分页查询人脸布控信息】获取 temp_301230caa5534d0d9de6f9c020936019
 name String false 布控名称(最大长度60) 重点人员名单库布控
 personlibIds String false 布控名单库ID(多个以英文逗号隔开,最多100个) 951fe58e57f94c5193e492bb070d82be
 cameraIndexCodes String false 需要分析的监控点id(多个id以逗号分隔,最多传2000个)可调用【资源目录服务】中获取监控点相关API获取,如【分页获取监控点资源】 90ad77d8057c43dab140b77361606927
 beginTime String false 布控任务自定义开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T00:00:00.000+08:00
 endTime String false 布控任务自定义结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T23:59:59.000+08:00
 remark String false 布控描述(最大长度200) 重点人员名单库布控,张三创建
 phoneNos String false 报警接收的手机号码(多个号码以逗号分割,最多传20个) 13805719999
 details Array false 分时段报警阈值设置(让预警更精确,最多可设置5个时间段)
  details[0] Object false
   thresholdMin Number false 报警阈值设置(float,取值范围[0,1]) 0.6
   startPeriod String false 报警时段开始时刻点,如00:00 00:00
   endPeriod String false 报警时段结束时刻点,如23:59 11:59
  • 入参举例
{
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
   “name”: “重点人员名单库布控”,
   “personlibIds”: “951fe58e57f94c5193e492bb070d82be”,
   “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
   “beginTime”: “2017-06-15T00:00:00.000+08:00”,
   “endTime”: “2017-06-15T23:59:59.000+08:00”,
   “remark”: “重点人员名单库布控,张三创建”,
   “phoneNos”: “13805719999”,
   “details”: [
     {
       “thresholdMin”: 0.6,
       “startPeriod”: “00:00”,
       “endPeriod”: “11:59”
    }
  ]
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”
}

分页查询人脸布控信息

  • 接口说明

用于查询人脸名布控任务列表信息,返回结果包含布控ID、布控名称、布控名单库、布控监控点、布控有效期、布控原因、报警接收手机号、任务状态等布控任务详情。人脸布控任务信息包含【单张人脸图片布控】【人脸名单库布控任务】两类布控。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/getPersonControlsWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回条数 20
 sort String false 排序字段,默认按录入时间createDate排序 createDate
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “sort”: “createDate”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码,0表示成功,其他表示失败 false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 当前分页记录数 false 20
  pageNo Number 当前页 false 20
  list Array List数据 false
   list[0] Object false
    taskId String 布控任务ID(最大长度为64) false temp_301230caa5534d0d9de6f9c020936019
    name String 布控名称(最大长度60) false 重点人员名单库布控
    personlibIds String 布控名单库ID(多个以英文逗号分隔,最多100个) false 1,2
    cameraIndexCodes String 已布控监控点id(多个id以逗号分隔,最多2000个) false 90ad77d8057c43dab140b77361606927
    beginTime String 布控任务自定义开始时间,IOS8601格式 false 2017-06-15T00:00:00.000+08:00
    endTime String 布控任务自定义结束时间,IOS8601格式 false 2017-06-15T23:59:59.000+08:00
    remark String 布控描述,最多200个字符 false 重点人员名单库布控,张三创建
    phoneNos String 报警接收的手机号码(多个号码以逗号分割,最多传20个) false 13805719999
    taskStatus String 任务状态: 1-未调度 Not Dispatched 2-等待 Waiting 3-正在执行 Executing 4-已完成 Completed 5-已删除 Deleted 6-节点不在线 Offline 7-服务器宕机 Server Down 8-正在停止 Stopping 9-已停止 Stopped 10-节点重启 Rebooting 11-暂停 Paused 12-暂停中 Pausing 13-任务失败 Failed 14-taskID不存在 false 1
    taskStatusName String 任务状态名称 false 未调度
    taskCode String 任务状态码,参考状态码列表 false 0x1302
    details Array 分时段报警阈值设置信息 false
     details[0] Object false
      thresholdMin Number 报警阈值设置,范围0-1 false 0.6
      startPeriod String 报警时段开始时刻点,如00:00 false 00:00
      endPeriod String 报警时段结束时刻点,如23:59 false 11:59
  • 返回值举例
{
   “code”: " 0",
   “msg”: " success",
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 20,
     “list”: [
       {
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
         “name”: “重点人员名单库布控”,
         “personlibIds”: “1,2”,
         “cameraIndexCodes”: “90ad77d8057c43dab140b77361606927”,
         “beginTime”: “2017-06-15T00:00:00.000+08:00”,
         “endTime”: “2017-06-15T23:59:59.000+08:00”,
         “remark”: “重点人员名单库布控,张三创建”,
         “phoneNos”: “13805719999”,
         “taskStatus”: “1”,
         “taskStatusName”: “未调度”,
         “taskCode”: “0x1302”,
         “details”: [
           {
             “thresholdMin”: 0.6,
             “startPeriod”: “00:00”,
             “endPeriod”: “11:59”
          }
        ]
      }
    ]
  }
}

人脸布控报警记录查询

  • 接口说明

用于查询人脸布控报警历史记录,支持根据布控ID、布控名称和时间段进行检索;返回结果包含【单张人脸图片布控】【人脸名单库布控任务】两类布控。

  • 接口版本

v1

  • 接口地址

/api/aiapplication/v1/face/queryAlarmRecordsWithPage

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 taskId String false 布控任务ID(最大长度为64)可从【单张人脸图片布控】【人脸名单库布控任务】【分页查询人脸布控信息】返回结果中获取 temp_301230caa5534d0d9de6f9c020936019
 name String false 布控名称(最大长度60) 黑名单布控
 beginTime String true 开始时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T01:00:00.000+08:00
 endTime String true 结束时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) 2017-06-15T01:00:00.000+08:00
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
   “name”: “黑名单布控”,
   “beginTime”: “2017-06-15T01:00:00.000+08:00”,
   “endTime”: “2017-06-15T01:00:00.000+08:00”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 每页返回的条数 false 20
  pageNo Number 指定第几页,从1开始 false 1
  list Array false
   list[0] Object List数据 false
    name String 布控名称(最大长度60) false 测试布控
    taskId String 布控任务ID(最大长度为64) false temp_301230caa5534d0d9de6f9c020936019
    alarmId String 报警ID false 8e49e4268d7a4b91aef8f0cd39c8e64d
    alarmTime String 报警时间(IOS8601格式yyyy-MM-dd’T’HH:mm:ss.SSSzzz) false 2017-06-15T00:00:00.000+08:00
    cameraName String 抓拍设备名称,最大255字符 false 人脸抓拍机
    cameraIndexCode String 抓拍设备编号 false 1100003210301421
    latitude String 经度(WGS84坐标系) false 120.216123284763
    longitude String 纬度(WGS84坐标系) false 30.21168569675452
    snappedPicUrl String 目标图片url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?=d1=i972z01c9s08a-690105m2ep=t9i6d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i2c7d0e13
    refrencePicUrl String 比对源图片url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?=d9=i974z01c9s08a-690105m2ep=t9i7d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i4c7d3e12
    similarity String 相似度(精确到小数点后两位, 取值范围[0,1]) false 0.1
    personLibId String 名单库id(最大长度32位) false ff80808162dbbeef0162e104de5c0005
    personLibName String 名单库名称(最大长度32位,只支持中文、英文、数字、_、- ) false 在逃犯库
    personId String 人员名单唯一ID(最大长度70) false 0094_9_48ef0f5c6f6140839df4ea7bf84b8708
    personName String 人员姓名(最大长度32,只支持中文或英文和.) false 张三
    certificateType Number 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,,337-机动车行驶证,414-护照,782-市名卡,990-其他证件。取值参考【数据字典】,typeCode为common.human_certificate_type) false 111
    certificateTypeName String 证件类型名称 false 居民身份证
    certificateNumber String 证件号 false 330602201106010356
    registerGender String 注册性别(male-男, female-女,unknown-未知。 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
    registerGenderName String 注册性别说明 false
    arlarmPersons Array 报警人员信息 false
     arlarmPersons[0] Object false
      personId String 人员名单唯一ID(最大长度70) false 0094_9_48ef0f5c6f6140839df4ea7bf84b8708
      personName String 人员姓名(最大长度32位,只支持中文或英文和.) false 张三
      certificateType String 证件类型(111-居民身份证,113-户口簿,114-中国人民解放军军官证,131-工作证,123警官证,133-学生证,335-机动车驾驶证,,337-机动车行驶证,414-护照,782-市名卡,990-其他证件。取值参考【数据字典】,typeCode为common.human_certificate_type) false 111
      certificateTypeName String 证件类型说明 false 居民身份证
      certificateNumber String 证件号 false 330602201106010356
      registerGender String 注册性别(male-男, female-女,unknown-未知。 最大长度为10,取值参考【数据字典】,typeCode为common.human_gender) false male
      registerGenderName String 注册性别说明 false
      personLibId String 名单库id(最大长度32位) false ff80808162dbbeef0162e104de5c0005
      personLibName String 名单库名称(最大长度32位,只支持中文、英文、数字、_、- ) false 在逃犯库
      similarity String 相似度(精确到小数点后两位, 取值范围[0,1]) false 0.1
      snappedPicUrl String 目标图片url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?=d1=i972z01c9s08a-690105m2ep=t9i6d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i2c7d0e13
      refrencePicUrl String 比对源图片url,该字段具体使用方式参考【图片访问方式说明】 false http://ip:port/pic?=d9=i974z01c9s08a-690105m2ep=t9i7d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i4c7d3e12
  • 返回值举例
{
   “code”: " 0",
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “name”: “测试布控”,
         “taskId”: “temp_301230caa5534d0d9de6f9c020936019”,
         “alarmId”: “8e49e4268d7a4b91aef8f0cd39c8e64d”,
         “alarmTime”: “2017-06-15T00:00:00.000+08:00”,
         “cameraName”: “人脸抓拍机”,
         “cameraIndexCode”: “1100003210301421”,
         “latitude”: “120.216123284763”,
         “longitude”: “30.21168569675452”,
         “snappedPicUrl”: “http://ip:port/pic?=d1=i972z01c9s08a-690105m2ep=t9i6d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i2c7d0e13”,
         “refrencePicUrl”: “http://ip:port/pic?=d9=i974z01c9s08a-690105m2ep=t9i7d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i4c7d3e12”,
         “similarity”: “0.1”,
         “personLibId”: “ff80808162dbbeef0162e104de5c0005”,
         “personLibName”: “在逃犯库”,
         “personId”: “0094_9_48ef0f5c6f6140839df4ea7bf84b8708”,
         “personName”: “张三”,
         “certificateType”: 111,
         “certificateTypeName”: “居民身份证”,
         “certificateNumber”: “330602201106010356”,
         “registerGender”: “male”,
         “registerGenderName”: “男”,
         “arlarmPersons”: [
           {
             “personId”: “0094_9_48ef0f5c6f6140839df4ea7bf84b8708”,
             “personName”: “张三”,
             “certificateType”: “111”,
             “certificateTypeName”: “居民身份证”,
             “certificateNumber”: “330602201106010356”,
             “registerGender”: “male”,
             “registerGenderName”: “男”,
             “personLibId”: “ff80808162dbbeef0162e104de5c0005”,
             “personLibName”: “在逃犯库”,
             “similarity”: “0.1”,
             “snappedPicUrl”: “http://ip:port/pic?=d1=i972z01c9s08a-690105m2ep=t9i6d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i2c7d0e13”,
             “refrencePicUrl”: “http://ip:port/pic?=d9=i974z01c9s08a-690105m2ep=t9i7d*=*6pdi=*1s0i1=98b2ifd92*dedb03682-81b3997-1423*0-f0i4c7d3e12”
          }
        ]
      }
    ]
  }
}