SDK参考

Size: px

Start display at page:

Download "SDK参考"

共钱
4 years ago
Views:

1 文档版本 03 发布日期华为技术有限公司

2 版权所有华为技术有限公司 2019 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品服务或特性可能不在您的购买或使用范围之内除非合同另有约定, 华为公司对本文档内容不做任何明示或默示的声明或保证由于产品版本升级或其他原因, 本文档内容会不定期进行更新除非另有约定, 本文档仅作为使用指导, 本文档中的所有陈述信息和建议不构成任何明示或暗示的担保华为技术有限公司地址 : 深圳市龙岗区坂田华为总部办公楼邮编 : 网址 : 客户服务邮箱 : support@huawei.com 客户服务电话 : 文档版本 03 ( ) 版权所有华为技术有限公司 i

3 目录目录 1 Java SDK 入门指导 SDK 接口示例 SDK & API 对应关系 Python SDK 入门指导 SDK 接口示例 SDK & API 对应关系 Go SDK 入门指导 SDK 接口示例 SDK & API 对应关系 CSharp SDK 入门指导 SDK 接口示例 SDK & API 对应关系...14 A 修订记录文档版本 03 ( ) 版权所有华为技术有限公司 ii

4 1 Java SDK 1 Java SDK 1.1 入门指导环境准备 1. 获取 API 相关文档, 服务的 API 请见 API 参考访问华为云开放 API 的产品界面, 可获取其他云服务的 API 参考 2. 获取服务的 Endpoint, 请参见地区和终端节点 3. 开通服务 : 登录管理控制台, 选择对应的子服务, 单击右侧的开通服务服务开通一次即可, 后续使用时无需再开通 4. 获取华为云账号的 AK/SK 如果之前没有生成过 AK/SK, 可登录华为云我的凭证界面, 选择管理访问密钥 > 新增访问密钥来获取 5. 已经安装好 JDK,Java SDK 适用于 JDK1.8+ 说明服务提供的 SDK 暂不支持访问重试, 如果访问异常,SDK 会直接返回本次的请求结果, 所以需要客户端自行建立重试机制安卓系统使用的 Java SDK 时, 不支持主线程直接调用, 建议使用子线程 SDK 获取和安装以 Eclipse 为例, 创建 Java 工程后, 执行以下步骤, 导入 JAR 文件到新建的工程中 : 1. 下载 SDK 的 JAR 文件 2. 将下载的 JAR 文件复制到工程文件夹中 3. 在 Eclipse 中打开工程, 右键单击该项工程, 选择 Properties 4. 在弹出的对话框中, 单击 Java Build Path, 然后在 Libraries 页签下单击 Add JARs, 添加下载的 JAR 文件 5. 单击 OK 本文档中涉及的服务使用同一个 JAR 文件文档版本 03 ( ) 版权所有华为技术有限公司 1

