快速入门
安装通用文字识别 Node SDK
通用文字识别 Node SDK目录结构
1├── src
2│ ├── auth //授权相关类
3│ ├── http //Http通信相关类
4│ ├── client //公用类
5│ ├── util //工具类
6│ └── const //常量类
7├── AipOcr.js //通用文字识别交互类
8├── index.js //入口文件
9└── package.json //npm包描述文件
支持 node 版本 4.0+
查看源码 Nodejs SDK代码已开源,您可以查看代码、或者在License范围内修改和编译SDK以适配您的环境。 github链接:https://github.com/Baidu-AIP/nodejs-sdk
直接使用node开发包步骤如下:
1.在官方网站下载node SDK压缩包。
2.将下载的aip-node-sdk-version.zip
解压后,复制到工程文件夹中。
3.进入目录,运行npm install安装sdk依赖库。
4.把目录当做模块依赖。
其中,version
为版本号,添加完成后,用户就可以在工程中使用通用文字识别 Node SDK。
直接使用npm安装依赖:
npm install baidu-aip-sdk
新建AipOcrClient
AipOcrClient是Optical Character Recognition的node客户端,为使用Optical Character Recognition的开发人员提供了一系列的交互方法。
用户可以参考如下代码新建一个AipOcrClient:
1var AipOcrClient = require("baidu-aip-sdk").ocr;
2
3// 设置APPID/AK/SK
4var APP_ID = "你的 App ID";
5var API_KEY = "你的 Api Key";
6var SECRET_KEY = "你的 Secret Key";
7
8// 新建一个对象,建议只保存一个对象调用服务接口
9var client = new AipOcrClient(APP_ID, API_KEY, SECRET_KEY);
为了使开发者更灵活的控制请求,模块提供了设置全局参数和全局请求拦截器的方法;本库发送网络请求依赖的是request模块,因此参数格式与request模块的参数相同,更多参数细节您可以参考request官方参数文档。
1var HttpClient = require("baidu-aip-sdk").HttpClient;
2
3// 设置request库的一些参数,例如代理服务地址,超时时间等
4// request参数请参考 https://github.com/request/request#requestoptions-callback
5HttpClient.setRequestOptions({timeout: 5000});
6
7// 也可以设置拦截每次请求(设置拦截后,调用的setRequestOptions设置的参数将不生效),
8// 可以按需修改request参数(无论是否修改,必须返回函数调用参数)
9// request参数请参考 https://github.com/request/request#requestoptions-callback
10HttpClient.setRequestInterceptor(function(requestOptions) {
11 // 查看参数
12 console.log(requestOptions)
13 // 修改参数
14 requestOptions.timeout = 5000;
15 // 返回参数
16 return requestOptions;
17});
在上面代码中,常量APP_ID
在百度智能云控制台中创建,常量API_KEY
与SECRET_KEY
是在创建完毕应用后,系统分配给用户的,均为字符串,用于标识用户,为访问做签名验证,可在AI服务控制台中的应用列表中查看。
注意:如您以前是百度智能云的老用户,其中API_KEY
对应百度智能云的“Access Key ID”,SECRET_KEY
对应百度智能云的“Access Key Secret”。