tccli 3.0.1268.1__py2.py3-none-any.whl → 3.0.1270.1__py2.py3-none-any.whl

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.
Files changed (107) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +5 -4
  3. tccli/services/aiart/aiart_client.py +106 -0
  4. tccli/services/aiart/v20221229/api.json +286 -11
  5. tccli/services/aiart/v20221229/examples.json +18 -2
  6. tccli/services/antiddos/v20200309/api.json +201 -132
  7. tccli/services/antiddos/v20200309/examples.json +12 -12
  8. tccli/services/apm/v20210622/api.json +13 -3
  9. tccli/services/billing/billing_client.py +4 -163
  10. tccli/services/billing/v20180709/api.json +0 -489
  11. tccli/services/billing/v20180709/examples.json +0 -24
  12. tccli/services/cam/v20190116/api.json +8 -8
  13. tccli/services/cat/v20180409/api.json +3 -1
  14. tccli/services/cbs/cbs_client.py +220 -8
  15. tccli/services/cbs/v20170312/api.json +418 -2
  16. tccli/services/cbs/v20170312/examples.json +32 -0
  17. tccli/services/ccc/v20200210/api.json +11 -11
  18. tccli/services/ccc/v20200210/examples.json +2 -2
  19. tccli/services/cdb/v20170320/api.json +48 -18
  20. tccli/services/cdwdoris/v20211228/api.json +10 -1
  21. tccli/services/cfw/v20190904/api.json +30 -30
  22. tccli/services/ckafka/v20190819/api.json +10 -0
  23. tccli/services/cls/v20201016/api.json +11 -0
  24. tccli/services/csip/v20221121/api.json +38 -38
  25. tccli/services/cwp/cwp_client.py +4 -57
  26. tccli/services/cwp/v20180228/api.json +0 -184
  27. tccli/services/cwp/v20180228/examples.json +0 -8
  28. tccli/services/cynosdb/v20190107/api.json +1 -1
  29. tccli/services/cynosdb/v20190107/examples.json +1 -1
  30. tccli/services/dcdb/dcdb_client.py +122 -16
  31. tccli/services/dcdb/v20180411/api.json +222 -0
  32. tccli/services/dcdb/v20180411/examples.json +16 -0
  33. tccli/services/dlc/v20210125/api.json +169 -50
  34. tccli/services/dlc/v20210125/examples.json +20 -20
  35. tccli/services/domain/v20180808/api.json +8 -8
  36. tccli/services/domain/v20180808/examples.json +3 -3
  37. tccli/services/dts/v20211206/api.json +1 -1
  38. tccli/services/es/v20180416/api.json +9 -9
  39. tccli/services/ess/v20201111/api.json +1 -1
  40. tccli/services/essbasic/v20210526/api.json +3 -3
  41. tccli/services/essbasic/v20210526/examples.json +2 -2
  42. tccli/services/facefusion/v20220927/api.json +4 -4
  43. tccli/services/faceid/v20180301/api.json +5 -5
  44. tccli/services/faceid/v20180301/examples.json +6 -0
  45. tccli/services/gme/v20180711/api.json +147 -141
  46. tccli/services/gme/v20180711/examples.json +9 -9
  47. tccli/services/hunyuan/v20230901/api.json +9 -0
  48. tccli/services/iotexplorer/v20190423/api.json +4 -4
  49. tccli/services/iotexplorer/v20190423/examples.json +5 -5
  50. tccli/services/keewidb/v20220308/api.json +2 -2
  51. tccli/services/lcic/v20220817/api.json +177 -177
  52. tccli/services/lcic/v20220817/examples.json +2 -2
  53. tccli/services/lighthouse/v20200324/api.json +76 -67
  54. tccli/services/live/v20180801/api.json +1 -1
  55. tccli/services/lke/v20231130/api.json +31 -0
  56. tccli/services/lkeap/v20240522/api.json +55 -9
  57. tccli/services/lkeap/v20240522/examples.json +1 -1
  58. tccli/services/mna/mna_client.py +106 -0
  59. tccli/services/mna/v20210119/api.json +246 -0
  60. tccli/services/mna/v20210119/examples.json +16 -0
  61. tccli/services/monitor/monitor_client.py +62 -57
  62. tccli/services/monitor/v20230616/api.json +266 -0
  63. tccli/services/monitor/v20230616/examples.json +19 -0
  64. tccli/services/mqtt/mqtt_client.py +489 -12
  65. tccli/services/mqtt/v20240516/api.json +864 -3
  66. tccli/services/mqtt/v20240516/examples.json +72 -0
  67. tccli/services/ocr/ocr_client.py +53 -0
  68. tccli/services/ocr/v20181119/api.json +319 -2
  69. tccli/services/ocr/v20181119/examples.json +8 -0
  70. tccli/services/postgres/postgres_client.py +334 -16
  71. tccli/services/postgres/v20170312/api.json +717 -34
  72. tccli/services/postgres/v20170312/examples.json +72 -0
  73. tccli/services/ses/v20201002/api.json +15 -5
  74. tccli/services/ssl/v20191205/api.json +496 -493
  75. tccli/services/ssl/v20191205/examples.json +144 -24
  76. tccli/services/svp/v20240125/api.json +6 -6
  77. tccli/services/taf/taf_client.py +0 -159
  78. tccli/services/taf/v20200210/api.json +0 -665
  79. tccli/services/taf/v20200210/examples.json +0 -24
  80. tccli/services/teo/v20220901/api.json +40 -2
  81. tccli/services/tione/v20211111/api.json +14 -3
  82. tccli/services/trabbit/__init__.py +4 -0
  83. tccli/services/trabbit/trabbit_client.py +1691 -0
  84. tccli/services/trabbit/v20230418/api.json +4773 -0
  85. tccli/services/trabbit/v20230418/examples.json +237 -0
  86. tccli/services/trp/v20210515/api.json +549 -513
  87. tccli/services/trp/v20210515/examples.json +5 -5
  88. tccli/services/trtc/v20190722/api.json +8 -8
  89. tccli/services/trtc/v20190722/examples.json +2 -2
  90. tccli/services/vclm/v20240523/api.json +0 -450
  91. tccli/services/vclm/v20240523/examples.json +0 -48
  92. tccli/services/vclm/vclm_client.py +0 -159
  93. tccli/services/vpc/v20170312/api.json +124 -0
  94. tccli/services/vpc/v20170312/examples.json +16 -0
  95. tccli/services/vpc/vpc_client.py +106 -0
  96. tccli/services/wedata/v20210820/api.json +211 -33
  97. tccli/services/wedata/v20210820/examples.json +14 -0
  98. tccli/services/wedata/wedata_client.py +53 -0
  99. {tccli-3.0.1268.1.dist-info → tccli-3.0.1270.1.dist-info}/METADATA +2 -2
  100. {tccli-3.0.1268.1.dist-info → tccli-3.0.1270.1.dist-info}/RECORD +103 -101
  101. tccli/services/aa/__init__.py +0 -4
  102. tccli/services/aa/aa_client.py +0 -207
  103. tccli/services/aa/v20200224/api.json +0 -397
  104. tccli/services/aa/v20200224/examples.json +0 -13
  105. {tccli-3.0.1268.1.dist-info → tccli-3.0.1270.1.dist-info}/WHEEL +0 -0
  106. {tccli-3.0.1268.1.dist-info → tccli-3.0.1270.1.dist-info}/entry_points.txt +0 -0
  107. {tccli-3.0.1268.1.dist-info → tccli-3.0.1270.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,13 @@
1
1
  {
2
2
  "actions": {
3
+ "ActivateCaCertificate": [
4
+ {
5
+ "document": "示例",
6
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ActivateCaCertificate\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-g4r4x85z\",\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\"\n}",
7
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"ab925a7a-bac9-4a6c-bf81-af13f9f9db48\"\n }\n}",
8
+ "title": "示例"
9
+ }
10
+ ],
3
11
  "ActivateDeviceCertificate": [
4
12
  {
5
13
  "document": "示例",
@@ -8,6 +16,14 @@
8
16
  "title": "示例"
9
17
  }
10
18
  ],
19
+ "ApplyRegistrationCode": [
20
+ {
21
+ "document": "示例",
22
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ApplyRegistrationCode\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-jeredv33\"\n}",
23
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"InstanceId\": \"mqtt-jeredv33\",\n \"RegistrationCode\": \"bb180052-7df5-4ff3-bda9-9b12fed8bf39\",\n \"RequestId\": \"8251a13b-b8a0-4134-bc43-5b3ab4253f92\"\n }\n}",
24
+ "title": "示例"
25
+ }
26
+ ],
11
27
  "CreateAuthorizationPolicy": [
12
28
  {
13
29
  "document": "示例",
@@ -64,6 +80,14 @@
64
80
  "title": "示例"
65
81
  }
66
82
  ],
83
+ "DeactivateCaCertificate": [
84
+ {
85
+ "document": "示例",
86
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeactivateCaCertificate\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-g4r4x85z\",\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\"\n}",
87
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"7ec2bb28-db0c-47a8-99dd-589732de4f58\"\n }\n}",
88
+ "title": "示例"
89
+ }
90
+ ],
67
91
  "DeactivateDeviceCertificate": [
68
92
  {
69
93
  "document": "示例",
@@ -88,6 +112,14 @@
88
112
  "title": "示例"
89
113
  }
90
114
  ],
115
+ "DeleteCaCertificate": [
116
+ {
117
+ "document": "示例",
118
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCaCertificate\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-g4r4x85z\",\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\"\n}",
119
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"c180b739-df35-41a7-b7d0-796c8b4e9c55\"\n }\n}",
120
+ "title": "示例"
121
+ }
122
+ ],
91
123
  "DeleteDeviceCertificate": [
92
124
  {
93
125
  "document": "示例",
@@ -150,6 +182,22 @@
150
182
  "title": "示例"
151
183
  }
152
184
  ],
185
+ "DescribeCaCertificate": [
186
+ {
187
+ "document": "示例",
188
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCaCertificate\n<公共请求参数>\n\n{\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"InstanceId\": \"mqtt-jbgwp4ae\"\n}",
189
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CaCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\\nBQAwgZIxCzAJBgNVBAYTAmNuMQ0wCwYDVQQIDAR4aWFuMQ0wCwYDVQQHDARodXlp\\nMREwDwYDVQQKDAhqZWhhbnN1bjEWMBQGA1UECwwNdW5pdCBqZWhhbnN1bjEVMBMG\\nA1UEAwwMc3Vuamlhbnhpb25nMSMwIQYJKoZIhvc1UEBwwEaHV5aTERMA8GA1UECgwI\\namVoYW5zdW4xFjAUBgNVB\\n-----END CERTIFICATE-----\\n\",\n \"CaCn\": \"sn\",\n \"CaIssuerCn\": \"cn\",\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CreatedTime\": 1724050364000,\n \"Format\": \"PEM\",\n \"LastActivationTime\": 1724050364340,\n \"LastInactivationTime\": 0,\n \"NotAfterTime\": 2030344601000,\n \"NotBeforeTime\": 1724052316000,\n \"RequestId\": \"7cb5d884-35a0-4f35-9cca-24c7d748a034\",\n \"Status\": \"ACTIVE\",\n \"UpdateTime\": 1724050364000\n }\n}",
190
+ "title": "示例"
191
+ }
192
+ ],
193
+ "DescribeCaCertificates": [
194
+ {
195
+ "document": "示例",
196
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCaCertificates\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-mmgej724\"\n}",
197
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"CaCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\",\n \"CaCn\": \"cn\",\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CreatedTime\": 1719992244000,\n \"Format\": \"PEM\",\n \"Status\": \"ACTIVE\",\n \"UpdateTime\": 1719992244000,\n \"LastInactivationTime\": 1719992244000,\n \"LastActivationTime\": 1719992244000,\n \"VerificationCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIID7TCCAtWgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmRIwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\"\n }\n ],\n \"RequestId\": \"d03f799b-1244-45d7-9e03-0ceaf8f63fed\"\n }\n}",
198
+ "title": "示例"
199
+ }
200
+ ],
153
201
  "DescribeDeviceCertificate": [
154
202
  {
155
203
  "document": "示例",
@@ -190,6 +238,14 @@
190
238
  "title": "示例"
191
239
  }
192
240
  ],
241
+ "DescribeProductSKUList": [
242
+ {
243
+ "document": "示例",
244
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProductSKUList\n<公共请求参数>\n\n{}",
245
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"MQTTProductSkuList\": [\n {\n \"ClientNumLimit\": 1,\n \"InstanceType\": \"BASIC\",\n \"OnSale\": true,\n \"SkuCode\": \"mqtt_1k\",\n \"TopicNumLimit\": 1,\n \"TpsLimit\": 1\n },\n {\n \"ClientNumLimit\": 1000,\n \"InstanceType\": \"BASIC\",\n \"OnSale\": true,\n \"SkuCode\": \"basic_1k\",\n \"TopicNumLimit\": 25,\n \"TpsLimit\": 1000\n }\n ],\n \"RequestId\": \"2be05982-b125-4259-b965-c487949cd896\",\n \"TotalCount\": 2\n }\n}",
246
+ "title": "示例"
247
+ }
248
+ ],
193
249
  "DescribeTopic": [
194
250
  {
195
251
  "document": "示例",
@@ -238,6 +294,14 @@
238
294
  "title": "示例"
239
295
  }
240
296
  ],
297
+ "ModifyInstanceCertBinding": [
298
+ {
299
+ "document": "示例",
300
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceCertBinding\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-jeredv33\",\n \"SSLServerCertId\": \"\",\n \"SSLCaCertId\": \"\",\n \"X509Mode\": \"TLS\"\n}",
301
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"91843178-a4a3-4ced-b5d9-f679962393c4\"\n }\n}",
302
+ "title": "示例"
303
+ }
304
+ ],
241
305
  "ModifyJWKSAuthenticator": [
242
306
  {
243
307
  "document": "示例",
@@ -270,6 +334,14 @@
270
334
  "title": "示例"
271
335
  }
272
336
  ],
337
+ "RegisterCaCertificate": [
338
+ {
339
+ "document": "示例",
340
+ "input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RegisterCaCertificate\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-g4r4x85z\",\n \"CaCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\",\n \"VerificationCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIID7TCCAtWgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmRIwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\"\n}",
341
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"2773beef-8527-4cc1-9e84-f15d56eaa7d9\"\n }\n}",
342
+ "title": "示例"
343
+ }
344
+ ],
273
345
  "RegisterDeviceCertificate": [
274
346
  {
275
347
  "document": "示例",
@@ -1629,6 +1629,58 @@ def doGetTaskState(args, parsed_globals):
1629
1629
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1630
1630
 
1631
1631
 
1632
+ def doRecognizeGeneralCardWarn(args, parsed_globals):
1633
+ g_param = parse_global_arg(parsed_globals)
1634
+
1635
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
1636
+ cred = credential.CVMRoleCredential()
1637
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
1638
+ cred = credential.STSAssumeRoleCredential(
1639
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
1640
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
1641
+ )
1642
+ elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
1643
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
1644
+ else:
1645
+ cred = credential.Credential(
1646
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
1647
+ )
1648
+ http_profile = HttpProfile(
1649
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
1650
+ reqMethod="POST",
1651
+ endpoint=g_param[OptionsDefine.Endpoint],
1652
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
1653
+ )
1654
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
1655
+ if g_param[OptionsDefine.Language]:
1656
+ profile.language = g_param[OptionsDefine.Language]
1657
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
1658
+ client = mod.OcrClient(cred, g_param[OptionsDefine.Region], profile)
1659
+ client._sdkVersion += ("_CLI_" + __version__)
1660
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
1661
+ model = models.RecognizeGeneralCardWarnRequest()
1662
+ model.from_json_string(json.dumps(args))
1663
+ start_time = time.time()
1664
+ while True:
1665
+ rsp = client.RecognizeGeneralCardWarn(model)
1666
+ result = rsp.to_json_string()
1667
+ try:
1668
+ json_obj = json.loads(result)
1669
+ except TypeError as e:
1670
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
1671
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
1672
+ break
1673
+ cur_time = time.time()
1674
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
1675
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
1676
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
1677
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
1678
+ else:
1679
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
1680
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
1681
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1682
+
1683
+
1632
1684
  def doFlightInvoiceOCR(args, parsed_globals):
1633
1685
  g_param = parse_global_arg(parsed_globals)
1634
1686
 
@@ -4635,6 +4687,7 @@ ACTION_MAP = {
4635
4687
  "VehicleLicenseOCR": doVehicleLicenseOCR,
4636
4688
  "BizLicenseOCR": doBizLicenseOCR,
4637
4689
  "GetTaskState": doGetTaskState,
4690
+ "RecognizeGeneralCardWarn": doRecognizeGeneralCardWarn,
4638
4691
  "FlightInvoiceOCR": doFlightInvoiceOCR,
4639
4692
  "RecognizeThaiIDCardOCR": doRecognizeThaiIDCardOCR,
4640
4693
  "TableOCR": doTableOCR,
@@ -378,6 +378,13 @@
378
378
  "output": "RecognizeFormulaOCRResponse",
379
379
  "status": "online"
380
380
  },
381
+ "RecognizeGeneralCardWarn": {
382
+ "document": "支持通用证照的有效性检测告警,包括卡证复印件告警、卡证翻拍告警等功能,支持通用证照的ps伪造检测,可以应用于各种证件信息有效性校验场景。",
383
+ "input": "RecognizeGeneralCardWarnRequest",
384
+ "name": "通用卡证鉴伪",
385
+ "output": "RecognizeGeneralCardWarnResponse",
386
+ "status": "online"
387
+ },
381
388
  "RecognizeGeneralInvoice": {
382
389
  "document": "本接口支持 PDF多页(最多30页)、一页中单张、多张、类型票据的混合识别,同时支持单选识别某类票据,已支持票种包括:增值税发票(专票、普票、卷票、区块链发票、通行费发票)、全电发票(专票、普票)、非税发票(通用票据、统一缴纳书)、定额发票、通用机打发票、购车发票(机动车销售发票、二手车发票)、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票共14种标准报销发票,支持OFD格式的 增值税电子普通发票、增值税电子专用发票、电子发票(普通发票)、电子发票(增值税专用发票)、电子发票(机票行程单)、电子发票(铁路电子客票)的第一页识别,并支持非上述类型的其他发票的智能识别,点击[立即试用](https://cloud.tencent.com/product/ocr)。\n\n默认接口请求频率限制:5次/秒。\n\n\n支持返回的细项目子票种SubType、子票种中文TypeDescription、以及对应所属大类票种Type 的说明如下列表:\n<table style=\"width:715px\">\n <thead>\n <tr>\n <th style=\"width:200px\">SubType 子票种英文</th>\n <th style=\"width:200px\">TypeDescription子票种中文</th>\n <th >Type 所属大类票种</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td> VatSpecialInvoice</td>\n <td> 增值税专用发票 </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatCommonInvoice</td>\n <td> 增值税普通发票 </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicCommonInvoice </td>\n <td> 增值税电子普通发票 </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoice </td>\n <td> 增值税电子专用发票 </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceBlockchain</td>\n <td> 区块链电子发票 </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceToll</td>\n <td> 增值税电子普通发票(通行费)</td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatSalesList</td>\n <td> 增值税销货清单</td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoiceFull</td>\n <td> 电子发票(专用发票)</td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceFull</td>\n <td> 电子发票(普通发票) </td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> ElectronicFlightTicketFull</td>\n <td> 电子发票(机票行程单)</td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> ElectronicTrainTicketFull</td>\n <td> 电子发票(铁路电子客票)</td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> MotorVehicleSaleInvoice </td>\n <td> 机动车销售统一发票 </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> UsedCarPurchaseInvoice </td>\n <td> 二手车销售统一发票 </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> VatInvoiceRoll </td>\n <td> 增值税普通发票(卷票) </td>\n <td> 11 </td>\n </tr>\n <tr>\n <td> TaxiTicket </td>\n <td> 出租车发票 </td>\n <td> 0 </td>\n </tr>\n <tr>\n <td> QuotaInvoice </td>\n <td> 定额发票 </td>\n <td> 1 </td>\n </tr>\n <tr>\n <td> TrainTicket </td>\n <td> 火车票 </td>\n <td> 2 </td>\n </tr>\n <tr>\n <td> AirTransport </td>\n <td> 机票行程单 </td>\n <td> 5 </td>\n </tr>\n <tr>\n <td> MachinePrintedInvoice </td>\n <td> 通用机打发票 </td>\n <td> 8 </td>\n </tr>\n <tr>\n <td> BusInvoice </td>\n <td> 汽车票 </td>\n <td> 9 </td>\n </tr>\n <tr>\n <td> ShippingInvoice </td>\n <td> 轮船票 </td>\n <td> 10 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeGeneralBill </td>\n <td> 非税收入通用票据 </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeElectronicBill </td>\n <td> 非税收入一般缴款书(电子) </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> TollInvoice </td>\n <td> 过路过桥费发票 </td>\n <td> 13 </td>\n </tr>\n <tr>\n <td> MedicalOutpatientInvoice </td>\n <td> 医疗门诊收费票据(电子) </td>\n <td> 17 </td>\n </tr>\n <tr>\n <td> MedicalHospitalizedInvoice </td>\n <td> 医疗住院收费票据(电子) </td>\n <td> 17 </td>\n </tr>\n <tr>\n <td> OtherInvoice </td>\n <td> 其他发票 </td>\n <td> -1 </td>\n </tr>\n </tbody>\n </table>",
383
390
  "input": "RecognizeGeneralInvoiceRequest",
@@ -1187,7 +1194,7 @@
1187
1194
  },
1188
1195
  {
1189
1196
  "disabled": false,
1190
- "document": "有效截至日期",
1197
+ "document": "有效截止日期",
1191
1198
  "example": "无",
1192
1199
  "member": "string",
1193
1200
  "name": "DateEnd",
@@ -2925,6 +2932,32 @@
2925
2932
  ],
2926
2933
  "type": "object"
2927
2934
  },
2935
+ "CustomsPaymentReceipt": {
2936
+ "document": "海关缴款书",
2937
+ "members": [
2938
+ {
2939
+ "disabled": false,
2940
+ "document": "发票名称",
2941
+ "example": "无",
2942
+ "member": "string",
2943
+ "name": "Title",
2944
+ "output_required": true,
2945
+ "type": "string",
2946
+ "value_allowed_null": false
2947
+ },
2948
+ {
2949
+ "disabled": false,
2950
+ "document": "识别出的字段名称(关键字),支持以下字段: 税号 、纳税人识别号 、纳税人名称 、金额合计大写 、金额合计小写 、填发日期 、税务机关 、填票人。 示例值:纳税人识别号",
2951
+ "example": "无",
2952
+ "member": "OtherInvoiceItem",
2953
+ "name": "Content",
2954
+ "output_required": true,
2955
+ "type": "list",
2956
+ "value_allowed_null": false
2957
+ }
2958
+ ],
2959
+ "usage": "out"
2960
+ },
2928
2961
  "DetailInformationOfAirTicketTupleList": {
2929
2962
  "document": "机票详细信息元组",
2930
2963
  "members": [
@@ -5921,6 +5954,26 @@
5921
5954
  "output_required": true,
5922
5955
  "type": "string",
5923
5956
  "value_allowed_null": false
5957
+ },
5958
+ {
5959
+ "disabled": false,
5960
+ "document": "客票生效日期",
5961
+ "example": "无",
5962
+ "member": "string",
5963
+ "name": "DateStart",
5964
+ "output_required": true,
5965
+ "type": "string",
5966
+ "value_allowed_null": false
5967
+ },
5968
+ {
5969
+ "disabled": false,
5970
+ "document": "有效截止日期",
5971
+ "example": "无",
5972
+ "member": "string",
5973
+ "name": "DateEnd",
5974
+ "output_required": true,
5975
+ "type": "string",
5976
+ "value_allowed_null": false
5924
5977
  }
5925
5978
  ],
5926
5979
  "usage": "out"
@@ -6223,6 +6276,42 @@
6223
6276
  ],
6224
6277
  "type": "object"
6225
6278
  },
6279
+ "GeneralCardWarnInfo": {
6280
+ "document": "通用卡证鉴伪告警信息",
6281
+ "members": [
6282
+ {
6283
+ "disabled": false,
6284
+ "document": "是否存在该告警",
6285
+ "example": "false",
6286
+ "member": "bool",
6287
+ "name": "IsWarn",
6288
+ "output_required": true,
6289
+ "type": "bool",
6290
+ "value_allowed_null": false
6291
+ },
6292
+ {
6293
+ "disabled": false,
6294
+ "document": "风险程度",
6295
+ "example": "0.5",
6296
+ "member": "float",
6297
+ "name": "RiskConfidence",
6298
+ "output_required": true,
6299
+ "type": "float",
6300
+ "value_allowed_null": false
6301
+ },
6302
+ {
6303
+ "disabled": false,
6304
+ "document": "告警位置四点坐标",
6305
+ "example": "无",
6306
+ "member": "Polygon",
6307
+ "name": "Polygon",
6308
+ "output_required": true,
6309
+ "type": "list",
6310
+ "value_allowed_null": false
6311
+ }
6312
+ ],
6313
+ "usage": "out"
6314
+ },
6226
6315
  "GeneralEfficientOCRRequest": {
6227
6316
  "document": "GeneralEfficientOCR请求参数结构体",
6228
6317
  "members": [
@@ -8114,7 +8203,7 @@
8114
8203
  },
8115
8204
  {
8116
8205
  "disabled": false,
8117
- "document": "识别出的图片所属的票据类型。\n-1:未知类型\n0:出租车发票\n1:定额发票\n2:火车票\n3:增值税发票\n5:机票行程单\n8:通用机打发票\n9:汽车票\n10:轮船票\n11:增值税发票(卷票)\n12:购车发票\n13:过路过桥费发票\n15:非税发票\n16:全电发票\n17:医疗发票",
8206
+ "document": "识别出的图片所属的票据类型。\n-1:未知类型\n0:出租车发票\n1:定额发票\n2:火车票\n3:增值税发票\n5:机票行程单\n8:通用机打发票\n9:汽车票\n10:轮船票\n11:增值税发票(卷票)\n12:购车发票\n13:过路过桥费发票\n15:非税发票\n16:全电发票\n17:医疗发票\n18:完税凭证\n19:海关缴款书",
8118
8207
  "example": "3",
8119
8208
  "member": "int64",
8120
8209
  "name": "Type",
@@ -12180,6 +12269,15 @@
12180
12269
  "name": "EnableImageCrop",
12181
12270
  "required": false,
12182
12271
  "type": "bool"
12272
+ },
12273
+ {
12274
+ "disabled": false,
12275
+ "document": "是否只返回检测框,默认false",
12276
+ "example": "false",
12277
+ "member": "bool",
12278
+ "name": "EnableOnlyDetectBorder",
12279
+ "required": false,
12280
+ "type": "bool"
12183
12281
  }
12184
12282
  ],
12185
12283
  "type": "object"
@@ -13295,6 +13393,139 @@
13295
13393
  ],
13296
13394
  "type": "object"
13297
13395
  },
13396
+ "RecognizeGeneralCardWarnRequest": {
13397
+ "document": "RecognizeGeneralCardWarn请求参数结构体",
13398
+ "members": [
13399
+ {
13400
+ "disabled": false,
13401
+ "document": "图片链接",
13402
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg",
13403
+ "member": "string",
13404
+ "name": "ImageUrl",
13405
+ "required": false,
13406
+ "type": "string"
13407
+ },
13408
+ {
13409
+ "disabled": false,
13410
+ "document": "图片base64",
13411
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==\t",
13412
+ "member": "string",
13413
+ "name": "ImageBase64",
13414
+ "required": false,
13415
+ "type": "string"
13416
+ },
13417
+ {
13418
+ "disabled": false,
13419
+ "document": "卡证类型参数,包含以下范围: \nGeneral:通用卡证\nIDCard:身份证 \nPassport:护照 \nBankCard:银行卡\nVehicleLicense:行驶证\nDriverLicense:驾驶证\nBizLicense:营业执照 \nHmtResidentPermit:港澳台居住证\nForeignPermanentResident:外国人永居证\nMainlandPermit:港澳台来往内地通行证",
13420
+ "example": "General",
13421
+ "member": "string",
13422
+ "name": "CardType",
13423
+ "required": false,
13424
+ "type": "string"
13425
+ },
13426
+ {
13427
+ "disabled": false,
13428
+ "document": "是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。",
13429
+ "example": "false",
13430
+ "member": "bool",
13431
+ "name": "IsPdf",
13432
+ "required": false,
13433
+ "type": "bool"
13434
+ },
13435
+ {
13436
+ "disabled": false,
13437
+ "document": "需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。",
13438
+ "example": "1",
13439
+ "member": "uint64",
13440
+ "name": "PdfPageNumber",
13441
+ "required": false,
13442
+ "type": "int"
13443
+ }
13444
+ ],
13445
+ "type": "object"
13446
+ },
13447
+ "RecognizeGeneralCardWarnResponse": {
13448
+ "document": "RecognizeGeneralCardWarn返回参数结构体",
13449
+ "members": [
13450
+ {
13451
+ "disabled": false,
13452
+ "document": "卡证类型参数,包含以下范围: \nGeneral:通用卡证\nIDCard:身份证 \nPassport:护照 \nBankCard:银行卡\nVehicleLicense:行驶证\nDriverLicense:驾驶证\nBizLicense:营业执照 \nHmtResidentPermit:港澳台居住证\nForeignPermanentResident:外国人永居证\nMainlandPermit:港澳台来往内地通行证",
13453
+ "example": "无",
13454
+ "member": "string",
13455
+ "name": "CardType",
13456
+ "output_required": false,
13457
+ "type": "string",
13458
+ "value_allowed_null": false
13459
+ },
13460
+ {
13461
+ "disabled": false,
13462
+ "document": "模糊信息",
13463
+ "example": "无",
13464
+ "member": "GeneralCardWarnInfo",
13465
+ "name": "Blur",
13466
+ "output_required": false,
13467
+ "type": "object",
13468
+ "value_allowed_null": false
13469
+ },
13470
+ {
13471
+ "disabled": false,
13472
+ "document": "边框不完整信息",
13473
+ "example": "无",
13474
+ "member": "GeneralCardWarnInfo",
13475
+ "name": "BorderIncomplete",
13476
+ "output_required": false,
13477
+ "type": "object",
13478
+ "value_allowed_null": false
13479
+ },
13480
+ {
13481
+ "disabled": false,
13482
+ "document": "复印件信息",
13483
+ "example": "无",
13484
+ "member": "GeneralCardWarnInfo",
13485
+ "name": "Copy",
13486
+ "output_required": false,
13487
+ "type": "object",
13488
+ "value_allowed_null": false
13489
+ },
13490
+ {
13491
+ "disabled": false,
13492
+ "document": "ps篡改信息",
13493
+ "example": "无",
13494
+ "member": "GeneralCardWarnInfo",
13495
+ "name": "Ps",
13496
+ "output_required": false,
13497
+ "type": "object",
13498
+ "value_allowed_null": false
13499
+ },
13500
+ {
13501
+ "disabled": false,
13502
+ "document": "反光信息",
13503
+ "example": "无",
13504
+ "member": "GeneralCardWarnInfo",
13505
+ "name": "Reflection",
13506
+ "output_required": false,
13507
+ "type": "object",
13508
+ "value_allowed_null": false
13509
+ },
13510
+ {
13511
+ "disabled": false,
13512
+ "document": "翻拍件信息",
13513
+ "example": "无",
13514
+ "member": "GeneralCardWarnInfo",
13515
+ "name": "Reprint",
13516
+ "output_required": false,
13517
+ "type": "object",
13518
+ "value_allowed_null": false
13519
+ },
13520
+ {
13521
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
13522
+ "member": "string",
13523
+ "name": "RequestId",
13524
+ "type": "string"
13525
+ }
13526
+ ],
13527
+ "type": "object"
13528
+ },
13298
13529
  "RecognizeGeneralInvoiceRequest": {
13299
13530
  "document": "RecognizeGeneralInvoice请求参数结构体",
13300
13531
  "members": [
@@ -16161,6 +16392,26 @@
16161
16392
  "output_required": true,
16162
16393
  "type": "object",
16163
16394
  "value_allowed_null": true
16395
+ },
16396
+ {
16397
+ "disabled": false,
16398
+ "document": "完税凭证\n注意:此字段可能返回 null,表示取不到有效值。",
16399
+ "example": "无",
16400
+ "member": "TaxPayment",
16401
+ "name": "TaxPayment",
16402
+ "output_required": true,
16403
+ "type": "object",
16404
+ "value_allowed_null": true
16405
+ },
16406
+ {
16407
+ "disabled": false,
16408
+ "document": "海关缴款\n注意:此字段可能返回 null,表示取不到有效值。",
16409
+ "example": "无",
16410
+ "member": "CustomsPaymentReceipt",
16411
+ "name": "CustomsPaymentReceipt",
16412
+ "output_required": true,
16413
+ "type": "object",
16414
+ "value_allowed_null": true
16164
16415
  }
16165
16416
  ],
16166
16417
  "usage": "out"
@@ -16952,6 +17203,32 @@
16952
17203
  ],