5 1 Java SDK 开始使用设置参数, 初始化 SDK 客户端, 然后调用 SDK 访问服务的 API // 设置认证参数 String ak = "ak"; String sk = "sk"; String projectid = "projectid"; //Proxy info, 当您需要使用代理才可以访问到服务时, 可在此处增加代理信息 ProxyHostInfo proxyhostinfo = new ProxyHostInfo("proxy ", 8080, "UserName", "Password" ); //Service info String url = " String region = "cn-north-4"; AuthInfo authinfo = new AuthInfo(url, region, ak, sk); try (FrsClient frsclient = new FrsClient(authInfo, projectid)) { //try (FrsClient frsclient = new FrsClient(authInfo, projectid, proxyhostinfo)) { // 需使用代理时 // 调用前请在管理控制台开通服务 // 创建人脸集合 String facesetname = "facesetname"; int facesetcapacity = 10000; // 创建人脸集合时, 自定义属性 CreateExternalFields createexternalfields = new CreateExternalFields(); createexternalfields.addfield("testinteger", FieldType.INTEGER); CreateFaceSetResult createfacesetresult = frsclient.getfacesetservice().createfaceset(facesetname, facesetcapacity, createexternalfields); System.out.println(createFaceSetResult.toJSONString()); // 获取人脸集合 GetAllFaceSetResult getallfacesetsresult = frsclient.getfacesetservice().getallfaceset(); System.out.println(getAllFaceSetResult.toJSONString()); // 添加人脸 String imageid = "image1"; File image = new File("data/face.jpg"); byte[] filedata = FileUtils.readFileToByteArray(image); String imagebase64 = Base64.encodeBase64String(fileData); AddExternalFields addexternalfields = new AddExternalFields(); addexternalfields.addfield("testinteger", 123); AddFaceResult addfaceresult = frsclient.getfaceservice().addfacebybase64(facesetname, imageid, imagebase64, addexternalfields); System.out.println(addFaceResult.toJSONString()); // 人脸对比 String image1path = "data/face1.jpg"; String image2path = "data/face2.jpg"; CompareFaceResult comparefaceresult = frsclient.getcompareservice().comparefacebyfile(image1path, image2path); System.out.println(compareFaceResult.toJSONString()); // 人脸检测 String obsurl = "/bucket/face.jpg"; String attr = "0,1,2,3,4,5"; DetectFaceResult detectfaceresult = frsclient.getdetectservice().detectfacebyobsurl(obsurl, attr); System.out.println(detectFaceResult.toJSONString()); } 文档版本 03 ( ) 版权所有华为技术有限公司 2

6 1 Java SDK 1.2 SDK 接口示例 1. 构造服务客户端 String ak = "ak"; String sk = "sk"; String projectid = "projectid"; //Proxy info, 当您需要使用代理才可以访问到服务时, 可在此处增加代理信息 ProxyHostInfo proxyhostinfo = new ProxyHostInfo("proxy", 8080, "UserName", "Password" ); //Service info String url = " String region = "cn-north-4"; AuthInfo authinfo = new AuthInfo(url, region, ak, sk); FrsClient frsclient = new FrsClient(authInfo, projectid); //FrsClient frsclient = new FrsClient(authInfo, projectid, proxyhostinfo);// 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 2. 创建人脸集 CreateExternalFields createexternalfields = new CreateExternalFields(); createexternalfields.addfield("testinteger", FieldType.INTEGER); CreateFaceSetResult createfacesetresult = frsclient.getfacesetservice().createfaceset(facesetname, facesetcapacity, createexternalfields); 3. 添加人脸 String imageid = "image1"; File image = new File("data/face.jpg"); byte[] filedata = FileUtils.readFileToByteArray(image); String imagebase64 = Base64.encodeBase64String(fileData); AddExternalFields addexternalfields = new AddExternalFields(); addexternalfields.addfield("testinteger", 123); AddFaceResult addfaceresult = frsclient.getfaceservice().addfacebybase64(facesetname, imageid, imagebase64, addexternalfields); 4. 调用人脸检测服务 String obsurl = "/bucket/face.jpg"; String attr = "0,1,2,3,4,5"; DetectFaceResult detectfaceresult = frsclient.getdetectservice().detectfacebyobsurl(obsurl, attr); 1.3 SDK & API 对应关系接口方法 API CompareServic e comparefacebybas e64 comparefacebyfile comparefacebyobs Url POST /v1/{project_id}/face-compare DetectService detectfacebybase64 POST /v1/{project_id}/face-detect detectfacebyfile detectfacebyobsurl 文档版本 03 ( ) 版权所有华为技术有限公司 3

7 1 Java SDK 接口方法 API FaceService addfacebybase64 POST /v1/{project_id}/face-sets/ addfacebyfile {face_set_name}/faces addfacebyobsurl getfaces getface deletefacebyfaceid deletefacebyextern alimageid deletefacebyfieldid GET /v1/{project_id}/face-sets/ {face_set_name}/faces?offset=xxx&limit=xxx GET /v1/{project_id}/face-sets/ {face_set_name}/faces?face_id={face_id} {face_set_name}/faces? external_image_id=imageid {face_set_name}/faces?face_id=faceid {face_set_name}/faces?id=home FaceSetService createfaceset POST /v1/{project_id}/face-sets LiveDetectServ ice SearchService getallfacesets getfaceset deletefaceset livedetectbybase64 livedetectbyfile livedetectbyobsurl searchfacebybase6 4 searchfacebyfile searchfacebyobsur l searchfacebyfaceid GET /v1/{project_id}/face-sets GET /v1/{project_id}/face-sets/{face_set_name} {face_set_name} POST /v1/{project_id}/live-detect POST /v1/{project_id}/face-sets/ {face_set_name}/search 文档版本 03 ( ) 版权所有华为技术有限公司 4

