SDK参考

Transcription

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

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

3 目录 目录 1 SDK 简介 申请服务 获取认证信息 获取 SDK 服务 SDK 环境搭建 Java 开发环境配置 Eclipse 安装与 JAVA SDK 工程导入 Python 开发环境配置 ios 开发环境配置 Android 开发环境配置 Node.js 开发环境配置 使用 SDK(Java) 使用 SDK(Python) 使用 SDK(iOS) 使用 SDK(Android) 使用 SDK(Node.js) A 修订记录 文档版本 06 ( ) 版权所有 华为技术有限公司 ii

4 1 SDK 简介 1 SDK 简介 概述 (Optical Character Recognition, 简称 OCR) 将图片或扫描件中的成可编辑的文本 可代替人工录入, 提升业务效率 支持身份证 驾驶证 行驶证 发票 英文海关单据 通用表格 通用文字等场景 以开放 API(Application Programming Interface, 应用程序编程接口 ) 的方式提供给用户, 用户通过实时访问和调用 API 获取推理结果, 帮助用户提升业务效率 SDK 概述 接口与 API 对应关系 软件开发工具包 (Optical Character Recognition Software Development Kit, 简称 OCR SDK) 是对提供的 REST API 进行的封装, 以简化用户的开发工作 用户直接调用 OCR SDK 提供的接口函数即可实现使用服务业务能力的目的 接口与 API 对应关系请参见表 1-1 表 1-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 文档版本 06 ( ) 版权所有 华为技术有限公司 1

5 1 SDK 简介 接口车辆通行费发票识别飞机行程单识别定额发票识别火车票识别银行卡识别营业执照识别护照识别道路运输证识别网络图片识别出租车发票识别 API POST /v1.0/ocr/toll-invoice POST /v1.0/ocr/flight-itinerary POST /v1.0/ocr/quota-invoice POST /v1.0/ocr/train-ticket POST /v1.0/ocr/bankcard POST /v1.0/ocr/business-license POST /v1.0/ocr/passport POST /v1.0/ocr/transportation-license POST /v1.0/ocr/web-image POST /v1.0/ocr/taxi-invoice 文档版本 06 ( ) 版权所有 华为技术有限公司 2

6 2 申请服务 2 申请服务 申请服务的具体操作步骤请参见 API 参考 的申请服务章节 文档版本 06 ( ) 版权所有 华为技术有限公司 3

7 3 获取认证信息 3 获取认证信息 获取 AK/SK 使用服务 API 需要进行认证, 有 Token 和 AK/SK 两种认证方式可选, 推荐用户使用 AK/SK 方式 步骤 1 步骤 3 步骤 4 步骤 5 登录管理控制台 鼠标移动至用户名处, 在下拉列表中单击 我的凭证, 进入 我的凭证 页面 选择 管理访问密钥 页签, 单击 新增访问秘钥 按钮 输入当前用户的登录密码 通过邮箱或者手机进行验证, 输入对应的验证码 单击 确定, 下载认证账号的 AK/SK, 请妥善保管 AK/SK 信息 说明 在统一身份服务中创建的用户, 如果创建时未填写邮箱或者手机号, 则只需校验登录密码 为防止访问密钥泄露, 建议您将其保存到安全的位置 配置 JAVA SDK 的 AK/SK 根据获取的 AK/SK, 修改 Demo 工程 OCRDemo.java 文件中 AK 和 SK 的值, 请参见图 3-1 图 3-1 修改 OCRDemo.java 文件 配置 Python SDK 的 AK/SK 根据获取的 AK/SK, 修改 Demo 工程 OCRDemo.py 文件中的 AK 和 SK 的值, 请参见图 3-2 文档版本 06 ( ) 版权所有 华为技术有限公司 4

8 3 获取认证信息 图 3-2 修改 OCRDemo.py 文件 配置 ios SDK 的 AK/SK 根据获取的 AK/SK, 修改 Demo 工程 ViewController.m 文件中 akskocrservice 函数的 AK 和 SK 的值, 请参见图 3-3 图 3-3 修改 ViewController.m 文件 配置 Android SDK 的 AK/SK 根据获取的 AK/SK, 修改 Demo 工程 MainActivity.java 文件中 akskocrservice 函数的 AK 和 SK 的值, 请参见图 3-4 图 3-4 修改 MainActivity.java 文件 配置 Node.js SDK 的 AK/SK 根据获取的 AK/SK, 修改 Demo 工程 demo.js 文件中 appkey 和 appsecret 的值, 请参见图 3-5 图 3-5 修改 demo.js 文件 文档版本 06 ( ) 版权所有 华为技术有限公司 5

