tccli-intl-en 3.0.1265.1__py2.py3-none-any.whl → 3.1.1.1__py2.py3-none-any.whl

tccli/services/ocr/v20181119/api.json

@@ -119,6 +119,13 @@
       "output": "RecognizeBrazilRNMOCRResponse",
       "status": "online"
     },
+    "RecognizeDetectCardCoords": {
+      "document": "This API is used to recognize the coordinates of four corners of cards.",
+      "input": "RecognizeDetectCardCoordsRequest",
+      "name": "Four-Corner coordinate detection and recognition",
+      "output": "RecognizeDetectCardCoordsResponse",
+      "status": "online"
+    },
     "RecognizeGeneralInvoice": {
       "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>",
       "input": "RecognizeGeneralInvoiceRequest",
@@ -1626,6 +1633,32 @@
       ],
       "usage": "out"
     },
+    "CoordsItem": {
+      "document": "Detected coordinate recognition information.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Coordinates of four points in the image.",
+          "example": "无",
+          "member": "Polygon",
+          "name": "Polygon",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Coordinates of two points in the image.",
+          "example": "无",
+          "member": "ItemCoord",
+          "name": "Coords",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "DetectedWordCoordPoint": {
       "document": "Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner",
       "members": [
@@ -2261,7 +2294,7 @@
           "example": "false",
           "member": "bool",
           "name": "ReturnHeadImage",
-          "required": true,
+          "required": false,
           "type": "bool"
         },
         {
@@ -2276,7 +2309,7 @@
         {
           "disabled": false,
           "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.",
-          "example": "无",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "ImageBase64",
           "required": false,
@@ -2285,7 +2318,7 @@
         {
           "disabled": false,
           "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.",
-          "example": "https://xx/a.jpg",
+          "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
           "member": "string",
           "name": "ImageUrl",
           "required": false,
@@ -2409,17 +2442,27 @@
         },
         {
           "disabled": false,
-          "document": "Base64-encoded identity photo\nNote: this field may return null, indicating that no valid values can be obtained.",
-          "example": "xx",
+          "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.",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "HeadImage",
           "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": false,
+          "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.",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
+          "member": "string",
+          "name": "SmallHeadImage",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "disabled": true,
-          "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",
+          "document": "This field is deprecated and will always return an empty array. Usage is not recommended.",
           "example": "[-9102,-9103]",
           "member": "int64",
           "name": "WarningCode",
@@ -2437,6 +2480,26 @@
           "type": "list",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Text information incorporated within the laser-perforated see-through window on the new-generation Hong Kong Identity Card.",
+          "example": "C000000",
+          "member": "string",
+          "name": "WindowEmbeddedText",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Versions of the Hong Kong Identity Card: HKID-2018, HKID-2003.",
+          "example": "HKID-2018",
+          "member": "string",
+          "name": "HKIDVersion",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "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.",
           "member": "string",
@@ -2828,7 +2891,7 @@
         {
           "disabled": false,
           "document": "X-coordinate of top-left point.",
-          "example": "",
+          "example": "537",
           "member": "int64",
           "name": "X",
           "required": true,
@@ -2838,7 +2901,7 @@
         {
           "disabled": false,
           "document": "Y-coordinate of top-left point.",
-          "example": "",
+          "example": "335",
           "member": "int64",
           "name": "Y",
           "required": true,
@@ -2848,7 +2911,7 @@
         {
           "disabled": false,
           "document": "Width",
-          "example": "",
+          "example": "169",
           "member": "int64",
           "name": "Width",
           "required": true,
@@ -2858,7 +2921,7 @@
         {
           "disabled": false,
           "document": "Height",
-          "example": "",
+          "example": "63",
           "member": "int64",
           "name": "Height",
           "required": true,
@@ -6291,6 +6354,52 @@
       ],
       "type": "object"
     },
+    "RecognizeDetectCardCoordsRequest": {
+      "document": "RecognizeDetectCardCoords request structure.",
+      "members": [
+        {
+          "disabled": false,
+          "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.",
+          "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/url.jpg",
+          "member": "string",
+          "name": "ImageUrl",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "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.",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
+          "member": "string",
+          "name": "ImageBase64",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "RecognizeDetectCardCoordsResponse": {
+      "document": "RecognizeDetectCardCoords response structure.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Detected coordinate information.",
+          "example": "无",
+          "member": "CoordsItem",
+          "name": "ItemList",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "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.",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "RecognizeGeneralInvoiceRequest": {
       "document": "RecognizeGeneralInvoice request structure.",
       "members": [

tccli/services/ocr/v20181119/examples.json

@@ -160,6 +160,14 @@
         "title": "RecognizeBrazilRNMOCR"
       }
     ],
+    "RecognizeDetectCardCoords": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecognizeDetectCardCoords\n<Common request parameters>\n\n{\n    \"ImageUrl\": \"https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ItemList\": [\n            {\n                \"Coords\": {\n                    \"Height\": 388,\n                    \"Width\": 607,\n                    \"X\": 93,\n                    \"Y\": 204\n                },\n                \"Polygon\": {\n                    \"LeftBottom\": {\n                        \"X\": 93,\n                        \"Y\": 592\n                    },\n                    \"LeftTop\": {\n                        \"X\": 95,\n                        \"Y\": 204\n                    },\n                    \"RightBottom\": {\n                        \"X\": 700,\n                        \"Y\": 592\n                    },\n                    \"RightTop\": {\n                        \"X\": 700,\n                        \"Y\": 204\n                    }\n                }\n            }\n        ],\n        \"RequestId\": \"27ca3357-3cfe-4cb2-9996-0120241211b1\"\n    }\n}",
+        "title": "Four Corner Coordinate Detection and Recognition"
+      }
+    ],
     "RecognizeGeneralInvoice": [
       {
         "document": "This example shows you how to recognize a general invoice or ticket (advanced).",