tencentcloud-sdk-nodejs-ocr 4.0.1026 → 4.0.1029

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,21 +1,20 @@
1
1
  # 简介
2
2
 
3
- 欢迎使用腾讯云开发者工具套件(SDK),NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
4
- 为方便 NODEJS 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 NODEJS 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
3
+ 欢迎使用腾讯云开发者工具套件(SDK),Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
4
+ 为方便 Node.js 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 Node.js 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
5
5
 
6
6
  # 依赖环境
7
7
 
8
- 1. NODEJS 10.0.0 版本及以上
9
- 2. 从腾讯云控制台 开通相应产品
10
- 3. 获取 SecretID、SecretKey 以及调用地址(endpoint),endpoint 一般形式为\*.tencentcloudapi.com,如 CVM 的调用地址为 cvm.tencentcloudapi.com,具体参考各产品说明。
8
+ 1. Node.js 10.0.0 版本及以上。
9
+ 2. 注意:部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
11
10
 
12
11
  # 获取安装
13
12
 
14
- 安装 NODEJS SDK 前,先获取安全凭证。在第一次使用云 API 之前,用户首先需要在腾讯云控制台上申请安全凭证,安全凭证包括 SecretID SecretKey, SecretID 是用于标识 API 调用者的身份,SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管,避免泄露。
13
+ 使用 SDK 需要 API 密钥,可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请,API 密钥包括 SecretID SecretKey,密钥须严格保管,避免泄露。
15
14
 
16
- ## 通过 NPM 安装
15
+ ## 通过 npm 安装
17
16
 
18
- 通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法,NPM NODEJS 的包管理工具。关于 NPM 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
17
+ 通过 npm 获取安装是使用 Node.js SDK 的推荐方法,关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
19
18
 
20
19
  ### 安装指定产品 SDK(推荐)
21
20
 
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
56
55
  1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
57
56
  2. 解压源码包到您项目合适的位置,例如 `sdk/tencentcloud-sdk-nodejs`。
58
57
  3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
59
- 4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入SDK,具体可参考示例。
58
+ 4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK,具体可参考示例。
60
59
 
61
60
  # 示例
62
61
 
62
+ 以云服务器产品查询可用区列表接口为例。
63
+
63
64
  ```js
64
65
  const tencentcloud = require("tencentcloud-sdk-nodejs")
65
66
 
@@ -102,7 +103,7 @@ client.DescribeZones().then(
102
103
  )
103
104
  ```
104
105
 
105
- 在支持 typescript 项目中,采用如下方式调用
106
+ 在支持 TypeScript 项目中,采用如下方式调用
106
107
 
107
108
  ```js
108
109
  import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -112,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
112
113
  // ...
113
114
  ```
114
115
 
115
- 实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
116
+ 实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
116
117
 
117
118
  ## Common Client
118
- 从 4.0.714 版本开始腾讯云 NODEJS SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
119
+
120
+ 从 4.0.714 版本开始,腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
119
121
 
120
122
  **注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
121
123
 
@@ -123,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
123
125
 
124
126
  ## 更多示例
125
127
 
126
- 更丰富的使用 demo 请在 examples 目录中寻找。
128
+ 请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
127
129
 
128
130
  # 相关配置
129
131
 
130
132
  ## 代理
131
133
 
132
- 如果是有代理的环境下,需要配置代理,请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
134
+ 如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
133
135
 
134
136
  # 凭证管理
135
137
 
136
138
  除显式传入凭证外,从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
137
139
 
138
- 在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
140
+ 在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
139
141
  ```javascript
140
142
  // ...
141
143
  const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -147,20 +149,16 @@ new XxxClient({
147
149
  })
148
150
  ```
149
151
 
150
- # 旧版 SDK
151
-
152
- 我们推荐使用新版 NODEJS SDK,如果一定要用旧版 SDK,请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
153
-
154
152
  # 常见问题
155
- - webpack打包出错/浏览器报错
153
+ - webpack 打包出错/浏览器报错
156
154
 
157
- 请**务必不要**将此SDK直接用于web前端(包括小程序等),暴露密钥在这些环境非常不安全。
155
+ 请**务必不要**将此 SDK 直接用于 Web 前端(包括小程序等),暴露密钥在这些环境非常不安全。
158
156
 