9 4 获取 SDK 4 获取 SDK 请在如下地址获取 OCR SDK 包并解压 : 请在如下地址获取 OCR 对应 Endpoint: 地区和终端节点 文档版本 06 ( ) 版权所有 华为技术有限公司 6

10 5 服务 SDK 环境搭建 5 服务 SDK 环境搭建 5.1 Java 开发环境配置 操作场景 服务 JAVA SDK 包要求的操作环境请参见表 5-1 表 5-1 准备环境 准备环境操作系统安装 JDK 安装和配置 Eclipse 说明 Windows 系统, 推荐 Windows 7 及以上版本 开发环境的基本配置 JDK 版本必须不低于 JDK8 用于开发 OCR 应用程序的工具 操作步骤 以下步骤以 win7 环境配置 JDK8 64 位为例, 已经下载 JDK 并配置好环境请跳过本章节 步骤 1 步骤 3 下载 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 ( 注意用英文分号分隔 ) 步骤 4 打开命令行窗口, 输入 java -version, 显示如图 5-1 表示配置成功 文档版本 06 ( ) 版权所有 华为技术有限公司 7

11 5 服务 SDK 环境搭建 图 5-1 Java 版本信息 5.2 Eclipse 安装与 JAVA 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, 导入后打开工程, 工程目录如下 : 图 5-2 工程目录 文档版本 06 ( ) 版权所有 华为技术有限公司 8

12 5 服务 SDK 环境搭建 5.3 Python 开发环境配置 操作场景 服务 Python SDK 包要求的操作环境请参见表 5-2 表 5-2 准备环境 准备环境 操作系统 安装 Python 说明 Windows 系统, 推荐 Windows 7 及以上版本 Python 版本建议使用 2.7 及以上版本 安装 Python 依赖库 OCR Python SDK 依赖第三方库 requests 包 操作步骤 以下步骤以 win7 环境配置 Python 2.7 为例, 已配置好 Python2.7 及更高版本并且安装了 requests 包请跳过本章节 步骤 1 根据系统环境下载 Python 安装包 : python-2711/ 下载完成后按照提示安装, 位置自选, 默认位置为 C:\Python27 步骤 3 配置 Python 环境变量 : 右键 计算机 > 属性 > 高级系统设置 > 环境变量, 在 path 中添加 C: \Python27;C:\Python27\Scripts 步骤 4 打开命令行窗口, 输入 python v, 显示如图 5-3 表示配置成功 图 5-3 Python 版本信息 步骤 5 通过 PIP 在线安装依赖包 requests, 在新打开的 CMD 窗口执行如下命令 : pip install -i requests --trusted-host pypi.tuna.tsinghua.edu.cn/simple 步骤 6 安装完成后通过 PIP 命令确认 requests 正确安装, 如图 5-4 所示 文档版本 06 ( ) 版权所有 华为技术有限公司 9

13 5 服务 SDK 环境搭建 图 5-4 requests 安装确认 5.4 ios 开发环境配置 操作场景 服务 ios SDK 包要求的操作环境请参见表 5-3 表 5-3 准备环境 准备环境 操作系统 安装 Xcode 说明 ios 9.0 及以上版本, 必须在 macos 运行 Xcode 版本建议使用 10.0 及以上版本 操作步骤 Xcode 是 ios 开发的 IDE 必不可少, 以下为步骤以安装 Xcode 10.0 为例创建 ios 开发环境, 已配置并安装成功请跳过本章节 步骤 1 注册 Apple ID 步骤 3 在 App Store 搜索 Xcode, 单击 获取 下载 下载完成之后点击 Lanchpad, 可以看到 Xcode, 打开即可 5.5 Android 开发环境配置 操作场景 服务 Android SDK 包要求的操作环境请参见表 5-4 文档版本 06 ( ) 版权所有 华为技术有限公司 10

