设备网络SDK开发使用手册


<FDLibCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
  <CreateFDLibList size="">
    <CreateFDLib>
      <!--req, 创建人脸比对库-->
      <id min="" max="">
        <!--req, xs:integer, "表示list中子项个数, 从"1"开始赋值, 依次增加" -->
      </id>
      <name min="" max="">
        <!--opt, xs:string, "face data lib name" -->
      </name>
      <thresholdValue min="" max="">
        <!--opt, xs:integer, "检测阈值,阈值越大检测准确率越高, 范围[0,100]"-->
      </thresholdValue>
      <customInfo  min="" max="">
        <!--opt, xs:string, 人脸库附加信息-->
      </customInfo>
      <faceDataMax  min="" max="">
        <!--opt, xs:integer, "人脸库支持的最大人脸数据条数"-->
      </faceDataMax>
      <customFaceLibID min="0" max="64">
        <!--opt, xs:string, "自定义人脸库ID"-->
      </customFaceLibID>
    </CreateFDLib>
  </CreateFDLibList>
  
  <FaceAppendData>
    <!--req, 人脸比对库图片数据关联信息（有该节点即可支持导入人脸图片数据到人脸库的功能）-->
    <bornTime>
      <!--opt, xs:ISO8601 time,出生日期-->
    </bornTime>
    <name>
      <!--opt,xs:string,姓名-->
    </name>
    <sex>
      <!--opt,xs:string,"male,female",性别-->
    </sex>
    <province>
      <!--opt,xs:string,省份-->
    </province>
    <city>
      <!--opt,xs:string,城市-->
    </city>
    <certificateType>
      <!--opt,xs:string,"officerID,ID,passportID,other",
    证件类型: OfficerID-军官证, ID-身份证, passportID-护照, other-其他-->
    </certificateType>
    <certificateNumber>
      <!--dep,xs:string,"证件号"-->
    </certificateNumber>

    <PersonInfoExtendList size="">
      <!--req,人员扩展信息列表-->
      <PersonInfoExtend>
        <id>
          <!--req,xs:integer, "人员扩展信息序号, 从"1"开始赋值, 依次增加" -->
        </id>
        <enable>
          <!--req,xs: boolean, "人员扩展信息使能" -->
        </enable>
        <name>
          <!--opt,xs:string, "人员标签信息扩展名称" -->
        </name>
        <value>
          <!--opt,xs:string, "人员标签信息扩展内容" -->
        </value>
      </PersonInfoExtend>
    </PersonInfoExtendList>
    
    <isSupportPhoneNumber>true</isSupportPhoneNumber>
    <!--opt,xs:boolen,是否支持电话号码-->
    
    <isSupportImagesURLImport>true</isSupportImagesURLImport>
    <!--opt,xs:boolen,是否支持通过图片URL的方式导入图片人脸库-->
    
    <customHumanID min="0" max="64">
      <!--opt,xs:string,"自定义人员ID"-->
    </customHumanID>    
  </FaceAppendData>

  <FDSearchDescription>
    <searchID>
      <!--req,xs:string; 搜索记录唯一标识，用来确认上层客户端是否为同一个(倘若是同一个，则设备记录内存，下次搜索加快速度) -->
    </searchID>
    <searchResultPosition>
      <!--req, xs: integer, 查询结果在结果列表中的起始位置-->
      <!--req, GET /ISAPI/Intelligent/FDLib/capabilities获取人脸库能力集，其中<isSupportStandardSearch>为true则该字段从0开始，否则从1开始-->
    </searchResultPosition>
    <maxResults>
      <!--req, xs: integer, 本次查询条数-->
    </maxResults>
    <FDID>
      <!--opt,xs:string,"人脸比对库唯一标示ID", 如果有这个节点表示指定人脸库查询，否则查询所有人脸库-->
    </FDID>
    <startTime>
      <!--req,xs:ISO8601 time, 人员的出生的最早时间，时间格式为年月日-->
    </startTime>
    <endTime>
      <!--dep,xs:ISO8601 time, 人员的出生的最晚时间，时间格式为年月日-->
    </endTime>
    <name>
      <!--opt,xs:string, 姓名-->
    </name>
    <sex>
      <!--opt,xs:string,"male,female", 性别: male-男, female-女-->
    </sex>
    <province>
      <!--opt,xs:string, 省份-->
    </province>
    <city>
      <!--opt,xs:string, 城市-->
    </city>
    <certificateType>
      <!--opt,xs:string," officerID,ID", Officer ID- 军官证, ID- 身份证-->
    </certificateType>
    <certificateNumber>
      <!--dep,xs:string,"证件号"-->
    </certificateNumber>
    <FaceModeCap>
      <!--opt, "人脸模型能力, 用于以图索图"-->
      <FaceMode>
        <similarity min="0.0" max="100.0">
          <!--opt,xs:float, 相似度,取值范围:[0.0,100.0]-->
        </similarity>
      </FaceMode>
    </FaceModeCap>
    <customFaceLibID min="0" max="64">
      <!--opt,xs:string-->
    </customFaceLibID>
    <modelingStatus opt="success,failed,none">
      <!--opt,xs:sting,建模状态: success-建模成功, failed-建模失败, none-无-->
    </modelingStatus>
  </FDSearchDescription>
      
  <isSuportAnalysisFace opt="false,true">
    <!--opt,string, 是否支持导入图片数据到设备识别图片目标功能(POST /ISAPI/Intelligent/analysisImage/face)-->
  </isSuportAnalysisFace>
  
  <isSuportFDLibImpEmp opt="false,true">
    <!--opt,string, 是否支持人脸库数据导入导出功能(UPLOAD_FD_DATA)-->
  </isSuportFDLibImpEmp> 
  
  <isSuportFCSearch opt="false,true">
    <!--opt,string, 是否支持人脸比对结果(包括抓拍图片)查询功能(POST /ISAPI/Intelligent/FDLib/FCSearch)-->
  </isSuportFCSearch>

  <isSupportFDLibEachImport>
    <!--opt,xs:boolen, "false,true", 是否支持人脸比对库图片相互导入的功能-->
    <!--opt,对应功能: PUT /ISAPI/Intelligent/FDLib/<FDID>/importFrom/FDLibSource-->
  </isSupportFDLibEachImport>

  <FCSearchDescription>
    <!--opt,人脸比对结果查询条件-->
    <snapStartTime>
      <!--opt,xs:ISO8601 time,开始时间-->
    </snapStartTime>
    <snapEndTime>
      <!--dep,xs:ISO8601 time,结束时间-->
    </snapEndTime>
    <faceMatchInfoEnable opt="true,false">
      <!--opt,xs:boolen, "表示是否需要只上传有匹配信息的数据,对应<FaceMatchInfoList>描述内容"-->
    </faceMatchInfoEnable>
    <monitorName min="" max="">
      <!--opt, xs:string, "监控点名称"-->
    </monitorName>
    <similarity min="0.0" max="100.0">
      <!--opt, xs:float,"相似度"-->
    </similarity>
    <eventType opt="unlimit,faceContrast,whiteFaceContrast">
      <!--opt,xs:string,"事件类型: unlimit-不限,faceContrast-人脸比对,whiteFaceContrast-白名单人脸比对(即陌生人模式)"-->
    </eventType>
    <FaceModeCap>
      <!--opt, "人脸模型, 用于以图索图"-->
      <FaceMode>
        <similarity min="0.0" max="100.0">
          <!--opt,xs:float, 相似度, 取值范围:[0.0,100.0]-->
        </similarity>
      </FaceMode>
    </FaceModeCap>
    <PictureSearchCap>
      <!--opt, "支持按图片ID检索能力"-->
      <maxSearchPictureNum min="1" max="1">
        <!--req,xs:integer,"最大支持检索图片数目"-->
      </maxSearchPictureNum>
    </PictureSearchCap>  
    <isSupportMultiChannelSearch>true</isSupportMultiChannelSearch>
    <!--opt,xs:boolen,"是否支持多通道检索"--> 
    <isSupportTotalSearchResult>true</isSupportTotalSearchResult>
    <!--opt,xs:boolen,"是否支持设备单次检索条数限制"-->
  </FCSearchDescription>

  <isSupportFDExecuteControl>true</isSupportFDExecuteControl>
  <!--opt,xs:boolen,"是否支持人脸库布控关系"-->

  <isSupportFCSearchDataPackage>true</isSupportFCSearchDataPackage>
  <!--opt,xs:boolen,"是否支持人脸检索结果打包"-->
  
  <maxFCSearchDataPackageNum>1000</maxFCSearchDataPackageNum>
  <!--opt,xs:integer,"最大支持人脸检索结果打包数目"-->

  <isSupportManualModeling>true</isSupportManualModeling>
  <!--opt,是否支持手动建模--> 
  <isSupportSingleManualModeling>true</isSupportSingleManualModeling>
  <!--opt,是否支持单一图片手动建模--> 
  <isSupportRangeManualModeling>true</isSupportRangeManualModeling>
  <!--opt,是否支持离散性手动建模-->  
  <isSupportSingleManualModelingSearch>true</isSupportSingleManualModelingSearch>
  <!--opt,是否支持单一手动建模任务查询--> 
  <isSupportRangeManualModelingSearch>true</isSupportRangeManualModelingSearch>
  <!--opt,是否支持离散性手动建模任务查询--> 
  <isSupportModelingStatusSearch>true</isSupportModelingStatusSearch>
  <!--opt,是否支持建模状态查询-->
  
  <Reboot>
    <!--opt,修改参数后, 需要提示重启设备生效的具体参数内容-->  
    <thresholdValue>true</thresholdValue>
    <!--opt,人脸库阈值修改后, 需要重启设备生效-->  
    <delFaceLib>true</delFaceLib>
    <!--opt,删除人脸库后, 需要重启设备生效-->
  </Reboot>
  
  <isSupportCoverImportpictures>true</isSupportCoverImportpictures>
  <!--opt,是否支持图片覆盖式导入(NENET_DVR_FACELIB_COND中byCover参数)-->
  <isSupportCoverImportFaceLib>true</isSupportCoverImportFaceLib>
  <!--opt,是否支持人脸库覆盖式导入(NET_DVR_FD_DATA_COND中byCover参数)-->
  <isSupportConcurrentImportpictures>true</isSupportConcurrentImportpictures>
  <!--opt,是否支持图片并发式导入(NENET_DVR_FACELIB_COND中byConcurrent参数)-->
  <isSupportSurplusCapacity>true</isSupportSurplusCapacity>
  <!--opt,是否支持指定人脸库中剩余人脸图片张数查询-->
  <isSupportFDCoverInfo>true</isSupportFDCoverInfo>
  <!--opt,是否支持 "获取指定人脸库导入会覆盖的人脸图片张数"-->

  <isSupportStandardSearch>true</isSupportStandardSearch>
  <!--opt,xs:boolen, "false,true", 是否支持标准查找方式(包括人脸库搜索/ISAPI/Intelligent/FDLib/FDSearch、人脸比对搜索/ISAPI/Intelligent/FDLib/FCSearch)：
  1)searchResultPosition从0开始,无该节点则searchResultPosition从1开始;
  2)responseStatus、matchList、matchElemen首字母都大写, 即ResponseStatus、MatchList、MatchElemen, 和协议保持一致-->
  
  <FDLibType opt="faceContrast,whitelistFaceContrast">
    <!--rep,xs: string,"人脸比对类型: faceContrast-人脸比对, whitelistFaceContrast-白名单人脸比对(陌生人模式)"-->
  </FDLibType>
  
  <isSupportFaceDataExport>true</isSupportFaceDataExport>
  <!--rep,表示支持人脸库中数据是否支持导出-->

  <isSupportNewlyPictureUpload>true</isSupportNewlyPictureUpload>
  <!--opt,xs:boolen,"是否支持导入图片到人脸库,用于设备端兼容大图片导入"-->
  
  <isSupportFCSearchNormal>true</isSupportFCSearchNormal>
  <!--opt,xs:boolen,"是否支持人脸数据全部检索,用于4200采用ISAPI协议搜索人脸结果, 如果不支持使用NET_DVR_SmartSearchPicture搜索所有图片"-->

  <FDLibEachImportCap>
    <!--opt,人脸库相互导入能力, 对应命令:PUT /ISAPI/Intelligent/FDLib/<FDID>/importFrom/FDLibSource-->
    <isSupportImportLib>
      <!--opt,xs:boolen,"是否支持整个库导入"-->
    </isSupportImportLib>
    <isSupportImportLibPicture>true</isSupportImportLibPicture>
    <!--opt,xs:boolen,"是否支持人脸库指定图片导入,即<Picture>字段"-->  
  </FDLibEachImportCap>

</FDLibCap>