tccli-intl-en 3.0.1282.1__py2.py3-none-any.whl → 3.1.33.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 (207) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/services/__init__.py +15 -0
  4. tccli/services/advisor/advisor_client.py +2 -2
  5. tccli/services/ai3d/__init__.py +4 -0
  6. tccli/services/ai3d/ai3d_client.py +266 -0
  7. tccli/services/ai3d/v20250513/api.json +264 -0
  8. tccli/services/ai3d/v20250513/examples.json +20 -0
  9. tccli/services/aiart/aiart_client.py +1 -1
  10. tccli/services/ams/ams_client.py +4 -4
  11. tccli/services/antiddos/antiddos_client.py +70 -70
  12. tccli/services/apigateway/apigateway_client.py +93 -93
  13. tccli/services/apm/apm_client.py +783 -55
  14. tccli/services/apm/v20210622/api.json +3936 -1145
  15. tccli/services/apm/v20210622/examples.json +133 -23
  16. tccli/services/asr/asr_client.py +2 -2
  17. tccli/services/autoscaling/autoscaling_client.py +58 -58
  18. tccli/services/autoscaling/v20180419/api.json +77 -27
  19. tccli/services/batch/batch_client.py +28 -28
  20. tccli/services/bi/bi_client.py +24 -24
  21. tccli/services/billing/billing_client.py +42 -42
  22. tccli/services/cam/cam_client.py +81 -81
  23. tccli/services/captcha/captcha_client.py +1 -1
  24. tccli/services/car/car_client.py +33 -33
  25. tccli/services/cbs/cbs_client.py +38 -38
  26. tccli/services/ccc/ccc_client.py +70 -70
  27. tccli/services/ccc/v20200210/api.json +71 -26
  28. tccli/services/cdb/cdb_client.py +1262 -422
  29. tccli/services/cdb/v20170320/api.json +2166 -335
  30. tccli/services/cdb/v20170320/examples.json +126 -6
  31. tccli/services/cdc/cdc_client.py +20 -20
  32. tccli/services/cdn/cdn_client.py +44 -44
  33. tccli/services/cdn/v20180606/api.json +22 -22
  34. tccli/services/cdn/v20180606/examples.json +1 -1
  35. tccli/services/cdwdoris/cdwdoris_client.py +77 -77
  36. tccli/services/cdwpg/cdwpg_client.py +24 -24
  37. tccli/services/cdz/cdz_client.py +1 -1
  38. tccli/services/cfg/cfg_client.py +16 -16
  39. tccli/services/cfs/cfs_client.py +39 -39
  40. tccli/services/cfw/cfw_client.py +66 -66
  41. tccli/services/chdfs/chdfs_client.py +29 -29
  42. tccli/services/ciam/ciam_client.py +16 -16
  43. tccli/services/ckafka/ckafka_client.py +468 -76
  44. tccli/services/ckafka/v20190819/api.json +1009 -246
  45. tccli/services/ckafka/v20190819/examples.json +73 -23
  46. tccli/services/clb/clb_client.py +720 -384
  47. tccli/services/clb/v20180317/api.json +2255 -1017
  48. tccli/services/clb/v20180317/examples.json +184 -124
  49. tccli/services/cloudaudit/cloudaudit_client.py +18 -18
  50. tccli/services/cls/cls_client.py +86 -86
  51. tccli/services/cmq/cmq_client.py +2 -2
  52. tccli/services/config/config_client.py +6 -6
  53. tccli/services/controlcenter/controlcenter_client.py +225 -1
  54. tccli/services/controlcenter/v20230110/api.json +528 -5
  55. tccli/services/controlcenter/v20230110/examples.json +32 -0
  56. tccli/services/csip/csip_client.py +34 -34
  57. tccli/services/ctsdb/ctsdb_client.py +2 -2
  58. tccli/services/cvm/cvm_client.py +84 -84
  59. tccli/services/cvm/v20170312/api.json +175 -116
  60. tccli/services/cvm/v20170312/examples.json +93 -93
  61. tccli/services/cwp/cwp_client.py +465 -465
  62. tccli/services/cynosdb/cynosdb_client.py +154 -154
  63. tccli/services/dataintegration/dataintegration_client.py +1 -1
  64. tccli/services/dayu/dayu_client.py +103 -103
  65. tccli/services/dbbrain/dbbrain_client.py +42 -42
  66. tccli/services/dc/dc_client.py +18 -18
  67. tccli/services/dcdb/dcdb_client.py +62 -62
  68. tccli/services/dlc/dlc_client.py +109 -109
  69. tccli/services/dms/dms_client.py +2 -2
  70. tccli/services/dnspod/dnspod_client.py +40 -40
  71. tccli/services/domain/domain_client.py +24 -24
  72. tccli/services/dts/dts_client.py +83 -83
  73. tccli/services/eb/eb_client.py +26 -26
  74. tccli/services/ecdn/ecdn_client.py +15 -15
  75. tccli/services/ecm/ecm_client.py +124 -124
  76. tccli/services/eiam/eiam_client.py +40 -40
  77. tccli/services/emr/emr_client.py +77 -77
  78. tccli/services/emr/v20190103/api.json +6 -6
  79. tccli/services/es/es_client.py +21 -21
  80. tccli/services/facefusion/facefusion_client.py +3 -3
  81. tccli/services/faceid/faceid_client.py +19 -19
  82. tccli/services/faceid/v20180301/api.json +124 -46
  83. tccli/services/gaap/gaap_client.py +88 -88
  84. tccli/services/gme/gme_client.py +10 -10
  85. tccli/services/gpm/gpm_client.py +18 -18
  86. tccli/services/gse/gse_client.py +22 -22
  87. tccli/services/gwlb/gwlb_client.py +18 -18
  88. tccli/services/hunyuan/__init__.py +4 -0
  89. tccli/services/hunyuan/hunyuan_client.py +546 -0
  90. tccli/services/hunyuan/v20230901/api.json +628 -0
  91. tccli/services/hunyuan/v20230901/examples.json +60 -0
  92. tccli/services/iai/iai_client.py +29 -29
  93. tccli/services/iap/iap_client.py +6 -6
  94. tccli/services/ims/ims_client.py +1 -1
  95. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +42 -42
  96. tccli/services/iotcloud/iotcloud_client.py +20 -20
  97. tccli/services/ip/ip_client.py +6 -6
  98. tccli/services/kms/kms_client.py +68 -68
  99. tccli/services/kms/v20190118/api.json +80 -3
  100. tccli/services/kms/v20190118/examples.json +3 -3
  101. tccli/services/lcic/lcic_client.py +53 -53
  102. tccli/services/lighthouse/lighthouse_client.py +434 -98
  103. tccli/services/lighthouse/v20200324/api.json +488 -0
  104. tccli/services/lighthouse/v20200324/examples.json +54 -0
  105. tccli/services/live/live_client.py +120 -120
  106. tccli/services/lke/lke_client.py +90 -90
  107. tccli/services/lkeap/lkeap_client.py +63 -7
  108. tccli/services/lkeap/v20240522/api.json +134 -0
  109. tccli/services/lkeap/v20240522/examples.json +21 -1
  110. tccli/services/mariadb/mariadb_client.py +50 -50
  111. tccli/services/mdc/mdc_client.py +18 -18
  112. tccli/services/mdl/mdl_client.py +225 -57
  113. tccli/services/mdl/v20200326/api.json +903 -59
  114. tccli/services/mdl/v20200326/examples.json +24 -0
  115. tccli/services/mdp/mdp_client.py +62 -62
  116. tccli/services/mdp/v20200527/api.json +191 -28
  117. tccli/services/message/message_client.py +1 -1
  118. tccli/services/mongodb/mongodb_client.py +1081 -129
  119. tccli/services/mongodb/v20190725/api.json +1798 -141
  120. tccli/services/mongodb/v20190725/examples.json +136 -0
  121. tccli/services/monitor/monitor_client.py +149 -149
  122. tccli/services/monitor/v20180724/api.json +8 -8
  123. tccli/services/mps/mps_client.py +1118 -278
  124. tccli/services/mps/v20190612/api.json +2117 -117
  125. tccli/services/mps/v20190612/examples.json +164 -62
  126. tccli/services/mqtt/__init__.py +4 -0
  127. tccli/services/mqtt/mqtt_client.py +1610 -0
  128. tccli/services/mqtt/v20240516/api.json +3057 -0
  129. tccli/services/mqtt/v20240516/examples.json +213 -0
  130. tccli/services/msp/msp_client.py +7 -7
  131. tccli/services/ocr/ocr_client.py +206 -38
  132. tccli/services/ocr/v20181119/api.json +726 -83
  133. tccli/services/ocr/v20181119/examples.json +36 -6
  134. tccli/services/omics/omics_client.py +20 -20
  135. tccli/services/organization/organization_client.py +116 -116
  136. tccli/services/postgres/postgres_client.py +91 -91
  137. tccli/services/privatedns/privatedns_client.py +31 -31
  138. tccli/services/pts/pts_client.py +48 -48
  139. tccli/services/quota/quota_client.py +5 -5
  140. tccli/services/rce/rce_client.py +1 -1
  141. tccli/services/redis/redis_client.py +109 -109
  142. tccli/services/redis/v20180412/api.json +12 -12
  143. tccli/services/region/region_client.py +3 -3
  144. tccli/services/rum/rum_client.py +60 -60
  145. tccli/services/scf/scf_client.py +42 -42
  146. tccli/services/ses/ses_client.py +29 -29
  147. tccli/services/smh/__init__.py +4 -0
  148. tccli/services/smh/smh_client.py +714 -0
  149. tccli/services/smh/v20210712/api.json +1287 -0
  150. tccli/services/smh/v20210712/examples.json +85 -0
  151. tccli/services/sms/sms_client.py +18 -18
  152. tccli/services/sqlserver/sqlserver_client.py +139 -139
  153. tccli/services/ssl/ssl_client.py +38 -38
  154. tccli/services/ssm/ssm_client.py +24 -24
  155. tccli/services/sts/sts_client.py +5 -5
  156. tccli/services/tag/tag_client.py +30 -30
  157. tccli/services/tat/tat_client.py +19 -19
  158. tccli/services/tbaas/tbaas_client.py +4 -4
  159. tccli/services/tcaplusdb/tcaplusdb_client.py +52 -52
  160. tccli/services/tchd/tchd_client.py +1 -1
  161. tccli/services/tcmpp/tcmpp_client.py +104 -104
  162. tccli/services/tcr/tcr_client.py +76 -76
  163. tccli/services/tcsas/tcsas_client.py +2340 -268
  164. tccli/services/tcsas/v20250106/api.json +8410 -3423
  165. tccli/services/tcsas/v20250106/examples.json +308 -12
  166. tccli/services/tcss/tcss_client.py +330 -330
  167. tccli/services/tdid/tdid_client.py +48 -48
  168. tccli/services/tdmq/tdmq_client.py +2500 -372
  169. tccli/services/tdmq/v20200217/api.json +11607 -3958
  170. tccli/services/tdmq/v20200217/examples.json +562 -264
  171. tccli/services/tem/tem_client.py +56 -56
  172. tccli/services/teo/teo_client.py +466 -298
  173. tccli/services/teo/v20220901/api.json +324 -16
  174. tccli/services/teo/v20220901/examples.json +64 -22
  175. tccli/services/tione/tione_client.py +1 -1
  176. tccli/services/tiw/tiw_client.py +51 -51
  177. tccli/services/tke/tke_client.py +306 -138
  178. tccli/services/tke/v20180525/api.json +227 -0
  179. tccli/services/tke/v20180525/examples.json +24 -0
  180. tccli/services/tms/tms_client.py +1 -1
  181. tccli/services/tmt/tmt_client.py +1 -1
  182. tccli/services/trabbit/trabbit_client.py +29 -29
  183. tccli/services/trocket/__init__.py +4 -0
  184. tccli/services/trocket/trocket_client.py +2450 -0
  185. tccli/services/trocket/v20230308/api.json +6062 -0
  186. tccli/services/trocket/v20230308/examples.json +339 -0
  187. tccli/services/trro/trro_client.py +19 -19
  188. tccli/services/trtc/trtc_client.py +51 -51
  189. tccli/services/trtc/v20190722/api.json +15 -15
  190. tccli/services/tts/tts_client.py +1 -1
  191. tccli/services/vclm/vclm_client.py +2 -2
  192. tccli/services/vm/vm_client.py +4 -4
  193. tccli/services/vod/v20180717/api.json +2929 -296
  194. tccli/services/vod/v20180717/examples.json +40 -6
  195. tccli/services/vod/vod_client.py +459 -179
  196. tccli/services/vpc/v20170312/api.json +99 -29
  197. tccli/services/vpc/v20170312/examples.json +21 -13
  198. tccli/services/vpc/vpc_client.py +357 -301
  199. tccli/services/waf/waf_client.py +107 -107
  200. tccli/services/wedata/wedata_client.py +310 -310
  201. tccli/services/yunjing/yunjing_client.py +71 -71
  202. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/METADATA +2 -2
  203. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/RECORD +207 -187
  204. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/WHEEL +1 -1
  205. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/LICENSE +0 -0
  206. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/entry_points.txt +0 -0
  207. {tccli_intl_en-3.0.1282.1.dist-info → tccli_intl_en-3.1.33.1.dist-info}/top_level.txt +0 -0