14 5 服务 SDK 环境搭建 表 5-4 准备环境 准备环境 操作系统 安装 Android Studio 说明 Windows 系统, 推荐 Windows 7 及以上版本 Android Studio 版本建议使用 及以上版本 操作步骤 Android SDK 使用 Android Studio IDE 开发 以下步骤以 win7 环境配置 Android Studio3.1.3 正式版为例, 已配置并安装成功请跳过本章节 步骤 1 Java 开发环境配置请参见 Java 开发环境配置 配置 Android Studio 访问 下载 正式版 Windows Android Studio 安装包 步骤 3 启动 Android Studio, 选择 Open an existing Android Studio project, 然后选择 Android SDK 包的本地路径 步骤 4 工程的目标 API 是 26, 如果本地 SDK 没有此版本, 请安装 Android API Node.js 开发环境配置 操作场景 服务 Node.js SDK 包要求的操作环境请参见表 5-5 表 5-5 准备环境 准备环境 操作系统 安装 Node.js 说明 Windows 系统, 推荐 Windows 7 及以上版本 Node.js 版本建议使用 Node.js v 及以上版本 安装 Node.js 依赖库 OCR Node.js SDK 依赖第三方库 request moment moment-timezone 包 操作步骤 以下步骤以 win7 环境安装 Node.js v 为例, 已安装 Node.js 或者更高版本并且安装了依赖包请跳过本章节 步骤 1 配置 Node.js Node.js 下载地址 : 下载 Node.js 最新版本 文档版本 06 ( ) 版权所有 华为技术有限公司 11

15 5 服务 SDK 环境搭建 配置 Node.js 环境变量 : 右键 计算机 > 属性 > 高级系统设置 > 环境变量 在 Path 中添加 C: \Program Files\nodejs(node.exe 默认安装路径 ) 验证 Node.js 在系统命令行输入 node v 查看 Node.js 的版本, 如果出现了当前的版本号, 即为配置成功 步骤 3 配置 cnpm 与配置国内软件库 $ npm install -g cnpm --registry= 如果已经配置, 请直接跳转到步骤 4 步骤 4 安装依赖包 在 Node.js 项目的根目录中,shift+ 鼠标右键, 选择 在此处打开命令窗口, 执行下列命令 : cnpm install request save cnpm install moment --save cnpm install moment-timezone --save 文档版本 06 ( ) 版权所有 华为技术有限公司 12

16 6 使用 SDK(Java) 6 使用 SDK(Java) 用户使用服务的认证方式有 Token 和 AK/SK 两种, 本章节以身份证识别服务为例, 对 Token 和 AK/SK 两种方式使用 SDK 进行示例说明 在 OCR SDK 开发工具包地址 : 选择 OCR Java SDK 工具包下载并解压 说明 SDK 中涉及到的所有图像均为合成的非真实图像, 仅供示例参考使用 AK/SK 认证方式使用 Demo 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码 步骤 1 按照 配置 JAVA SDK 的 AK/SK 配置用户 AK/SK 如使用本地图片文件进行识别, 修改 OCRDemo.java 文件参数为本地图片路径, 请参见图 6-1 如使用 SDK 默认图片则不需要进行修改 图 6-1 入参数据路径 步骤 3 执行 OCRDemo.java 文件, 控制台输出 200 即表示程序执行成功 身份证服务的结果可以采用 json 编辑器展示, 请参见图 6-2 图 6-2 身份证识别结果示意图 文档版本 06 ( ) 版权所有 华为技术有限公司 13

