tccli 3.0.1316.1__py2.py3-none-any.whl → 3.0.1317.1__py2.py3-none-any.whl

tccli/services/ess/v20201111/api.json

@@ -385,6 +385,13 @@
       "output": "CreateUserMobileChangeUrlResponse",
       "status": "online"
     },
+    "CreateUserNameChangeUrl": {
+      "document": "生成个人用户实名更名链接，个人用户点击此链接进入更名流程（若用户未完成实名认证，则直接进入实名页面实名后再进行更名）。此链接为通用链接，任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。\n\n注： 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
+      "input": "CreateUserNameChangeUrlRequest",
+      "name": "生成个人更名链接",
+      "output": "CreateUserNameChangeUrlResponse",
+      "status": "online"
+    },
     "CreateUserVerifyUrl": {
       "document": "生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。\n\n注： 调用此接口需要购买<font color=\"red\"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。",
       "input": "CreateUserVerifyUrlRequest",
@@ -7951,6 +7958,81 @@
       ],
       "type": "object"
     },
+    "CreateUserNameChangeUrlRequest": {
+      "document": "CreateUserNameChangeUrl请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "操作人信息",
+          "example": "无",
+          "member": "UserInfo",
+          "name": "Operator",
+          "required": true,
+          "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "要跳转的链接类型\n\n<ul>\n<li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>\n<li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>\n<li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>\n</ul>\n\n注：如果不传递，默认值是 <font color=\"red\"> HTTP </font>",
+          "example": "APP",
+          "member": "string",
+          "name": "Endpoint",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。",
+          "example": "MTIzNDU2Nzg5",
+          "member": "string",
+          "name": "UserData",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateUserNameChangeUrlResponse": {
+      "document": "CreateUserNameChangeUrl返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "腾讯电子签小程序的个人更名链接。\n如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。\n\n<strong>1.如果EndPoint是APP</strong>：\n得到的链接类似于<a href=\"\">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的\"跳转到小程序的实现\"\n\n<strong>2.如果EndPoint是HTTP</strong>：\n得到的链接类似于 <a href=\"\">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：\n得到的链接类似于<a href=\"\">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署\n\n\n`注：` <font color=\"red\">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>",
+          "example": "https://essurl.cn/2n**42Nd",
+          "member": "string",
+          "name": "UserVerifyUrl",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "链接过期时间，为Unix时间戳（单位为秒）。",
+          "example": "1736416390",
+          "member": "int64",
+          "name": "ExpireTime",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回",
+          "example": "gh_da88f6188665",
+          "member": "string",
+          "name": "MiniAppId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateUserVerifyUrlRequest": {
       "document": "CreateUserVerifyUrl请求参数结构体",
       "members": [

tccli/services/ess/v20201111/examples.json

@@ -1256,6 +1256,14 @@
         "title": "使用二要素生成修改员工手机号链接"
       }
     ],
+    "CreateUserNameChangeUrl": [
+      {
+        "document": "生成个人通用更名链接",
+        "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserNameChangeUrl\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"UserId\": \"19561039c9***********32520fde6a\",\n        \"ClientIp\": \"8.8.8.8\"\n    },\n    \"Endpoint\": \"HTTP\",\n    \"UserData\": \"TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5LCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ExpireTime\": 1748247333,\n        \"MiniAppId\": \"\",\n        \"RequestId\": \"s1747642533895017639\",\n        \"UserVerifyUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=MP_PERSONAL_VERIFY&shortKey=yDttYU******bLXcb\"\n    }\n}",
+        "title": "生成个人更名链接"
+      }
+    ],
     "CreateUserVerifyUrl": [
       {
         "document": "获取c端用户实名链接",

tccli/services/essbasic/v20210526/api.json

@@ -9830,7 +9830,7 @@
         },
         {
           "disabled": false,
-          "document": "指定企业经办签署人OpenId",
+          "document": "指定企业经办签署人OpenId\n\n注: `签署人OpenId未实名时，需要传入签署人姓名以及手机号码。`",
           "example": "n9527",
           "member": "string",
           "name": "OpenId",
@@ -13448,7 +13448,7 @@
         },
         {
           "disabled": false,
-          "document": "二维码，在生成动态签署人跳转封面页链接时返回",
+          "document": "二维码，在生成动态签署人跳转封面页链接时返回\n\n注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`",
           "example": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d**2f0db15e6b",
           "member": "string",
           "name": "SignQrcodeUrl",

tccli/services/essbasic/v20210526/examples.json

@@ -236,10 +236,10 @@
     ],
     "ChannelCreateFlowApprovers": [
       {
-        "document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 \n注:`补充动态签署人时FillApproverType传值为1 `",
-        "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"OpenId\": \"\",\n        \"ClientIp\": \"\",\n        \"CustomUserId\": \"\",\n        \"ProxyIp\": \"\",\n        \"Channel\": \"\"\n    },\n    \"Agent\": {\n        \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n        \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n        },\n        \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n    },\n    \"FlowId\": \"111111***22222\",\n    \"FillApproverType\": 1,\n    \"Approvers\": [\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n            \"ApproverName\": \"典子谦\",\n            \"ApproverMobile\": \"13200000000\",\n            \"OrganizationName\": \"***有限公司\",\n            \"OrganizationOpenId\": \"org_diziqian\"\n        },\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n            \"ApproverName\": \"张三\",\n            \"ApproverMobile\": \"18888888888\"\n        }\n    ]\n}",
+        "document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 \n注:\n`补充动态签署人时FillApproverType传值为1 `\n`子客企业签署人OpenId未实名的情况下，需要传入签署人姓名和手机号码（ApproverName和ApproverMobile）`",
+        "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"OpenId\": \"\",\n        \"ClientIp\": \"\",\n        \"CustomUserId\": \"\",\n        \"ProxyIp\": \"\",\n        \"Channel\": \"\"\n    },\n    \"Agent\": {\n        \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n        \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n        },\n        \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n    },\n    \"FlowId\": \"111111***22222\",\n    \"FillApproverType\": 1,\n    \"Approvers\": [\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n            \"ApproverName\": \"典子谦\",\n            \"ApproverMobile\": \"13200000000\",\n            \"OpenId\": \"zhangsan\",\n            \"OrganizationName\": \"***有限公司\",\n            \"OrganizationOpenId\": \"org_diziqian\"\n        },\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n            \"ApproverName\": \"张三\",\n            \"ApproverMobile\": \"18888888888\"\n        }\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n    }\n}",
-        "title": "B2C签署，批量补充两方动态签署人信息"
+        "title": "B2C签署，批量补充两方动态签署人信息，子客企业签署人未实名"
       },
       {
         "document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 \n注:`补充动态签署人时FillApproverType传值为1 `",
@@ -258,6 +258,12 @@
         "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"OpenId\": \"\",\n        \"ClientIp\": \"\",\n        \"CustomUserId\": \"\",\n        \"ProxyIp\": \"\",\n        \"Channel\": \"\"\n    },\n    \"Agent\": {\n        \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n        \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n        },\n        \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n    },\n    \"FlowId\": \"111111***22222\",\n    \"FillApproverType\": 1,\n    \"Approvers\": [\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n            \"ApproverName\": \"张三\",\n            \"ApproverIdCardType\": \"ID_CARD\",\n            \"ApproverIdCardNumber\": \"620000198802020000\"\n        }\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n    }\n}",
         "title": "B2C签署，通过姓名和证件类型、证件号码补充已实名个人用户"
+      },
+      {
+        "document": "在B2C签署中，双方签署方未指定具体签署人时，需要进行补充。 \n注:\n`补充动态签署人时FillApproverType传值为1 `",
+        "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateFlowApprovers\n<公共请求参数>\n\n{\n    \"Operator\": {\n        \"OpenId\": \"\",\n        \"ClientIp\": \"\",\n        \"CustomUserId\": \"\",\n        \"ProxyIp\": \"\",\n        \"Channel\": \"\"\n    },\n    \"Agent\": {\n        \"ProxyAppId\": \"c17bdf9c2a7bdcb32611f4d0200fef3d\",\n        \"ProxyOrganizationOpenId\": \"d7c13a8b81340cce9e3968c0ee248f04\",\n        \"ProxyOperator\": {\n            \"OpenId\": \"00498cc8500be9cxxxxxxx3aff766cac\"\n        },\n        \"AppId\": \"65fb0c591044be8a1f60aa382cc5ed0e\"\n    },\n    \"FlowId\": \"111111***22222\",\n    \"FillApproverType\": 1,\n    \"Approvers\": [\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR\",\n            \"OpenId\": \"zhangsan\",\n            \"OrganizationName\": \"***有限公司\",\n            \"OrganizationOpenId\": \"org_diziqian\"\n        },\n        {\n            \"RecipientId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n            \"ApproverName\": \"张三\",\n            \"ApproverMobile\": \"18888888888\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\"\n    }\n}",
+        "title": "B2C签署，批量补充两方动态签署人信息，子客企业签署人已实名"
       }
     ],
     "ChannelCreateFlowByFiles": [

tccli/services/hai/v20230812/api.json

@@ -1,7 +1,7 @@
 {
   "actions": {
     "CreateApplication": {
-      "document": "本接口（CreateApplicaiton）用于对HAI实例制作自定义应用。",
+      "document": "本接口（CreateApplication）用于对HAI实例制作自定义应用。",
       "input": "CreateApplicationRequest",
       "name": "创建自定义应用",
       "output": "CreateApplicationResponse",

tccli/services/lke/v20231130/api.json

@@ -7213,7 +7213,7 @@
         },
         {
           "disabled": false,
-          "document": "数量,  数量需大于2",
+          "document": "数量,  数量需大于2, 最大1000",
           "example": "2",
           "member": "uint64",
           "name": "Count",
@@ -7229,15 +7229,6 @@
           "required": true,
           "type": "string"
         },
-        {
-          "disabled": false,
-          "document": "最后一条记录ID",
-          "example": "无",
-          "member": "string",
-          "name": "LastRecordId",
-          "required": false,
-          "type": "string"
-        },
         {
           "disabled": false,
           "document": "应用AppKey, 当Type=5[API访客]时, 该字段必填  :</br>  获取方式:</br>   1、应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取</br>   2、参考 https://cloud.tencent.com/document/product/1759/109469 第二项",
@@ -7258,7 +7249,16 @@
         },
         {
           "disabled": false,
-          "document": "传该值，代表拉取该记录id的前后总共count条消息记录",
+          "document": "最后一条记录ID， 消息从后往前获取\n\nMidRecordId与LastRecordId只能选择一个\n",
+          "example": "无",
+          "member": "string",
+          "name": "LastRecordId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "传该值，代表拉取该记录id的前后总共count条消息记录\n\nMidRecordId与LastRecordId只能选择一个\n",
           "example": "无",
           "member": "string",
           "name": "MidRecordId",

tccli/services/lkeap/lkeap_client.py

@@ -173,6 +173,58 @@ def doGetReconstructDocumentResult(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doRetrieveKnowledgeRealtime(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.LkeapClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.RetrieveKnowledgeRealtimeRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.RetrieveKnowledgeRealtime(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 doGetSplitDocumentResult(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -1265,58 +1317,6 @@ def doGetCharacterUsage(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
-def doUploadDocRealtime(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.LkeapClient(cred, g_param[OptionsDefine.Region], profile)
-    client._sdkVersion += ("_CLI_" + __version__)
-    models = MODELS_MAP[g_param[OptionsDefine.Version]]
-    model = models.UploadDocRealtimeRequest()
-    model.from_json_string(json.dumps(args))
-    start_time = time.time()
-    while True:
-        rsp = client.UploadDocRealtime(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 doUploadDoc(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -1435,6 +1435,7 @@ ACTION_MAP = {
     "RetrieveKnowledge": doRetrieveKnowledge,
     "ModifyQA": doModifyQA,
     "GetReconstructDocumentResult": doGetReconstructDocumentResult,
+    "RetrieveKnowledgeRealtime": doRetrieveKnowledgeRealtime,
     "GetSplitDocumentResult": doGetSplitDocumentResult,
     "DescribeDoc": doDescribeDoc,
     "ReconstructDocumentSSE": doReconstructDocumentSSE,
@@ -1456,7 +1457,6 @@ ACTION_MAP = {
     "DeleteKnowledgeBase": doDeleteKnowledgeBase,
     "CreateSplitDocumentFlow": doCreateSplitDocumentFlow,
     "GetCharacterUsage": doGetCharacterUsage,
-    "UploadDocRealtime": doUploadDocRealtime,
     "UploadDoc": doUploadDoc,
     "ChatCompletions": doChatCompletions,
 

tccli/services/lkeap/v20240522/api.json

@@ -168,6 +168,13 @@
       "output": "RetrieveKnowledgeResponse",
       "status": "online"
     },
+    "RetrieveKnowledgeRealtime": {
+      "document": "用于实时检索在UploadDocRealtime接口上传的实时文档内容。 使用场景：适用于在会话中对文档进行问答的场景",
+      "input": "RetrieveKnowledgeRealtimeRequest",
+      "name": "实时检索知识库内容",
+      "output": "RetrieveKnowledgeRealtimeResponse",
+      "status": "online"
+    },
     "RunRerank": {
       "document": "基于知识引擎精调模型技术的rerank模型，支持对多路召回的结果进行重排序，根据query与切片内容的相关性，按分数由高到低对切片进行排序，并输出对应的打分结果。",
       "input": "RunRerankRequest",
@@ -181,13 +188,6 @@
       "name": "上传文档",
       "output": "UploadDocResponse",
       "status": "online"
-    },
-    "UploadDocRealtime": {
-      "document": "用于上传实时文档内容。\n实时文档在上传后可以立即通过SearchRealtime进行实时检索，适用于在会话中对文档进行问答的场景。",
-      "input": "UploadDocRealtimeRequest",
-      "name": "实时文档上传",
-      "output": "UploadDocRealtimeResponse",
-      "status": "online"
     }
   },
   "metadata": {
@@ -2371,6 +2371,89 @@
       ],
       "usage": "in"
     },
+    "RetrieveKnowledgeRealtimeRequest": {
+      "document": "RetrieveKnowledgeRealtime请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "知识库ID。",
+          "example": "1840331836752986944",
+          "member": "string",
+          "name": "KnowledgeBaseId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "用于检索的文本。",
+          "example": "国庆放几天假",
+          "member": "string",
+          "name": "Query",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实时文件ID列表。",
+          "example": "[\"1828720159590123264\"]",
+          "member": "string",
+          "name": "DocIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "检索方法，默认使用`HYBRID`混合检索。\n- `SEMANTIC`：语义检索\n- `FULL_TEXT`：全文检索\n- `HYBRID`：混合检索",
+          "example": "SEMANTIC",
+          "member": "string",
+          "name": "RetrievalMethod",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "检索设置。",
+          "example": "{\"TopK\":3,\"ScoreThreshold\":0.7}",
+          "member": "RetrievalSetting",
+          "name": "RetrievalSetting",
+          "required": false,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "RetrieveKnowledgeRealtimeResponse": {
+      "document": "RetrieveKnowledgeRealtime返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "检索结果",
+          "example": "[{\"Metadata\":{\"Type\":\"DOC\",\"ResultSource\":\"SEMANTIC\",\"ChunkPageNumbers\":[1,2]},\"Score\":0,\"Title\":\"example.pdf\",\"Content\":\"国庆放7天假\"}]",
+          "member": "RetrievalRecord",
+          "name": "Records",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "检索结果数量",
+          "example": "3",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "RetrieveKnowledgeRequest": {
       "document": "RetrieveKnowledge请求参数结构体",
       "members": [
@@ -2633,69 +2716,6 @@
       ],
       "usage": "out"
     },
-    "UploadDocRealtimeRequest": {
-      "document": "UploadDocRealtime请求参数结构体",
-      "members": [
-        {
-          "disabled": false,
-          "document": "知识库ID",
-          "example": "4901991032",
-          "member": "string",
-          "name": "KnowledgeBaseId",
-          "required": true,
-          "type": "string"
-        },
-        {
-          "disabled": false,
-          "document": "文件名，可选。\n**需带文件类型后缀**，当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。",
-          "example": "example.pdf",
-          "member": "string",
-          "name": "FileName",
-          "required": true,
-          "type": "string"
-        },
-        {
-          "disabled": false,
-          "document": "文件类型。\n**支持的文件类型：**\n- `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`\n\n**支持的文件大小：**\n - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M \n - `TXT`、`MD` 最大10M \n - 其他 最大20M",
-          "example": "PDF",
-          "member": "string",
-          "name": "FileType",
-          "required": true,
-          "type": "string"
-        },
-        {
-          "disabled": false,
-          "document": "文件的 URL 地址。\n文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。\n参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
-          "example": "https://example.com/example.pdf",
-          "member": "string",
-          "name": "FileUrl",
-          "required": true,
-          "type": "string"
-        },
-        {
-          "disabled": false,
-          "document": "过期时间的秒数，最长24小时，默认24小时",
-          "example": "86400",
-          "member": "int64",
-          "name": "ExpireTime",
-          "required": false,
-          "type": "int"
-        }
-      ],
-      "type": "object"
-    },
-    "UploadDocRealtimeResponse": {
-      "document": "UploadDocRealtime返回参数结构体",
-      "members": [
-        {
-          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
-          "member": "string",
-          "name": "RequestId",
-          "type": "string"
-        }
-      ],
-      "type": "object"
-    },
     "UploadDocRequest": {
       "document": "UploadDoc请求参数结构体",
       "members": [

tccli/services/lkeap/v20240522/examples.json

@@ -216,6 +216,14 @@
         "title": "语义检索（问答对）"
       }
     ],
+    "RetrieveKnowledgeRealtime": [
+      {
+        "document": "实时语义检索",
+        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RetrieveKnowledgeRealtime\n<公共请求参数>\n\n{\n    \"KnowledgeBaseId\": \"49019910106\",\n    \"Query\": \"国庆节放几天假\",\n    \"DocIds\": [\n        \"1828720159590123264\"\n    ],\n    \"RetrievalMethod\": \"SEMANTIC\",\n    \"RetrievalSetting\": {\n        \"TopK\": 3,\n        \"ScoreThreshold\": 0.7\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Records\": [\n            {\n                \"Metadata\": {\n                    \"Type\": \"DOC\",\n                    \"ResultSource\": \"SEMANTIC\",\n                    \"ChunkPageNumbers\": [\n                        1\n                    ]\n                },\n                \"Title\": \"example.pdf\",\n                \"Content\": \"国庆放七天假\"\n            }\n        ],\n        \"TotalCount\": 1,\n        \"RequestId\": \"d422c101-96e6-4aeb-b51c-0ccb551a5a52\"\n    }\n}",
+        "title": "实时语义检索"
+      }
+    ],
     "RunRerank": [
       {
         "document": "重排序",
@@ -231,14 +239,6 @@
         "output": "{\n    \"Response\": {\n        \"DocId\": \"1830996257459865536\",\n        \"RequestId\": \"804c3fe0-05b1-48f9-8003-ab118658fec7\"\n    }\n}",
         "title": "上传无属性标签文档"
       }
-    ],
-    "UploadDocRealtime": [
-      {
-        "document": "实时文档上传",
-        "input": "POST / HTTP/1.1\nHost: lkeap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UploadDocRealtime\n<公共请求参数>\n\n{\n    \"KnowledgeBaseId\": \"594669442\",\n    \"FileName\": \"changan-short.doc\",\n    \"FileType\": \"DOC\",\n    \"FileUrl\": \"https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/2024-08-20/1251316161/20548499/changan-short.doc?q-sign-algorithm=sha1&q-ak=AKxxxxxxx&q-sign-time=1726245910;1726253110&q-key-time=1726245910;1726253110&q-header-list=&q-url-param-list=&q-signature=114996cce2050ca1edbe6e69606e5c01b4c5a3a1\"\n}",
-        "output": "{\n\t\"IsFinal\": true,\n\t\"DocId\": \"1828430526517084160\",\n\t\"Progress\": 80,\n\t\"PageNum\": 0,\n\t\"Status\": \"SUCCESS\"\n}",
-        "title": "实时文档上传"
-      }
     ]
   },
   "version": "1.0"