16953
17204
  "usage": "out"
16954
17205
  },
17206
+ "TaxPayment": {
17207
+ "document": "完税凭证",
17208
+ "members": [
17209
+ {
17210
+ "disabled": false,
17211
+ "document": "发票名称",
17212
+ "example": "无",
17213
+ "member": "string",
17214
+ "name": "Title",
17215
+ "output_required": true,
17216
+ "type": "string",
17217
+ "value_allowed_null": false
17218
+ },
17219
+ {
17220
+ "disabled": false,
17221
+ "document": "识别出的字段名称(关键字),支持以下字段:\n税号 、纳税人识别号 、纳税人名称 、金额合计大写 、金额合计小写 、填发日期 、税务机关 、填票人。\n示例值:纳税人识别号",
17222
+ "example": "无",
17223
+ "member": "OtherInvoiceItem",
17224
+ "name": "Content",
17225
+ "output_required": true,
17226
+ "type": "list",
17227
+ "value_allowed_null": false
17228
+ }
17229
+ ],
17230
+ "usage": "out"
17231
+ },
16955
17232
  "TaxiInvoiceOCRRequest": {
16956
17233
  "document": "TaxiInvoiceOCR请求参数结构体",
16957
17234
  "members": [
@@ -20294,6 +20571,46 @@
20294
20571
  "output_required": true,
20295
20572
  "type": "string",
20296
20573
  "value_allowed_null": false
20574
+ },
20575
+ {
20576
+ "disabled": false,
20577
+ "document": "出行人,仅旅客运输服务发票返回",
20578
+ "example": "无",
20579
+ "member": "string",
20580
+ "name": "Traveler",
20581
+ "output_required": true,
20582
+ "type": "string",
20583
+ "value_allowed_null": false
20584
+ },
20585
+ {
20586
+ "disabled": false,
20587
+ "document": "有效身份证件号,仅旅客运输服务发票返回",
20588
+ "example": "无",
20589
+ "member": "string",
20590
+ "name": "TravelerID",
20591
+ "output_required": true,
20592
+ "type": "string",
20593
+ "value_allowed_null": false
20594
+ },
20595
+ {
20596
+ "disabled": false,
20597
+ "document": "出行日期,仅旅客运输服务发票返回",
20598
+ "example": "无",
20599
+ "member": "string",
20600
+ "name": "TravelDate",
20601
+ "output_required": true,
20602
+ "type": "string",
20603
+ "value_allowed_null": false
20604
+ },
20605
+ {
20606
+ "disabled": false,
20607
+ "document": "等级,仅旅客运输服务发票返回",
20608
+ "example": "无",
20609
+ "member": "string",
20610
+ "name": "TravelLevel",
20611
+ "output_required": true,
20612
+ "type": "string",
20613
+ "value_allowed_null": false
20297
20614
  }
20298
20615
  ],
20299
20616
  "usage": "out"
@@ -474,6 +474,14 @@
474
474
  "title": "公式识别调用示例"
475
475
  }
476
476
  ],
477
+ "RecognizeGeneralCardWarn": [
478
+ {
479
+ "document": "身份证",
480
+ "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecognizeGeneralCardWarn\n<公共请求参数>\n\n{\n \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg\"\n}",
481
+ "output": "{\n \"Response\": {\n \"Blur\": {\n \"IsWarn\": false,\n \"Polygon\": [],\n \"RiskConfidence\": 0.01\n },\n \"BorderIncomplete\": {\n \"IsWarn\": false,\n \"Polygon\": [],\n \"RiskConfidence\": 0.01\n },\n \"CardType\": \"IDCard\",\n \"Copy\": {\n \"IsWarn\": false,\n \"Polygon\": [],\n \"RiskConfidence\": 0.01\n },\n \"Ps\": {\n \"IsWarn\": true,\n \"Polygon\": [\n {\n \"LeftBottom\": {\n \"X\": 477,\n \"Y\": 494\n },\n \"LeftTop\": {\n \"X\": 477,\n \"Y\": 257\n },\n \"RightBottom\": {\n \"X\": 662,\n \"Y\": 494\n },\n \"RightTop\": {\n \"X\": 662,\n \"Y\": 257\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 309,\n \"Y\": 551\n },\n \"LeftTop\": {\n \"X\": 309,\n \"Y\": 527\n },\n \"RightBottom\": {\n \"X\": 617,\n \"Y\": 551\n },\n \"RightTop\": {\n \"X\": 617,\n \"Y\": 527\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 210,\n \"Y\": 461\n },\n \"LeftTop\": {\n \"X\": 210,\n \"Y\": 403\n },\n \"RightBottom\": {\n \"X\": 417,\n \"Y\": 461\n },\n \"RightTop\": {\n \"X\": 417,\n \"Y\": 403\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 218,\n \"Y\": 284\n },\n \"LeftTop\": {\n \"X\": 218,\n \"Y\": 256\n },\n \"RightBottom\": {\n \"X\": 284,\n \"Y\": 284\n },\n \"RightTop\": {\n \"X\": 284,\n \"Y\": 256\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 216,\n \"Y\": 379\n },\n \"LeftTop\": {\n \"X\": 216,\n \"Y\": 358\n },\n \"RightBottom\": {\n \"X\": 268,\n \"Y\": 379\n },\n \"RightTop\": {\n \"X\": 268,\n \"Y\": 358\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 309,\n \"Y\": 377\n },\n \"LeftTop\": {\n \"X\": 309,\n \"Y\": 356\n },\n \"RightBottom\": {\n \"X\": 326,\n \"Y\": 377\n },\n \"RightTop\": {\n \"X\": 326,\n \"Y\": 356\n }\n },\n {\n \"LeftBottom\": {\n \"X\": 361,\n \"Y\": 378\n },\n \"LeftTop\": {\n \"X\": 361,\n \"Y\": 356\n },\n \"RightBottom\": {\n \"X\": 386,\n \"Y\": 378\n },\n \"RightTop\": {\n \"X\": 386,\n \"Y\": 356\n }\n }\n ],\n \"RiskConfidence\": 0.9318133\n },\n \"Reflection\": {\n \"IsWarn\": false,\n \"Polygon\": [],\n \"RiskConfidence\": 0.01\n },\n \"Reprint\": {\n \"IsWarn\": false,\n \"Polygon\": [],\n \"RiskConfidence\": 0.01\n },\n \"RequestId\": \"b8b73be7-2d64-49c6-8cbc-3b1d2b5f3651\"\n }\n}",
482
+ "title": "通用卡证ps检测告警"
483
+ }
484
+ ],
477
485
  "RecognizeGeneralInvoice": [
478
486
  {
479
487
  "document": "通用票据识别(高级版)识别多张票据",