8 2 Python SDK 2 Python SDK 2.1 入门指导环境准备 1. 获取 API 相关文档, 服务的 API 请见 API 参考访问华为云开放 API 的产品界面, 可获取其他云服务的 API 参考 2. 获取服务的 Endpoint, 请参见地区和终端节点 3. 开通服务 : 登录管理控制台, 选择对应的子服务, 单击右侧的开通服务服务开通一次即可, 后续使用时无需再开通 4. 获取华为云账号的 AK/SK 如果之前没有生成过 AK/SK, 可登录华为云我的凭证界面, 选择管理访问密钥 > 新增访问密钥来获取 5. 已经安装好 Python 环境,Python SDK 适用于 Python2.7 Python3.6 SDK 获取和安装开始使用说明服务提供的 SDK 暂不支持访问重试, 如果访问异常,SDK 会直接返回本次的请求结果, 所以需要客户端自行建立重试机制 1. 下载服务的 Python SDK 并解压 2. 下载和安装 setuptools 工具 3. 命令行切换到 Python SDK 解压目录 4. 在 SDK 目录中, 执行 Python setup.py install 命令安装 Python SDK 到开发环境, 或者将.py 文件直接引入项目说明 Python 编程时要引用 frsclient 文件夹下所有的文件 :from frsclient import * 设置参数, 初始化 SDK 客户端, 然后调用 SDK 访问服务的 API 文档版本 03 ( ) 版权所有华为技术有限公司 5