159
- 正确的做法是在自己的服务端引用此SDK,并保存好密钥,做好请求鉴权;前端再调用服务端执行业务流程。
157
+ 正确的做法是在自己的服务端引用此 SDK,并保存好密钥,做好请求鉴权,前端再调用服务端执行业务流程。
160
158
 
161
159
  - `The "original" argument must be of type Function.`
162
160
 
163
- 通常是因为nodejs版本低于 `v10` ,或处于非node环境,请再次确认执行环境。
161
+ 通常是因为 Node.js 版本低于 `v10` ,或处于非 Node.js 环境,请再次确认执行环境。
164
162
 
165
163
  - 请求不通
166
164
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ocr",
3
- "version": "4.0.1026",
3
+ "version": "4.0.1029",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
@@ -7035,57 +7035,69 @@ export interface TextVehicleFront {
7035
7035
  * 号牌号码
7036
7036
  注意:此字段可能返回 null,表示取不到有效值。
7037
7037
  */
7038
- PlateNo: string
7038
+ PlateNo?: string
7039
7039
  /**
7040
7040
  * 车辆类型
7041
7041
  注意:此字段可能返回 null,表示取不到有效值。
7042
7042
  */
7043
- VehicleType: string
7043
+ VehicleType?: string
7044
7044
  /**
7045
7045
  * 所有人
7046
7046
  注意:此字段可能返回 null,表示取不到有效值。
7047
7047
  */
7048
- Owner: string
7048
+ Owner?: string
7049
7049
  /**
7050
7050
  * 住址
7051
7051
  注意:此字段可能返回 null,表示取不到有效值。
7052
7052
  */
7053
- Address: string
7053
+ Address?: string
7054
7054
  /**
7055
7055
  * 使用性质
7056
7056
  注意:此字段可能返回 null,表示取不到有效值。
7057
7057
  */
7058
- UseCharacter: string
7058
+ UseCharacter?: string
7059
7059
  /**
7060
7060
  * 品牌型号
7061
7061
  注意:此字段可能返回 null,表示取不到有效值。
7062
7062
  */
7063
- Model: string
7063
+ Model?: string
7064
7064
  /**
7065
7065
  * 车辆识别代号
7066
7066
  注意:此字段可能返回 null,表示取不到有效值。
7067
7067
  */
7068
- Vin: string
7068
+ Vin?: string
7069
7069
  /**
7070
7070
  * 发动机号码
7071
7071
  注意:此字段可能返回 null,表示取不到有效值。
7072
7072
  */
7073
- EngineNo: string
7073
+ EngineNo?: string
7074
7074
  /**
7075
7075
  * 注册日期
7076
7076
  注意:此字段可能返回 null,表示取不到有效值。
7077
7077
  */
7078
- RegisterDate: string
7078
+ RegisterDate?: string
7079
7079
  /**
7080
7080
  * 发证日期
7081
7081
  注意:此字段可能返回 null,表示取不到有效值。
7082
7082
  */
7083
- IssueDate: string
7083
+ IssueDate?: string
7084
7084
  /**
7085
7085
  * 印章
7086
7086
  注意:此字段可能返回 null,表示取不到有效值。
7087
7087
  */
7088
- Seal: string
7088
+ Seal?: string
7089
+ /**
7090
+ * 状态
7091
+ */
7092
+ StateElectronic?: string
7093
+ /**
7094
+ * 检验有效期
7095
+ */
7096
+ InspectionValidityTimeElectronic?: string
7097
+ /**
7098
+ * 生成时间
7099
+ */
7100
+ GenerationTimeElectronic?: string
7089
7101
  }
7090
7102
 
7091
7103
  /**
@@ -8856,17 +8868,29 @@ export interface ContentInfo {
8856
8868
  */
8857
8869
  Confidence?: number
8858
8870
  /**
8859
- * 字段是否不完整
8871
+ * 字段是否不完整(value内容)
8860
8872
  0 字段正常
8861
8873
  1 字段不完整
8862
8874
  */
8863
8875
  IsInComplete?: number
8864
8876
  /**
8865
- * 字段反光
8877
+ * 字段反光(value内容)
8866
8878
  0 字段正常
8867
8879
  1 字段有反光
8868
8880
  */
8869
8881
  IsReflect?: number
8882
+ /**
8883
+ * 字段是否不完整(key内容)
8884
+ 0 字段正常
8885
+ 1 字段不完整
8886
+ */
8887
+ IsKeyInComplete?: number
8888
+ /**
8889
+ * 字段反光(key内容)
8890
+ 0 字段正常
8891
+ 1 字段有反光
8892
+ */
8893
+ IsKeyReflect?: number
8870
8894
  }
8871
8895
 
8872
8896
  /**
@@ -6831,57 +6831,69 @@ export interface TextVehicleFront {
6831
6831
  * 号牌号码
6832
6832
  注意:此字段可能返回 null,表示取不到有效值。
6833
6833
  */
6834
- PlateNo: string;
6834
+ PlateNo?: string;
6835
6835
  /**
6836
6836
  * 车辆类型
6837
6837
  注意:此字段可能返回 null,表示取不到有效值。
6838
6838
  */
6839
- VehicleType: string;
6839
+ VehicleType?: string;
6840
6840
  /**
6841
6841
  * 所有人
6842
6842
  注意:此字段可能返回 null,表示取不到有效值。
6843
6843
  */
6844
- Owner: string;
6844
+ Owner?: string;
6845
6845
  /**
6846
6846
  * 住址
6847
6847
  注意:此字段可能返回 null,表示取不到有效值。
6848
6848
  */
6849
- Address: string;
6849
+ Address?: string;
6850
6850
  /**
6851
6851
  * 使用性质
6852
6852
  注意:此字段可能返回 null,表示取不到有效值。
6853
6853
  */
6854
- UseCharacter: string;
6854
+ UseCharacter?: string;
6855
6855
  /**
6856
6856
  * 品牌型号
6857
6857
  注意:此字段可能返回 null,表示取不到有效值。
6858
6858
  */
6859
- Model: string;
6859
+ Model?: string;
6860
6860
  /**
6861
6861
  * 车辆识别代号
6862
6862
  注意:此字段可能返回 null,表示取不到有效值。
6863
6863
  */
6864
- Vin: string;
6864
+ Vin?: string;
6865
6865
  /**
6866
6866
  * 发动机号码
6867
6867
  注意:此字段可能返回 null,表示取不到有效值。
6868
6868
  */
6869
- EngineNo: string;
6869
+ EngineNo?: string;
6870
6870
  /**
6871
6871
  * 注册日期
6872
6872
  注意:此字段可能返回 null,表示取不到有效值。
6873
6873
  */
6874
- RegisterDate: string;
6874
+ RegisterDate?: string;
6875
6875
  /**
6876
6876
  * 发证日期
6877
6877
  注意:此字段可能返回 null,表示取不到有效值。
6878
6878
  */
6879
- IssueDate: string;
6879
+ IssueDate?: string;
6880
6880
  /**
6881
6881
  * 印章
6882
6882
  注意:此字段可能返回 null,表示取不到有效值。
6883
6883
  */
6884
- Seal: string;
6884
+ Seal?: string;
6885
+ /**
6886
+ * 状态
6887
+ */
6888
+ StateElectronic?: string;
6889
+ /**
6890
+ * 检验有效期
6891
+ */
6892
+ InspectionValidityTimeElectronic?: string;
6893
+ /**
6894
+ * 生成时间
6895
+ */
6896
+ GenerationTimeElectronic?: string;
6885
6897
  }
6886
6898
  /**
6887
6899
  * 广告文字识别结果
@@ -8601,17 +8613,29 @@ export interface ContentInfo {
8601
8613
  */
8602
8614
  Confidence?: number;
8603
8615
  /**
8604
- * 字段是否不完整
8616
+ * 字段是否不完整(value内容)
8605
8617
  0 字段正常
8606
8618
  1 字段不完整
8607
8619
  */
8608
8620
  IsInComplete?: number;
8609
8621
  /**
8610
- * 字段反光
8622
+ * 字段反光(value内容)
8611
8623
  0 字段正常
8612
8624
  1 字段有反光
8613
8625
  */
8614
8626
  IsReflect?: number;
8627
+ /**
8628
+ * 字段是否不完整(key内容)
8629
+ 0 字段正常
8630
+ 1 字段不完整
8631
+ */
8632
+ IsKeyInComplete?: number;
8633
+ /**
8634
+ * 字段反光(key内容)
8635
+ 0 字段正常
8636
+ 1 字段有反光
8637
+ */
8638
+ IsKeyReflect?: number;
8615
8639
  }
8616
8640
  /**
8617
8641
  * QuestionOCR请求参数结构体