SDK参考

Size: px

Start display at page:

Download "SDK参考"

添纪
5 years ago
Views:

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

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

3 目录目录 1 文字识别服务 SDK 环境搭建申请服务获取 SDK Java 开发环境配置 Eclipse 安装与 SDK 工程导入 AK/SK 认证英文海关单据识别服务 Demo 增值税发票识别服务 Demo 身份证识别服务 Demo 驾驶证识别服务 Demo 行驶证识别服务 Demo 通用表格识别服务 Demo 手写字母数字识别服务 Demo 机动车销售发票识别 Demo 通用文字识别 Demo Token 认证方式使用 Demo 接口与 API 对应关系 A 修订记录 ii

4 1 文字识别服务 SDK 环境搭建 1 文字识别服务 SDK 环境搭建 1.1 申请服务申请服务的具体操作步骤请参见文字识别用户指南的业务操作 > 申请服务章节 1.2 获取 SDK 请在如下地址获取 OCR java 版本 SDK 包并解压 : OCR 1.3 Java 开发环境配置文字识别服务 SDK 包要求的 JDK 版本必须不低于 JDK8 版本, 以下步骤以 win7 环境配置 JDK8 64 位为例, 已经下载 JDK 并配置好环境请忽略本章节步骤 1 步骤 3 步骤 4 下载 JDK 文件 : downloads html 下载完成后按照提示安装, 位置自选, 比如安装到本地 C:\Program Files\Java \jdk1.8.0_131 配置 Java 环境变量 : 右键计算机 > 属性 > 高级系统设置 > 环境变量, 进行如下操作 1. 新建系统变量 JAVA_HOME, 变量值为实际 JDK 安装位置 2. 在 Path 中添加 %JAVA_HOME%\bin;%JAVA_HOME%\jre\bin ( 注意用英文分号分隔 ) 打开命令行窗口, 输入 java -version, 显示如图 1-1 表示配置成功 1

5 1 文字识别服务 SDK 环境搭建图 1-1 Java 版本信息 1.4 Eclipse 安装与 SDK 工程导入以下以 eclipse 工具为例给出文字识别服务 SDK 工程导入步骤, 如果使用其他 IDE 工具, 请参照处理 : 步骤 1 在下载对应平台的 eclipse 版本, 比如 : eclipse-jee-mars-r-win32-x86_64.zip 解压后直接打开 eclipse 步骤 3 步骤 4 确保 Window>Preferences>Java>Installed JREs 配置正确的 JRE 路径在左侧 Package Explorer 页面右键, 单击 Import, 选择 General>Existing Projects into Workspace, 单击 Next, 单击 Browse, 选择文字识别服务 SDK 包所在路径步骤 5 单击 Finish, 导入 demo, 导入后打开工程, 工程目录如下 : 2

6 1 文字识别服务 SDK 环境搭建图 1-2 工程目录 1.5 AK/SK 认证使用服务 API 需要进行认证, 有 Token 和 AK/SK 两种认证方式可选, 推荐用户使用 AK/SK 方式步骤 1 登录管理控制台单击用户名, 在下拉列表中单击我的凭证, 进入我的凭证页面步骤 3 单击管理访问密钥步骤 4 步骤 5 步骤 6 输入当前用户的登录密码通过邮箱或者手机进行验证, 输入对应的验证码单击确定, 下载访问密钥说明在统一身份服务中创建的用户, 如果创建时未填写邮箱或者手机号, 则只需校验登录密码为防止访问密钥泄露, 建议您将其保存到安全的位置 3

7 1 文字识别服务 SDK 环境搭建步骤 7 根据获取的 AK/SK, 修改 Demo 工程中的 ClientContextUtils.java 文件中的 your AK 和 your SK 的值, 如图 1-3 图 1-3 修改 ClientContextUtils.java 文件 4

8 2.1 英文海关单据识别服务 Demo 该英文海关单据识别服务 demo 对应 API:POST /v1.0/ocr/action/ocr_form 该 Demo 为英文海关单据识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-1 修改 CustomsFormEnDemo.java 文件中原文件路径图 2-1 入参数据路径步骤 3 执行 CustomsFormEnDemo.java 文件, 控制台输出 200 即表示程序执行成功英文海关单据识别服务的结果可以采用 json 编辑器展示如图 2-2 5

9 图 2-2 英文海关单据识别结果示意图 2.2 增值税发票识别服务 Demo 该增值税发票识别服务 demo 对应 API:POST /v1.0/ocr/vat-invoice 该 Demo 为增值税发票识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-3 修改 VatInvoiceDemo.java 文件中原文件路径图 2-3 入参数据路径步骤 3 执行 VatInvoiceDemo.java 文件, 控制台输出 200 即表示程序执行成功增值税发票服务的结果可以采用 json 编辑器展示如图 2-4 6

10 图 2-4 增值税发票识别结果示意图 2.3 身份证识别服务 Demo 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-5 修改 IDCardDemo.java 文件中原文件路径 7

11 图 2-5 入参数据路径步骤 3 执行 IDCardDemo.java 文件, 控制台输出 200 即表示程序执行成功身份证服务的结果可以采用 json 编辑器展示如图 2-6 图 2-6 身份证识别结果示意图 2.4 驾驶证识别服务 Demo 该驾驶证识别服务 demo 对应 API:POST /v1.0/ocr/driver-license 该 demo 为驾驶证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-7 修改 DriverLicenseDemo.java 文件中原文件路径 8