@@ -1,5 +1,12 @@
1
1
  {
2
2
  "actions": {
3
+ "ApplyCardVerificationExternal": {
4
+ "document": "This API is used for general recognition of overseas cards.\n\nThe following list details the countries or regions, document types supported by the overseas document recognition API and whether the back side of the document is required:\n\n<table>\n<thead>\n<tr>\n<td style=\"width:200px\">Nationality</td>\n<td style=\"width:200px\">CardType</td>\n<td style=\"width:200px\">Whether the Back Side is Required</td>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Argentina</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Argentina</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Argentina</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Passport</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Residence Permit</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Indonesia</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Indonesia</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Hong Kong, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Thailand</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Thailand</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Malaysia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Malaysia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Philippines</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Philippines</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Japan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Japan</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Macau, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Taiwan, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n</tbody>\n</table>",
5
+ "input": "ApplyCardVerificationExternalRequest",
6
+ "name": "Initiate overseas document recognition",
7
+ "output": "ApplyCardVerificationExternalResponse",
8
+ "status": "online"
9
+ },
3
10
  "BankCardOCR": {
4
11
  "document": "This API is used to detect and recognize key fields such as the card number, bank information, and expiration date on mainstream bank cards in Mainland China.\n\nThis API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).",
5
12
  "input": "BankCardOCRRequest",
@@ -28,6 +35,13 @@
28
35
  "output": "GeneralBasicOCRResponse",
29
36
  "status": "online"
30
37
  },
38
+ "GetCardVerificationExternalResult": {
39
+ "document": "This API is used to obtain document recognition results.",
40
+ "input": "GetCardVerificationExternalResultRequest",
41
+ "name": "Retrieve the card recognition result",
42
+ "output": "GetCardVerificationExternalResultResponse",
43
+ "status": "online"
44
+ },
31
45
  "HKIDCardOCR": {
32
46
  "document": "This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute. \n\nThis API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).",
33
47
  "input": "HKIDCardOCRRequest",
@@ -119,6 +133,13 @@
119
133
  "output": "RecognizeBrazilRNMOCRResponse",
120
134
  "status": "online"
121
135
  },
136
+ "RecognizeDetectCardCoords": {
137
+ "document": "This API is used to recognize the coordinates of four corners of cards.",
138
+ "input": "RecognizeDetectCardCoordsRequest",
139
+ "name": "Four-Corner coordinate detection and recognition",
140
+ "output": "RecognizeDetectCardCoordsResponse",
141
+ "status": "online"
142
+ },
122
143
  "RecognizeGeneralInvoice": {
123
144
  "document": "This API is used to recognize various types of invoices or tickets in an image or PDF file. You can also specify a type. 14 types of standard expense reimbursement invoices are supported, including value-added tax (VAT) invoice (special, general, roll, blockchain, and toll), fully digitalized electronic invoice (special and general), non-tax revenue invoice (general receipt and general payment voucher), quota invoice, general machine-printed invoice, car sales invoice (motor vehicle sales invoice and used car invoice), train ticket, taxi receipt, itinerary/receipt of e-ticket for air transportation, bus ticket, ship ticket, toll receipt, and medical invoice (inpatient and outpatient). This API can also be used for intelligent recognition of other types of invoices. To try now, click [here](https://intl.cloud.tencent.com/product/ocr?from_cn_redirect=1).\n\nA maximum of 5 requests can be initiated per second for this API.\n\n\nThe invoice/ticket subtype (SubType), subtype description (TypeDescription), and parent type (Type) can be returned, as described below:\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> Special VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatCommonInvoice</td>\n <td> General VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicCommonInvoice </td>\n <td> Electronic general VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoice </td>\n <td> Electronic special VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceBlockchain</td>\n <td> Blockchain electronic invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceToll</td>\n <td> Electronic general VAT invoice (toll)</td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoiceFull</td>\n <td> Electronic invoice (special)</td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceFull</td>\n <td> Electronic invoice (general) </td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> MotorVehicleSaleInvoice </td>\n <td> Motor vehicle sales invoice </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> UsedCarPurchaseInvoice </td>\n <td> Used car invoice </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> VatInvoiceRoll </td>\n <td> General VAT invoice (roll) </td>\n <td> 11 </td>\n </tr>\n <tr>\n <td> TaxiTicket </td>\n <td> Taxi receipt </td>\n <td> 0 </td>\n </tr>\n <tr>\n <td> QuotaInvoice </td>\n <td> Quota invoice </td>\n <td> 1 </td>\n </tr>\n <tr>\n <td> TrainTicket </td>\n <td> Train ticket </td>\n <td> 2 </td>\n </tr>\n <tr>\n <td> AirTransport </td>\n <td> Itinerary/Receipt of e-ticket for air transportation </td>\n <td> 5 </td>\n </tr>\n <tr>\n <td> MachinePrintedInvoice </td>\n <td> General machine-printed invoice </td>\n <td> 8 </td>\n </tr>\n <tr>\n <td> BusInvoice </td>\n <td> Bus ticket </td>\n <td> 9 </td>\n </tr>\n <tr>\n <td> ShippingInvoice </td>\n <td> Ship ticket </td>\n <td> 10 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeGeneralBill </td>\n <td> General receipt for non-tax revenue </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeElectronicBill </td>\n <td> General payment voucher for non-tax revenue (electronic) </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> TollInvoice </td>\n <td> Toll receipt </td>\n <td> 13 </td>\n </tr>\n <tr>\n <td> OtherInvoice </td>\n <td> Other </td>\n <td> -1 </td>\n </tr>\n </tbody>\n </table>",
124
145
  "input": "RecognizeGeneralInvoiceRequest",
@@ -273,6 +294,112 @@
273
294
  "serviceShortName": "ocr"
274
295
  },
275
296
  "objects": {
297
+ "AddressInfo": {
298
+ "document": "Overseas document recognition address information.",
299
+ "members": [
300
+ {
301
+ "disabled": false,
302
+ "document": "Country.\nNote: This field may return null, indicating that no valid values can be obtained.",
303
+ "example": "无",
304
+ "member": "string",
305
+ "name": "Country",
306
+ "output_required": false,
307
+ "type": "string",
308
+ "value_allowed_null": true
309
+ },
310
+ {
311
+ "disabled": false,
312
+ "document": "Postal code.\nNote: This field may return null, indicating that no valid values can be obtained.",
313
+ "example": "无",
314
+ "member": "string",
315
+ "name": "PostalCode",
316
+ "output_required": false,
317
+ "type": "string",
318
+ "value_allowed_null": true
319
+ },
320
+ {
321
+ "disabled": false,
322
+ "document": "Specifies the sub-region.\nNote: This field may return null, indicating that no valid values can be obtained.",
323
+ "example": "无",
324
+ "member": "string",
325
+ "name": "Subdivision",
326
+ "output_required": false,
327
+ "type": "string",
328
+ "value_allowed_null": true
329
+ },
330
+ {
331
+ "disabled": false,
332
+ "document": "Specifies the city.\nNote: This field may return null, indicating that no valid values can be obtained.",
333
+ "example": "无",
334
+ "member": "string",
335
+ "name": "City",
336
+ "output_required": false,
337
+ "type": "string",
338
+ "value_allowed_null": true
339
+ },
340
+ {
341
+ "disabled": false,
342
+ "document": "Complete address.\nNote: This field may return null, indicating that no valid values can be obtained.",
343
+ "example": "无",
344
+ "member": "string",
345
+ "name": "FormattedAddress",
346
+ "output_required": false,
347
+ "type": "string",
348
+ "value_allowed_null": true
349
+ },
350
+ {
351
+ "disabled": false,
352
+ "document": "First line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
353
+ "example": "无",
354
+ "member": "string",
355
+ "name": "LineOne",
356
+ "output_required": false,
357
+ "type": "string",
358
+ "value_allowed_null": true
359
+ },
360
+ {
361
+ "disabled": false,
362
+ "document": "Second line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
363
+ "example": "无",
364
+ "member": "string",
365
+ "name": "LineTwo",
366
+ "output_required": false,
367
+ "type": "string",
368
+ "value_allowed_null": true
369
+ },
370
+ {
371
+ "disabled": false,
372
+ "document": "Specifies the third line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
373
+ "example": "无",
374
+ "member": "string",
375
+ "name": "LineThree",
376
+ "output_required": false,
377
+ "type": "string",
378
+ "value_allowed_null": true
379
+ },
380
+ {
381
+ "disabled": false,
382
+ "document": "Specifies the fourth line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
383
+ "example": "无",
384
+ "member": "string",
385
+ "name": "LineFour",
386
+ "output_required": false,
387
+ "type": "string",
388
+ "value_allowed_null": true
389
+ },
390
+ {
391
+ "disabled": false,
392
+ "document": "Specifies the fifth line in the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
393
+ "example": "无",
394
+ "member": "string",
395
+ "name": "LineFive",
396
+ "output_required": false,
397
+ "type": "string",
398
+ "value_allowed_null": true
399
+ }
400
+ ],
401
+ "usage": "out"
402
+ },
276
403
  "AirTransport": {
277
404
  "document": "Itinerary/Receipt of e-ticket for air transportation",
278
405
  "members": [
@@ -519,6 +646,97 @@
519
646
  ],
520
647
  "usage": "out"
521
648
  },
649
+ "ApplyCardVerificationExternalRequest": {
650
+ "document": "ApplyCardVerificationExternal request structure.",
651
+ "members": [
652
+ {
653
+ "disabled": false,
654
+ "document": "Specifies the country of the document.\nARG:Argentina\nAUS:Australia\nKHM:Cambodia\nCAN:Canada\nSGP:Singapore\nCHL:Chile\nDEU:Germany\nMEX:Mexico\nMMR:Myanmar\nNZL:New Zealand\nBGD:Bangladesh\nNGA:Nigeria\nPAK:Pakistan\nRUS:Russia\nIDN:Indonesia\nHKG:Hong Kong, China\nTHA:Thailand\nMYS:Malaysia\nJPN:Japan\nPHL:Philippines\nMAC:Macao, China\nCHN:ChinaPermit\nTWN:Taiwan, China\nBGD:Bangladesh\nNGA:Nigeria \nPAK:Pakistan\n\nAUTO: supports cards and documents from 200+ countries",
655
+ "example": "ARG",
656
+ "member": "string",
657
+ "name": "Nationality",
658
+ "required": true,
659
+ "type": "string"
660
+ },
661
+ {
662
+ "disabled": false,
663
+ "document": "Document type.\nID_CARD\nPASSPORT\nDRIVING_LICENSE\nRESIDENCE_PERMIT (Supported in certain countries/regions, including Australia, Canada, Germany, New Zealand, Nigeria, Singapore).",
664
+ "example": "ID_CARD",
665
+ "member": "string",
666
+ "name": "CardType",
667
+ "required": true,
668
+ "type": "string"
669
+ },
670
+ {
671
+ "disabled": false,
672
+ "document": "The Base64 value of the document Front. supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.",
673
+ "example": "/9j/4AAQSkZJRgABAQAASABIAAD",
674
+ "member": "string",
675
+ "name": "ImageBase64Front",
676
+ "required": false,
677
+ "type": "string"
678
+ },
679
+ {
680
+ "disabled": false,
681
+ "document": "The Base64 value of the reverse side of the document. Supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlBack is used.",
682
+ "example": "/9j/4AAQSkZJRgABAQAASABIAAD",
683
+ "member": "string",
684
+ "name": "ImageBase64Back",
685
+ "required": false,
686
+ "type": "string"
687
+ },
688
+ {
689
+ "disabled": false,
690
+ "document": "Url of the document Front. supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.",
691
+ "example": "https://test/demo.jpeg",
692
+ "member": "string",
693
+ "name": "ImageUrlFront",
694
+ "required": false,
695
+ "type": "string"
696
+ },
697
+ {
698
+ "disabled": false,
699
+ "document": "Specifies the Url of the document Back. supported image formats: PNG, JPG/JPEG\nSupported image size: no more than 2M after Base64 encoding. image download time should not exceed 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only use ImageUrlBack.\n",
700
+ "example": "https://test/demo.jpeg",
701
+ "member": "string",
702
+ "name": "ImageUrlBack",
703
+ "required": false,
704
+ "type": "string"
705
+ },
706
+ {
707
+ "disabled": false,
708
+ "document": "Whether to extract the ID portrait. Default value: false.",
709
+ "example": "false",
710
+ "member": "bool",
711
+ "name": "ReturnHeadImage",
712
+ "required": false,
713
+ "type": "bool"
714
+ }
715
+ ],
716
+ "type": "object"
717
+ },
718
+ "ApplyCardVerificationExternalResponse": {
719
+ "document": "ApplyCardVerificationExternal response structure.",
720
+ "members": [
721
+ {
722
+ "disabled": false,
723
+ "document": "Process token, which is used to obtain the result.",
724
+ "example": "88ed374d-cfa7-4391-bcde-66b49f2f192b",
725
+ "member": "string",
726
+ "name": "CardVerificationToken",
727
+ "output_required": false,
728
+ "type": "string",
729
+ "value_allowed_null": false
730
+ },
731
+ {
732
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
733
+ "member": "string",
734
+ "name": "RequestId",
735
+ "type": "string"
736
+ }
737
+ ],
738
+ "type": "object"
739
+ },
522
740
  "BankCardOCRRequest": {
523
741
  "document": "BankCardOCR request structure.",
524
742
  "members": [
@@ -1626,6 +1844,32 @@
1626
1844
  ],
1627
1845
  "usage": "out"
1628
1846
  },
1847
+ "CoordsItem": {
1848
+ "document": "Detected coordinate recognition information.",
1849
+ "members": [
1850
+ {
1851
+ "disabled": false,
1852
+ "document": "Coordinates of four points in the image.",
1853
+ "example": "无",
1854
+ "member": "Polygon",
1855
+ "name": "Polygon",
1856
+ "output_required": false,
1857
+ "type": "object",
1858
+ "value_allowed_null": false
1859
+ },
1860
+ {
1861
+ "disabled": false,
1862
+ "document": "Coordinates of two points in the image.",
1863
+ "example": "无",
1864
+ "member": "ItemCoord",
1865
+ "name": "Coords",
1866
+ "output_required": false,
1867
+ "type": "object",
1868
+ "value_allowed_null": false
1869
+ }
1870
+ ],
1871
+ "usage": "out"
1872
+ },
1629
1873
  "DetectedWordCoordPoint": {
1630
1874
  "document": "Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner",
1631
1875
  "members": [
@@ -2047,108 +2291,334 @@
2047
2291
  },
2048
2292
  {
2049
2293
  "disabled": false,
2050
- "document": "URL address of image/PDF. (This field is not supported outside Chinese mainland)\nThe image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.\nWe recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.",
2051
- "example": "https://xx/a.jpg",
2294
+ "document": "URL address of image/PDF. (This field is not supported outside Chinese mainland)\nThe image/PDF cannot exceed 7 MB after being Base64-encoded. A resolution above 600x800 is recommended. PNG, JPG, JPEG, BMP, and PDF formats are supported.\nWe recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.",
2295
+ "example": "https://xx/a.jpg",
2296
+ "member": "string",
2297
+ "name": "ImageUrl",
2298
+ "required": false,
2299
+ "type": "string"
2300
+ },
2301
+ {
2302
+ "disabled": false,
2303
+ "document": "Reserved field.",
2304
+ "example": "无",
2305
+ "member": "string",
2306
+ "name": "Scene",
2307
+ "required": false,
2308
+ "type": "string"
2309
+ },
2310
+ {
2311
+ "disabled": false,
2312
+ "document": "Language to recognize\nThe language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together.\nValid values:\n`zh`: Chinese-English mix\n`zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc.\n`auto`\n`mix`: language mix\n`jap`: Japanese\n`kor`: Korean\n`spa`: Spanish\n`fre`: French\n`ger`: German\n`por`: Portuguese\n`vie`: Vietnamese\n`may`: Malay\n`rus`: Russian\n`ita`: Italian\n`hol`: Dutch\n`swe`: Swedish\n`fin`: Finnish\n`dan`: Danish\n`nor`: Norwegian\n`hun`: Hungarian\n`tha`: Thai\n`hi`: Hindi\n`ara`: Arabic",
2313
+ "example": "无",
2314
+ "member": "string",
2315
+ "name": "LanguageType",
2316
+ "required": false,
2317
+ "type": "string"
2318
+ },
2319
+ {
2320
+ "disabled": false,
2321
+ "document": "Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.",
2322
+ "example": "无",
2323
+ "member": "bool",
2324
+ "name": "IsPdf",
2325
+ "required": false,
2326
+ "type": "bool"
2327
+ },
2328
+ {
2329
+ "disabled": false,
2330
+ "document": "Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.",
2331
+ "example": "无",
2332
+ "member": "uint64",
2333
+ "name": "PdfPageNumber",
2334
+ "required": false,
2335
+ "type": "int"
2336
+ },
2337
+ {
2338
+ "disabled": false,
2339
+ "document": "Whether to return the character information. Default value: `false`",
2340
+ "example": "无",
2341
+ "member": "bool",
2342
+ "name": "IsWords",
2343
+ "required": false,
2344
+ "type": "bool"
2345
+ }
2346
+ ],
2347
+ "type": "object"
2348
+ },
2349
+ "GeneralBasicOCRResponse": {
2350
+ "document": "GeneralBasicOCR response structure.",
2351
+ "members": [
2352
+ {
2353
+ "disabled": false,
2354
+ "document": "Information of recognized text, including the text line content, confidence, text line coordinates, and text line coordinates after rotation correction. For more information, please click the link on the left.",
2355
+ "example": "无",
2356
+ "member": "TextDetection",
2357
+ "name": "TextDetections",
2358
+ "type": "list",
2359
+ "value_allowed_null": false
2360
+ },
2361
+ {
2362
+ "disabled": false,
2363
+ "document": "Detected language. For more information on the supported languages, please see the description of the `LanguageType` input parameter.",
2364
+ "example": "zh",
2365
+ "member": "string",
2366
+ "name": "Language",
2367
+ "type": "string",
2368
+ "value_allowed_null": false
2369
+ },
2370
+ {
2371
+ "disabled": false,
2372
+ "document": "Image rotation angle in degrees. 0°: The horizontal direction of the text on the image; a positive value: rotate clockwise; a negative value: rotate counterclockwise.",
2373
+ "example": "6.5",
2374
+ "member": "float",
2375
+ "name": "Angel",
2376
+ "type": "float",
2377
+ "value_allowed_null": false
2378
+ },
2379
+ {
2380
+ "disabled": false,
2381
+ "document": "Total number of PDF pages to be returned if the image is a PDF. Default value: 0.",
2382
+ "example": "0",
2383
+ "member": "int64",
2384
+ "name": "PdfPageSize",
2385
+ "type": "int",
2386
+ "value_allowed_null": false
2387
+ },
2388
+ {
2389
+ "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
2390
+ "member": "string",
2391
+ "name": "RequestId",
2392
+ "type": "string"
2393
+ }
2394
+ ],
2395
+ "type": "object"
2396
+ },
2397
+ "GeneralCard": {
2398
+ "document": "General card certificate information.",
2399
+ "members": [
2400
+ {
2401
+ "disabled": false,
2402
+ "document": "ID number.\nNote: This field may return null, indicating that no valid values can be obtained.",
2403
+ "example": "",
2404
+ "member": "string",
2405
+ "name": "LicenseNumber",
2406
+ "output_required": true,
2407
+ "type": "string",
2408
+ "value_allowed_null": true
2409
+ },
2410
+ {
2411
+ "disabled": false,
2412
+ "document": "Personal number. returned when the identity document type is passport.\nNote: This field may return null, indicating that no valid values can be obtained.",
2413
+ "example": "",
2414
+ "member": "string",
2415
+ "name": "PersonalNumber",
2416
+ "output_required": true,
2417
+ "type": "string",
2418
+ "value_allowed_null": true
2419
+ },
2420
+ {
2421
+ "disabled": false,
2422
+ "document": "Passport mrz line 1.\nNote: This field may return null, indicating that no valid values can be obtained.",
2423
+ "example": "",
2424
+ "member": "string",
2425
+ "name": "PassportCodeFirst",
2426
+ "output_required": true,
2427
+ "type": "string",
2428
+ "value_allowed_null": true
2429
+ },
2430
+ {
2431
+ "disabled": false,
2432
+ "document": "Passport mrz line 2.\nNote: This field may return null, indicating that no valid values can be obtained.",
2433
+ "example": "",
2434
+ "member": "string",
2435
+ "name": "PassportCodeSecond",
2436
+ "output_required": true,
2437
+ "type": "string",
2438
+ "value_allowed_null": true
2439
+ },
2440
+ {
2441
+ "disabled": false,
2442
+ "document": "Expiration date, in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2443
+ "example": "",
2444
+ "member": "string",
2445
+ "name": "ExpirationDate",
2446
+ "output_required": true,
2447
+ "type": "string",
2448
+ "value_allowed_null": true
2449
+ },
2450
+ {
2451
+ "disabled": false,
2452
+ "document": "Expiration date in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2453
+ "example": "",
2454
+ "member": "string",
2455
+ "name": "DueDate",
2456
+ "output_required": true,
2457
+ "type": "string",
2458
+ "value_allowed_null": true
2459
+ },
2460
+ {
2461
+ "disabled": false,
2462
+ "document": "Issue date, in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2463
+ "example": "",
2464
+ "member": "string",
2465
+ "name": "IssuedDate",
2466
+ "output_required": true,
2467
+ "type": "string",
2468
+ "value_allowed_null": true
2469
+ },
2470
+ {
2471
+ "disabled": false,
2472
+ "document": "Issuing authority.\nNote: This field may return null, indicating that no valid values can be obtained.",
2473
+ "example": "",
2474
+ "member": "string",
2475
+ "name": "IssuedAuthority",
2476
+ "output_required": true,
2477
+ "type": "string",
2478
+ "value_allowed_null": true
2479
+ },
2480
+ {
2481
+ "disabled": false,
2482
+ "document": "Issuing country, following the ISO 3166 country coding specification.\nNote: This field may return null, indicating that no valid values can be obtained.",
2483
+ "example": "",
2484
+ "member": "string",
2485
+ "name": "IssuedCountry",
2486
+ "output_required": true,
2487
+ "type": "string",
2488
+ "value_allowed_null": true
2489
+ },
2490
+ {
2491
+ "disabled": false,
2492
+ "document": "Specifies the name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2493
+ "example": "",
2494
+ "member": "string",
2495
+ "name": "FullName",
2496
+ "output_required": true,
2497
+ "type": "string",
2498
+ "value_allowed_null": true
2499
+ },
2500
+ {
2501
+ "disabled": false,
2502
+ "document": "Name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2503
+ "example": "",
2504
+ "member": "string",
2505
+ "name": "FirstName",
2506
+ "output_required": true,
2507
+ "type": "string",
2508
+ "value_allowed_null": true
2509
+ },
2510
+ {
2511
+ "disabled": false,
2512
+ "document": "Name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2513
+ "example": "",
2514
+ "member": "string",
2515
+ "name": "LastName",
2516
+ "output_required": true,
2517
+ "type": "string",
2518
+ "value_allowed_null": true
2519
+ },
2520
+ {
2521
+ "disabled": false,
2522
+ "document": "Gender on the document.\n-M: man.\n-F: woman.\n-X: other gender identity.\nNote: This field may return null, indicating that no valid values can be obtained.",
2523
+ "example": "",
2524
+ "member": "string",
2525
+ "name": "Sex",
2526
+ "output_required": true,
2527
+ "type": "string",
2528
+ "value_allowed_null": true
2529
+ },
2530
+ {
2531
+ "disabled": false,
2532
+ "document": "Age. 0 means no valid info.\nNote: This field may return null, indicating that no valid values can be obtained.",
2533
+ "example": "",
2052
2534
  "member": "string",
2053
- "name": "ImageUrl",
2054
- "required": false,
2055
- "type": "string"
2535
+ "name": "Age",
2536
+ "output_required": true,
2537
+ "type": "string",
2538
+ "value_allowed_null": true
2056
2539
  },
2057
2540
  {
2058
2541
  "disabled": false,
2059
- "document": "Reserved field.",
2060
- "example": "",
2542
+ "document": "Date of birth.\nNote: This field may return null, indicating that no valid values can be obtained.",
2543
+ "example": "",
2061
2544
  "member": "string",
2062
- "name": "Scene",
2063
- "required": false,
2064
- "type": "string"
2545
+ "name": "Birthday",
2546
+ "output_required": true,
2547
+ "type": "string",
2548
+ "value_allowed_null": true
2065
2549
  },
2066
2550
  {
2067
2551
  "disabled": false,
2068
- "document": "Language to recognize\nThe language can be automatically recognized or manually specified. Chinese-English mix (`zh`) is selected by default. Mixed characters in English and each supported language can be recognized together.\nValid values:\n`zh`: Chinese-English mix\n`zh_rare`: supports letters, digits, rare Chinese characters, Traditional Chinese characters, special characters, etc.\n`auto`\n`mix`: language mix\n`jap`: Japanese\n`kor`: Korean\n`spa`: Spanish\n`fre`: French\n`ger`: German\n`por`: Portuguese\n`vie`: Vietnamese\n`may`: Malay\n`rus`: Russian\n`ita`: Italian\n`hol`: Dutch\n`swe`: Swedish\n`fin`: Finnish\n`dan`: Danish\n`nor`: Norwegian\n`hun`: Hungarian\n`tha`: Thai\n`hi`: Hindi\n`ara`: Arabic",
2069
- "example": "",
2552
+ "document": "Birth place.\nNote: This field may return null, indicating that no valid values can be obtained.",
2553
+ "example": "",
2070
2554
  "member": "string",
2071
- "name": "LanguageType",
2072
- "required": false,
2073
- "type": "string"
2555
+ "name": "BirthPlace",
2556
+ "output_required": true,
2557
+ "type": "string",
2558
+ "value_allowed_null": true
2074
2559
  },
2075
2560
  {
2076
2561
  "disabled": false,
2077
- "document": "Whether to enable PDF recognition. Default value: false. After this feature is enabled, both images and PDF files can be recognized at the same time.",
2078
- "example": "",
2079
- "member": "bool",
2080
- "name": "IsPdf",
2081
- "required": false,
2082
- "type": "bool"
2562
+ "document": "Document nationality, following ISO 3166 country coding specification.\nNote: This field may return null, indicating that no valid values can be obtained.",
2563
+ "example": "",
2564
+ "member": "string",
2565
+ "name": "Nationality",
2566
+ "output_required": true,
2567
+ "type": "string",
2568
+ "value_allowed_null": true
2083
2569
  },
2084
2570
  {
2085
2571
  "disabled": false,
2086
- "document": "Page number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of the `IsPdf` parameter is `true`. Default value: 1.",
2087
- "example": "",
2088
- "member": "uint64",
2089
- "name": "PdfPageNumber",
2090
- "required": false,
2091
- "type": "int"
2572
+ "document": "Registration number.\nNote: This field may return null, indicating that no valid values can be obtained.",
2573
+ "example": "",
2574
+ "member": "string",
2575
+ "name": "RegistrationNumber",
2576
+ "output_required": true,
2577
+ "type": "string",
2578
+ "value_allowed_null": true
2092
2579
  },
2093
2580
  {
2094
2581
  "disabled": false,
2095
- "document": "Whether to return the character information. Default value: `false`",
2096
- "example": "",
2097
- "member": "bool",
2098
- "name": "IsWords",
2099
- "required": false,
2100
- "type": "bool"
2101
- }
2102
- ],
2103
- "type": "object"
2104
- },
2105
- "GeneralBasicOCRResponse": {
2106
- "document": "GeneralBasicOCR response structure.",
2107
- "members": [
2108
- {
2109
- "disabled": false,
2110
- "document": "Information of recognized text, including the text line content, confidence, text line coordinates, and text line coordinates after rotation correction. For more information, please click the link on the left.",
2111
- "example": "无",
2112
- "member": "TextDetection",
2113
- "name": "TextDetections",
2114
- "type": "list",
2115
- "value_allowed_null": false
2582
+ "document": "Specifies the address information of the document.\nNote: This field may return null, indicating that no valid values can be obtained.",
2583
+ "example": "",
2584
+ "member": "AddressInfo",
2585
+ "name": "Address",
2586
+ "output_required": false,
2587
+ "type": "object",
2588
+ "value_allowed_null": true
2116
2589
  },
2117
2590
  {
2118
2591
  "disabled": false,
2119
- "document": "Detected language. For more information on the supported languages, please see the description of the `LanguageType` input parameter.",
2120
- "example": "zh",
2592
+ "document": "Localized name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2593
+ "example": "",
2121
2594
  "member": "string",
2122
- "name": "Language",
2595
+ "name": "FullNameLocal",
2596
+ "output_required": false,
2123
2597
  "type": "string",
2124
- "value_allowed_null": false
2598
+ "value_allowed_null": true
2125
2599
  },
2126
2600
  {
2127
2601
  "disabled": false,
2128
- "document": "Image rotation angle in degrees. 0°: The horizontal direction of the text on the image; a positive value: rotate clockwise; a negative value: rotate counterclockwise.",
2129
- "example": "6.5",
2130
- "member": "float",
2131
- "name": "Angel",
2132
- "type": "float",
2133
- "value_allowed_null": false
2602
+ "document": "Localization name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2603
+ "example": "",
2604
+ "member": "string",
2605
+ "name": "FirstNameLocal",
2606
+ "output_required": false,
2607
+ "type": "string",
2608
+ "value_allowed_null": true
2134
2609
  },
2135
2610
  {
2136
2611
  "disabled": false,
2137
- "document": "Total number of PDF pages to be returned if the image is a PDF. Default value: 0.",
2138
- "example": "0",
2139
- "member": "int64",
2140
- "name": "PdfPageSize",
2141
- "type": "int",
2142
- "value_allowed_null": false
2143
- },
2144
- {
2145
- "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
2612
+ "document": "Localized surname.\nNote: This field may return null, indicating that no valid values can be obtained.",
2613
+ "example": "",
2146
2614
  "member": "string",
2147
- "name": "RequestId",
2148
- "type": "string"
2615
+ "name": "LastNameLocal",
2616
+ "output_required": false,
2617
+ "type": "string",
2618
+ "value_allowed_null": true
2149
2619
  }
2150
2620
  ],
2151
- "type": "object"
2621
+ "usage": "out"
2152
2622
  },
2153
2623
  "GeneralMachineItem": {
2154
2624
  "document": "Items of a general machine-printed invoice",
@@ -2236,6 +2706,83 @@
2236
2706
  ],
2237
2707
  "usage": "out"
2238
2708
  },
2709
+ "GetCardVerificationExternalResultRequest": {
2710
+ "document": "GetCardVerificationExternalResult request structure.",
2711
+ "members": [
2712
+ {
2713
+ "disabled": false,
2714
+ "document": "Initiates the recognition interface and returns a unique token.",
2715
+ "example": "9943345f-a690-4220-a749-9c68518f2e17",
2716
+ "member": "string",
2717
+ "name": "CardVerificationToken",
2718
+ "required": true,
2719
+ "type": "string"
2720
+ }
2721
+ ],
2722
+ "type": "object"
2723
+ },
2724
+ "GetCardVerificationExternalResultResponse": {
2725
+ "document": "GetCardVerificationExternalResult response structure.",
2726
+ "members": [
2727
+ {
2728
+ "disabled": false,
2729
+ "document": "Indicates the status. valid values: \nPASSED\nPROCESSING\nWARNING",
2730
+ "example": "PASSED",
2731
+ "member": "string",
2732
+ "name": "Status",
2733
+ "output_required": false,
2734
+ "type": "string",
2735
+ "value_allowed_null": false
2736
+ },
2737
+ {
2738
+ "disabled": false,
2739
+ "document": "Indicates the anti-counterfeiting information.\n-ScreenshotSuspected: The image is a screenshot.\n-RetakeSuspected: The image is taken from another screen.\n-PaperCopy: The image is a black and white, or color photocopy.\n-FakeSuspected: The image of the card, or the information on the card has been edited or altered.\n-OtherWarning: Document's authenticity is not verified for various reasons.\nNote: This field may return null, indicating that no valid values can be obtained.",
2740
+ "example": "[\"OtherWarning\"]",
2741
+ "member": "string",
2742
+ "name": "WarnInfo",
2743
+ "output_required": false,
2744
+ "type": "list",
2745
+ "value_allowed_null": true
2746
+ },
2747
+ {
2748
+ "disabled": false,
2749
+ "document": "Country Code.\nNote: This field may return null, indicating that no valid values can be obtained.",
2750
+ "example": "PHL",
2751
+ "member": "string",
2752
+ "name": "Nationality",
2753
+ "output_required": false,
2754
+ "type": "string",
2755
+ "value_allowed_null": true
2756
+ },
2757
+ {
2758
+ "disabled": false,
2759
+ "document": "Recognition result of the text in the id photo.\t\nNote: This field may return null, indicating that no valid values can be obtained.",
2760
+ "example": "无",
2761
+ "member": "GeneralCard",
2762
+ "name": "CardInfo",
2763
+ "output_required": false,
2764
+ "type": "object",
2765
+ "value_allowed_null": true
2766
+ },
2767
+ {
2768
+ "disabled": false,
2769
+ "document": "Specifies the token in the request parameters.",
2770
+ "example": "9943345f-a690-4220-a749-9c68518f2e17",
2771
+ "member": "string",
2772
+ "name": "CardVerificationToken",
2773
+ "output_required": false,
2774
+ "type": "string",
2775
+ "value_allowed_null": false
2776
+ },
2777
+ {
2778
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2779
+ "member": "string",
2780
+ "name": "RequestId",
2781
+ "type": "string"
2782
+ }
2783
+ ],
2784
+ "type": "object"
2785
+ },
2239
2786
  "GroupInfo": {
2240
2787
  "document": "The sequence number of an element group in the image",
2241
2788
  "members": [
@@ -2261,7 +2808,7 @@
2261
2808
  "example": "false",
2262
2809
  "member": "bool",
2263
2810
  "name": "ReturnHeadImage",
2264
- "required": true,
2811
+ "required": false,
2265
2812
  "type": "bool"
2266
2813
  },
2267
2814
  {
@@ -2276,7 +2823,7 @@
2276
2823
  {
2277
2824
  "disabled": false,
2278
2825
  "document": "Base64 string of the image\nSupported image formats: PNG, JPG, JPEG. GIF is not supported yet.\nSupported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.",
2279
- "example": "",
2826
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
2280
2827
  "member": "string",
2281
2828
  "name": "ImageBase64",
2282
2829
  "required": false,
@@ -2285,7 +2832,7 @@
2285
2832
  {
2286
2833
  "disabled": false,
2287
2834
  "document": "URL address of image. (This field is not supported outside Chinese mainland)\nSupported image formats: PNG, JPG, JPEG. GIF is currently not supported.\nSupported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds.\nWe recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.\nThe download speed and stability of non-Tencent Cloud URLs may be low.",
2288
- "example": "https://xx/a.jpg",
2835
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
2289
2836
  "member": "string",
2290
2837
  "name": "ImageUrl",
2291
2838
  "required": false,
@@ -2409,17 +2956,27 @@
2409
2956
  },
2410
2957
  {
2411
2958
  "disabled": false,
2412
- "document": "Base64-encoded identity photo\nNote: this field may return null, indicating that no valid values can be obtained.",
2413
- "example": "xx",
2959
+ "document": "Base64-encoded large primary portrait photo from the left side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
2960
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
2414
2961
  "member": "string",
2415
2962
  "name": "HeadImage",
2416
2963
  "output_required": true,
2417
2964
  "type": "string",
2418
2965
  "value_allowed_null": true
2419
2966
  },
2967
+ {
2968
+ "disabled": false,
2969
+ "document": "Base64-encoded small secondary portrait photo from the right side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
2970
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
2971
+ "member": "string",
2972
+ "name": "SmallHeadImage",
2973
+ "output_required": false,
2974
+ "type": "string",
2975
+ "value_allowed_null": true
2976
+ },
2420
2977
  {
2421
2978
  "disabled": true,
2422
- "document": "Multiple alarm codes. If the ID card is spoofed, photocopied, or photoshopped, the corresponding alarm code will be returned.\n-9102: Alarm for photocopied document\n-9103: Alarm for spoofed document",
2979
+ "document": "This field is deprecated and will always return an empty array. Usage is not recommended.",
2423
2980
  "example": "[-9102,-9103]",
2424
2981
  "member": "int64",
2425
2982
  "name": "WarningCode",
@@ -2437,6 +2994,26 @@
2437
2994
  "type": "list",
2438
2995
  "value_allowed_null": false
2439
2996
  },
2997
+ {
2998
+ "disabled": false,
2999
+ "document": "Text information incorporated within the laser-perforated see-through window on the new-generation Hong Kong Identity Card.",
3000
+ "example": "C000000",
3001
+ "member": "string",
3002
+ "name": "WindowEmbeddedText",
3003
+ "output_required": false,
3004
+ "type": "string",
3005
+ "value_allowed_null": false
3006
+ },
3007
+ {
3008
+ "disabled": false,
3009
+ "document": "Versions of the Hong Kong Identity Card: HKID-2018, HKID-2003.",
3010
+ "example": "HKID-2018",
3011
+ "member": "string",
3012
+ "name": "HKIDVersion",
3013
+ "output_required": false,
3014
+ "type": "string",
3015
+ "value_allowed_null": true
3016
+ },
2440
3017
  {
2441
3018
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2442
3019
  "member": "string",
@@ -2828,7 +3405,7 @@
2828
3405
  {
2829
3406
  "disabled": false,
2830
3407
  "document": "X-coordinate of top-left point.",
2831
- "example": "",
3408
+ "example": "537",
2832
3409
  "member": "int64",
2833
3410
  "name": "X",
2834
3411
  "required": true,
@@ -2838,7 +3415,7 @@
2838
3415
  {
2839
3416
  "disabled": false,
2840
3417
  "document": "Y-coordinate of top-left point.",
2841
- "example": "",
3418
+ "example": "335",
2842
3419
  "member": "int64",
2843
3420
  "name": "Y",
2844
3421
  "required": true,
@@ -2848,7 +3425,7 @@
2848
3425
  {
2849
3426
  "disabled": false,
2850
3427
  "document": "Width",
2851
- "example": "",
3428
+ "example": "169",
2852
3429
  "member": "int64",
2853
3430
  "name": "Width",
2854
3431
  "required": true,
@@ -2858,7 +3435,7 @@
2858
3435
  {
2859
3436
  "disabled": false,
2860
3437
  "document": "Height",
2861
- "example": "",
3438
+ "example": "63",
2862
3439
  "member": "int64",
2863
3440
  "name": "Height",
2864
3441
  "required": true,
@@ -3295,7 +3872,7 @@
3295
3872
  {
3296
3873
  "disabled": false,
3297
3874
  "document": "Date of birth",
3298
- "example": "20230414",
3875
+ "example": "20230415",
3299
3876
  "member": "string",
3300
3877
  "name": "DateOfBirth",
3301
3878
  "output_required": true,
@@ -3385,7 +3962,7 @@
3385
3962
  {
3386
3963
  "disabled": false,
3387
3964
  "document": "The second row of the MRZ at the bottom",
3388
- "example": "`JK123488<3CAN8510168M2603298<<<<<<<<<<<<<<04`",
3965
+ "example": "1357",
3389
3966
  "member": "string",
3390
3967
  "name": "CodeCrc",
3391
3968
  "output_required": true,
@@ -3425,7 +4002,7 @@
3425
4002
  {
3426
4003
  "disabled": false,
3427
4004
  "document": "Document content in Information Zone",
3428
- "example": "{\"DateOfBirth\":\"11 Apr 1990\"}",
4005
+ "example": "",
3429
4006
  "member": "PassportRecognizeInfos",
3430
4007
  "name": "PassportRecognizeInfos",
3431
4008
  "output_required": true,
@@ -3452,6 +4029,16 @@
3452
4029
  "type": "int",
3453
4030
  "value_allowed_null": false
3454
4031
  },
4032
+ {
4033
+ "disabled": false,
4034
+ "document": "complete or not",
4035
+ "example": "true",
4036
+ "member": "bool",
4037
+ "name": "IsComplete",
4038
+ "output_required": false,
4039
+ "type": "bool",
4040
+ "value_allowed_null": false
4041
+ },
3455
4042
  {
3456
4043
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3457
4044
  "member": "string",
@@ -6291,6 +6878,52 @@
6291
6878
  ],
6292
6879
  "type": "object"
6293
6880
  },
6881
+ "RecognizeDetectCardCoordsRequest": {
6882
+ "document": "RecognizeDetectCardCoords request structure.",
6883
+ "members": [
6884
+ {
6885
+ "disabled": false,
6886
+ "document": "The Url of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: the downloaded image should be no more than 7M after Base64 encoding. image download time should be no more than 3 seconds. images stored in tencent cloud's urls guarantee higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.",
6887
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/url.jpg",
6888
+ "member": "string",
6889
+ "name": "ImageUrl",
6890
+ "required": false,
6891
+ "type": "string"
6892
+ },
6893
+ {
6894
+ "disabled": false,
6895
+ "document": "The Base64 value of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after the downloaded image is encoded in Base64. image download time is not more than 3 seconds. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.",
6896
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6897
+ "member": "string",
6898
+ "name": "ImageBase64",
6899
+ "required": false,
6900
+ "type": "string"
6901
+ }
6902
+ ],
6903
+ "type": "object"
6904
+ },
6905
+ "RecognizeDetectCardCoordsResponse": {
6906
+ "document": "RecognizeDetectCardCoords response structure.",
6907
+ "members": [
6908
+ {
6909
+ "disabled": false,
6910
+ "document": "Detected coordinate information.",
6911
+ "example": "无",
6912
+ "member": "CoordsItem",
6913
+ "name": "ItemList",
6914
+ "output_required": true,
6915
+ "type": "list",
6916
+ "value_allowed_null": false
6917
+ },
6918
+ {
6919
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6920
+ "member": "string",
6921
+ "name": "RequestId",
6922
+ "type": "string"
6923
+ }
6924
+ ],
6925
+ "type": "object"
6926
+ },
6294
6927
  "RecognizeGeneralInvoiceRequest": {
6295
6928
  "document": "RecognizeGeneralInvoice request structure.",
6296
6929
  "members": [
@@ -8596,6 +9229,16 @@
8596
9229
  "type": "int",
8597
9230
  "value_allowed_null": false
8598
9231
  },
9232
+ {
9233
+ "disabled": false,
9234
+ "document": "The card information field complete or not\ntrue: complete; false: incomplete",
9235
+ "example": "false",
9236
+ "member": "bool",
9237
+ "name": "IsComplete",
9238
+ "output_required": false,
9239
+ "type": "bool",
9240
+ "value_allowed_null": false
9241
+ },
8599
9242
  {
8600
9243
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
8601
9244
  "member": "string",