9 2 Python SDK ak = "ak" sk = "sk" project_id = "projectid" end_point = " proxy = {"http": " "https": " auth_info = AuthInfo(ak=ak, sk=sk, end_point=end_point) frs_client = FrsClient(auth_info=auth_info, project_id=project_id) # frs_client = FrsClient(auth_info=auth_info, project_id=project_id, proxies=proxy) # 需要使用代理访问云服务时配置 // 人脸对比 image1_path = "" image2_path = "" cs = frs_client.get_compare_service() res = cs.compare_face_by_file(image1_path, image2_path) print res.get_eval_result() // 活体检测 lds = frs_client.get_live_detect_service() video_file = "data/video.mp4" actions = "1" res = lds.live_detect_by_file(video_file, actions) print res.get_eval_result() 2.2 SDK 接口示例 1. 构造服务客户端 ak = "ak" sk = "sk" project_id = "projectid" end_point = " proxy = {"http": " "https": " auth_info = AuthInfo(ak=ak, sk=sk, end_point=end_point) frs_client = FrsClient(auth_info=auth_info, project_id=project_id) # frs_client = FrsClient(auth_info=auth_info, project_id=project_id, proxies=proxy) # 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 2. 创建人脸集 fss = frs_client.get_face_set_service() external_fields = "{\"timestamp\":{\"type\" : \"long\"},\"id\":{\"type\":\"string\"},\"number \":{\"type\":\"integer\"}}" ret = fss.create_face_set("facesetname", 10000, external_fields) 3. 添加人脸 fs = frsclient.get_face_service() external_fields = "{\"timestamp\": 12,\"id\": \"home\"}" res = fs.add_face_by_obs_url("facesetname", "/obs/image.jpg", "externalimageid", external_fields) 4. 人脸检测 ds = frs.get_detect_service() res = ds.detect_face_by_file("imagepath", "0,1,2,3") 2.3 SDK & API 对应关系接口方法 API CompareServic e compare_face_by_b ase64 POST /v1/{project_id}/face-compare 文档版本 03 ( ) 版权所有华为技术有限公司 6

10 2 Python SDK 接口方法 API compare_face_by_fi le compare_face_by_o bs_url DetectService detect_face_by_base 64 detect_face_by_file detect_face_by_obs _url POST /v1/{project_id}/face-detect FaceService add_face_by_base64 POST /v1/{project_id}/face-sets/ add_face_by_file {face_set_name}/faces add_face_by_obs_ur l get_faces get_face delete_face_by_face _id delete_face_by_exte rnal_image_id delete_face_by_field _id GET /v1/{project_id}/face-sets/ {face_set_name}/faces?offset=xxx&limit=xxx GET /v1/{project_id}/face-sets/ {face_set_name}/faces?face_id={face_id} {face_set_name}/faces? external_image_id=imageid {face_set_name}/faces?face_id=faceid {face_set_name}/faces?id=home FaceSetService create_face_set POST /v1/{project_id}/face-sets LiveDetectServ ice SearchService get_all_face_sets get_face_set delete_face_set live_detect_by_base 64 live_detect_by_file live_detect_by_obs_ url search_face_by_bas e64 GET /v1/{project_id}/face-sets GET /v1/{project_id}/face-sets/{face_set_name} {face_set_name} POST /v1/{project_id}/live-detect POST /v1/{project_id}/face-sets/ {face_set_name}/search 文档版本 03 ( ) 版权所有华为技术有限公司 7

12 3 Go SDK 3 Go SDK 3.1 入门指导环境准备 1. 获取 API 相关文档, 服务的 API 请见 API 参考访问华为云开放 API 的产品界面, 可获取其他云服务的 API 参考 2. 获取服务的 Endpoint, 请参见地区和终端节点 3. 开通服务 : 登录管理控制台, 选择对应的子服务, 单击右侧的开通服务服务开通一次即可, 后续使用时无需再开通 4. 获取华为云账号的 AK/SK 如果之前没有生成过 AK/SK, 可登录华为云我的凭证界面, 选择管理访问密钥 > 新增访问密钥来获取 5. 已经安装好 Go, 并设置好 Go 语言环境变量 SDK 获取和安装开始使用说明服务提供的 SDK 暂不支持访问重试, 如果访问异常,SDK 会直接返回本次的请求结果, 所以需要客户端自行建立重试机制 1. 下载服务的 Go SDK 并解压 2. 使用 Eclipse 新建 Go 工程, 将 Go SDK 文件夹下的全部内容拷贝至新建工程中的文件夹下 3. 右键单击建好的 Go 工程, 运行弹出菜单中的 Build Project 命令编译工程并等待编译完成设置参数, 初始化 SDK 客户端, 然后调用 SDK 访问服务的 API authinfo := param.authinfo{endpoint: " Ak: "ak", Sk: "sk"} frsclient := service.newfrsclient(&authinfo, "projectid") 文档版本 03 ( ) 版权所有华为技术有限公司 9

13 3 Go SDK //proxyinfo := param.proxyhostinfo{proxy: " //frsclient := service.newfrsclientwithproxy(&authinfo, "projectid", &proxyinfo)// 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 // 人脸对比 compareresult, err := frsclient.getcompareservice().comparefacebyfile("image1path", "image2path") if nil!= err { fmt.println(err.error()) } else { fmt.println(compareresult) } // 人脸检测 detectresult, err2 := frsclient.getdetectservice().detectfacebyobsurlwithattr("obsurl", "0,1,2") if nil!= err2 { fmt.println(err2.error()) } else { fmt.println(detectresult) } 3.2 SDK 接口示例 1. 构造服务客户端 authinfo := param.authinfo{endpoint: " Ak: "ak", Sk: "sk"} frsclient := service.newfrsclient(&authinfo, "projectid") //proxyinfo := param.proxyhostinfo{proxy: " //frsclient := service.newfrsclientwithproxy(&authinfo, "projectid", &proxyinfo)// 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 2. 创建人脸集 externalfields := param.newcreateexternalfields() externalfields.addfield("testinteger", param.integer) result, err := frsclient.getfacesetservice().createfacesetwithextfields("facesetname", 10000, externalfields) if nil!= err { fmt.println(err.error()) } else { fmt.println(result) } 3. 添加人脸 externalfields := param.newaddexternalfields() externalfields.addfield("testinteger", 123) result, err := frsclient.getfaceservice().addfacebyfilefull("facesetname", "externalimageid", "imagepath", externalfields) if nil!= err { fmt.println(err.error()) } else { fmt.println(result) } 4. 人脸检测 detectresult, err := frsclient.getdetectservice().detectfacebyobsurlwithattr("/obs/ image.jpg", "0,1,2") if nil!= err { fmt.println(err.error()) } else { fmt.println(detectresult) } 文档版本 03 ( ) 版权所有华为技术有限公司 10

14 3 Go SDK 3.3 SDK & API 对应关系接口方法 API CompareServic e DetectService CompareFaceByBas e64 CompareFaceByFile CompareFaceByObs Url DetectFaceByBase6 4 DetectFaceByFile DetectFaceByObsUr l POST /v1/{project_id}/face-compare POST /v1/{project_id}/face-detect FaceService AddFaceByBase64 POST /v1/{project_id}/face-sets/ AddFaceByFile {face_set_name}/faces AddFaceByObsUrl GetFaces GetFace DeleteFaceByFaceId DeleteFaceByExtern alimageid DeleteFaceByFieldI d GET /v1/{project_id}/face-sets/ {face_set_name}/faces?offset=xxx&limit=xxx GET /v1/{project_id}/face-sets/ {face_set_name}/faces?face_id={face_id} {face_set_name}/faces? external_image_id=imageid {face_set_name}/faces?face_id=faceid {face_set_name}/faces?id=home FaceSetService CreateFaceSet POST /v1/{project_id}/face-sets LiveDetectServ ice GetAllFaceSets GetFaceSet DeleteFaceSet LiveDetectByBase6 4 LiveDetectByFile GET /v1/{project_id}/face-sets GET /v1/{project_id}/face-sets/{face_set_name} {face_set_name} POST /v1/{project_id}/live-detect 文档版本 03 ( ) 版权所有华为技术有限公司 11

15 3 Go SDK 接口方法 API LiveDetectByObsUr l SearchService SearchFaceByBase6 4 SearchFaceByFile SearchFaceByObsU rl SearchFaceByFaceI d POST /v1/{project_id}/face-sets/ {face_set_name}/search 文档版本 03 ( ) 版权所有华为技术有限公司 12

16 4 CSharp SDK 4 CSharp SDK 4.1 入门指导环境准备 1. 获取 API 相关文档, 服务的 API 请见 API 参考访问华为云开放 API 的产品界面, 可获取其他云服务的 API 参考 2. 获取服务的 Endpoint, 请参见地区和终端节点 3. 开通服务 : 登录管理控制台, 选择对应的子服务, 单击右侧的开通服务服务开通一次即可, 后续使用时无需再开通 4. 获取华为云账号的 AK/SK 如果之前没有生成过 AK/SK, 可登录华为云我的凭证界面, 选择管理访问密钥 > 新增访问密钥来获取 5. 已经安装好.net 开发环境说明服务提供的 SDK 暂不支持访问重试, 如果访问异常,SDK 会直接返回本次的请求结果, 所以需要客户端自行建立重试机制 SDK 获取和安装开始使用下载 CSharp SDK 的源码设置参数, 初始化 SDK 客户端, 然后调用 SDK 访问服务的 API AuthInfo authinfo = new AuthInfo(" "ak", "sk"); FrsClient frsclient = new FrsClient(authInfo, "project id"); //ProxyHostInfo proxy := new ProxyHostInfo("host", 8080); //FrsClient frsclient = new FrsClient (authinfo, "projectid", proxy); // 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 // 人脸对比 CompareFaceResult comparefaceresult = frsclient.getcompareservice().comparefacebyurl("/obs/1.jpg", "/obs/1.jpg"); 文档版本 03 ( ) 版权所有华为技术有限公司 13

17 4 CSharp SDK Console.WriteLine(compareFaceResult.GetJsonString()); comparefaceresult = frsclient.getcompareservice().comparefacebyfile("/resource/1.jpeg", "/resource/ 1.jpeg"); Console.WriteLine(compareFaceResult.GetJsonString()); // 人脸检测 DetectFaceResult detectfaceresult = frsclient.getdetectservice().detectfacebyurl("/obs/1.jpg", "0,1,2"); Console.WriteLine(detectFaceResult.GetJsonString()); DetectFaceResult detectfaceresult2 = frsclient.getdetectservice().detectfacebyfile("/resource/ 1.jpeg", "1,2"); Console.WriteLine(detectFaceResult2.GetJsonString()); 4.2 SDK 接口示例 1. 构造服务客户端 AuthInfo authinfo = new AuthInfo(" "ak", "sk"); FrsClient frsclient = new FrsClient(authInfo, "project id"); //ProxyHostInfo proxy := new ProxyHostInfo("host", 8080); //FrsClient frsclient = new FrsClient (authinfo, "projectid", proxy);// 当您需要代理才可以访问到服务时, 在第三个参数增加代理信息即可 2. 创建人脸集 CreateExternalFields createexternalfields = new CreateExternalFields(); createexternalfields.addfield("testint", FieldType.INTEGER); createexternalfields.addfield("teststr", FieldType.STRING); CreateFaceSetResult createfacesetresult = frsclient.getfacesetservice().createfaceset("face_set_name_test", 10000, createexternalfields); Console.WriteLine(createFaceSetResult.GetJsonString()); 3. 添加人脸 AddExternalFields addexternalfields = new AddExternalFields(); addexternalfields.addfield("testint", 1); addexternalfields.addfield("teststr", "str"); AddFaceResult addfaceresult = frsclient.getfaceservice().addfacebyfile("face_set_name_test", "/resource/3.png", addexternalfields); Console.WriteLine(addFaceResult.GetJsonString()); 4. 人脸检测 DetectFaceResult detectfaceresult = frsclient.getdetectservice().detectfacebyurl("/obs/ 1.jpg", "0,1,2"); Console.WriteLine(detectFaceResult.GetJsonString()); DetectFaceResult detectfaceresult2 = frsclient.getdetectservice().detectfacebyfile("/ resource/1.jpeg", "1,2"); Console.WriteLine(detectFaceResult2.GetJsonString()); 4.3 SDK & API 对应关系接口方法 API CompareServic e CompareFaceByBase64 CompareFaceByFile CompareFaceByUrl POST /v1/{project_id}/face-compare DetectService DetectFaceByBase64 POST /v1/{project_id}/face-detect DetectFaceByFile DetectFaceByUrl 文档版本 03 ( ) 版权所有华为技术有限公司 14

18 4 CSharp SDK 接口方法 API FaceService AddFaceByBase64 POST /v1/{project_id}/face-sets/ AddFaceByFile {face_set_name}/faces AddFaceByUrl GetFaces GetFace DeleteFaceByFaceId DeleteFaceByExternalIma geid DeleteFaceByFieldId GET /v1/{project_id}/face-sets/ {face_set_name}/faces? offset=xxx&limit=xxx GET /v1/{project_id}/face-sets/ {face_set_name}/faces?face_id={face_id} {face_set_name}/faces? external_image_id=imageid {face_set_name}/faces?face_id=faceid {face_set_name}/faces?id=home FaceSetService CreateFaceSet POST /v1/{project_id}/face-sets LiveDetectServ ice GetAllFaceSets GetFaceSet DeleteFaceSet LiveDetectByBase64 LiveDetectByFile LiveDetectByUrl GET /v1/{project_id}/face-sets GET /v1/{project_id}/face-sets/ {face_set_name} {face_set_name} POST /v1/{project_id}/live-detect SearchService SearchFaceByBase64 POST /v1/{project_id}/face-sets/ SearchFaceByFile {face_set_name}/search SearchFaceByObsUrl SearchFaceByFaceId 文档版本 03 ( ) 版权所有华为技术有限公司 15

API参考

API参考文档版本 03 发布日期 2018-06-20 华为技术有限公司版权所有华为技术有限公司 2018 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品