SearchFaceInfoParamInput.xml 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <FDSearchDescription xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
  3. <!--opt, object, 查询描述, attr:version{req, string, 协议版本, range:[,]}-->
  4. <searchID>
  5. <!--req, string, 搜索记录唯一标识, range:[,], desc:用来确认上层客户端是否为同一个(倘若是同一个,则设备记录内存,下次搜索加快速度)-->
  6. test
  7. </searchID>
  8. <searchResultPosition>
  9. <!--req, int, 查询结果在结果列表中的起始位置, range:[,], step:, unit:, unitType:, desc:当记录条数很多时, 一次查询不能获取所有的记录, 下一次查询时指定位置可以查询后面的记录-->
  10. 1
  11. </searchResultPosition>
  12. <maxResults>
  13. <!--req, int, 本次查询(每页显示)最大记录数, range:[,], step:, unit:, unitType:-->1
  14. </maxResults>
  15. <FDID>
  16. <!--opt, string, 人脸比对库唯一标示ID, range:[,]-->test
  17. </FDID>
  18. <startTime>
  19. <!--opt, date, 人脸库人员出生开始时间-->1970-01-01+08:00
  20. </startTime>
  21. <endTime>
  22. <!--opt, date, 人脸库人员出生结束时间-->1970-01-01+08:00
  23. </endTime>
  24. <name>
  25. <!--req, string, 姓名, range:[1,32]-->test
  26. </name>
  27. <sex>
  28. <!--opt, enum, 性别, subType:string, [male#男,female#女]-->male
  29. </sex>
  30. <province>
  31. <!--opt, string, 省份, range:[,], desc:参考《全国各省份城市列表.txt》-->11
  32. </province>
  33. <city>
  34. <!--opt, string, 城市, range:[,], desc:参考《全国各省份城市列表.txt》-->11
  35. </city>
  36. <certificateType>
  37. <!--opt, enum, 证件类型, subType:string, [ID#身份证,passportID#护照,other#其他]-->ID
  38. </certificateType>
  39. <certificateNumber>
  40. <!--opt, string, 证件号, range:[8,32], desc:当certificateType为ID时,certificateNumber长度范围[8,18];当certificateType为passportID时,certificateNumber长度范围[8,32];当certificateType为other时,certificateNumber长度范围[8,18];-->
  41. test
  42. </certificateNumber>
  43. <phoneNumber>
  44. <!--opt, string, 电话号码, range:[1,64]-->test
  45. </phoneNumber>
  46. <FaceModeList>
  47. <!--opt, array, 人脸模型信息列表, subType:object, range:[,]-->
  48. <FaceMode>
  49. <!--opt, object, 人脸模型-->
  50. <ModeInfo>
  51. <!--opt, object, 模型数据, desc:以图搜图时<ModeInfo>字段必填-->
  52. <similarity>
  53. <!--opt, float, 相似度, range:[0.0,100.0], step:, unit:, unitType:-->0.0
  54. </similarity>
  55. <modeData>
  56. <!--opt, string, 目标模型数据, range:[,], desc:传输过程中针对二进制非建模数据进行base64的加密处理-->
  57. test
  58. </modeData>
  59. </ModeInfo>
  60. </FaceMode>
  61. </FaceModeList>
  62. <modelStatus>
  63. <!--opt, enum, 建模状态(旧), subType:string, [modeling#已建模,unmodeled#未建模,modelingFailed#建模失败]-->
  64. modeling
  65. </modelStatus>
  66. <modelingStatus>
  67. <!--opt, string, 建模状态, range:[,], desc:success-建模成功,failed-建模失败,none-尚未建模;支持复选;后续使用这个字段,modelStatus将会去除-->
  68. success,failed,none
  69. </modelingStatus>
  70. <customFaceLibID>
  71. <!--opt, string, 自定义人脸库ID, range:[,], desc:当FDID和customFaceLibID同时存在时,以customFaceLibID为准-->test
  72. </customFaceLibID>
  73. <sortord>
  74. <!--opt, enum, 搜索结果排序类型, subType:string, [time#入库时间,contrastSuccessTime#比对成功时间,count#比对成功次数]-->
  75. time
  76. </sortord>
  77. <order>
  78. <!--opt, enum, 搜索结果排序方式, subType:string, [DESC#最晚入库最先展示,ASC#最早入库最先展示], desc:默认:DESC-->
  79. DESC
  80. </order>
  81. <StrangerLibFaceAppendData>
  82. <!--opt, object, 陌生人库支持人脸属性信息-->
  83. <PersonInfoExtendList size="4">
  84. <!--opt, array, 人员扩展信息列表, subType:object, range:[,], attr:size{req, int, 数组元素总数, range:[,], step:, unit:, unitType:}-->
  85. <PersonInfoExtend>
  86. <!--opt, object, 人员扩展信息-->
  87. <id>
  88. <!--req, int, 人员扩展信息序号, range:[,], step:, unit:, unitType:, desc:从1开始赋值,依次增加-->1
  89. </id>
  90. <enable>
  91. <!--req, bool, 人员扩展信息使能-->true
  92. </enable>
  93. <name>
  94. <!--opt, string, 人员标签信息扩展名称, range:[,]-->test
  95. </name>
  96. <value>
  97. <!--opt, string, 人员标签信息扩展内容, range:[,]-->test
  98. </value>
  99. </PersonInfoExtend>
  100. </PersonInfoExtendList>
  101. </StrangerLibFaceAppendData>
  102. <OccurrencesInfo>
  103. <!--opt, object, 频次信息-->
  104. <enabled>
  105. <!--req, bool, 频次是否返回-->true
  106. </enabled>
  107. <occurrences>
  108. <!--opt, int, 频次, range:[,], step:, unit:, unitType:, desc:达到最低频次的人脸库图片才返回,当enabled为true时必须存在-->
  109. 1
  110. </occurrences>
  111. <occurrencesSearchType>
  112. <!--opt, enum, 频次检索方式, subType:string, [greaterThanOrEqual#大于等于,lessThan#小于,equal#等于], desc:当enabled为true时必须存在-->
  113. greaterThanOrEqual
  114. </occurrencesSearchType>
  115. </OccurrencesInfo>
  116. <faceScore>
  117. <!--opt, int, 人脸评分, range:[-1,100], step:, unit:, unitType:, desc:-1表示评分未知(未对该人脸评分)-->1
  118. </faceScore>
  119. <FDIDList>
  120. <!--opt, object, 人脸库列表, desc:支持查询多个人脸库搜索,理论上FDID和FDIDList是互斥的,若用户同时下发,则以FDIDList为准-->
  121. <FDID>
  122. <!--req, string, 人脸库ID, range:[1,64]-->test
  123. </FDID>
  124. </FDIDList>
  125. <faceScoreMax>
  126. <!--opt, int, 人脸评分范围最大值, range:[-1,100], step:, unit:, unitType:, desc:有效值[0-100],-1表示评分未知(未对该人脸评分),该节点可以和faceScore组合,此时faceScore表示该范围最小值,faceScore表示该范围最大值,如果单独使用,则最小值为0-->
  127. 0
  128. </faceScoreMax>
  129. <pictureStatus>
  130. <!--opt, enum, 人脸图片状态, subType:string, [normal#正常人脸,abnormal#异常人脸],
  131. desc:异常人脸(建模失败+人脸评分为低+图片url下载失败的),
  132. Note:此搜索结果是设备根据当前算法识别效果提供的评判标准,异常图片可能影响人脸抓拍和比对的效果,如果为异常图片的,建议更换图片,后期随着算法准确率的提提升,此判断标准可能发生变化,因此此判断标准结果仅供参考,-->
  133. normal
  134. </pictureStatus>
  135. <importStartTime>
  136. <!--ro, opt, datetime, 入库开始时间-->1970-01-01T00:00:00+08:00
  137. </importStartTime>
  138. <importEndTime>
  139. <!--ro, opt, datetime, 入库结束时间-->1970-01-01T00:00:00+08:00
  140. </importEndTime>
  141. <faceContrastSuccessStartTime>
  142. <!--ro, opt, datetime, 人脸比对成功开始时间, desc:支持确认某段时间内监控场景有哪些人出现过。配合使用的查询条件:人脸库ID(FDID,包括:动态库、允许库、静态库)、排序类型(sortord)、排序顺序(order)-->
  143. 1970-01-01T00:00:00+08:00
  144. </faceContrastSuccessStartTime>
  145. <faceContrastSuccessEndTime>
  146. <!--ro, opt, datetime, 人脸比对成功结束时间, desc:支持确认某段时间内监控场景有哪些人出现过。配合使用的查询条件:人脸库ID(FDID,包括:动态库,允许库、静态库)、排序类型(sortord)、排序顺序(order)-->
  147. 1970-01-01T00:00:00+08:00
  148. </faceContrastSuccessEndTime>
  149. </FDSearchDescription>