17 6 使用 SDK(Java) 说明 如想调用 OCR 其他识别服务, 只需要把 requestocrservicebase64 函数的第一个参数改成对应的 URI 即可 URI 列表请参见表 1-1 Token 认证方式使用 在本节 demo 使用 Token 认证方式调用身份证识别服务 ( 用户参照如下步骤操作后, 即可体验身份证识别服务, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 OCRDemo 包下面的 OCRDemo.java 文件, 修改 main 函数中 Token demo code 段的 Username Password 和 Domainname 为系统中实际注册的用户名 密码和域名 ( 如果用户为非 IAM 用户, 域名与用户名一致 ), 请参见图 6-3 图 6-3 修改用户名 密码和域名 直接执行相应代码, 在控制台可看到使用 Token 方式身份证识别服务的识别结果 文档版本 06 ( ) 版权所有 华为技术有限公司 14

18 7 使用 SDK(Python) 7 使用 SDK(Python) 用户使用服务的认证方式有 Token 和 AK/SK 两种, 本章节以身份证识别服务为例, 对 Token 和 AK/SK 两种方式如何使用 SDK 进行示例说明 在 OCR SDK 开发工具包地址 : 选择 OCR Python SDK 工具包下载并解压 AK/SK 认证方式使用 Demo 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码 步骤 1 按照 配置 Python SDK 的 AK/SK 配置用户 AK/SK 如使用本地图片文件进行识别, 修改 OCRDemo.py 文件参数为本地图片路径, 请参见图 7-1 如使用 SDK 默认图片则不需要进行修改 图 7-1 入参数据路径 步骤 3 执行 OCRDemo.py 文件, 控制台输出 200 即表示程序执行成功 身份证服务的结果可以采用 json 编辑器展示, 请参见图 7-2 图 7-2 身份证识别结果示意图 文档版本 06 ( ) 版权所有 华为技术有限公司 15

19 7 使用 SDK(Python) 说明 如想调用 OCR 其他识别服务, 只需要把 requestocrservicebase64 函数的第一个参数改成对应的 URI 即可 URI 列表请参见表 1-1 Token 认证方式使用 在本节 demo 使用 Token 认证方式调用身份证识别服务 ( 用户参照如下步骤操作后, 即可体验身份证识别服务, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 OCRDemo.py 文件, 修改 main 函数中的 username password 和 domain_name 为系统中实际注册的用户名 密码和域名 ( 如果用户为非 IAM 用户, 域名与用户名一致 ), 请参见图 7-3 图 7-3 修改用户名 密码和域名 直接执行相应代码, 在控制台可看到使用 Token 方式身份证识别服务的识别结果 文档版本 06 ( ) 版权所有 华为技术有限公司 16

20 8 使用 SDK(iOS) 8 使用 SDK(iOS) 用户使用服务的认证方式有 Token 和 AK/SK 两种, 本章节以身份证识别服务为例, 对 Token 和 AK/SK 两种方式使用 SDK 进行示例说明 在 OCR SDK 开发工具包地址 : 选择 OCR ios SDK 工具包下载并解压 AK/SK 认证方式使用 Demo 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码 步骤 1 按照 配置 ios SDK 的 AK/SK 配置用户 AK/SK 如使用本地图片文件进行识别, 修改 ViewController.m 文件中 akskocrservice 函数中 image 参数, 请参见图 8-1 如使用 SDK 默认图片则不需要进行修改 图 8-1 入参数据路径 步骤 3 执行 akskocrservice 函数, 控制台输出 200 即表示程序执行成功 身份证服务的结果可以采用 json 编辑器展示, 请参见图 8-2 图 8-2 身份证识别结果示意图 文档版本 06 ( ) 版权所有 华为技术有限公司 17

21 8 使用 SDK(iOS) 说明 如想调用 OCR 其他识别服务, 只需要把 requestocrservicebase64 函数的第一个参数改成对应的 URI 即可 URI 列表请参见表 1-1 Token 认证方式使用 在本节 demo 使用 Token 认证方式调用身份证识别服务 ( 用户参照如下步骤操作后, 即可体验身份证识别服务, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 ViewController.m 文件, 修改 tokenocrservice 函数中的 username password 和 domainname 为系统中实际注册的用户名 密码和域名 ( 如果用户为非 IAM 用户, 域名与用户名一致 ), 请参见图 8-3 图 8-3 修改用户名 密码和域名 直接执行相应代码, 在控制台可看到使用 Token 方式身份证识别服务的识别结果 文档版本 06 ( ) 版权所有 华为技术有限公司 18

22 9 使用 SDK(Android) 9 使用 SDK(Android) AK/SK 认证方式使用 Demo 用户使用服务的认证方式有 Token 和 AK/SK 两种, 本章节以身份证识别服务为例, 对 Token 和 AK/SK 两种方式使用 SDK 进行示例说明 在 OCR SDK 开发工具包地址 : 选择 OCR Android SDK 工具包下载并解压 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码 步骤 1 按照 配置 Android SDK 的 AK/SK 配置用户 AK/SK 如使用本地图片文件进行识别, 修改 MainActivity.java 文件中 akskocrservice 函数的 Bitmap 类型的参数, 请参见图 9-1 如使用 SDK 默认图片则不需要进行修改 图 9-1 入参数据路径 步骤 3 执行 akskocrservice 函数, 控制台输出 200 即表示程序执行成功 身份证服务的结果可以采用 json 编辑器展示, 请参见图 9-2 文档版本 06 ( ) 版权所有 华为技术有限公司 19

23 9 使用 SDK(Android) 图 9-2 身份证识别结果示意图 说明 如想调用 OCR 其他识别服务, 只需要把 requestocrservicebase64 函数的第一个参数改成对应的 URI 即可 URI 列表请参见表 1-1 Token 认证方式使用 在本节 demo 使用 Token 认证方式调用身份证识别服务 ( 用户参照如下步骤操作后, 即可体验身份证识别服务, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 MainActivity.java 文件, 修改 tokenocrservice 函数中的 username password 和 domainname 为系统中实际注册的用户名 密码和域名 ( 如果用户为非 IAM 用户, 域名与用户名一致 ), 请参见图 9-3 图 9-3 修改用户名 密码和域名 直接执行相应代码, 在控制台可看到使用 Token 方式身份证识别服务的识别结果 文档版本 06 ( ) 版权所有 华为技术有限公司 20

24 10 使用 SDK(Node.js) 10 使用 SDK(Node.js) AK/SK 认证方式使用 Demo 用户使用服务的认证方式有 Token 和 AK/SK 两种, 本章节以身份证识别服务为例, 对 Token 和 AK/SK 两种方式使用 SDK 进行示例说明 在 OCR SDK 开发工具包地址 : 选择 OCR Node.js SDK 工具包下载并解压 该身份证识别服务 demo 对应 API:POST /v1.0/ocr/id-card 该 demo 为身份证识别服务的请求代码示例, 只需修改 AK/SK, 无需另外编写代码 步骤 1 按照 配置 Node.js SDK 的 AK/SK 配置用户 AK/SK 如使用本地图片文件进行识别, 修改 demo.js 文件参数为本地图片路径, 请参见图 10-1 如使用 SDK 默认图片则不需要进行修改 图 10-1 入参数据路径 步骤 3 执行 demo.js 文件, 控制台输出 200 即表示程序执行成功 身份证服务的结果可以采用 json 编辑器展示, 请参见图 10-2 图 10-2 身份证识别结果示意图 文档版本 06 ( ) 版权所有 华为技术有限公司 21

25 10 使用 SDK(Node.js) 说明 如想调用 OCR 其他识别服务, 只需要把 requestocrservicebase64 函数的第一个参数改成对应的 URI 即可 URI 列表请参见表 1-1 Token 认证方式使用 在本节 demo 使用 Token 认证方式调用身份证识别服务 ( 用户参照如下步骤操作后, 即可体验身份证识别服务, 修改用户名和密码后, 无需另外编写代码 ) 步骤 1 打开 demo.js 文件, 修改 main 函数中的 username password 和 domainname 为系统中实际注册的用户名 密码和域名 ( 如果用户为非 IAM 用户, 域名与用户名一致 ), 请参见图 10-3 图 10-3 修改用户名 密码和域名 直接执行相应代码, 在控制台可看到使用 Token 方式身份证识别服务的识别结果 文档版本 06 ( ) 版权所有 华为技术有限公司 22

26 A 修订记录 A 修订记录 发布日期 修订说明 第六次正式发布 修改 第五次正式发布 将对应 Endpoint 修改为 ocr.cnnorth-1.myhuaweicloud.com 新增 第四次正式发布 服务 SDK 环境搭建, 新增 Python ios Android Node.js 开发环境配置方法 使用 SDK, 新增 Python ios Android Node.js 示例 修改 第三次正式发布 申请服务操作步骤参见文档为 API 参考 修改 删除银行卡识别 一维码识别 二维码识别和车牌识别相关内容 文档版本 06 ( ) 版权所有 华为技术有限公司 23

27 A 修订记录 发布日期 修订说明 第二次正式发布 新增 银行卡识别服务的 demo 用例 一维码识别服务的 demo 用例 二维码识别服务的 demo 用例 车牌识别服务的 demo 用例 机动车销售发票识别的 demo 用例 通用的 demo 用例 修改申请服务的获取信息 第一次正式发布 文档版本 06 ( ) 版权所有 华为技术有限公司 24