12 图 2-7 入参数据路径步骤 3 执行 DriverLicenseDemo.java 文件, 控制台输出 200 即表示程序执行成功驾驶证服务的结果可以采用 json 编辑器展示如图 2-8 图 2-8 驾驶证识别结果示意图 2.5 行驶证识别服务 Demo 该行驶证识别服务 demo 对应 API:POST /v1.0/ocr/vehicle-license 该 demo 为行驶证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-9 修改 VehicleLicenseDemo.java 文件中原文件路径 9

13 图 2-9 入参数据路径步骤 3 执行 VehicleLicenseDemo.java 文件, 控制台输出 200 即表示程序执行成功行驶证服务的结果可以采用 json 编辑器展示如图 2-10 图 2-10 行驶证识别结果示意图 2.6 通用表格识别服务 Demo 该通用表格识别服务 demo 对应 API:POST /v1.0/ocr/general-table 该 demo 为通用表格识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-11 修改 GeneralTableDemo.java 文件中原文件路径 10

14 图 2-11 入参数据路径步骤 3 执行 GeneralTableDemo.java 文件, 控制台输出 200 即表示程序执行成功通用表格服务的结果可以采用 json 编辑器展示如图 2-12 图 2-12 通用表格识别结果示意图 2.7 手写字母数字识别服务 Demo 该手写字母数字识别服务 demo 对应 API:POST /v1.0/ocr/handwriting 11

15 该 demo 为手写字母数字识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-13 修改 HandwritingDemo.java 文件中需要识别的图片路径图 2-13 入参数据路径步骤 3 参考图 2-14 选择是否检测文字方向以及需要检测的文字类型 ( 数字 / 大写字母 ), 此项为可选内容图 2-14 可选入参数据设置步骤 4 执行 HandwritingDemo.java 文件, 控制台输出 200 即表示程序执行成功手写字母数字识别服务的结果可以采用 json 编辑器展示, 如图

16 图 2-15 手写字母数字识别结果示意图 2.8 机动车销售发票识别 Demo 该机动车销售发票识别 demo 对应 API:POST /v1.0/ocr/mvs-invoice 该 Demo 为机动车销售发票识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-16 修改 MvsInvoiceDemo.java 文件中原文件路径 13

17 图 2-16 入参数据路径步骤 3 执行 MvsInvoiceDemo.java 文件, 控制台输出 200 即表示程序执行成功机动车销售发票服务的结果可以采用 json 编辑器展示如图 2-17 图 2-17 机动车销售发票识别结果示意图 14

18 2.9 通用文字识别 Demo 该通用文字识别服务 demo 对应 API:POST /v1.0/ocr/general-text 该 demo 为通用文字识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码步骤 1 按照 AK/SK 认证配置用户 AK/SK 选择本地入参数据或者使用 Demo 默认入参数据, 参考图 2-18 修改 GeneralTextDemo.java 文件中原文件路径图 2-18 入参数据路径步骤 3 执行 GeneralTextDemo.java 文件, 控制台输出 200 即表示程序执行成功通用文字服务的结果可以采用 json 编辑器展示如图

19 图 2-19 通用文字识别结果示意图 16

20 3 Token 认证方式使用 Demo 3 Token 认证方式使用 Demo 服务认证方式有 Token 和 AK/SK 两种方式, 在本节 demo 试用使用 Token 认证方式 ( 用户参照如下步骤操作后, 即可体验相关文字识别服务, 各识别服务 demo 为相关服务的请求代码示例, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 com.huawei.ais.demo 包下面的 TokenDemo.java 文件, 修改 main 函数中的 username 和 password 为系统中实际注册的用户名和密码, 如图 3-1 图 3-1 修改用户名和密码将相关服务的注释代码恢复, 然后直接运行 TokenDemo.java, 在控制台可看到使用 Token 方式图像识别服务的识别结果说明 SDK 中涉及到的所有图像均为合成的非真实图像, 仅供示例参考使用 17

21 4 接口与 API 对应关系 4 接口与 API 对应关系表 4-1 接口与 API 对应关系表接口英文海关单据识别服务增值税发票识别服务身份证识别服务驾驶证识别服务行驶证识别服务通用表格识别服务手写字母数字识别服务机动车销售发票识别服务通用文字识别服务 API POST /v1.0/ocr/action/ocr_form POST /v1.0/ocr/vat-invoice POST /v1.0/ocr/id-card POST /v1.0/ocr/driver-license POST /v1.0/ocr/vehicle-license POST /v1.0/ocr/general-table POST /v1.0/ocr/handwriting POST /v1.0/ocr/mvs-invoice POST /v1.0/ocr/general-text 18

22 A 修订记录 A 修订记录发布日期修改说明第三次正式发布第二次正式发布修改删除银行卡识别一维码识别二维码识别和车牌识别相关内容新增 1. 银行卡识别服务 Demo 的 demo 用例 2. 一维码识别服务 Demo 的 demo 用例 3. 二维码识别服务 Demo 的 demo 用例 4. 车牌识别服务 Demo 的 demo 用例 5. 机动车销售发票识别 Demo 的 demo 用例 6. 通用文字识别 Demo 的 demo 用例修改申请服务的获取信息第一次正式发布 19

SDK参考

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