tccli 3.0.1099.1__py2.py3-none-any.whl → 3.0.1100.1__py2.py3-none-any.whl

tccli/services/ocr/ocr_client.py

@@ -2357,6 +2357,58 @@ def doHmtResidentPermitOCR(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doRecognizeGeneralTextImageWarn(args, parsed_globals):
+    g_param = parse_global_arg(parsed_globals)
+
+    if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
+        cred = credential.CVMRoleCredential()
+    elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
+        cred = credential.STSAssumeRoleCredential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
+            g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    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):
+        cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
+    else:
+        cred = credential.Credential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
+        )
+    http_profile = HttpProfile(
+        reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
+        reqMethod="POST",
+        endpoint=g_param[OptionsDefine.Endpoint],
+        proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
+    )
+    profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.OcrClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.RecognizeGeneralTextImageWarnRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.RecognizeGeneralTextImageWarn(model)
+        result = rsp.to_json_string()
+        try:
+            json_obj = json.loads(result)
+        except TypeError as e:
+            json_obj = json.loads(result.decode('utf-8'))  # python3.3
+        if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
+            break
+        cur_time = time.time()
+        if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
+            raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
+            (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
+            search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
+        else:
+            print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
+        time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
+    FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
+
+
 def doSmartStructuralOCR(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -4441,6 +4493,7 @@ ACTION_MAP = {
     "TableOCR": doTableOCR,
     "EnglishOCR": doEnglishOCR,
     "HmtResidentPermitOCR": doHmtResidentPermitOCR,
+    "RecognizeGeneralTextImageWarn": doRecognizeGeneralTextImageWarn,
     "SmartStructuralOCR": doSmartStructuralOCR,
     "ArithmeticOCR": doArithmeticOCR,
     "TollInvoiceOCR": doTollInvoiceOCR,

tccli/services/ocr/v20181119/api.json

@@ -343,6 +343,13 @@
       "output": "RecognizeGeneralInvoiceResponse",
       "status": "online"
     },
+    "RecognizeGeneralTextImageWarn": {
+      "document": "本接口支持多种类型证件有效性检测告警，包括卡证复印件告警、卡证翻拍告警等功能。可以应用于各种证件信息有效性校验场景，例如银行开户、用户注册等场景。\n\n默认接口请求频率限制：10次/秒。",
+      "input": "RecognizeGeneralTextImageWarnRequest",
+      "name": "通用文本图像告警",
+      "output": "RecognizeGeneralTextImageWarnResponse",
+      "status": "online"
+    },
     "RecognizeHealthCodeOCR": {
       "document": "本接口支持北京、上海、广东、江苏、吉林、黑龙江、天津、辽宁、浙江、河南、四川、贵州、山东、安徽、福建、江西、湖北、湖南等省份健康码的识别，包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间，疫苗接种信息，八个字段的识别结果输出。不同省市健康码显示的字段信息有所不同，上述字段的识别结果可能为空，以图片上具体展示的信息为准。\n\n默认接口请求频率限制：10次/秒。",
       "input": "RecognizeHealthCodeOCRRequest",
@@ -5721,6 +5728,42 @@
       ],
       "usage": "out"
     },
+    "GeneralWarnInfo": {
+      "document": "通用告警详情",
+      "members": [
+        {
+          "disabled": false,
+          "document": "是否存在该告警",
+          "example": "无",
+          "member": "bool",
+          "name": "IsWarn",
+          "output_required": true,
+          "type": "bool",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "告警位置四点坐标",
+          "example": "无",
+          "member": "Polygon",
+          "name": "Polygon",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "特殊判定，支持包括\n\nFinger：由手指导致的不完整，仅在不完整告警中返回",
+          "example": "无",
+          "member": "string",
+          "name": "SpecificMatter",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "GetTaskStateRequest": {
       "document": "GetTaskState请求参数结构体",
       "members": [
@@ -11320,6 +11363,119 @@
       ],
       "type": "object"
     },
+    "RecognizeGeneralTextImageWarnRequest": {
+      "document": "RecognizeGeneralTextImageWarn请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "图片的 Url 地址。\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。\n支持的图片像素：需介于20-10000px之间。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。",
+          "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/docume",
+          "member": "string",
+          "name": "ImageUrl",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "图片的 Base64 值。\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。\n支持的图片像素：需介于20-10000px之间。\n图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。",
+          "example": "无",
+          "member": "string",
+          "name": "ImageBase64",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "是否开启PDF识别，默认值为true，开启后可同时支持图片和PDF的识别。 示例值：false",
+          "example": "true",
+          "member": "bool",
+          "name": "EnablePdf",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "需要识别的PDF页面的对应页码，传入时仅支持PDF单页识别，当上传文件为PDF且EnablePdf参数值为true时有效，默认值为1。 示例值：1",
+          "example": "1",
+          "member": "int64",
+          "name": "PdfPageNumber",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "支持的模板类型\n- General 通用告警\n- LicensePlate 车牌告警",
+          "example": "无",
+          "member": "string",
+          "name": "Type",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "RecognizeGeneralTextImageWarnResponse": {
+      "document": "RecognizeGeneralTextImageWarn返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "复印告警信息",
+          "example": "无",
+          "member": "GeneralWarnInfo",
+          "name": "Copy",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "翻拍告警信息",
+          "example": "无",
+          "member": "GeneralWarnInfo",
+          "name": "Reprint",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "模糊告警信息",
+          "example": "无",
+          "member": "GeneralWarnInfo",
+          "name": "Blur",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "反光告警信息",
+          "example": "无",
+          "member": "GeneralWarnInfo",
+          "name": "Reflection",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "边框不完整告警信息",
+          "example": "无",
+          "member": "GeneralWarnInfo",
+          "name": "BorderIncomplete",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "RecognizeHealthCodeOCRRequest": {
       "document": "RecognizeHealthCodeOCR请求参数结构体",
       "members": [

tccli/services/ocr/v20181119/examples.json

@@ -446,6 +446,14 @@
         "title": "通用票据识别（高级版）"
       }
     ],
+    "RecognizeGeneralTextImageWarn": [
+      {
+        "document": "通用文本图像告警示例",
+        "input": "POST / HTTP/1.1\nHost: ocr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RecognizeGeneralTextImageWarn\n<公共请求参数>\n\n{\n    \"ImageUrl\": \"https://xx/a.jpg\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Blur\": {\n            \"IsWarn\": false,\n            \"Polygon\": [],\n            \"SpecificMatter\": \"\"\n        },\n        \"BorderIncomplete\": {\n            \"IsWarn\": false,\n            \"Polygon\": [],\n            \"SpecificMatter\": \"\"\n        },\n        \"Copy\": {\n            \"IsWarn\": true,\n            \"Polygon\": [\n                {\n                    \"LeftBottom\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"LeftTop\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"RightBottom\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"RightTop\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    }\n                }\n            ],\n            \"SpecificMatter\": \"\"\n        },\n        \"Reflection\": {\n            \"IsWarn\": false,\n            \"Polygon\": [],\n            \"SpecificMatter\": \"\"\n        },\n        \"Reprint\": {\n            \"IsWarn\": true,\n            \"Polygon\": [\n                {\n                    \"LeftBottom\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"LeftTop\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"RightBottom\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    },\n                    \"RightTop\": {\n                        \"X\": 0,\n                        \"Y\": 0\n                    }\n                }\n            ],\n            \"SpecificMatter\": \"\"\n        },\n        \"RequestId\": \"d8b2bf40-091e-43f1-a075-d98a5c9b2e1e\"\n    }\n}",
+        "title": "通用文本图像告警示例代码"
+      }
+    ],
     "RecognizeHealthCodeOCR": [
       {
         "document": "健康码识别",

tccli/services/rce/v20201103/api.json

@@ -684,41 +684,41 @@
       "members": [
         {
           "disabled": false,
-          "document": "返回码。0表示成功，非0标识失败错误码。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "",
+          "document": "错误码，0 表示成功，非0表示失败错误码。\n0：成功\n1：错误\n1002：参数错误\n4300：未开通服务\n4301：后端未创建对应产品\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
           "member": "int64",
           "name": "Code",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
         {
           "disabled": false,
           "document": "UTF-8编码，出错消息。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "Message",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
           "disabled": false,
           "document": "业务详情。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "",
+          "example": "无",
           "member": "OutputManageMarketingRiskValue",
           "name": "Value",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": true
         },
         {
           "disabled": false,
           "document": "控制台显示的req_id。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "",
+          "example": "无",
           "member": "string",
           "name": "UUid",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         }

tccli/services/rum/v20210622/api.json

@@ -644,7 +644,7 @@
         },
         {
           "disabled": false,
-          "document": "每天数据上报量",
+          "document": "每天数据上报量，（不作量级限制）",
           "example": "100",
           "member": "string",
           "name": "CountNum",
@@ -708,6 +708,7 @@
           "example": "taw-12345678",
           "member": "string",
           "name": "InstanceId",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -717,6 +718,7 @@
           "example": "20211011688006794751081",
           "member": "string",
           "name": "DealName",
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -743,7 +745,7 @@
         },
         {
           "disabled": false,
-          "document": "备注",
+          "document": "备注（暂未作字节数限制）",
           "example": "备注",
           "member": "string",
           "name": "Remark",
@@ -780,7 +782,7 @@
           "example": "无",
           "member": "string",
           "name": "Msg",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -790,7 +792,7 @@
           "example": "1",
           "member": "uint64",
           "name": "ID",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -1588,7 +1590,7 @@
         },
         {
           "disabled": false,
-          "document": "网络类型",
+          "document": "网络类型（1,2,3,4,5,100），1表示WIFI, 2表示2G, 3表示3G, 4表示4G, 5表示5G, 6表示6G, 100表示未知。",
           "example": "2",
           "member": "string",
           "name": "NetType",
@@ -1606,7 +1608,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -1670,7 +1672,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2067,7 +2069,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -2149,7 +2151,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2320,7 +2322,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -2384,7 +2386,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2555,7 +2557,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -2646,7 +2648,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -2872,7 +2874,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -2918,7 +2920,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -3062,7 +3064,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -3153,7 +3155,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -3324,7 +3326,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -3370,7 +3372,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -3541,7 +3543,7 @@
         },
         {
           "disabled": false,
-          "document": "显示是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -3895,7 +3897,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -3959,7 +3961,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4130,7 +4132,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -4194,7 +4196,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4365,7 +4367,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -4429,7 +4431,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4600,7 +4602,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -4664,7 +4666,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -4835,7 +4837,7 @@
         },
         {
           "disabled": false,
-          "document": "是否海外",
+          "document": "显示是否海外,1表示海外，0表示非海外；默认值为空，查询所有。",
           "example": "1",
           "member": "string",
           "name": "IsAbroad",
@@ -4890,7 +4892,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -5354,7 +5356,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -5436,7 +5438,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -5654,7 +5656,7 @@
           "example": "无",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },