tccli 3.0.1316.1__py2.py3-none-any.whl → 3.0.1318.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 (64) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/batch/v20170312/api.json +2 -2
  3. tccli/services/cbs/v20170312/api.json +59 -60
  4. tccli/services/cbs/v20170312/examples.json +5 -5
  5. tccli/services/cdb/v20170320/api.json +9 -9
  6. tccli/services/cdb/v20170320/examples.json +12 -0
  7. tccli/services/cdwdoris/v20211228/api.json +37 -1
  8. tccli/services/clb/v20180317/api.json +1 -1
  9. tccli/services/cls/v20201016/api.json +12 -2
  10. tccli/services/cvm/v20170312/api.json +18 -18
  11. tccli/services/cvm/v20170312/examples.json +1 -1
  12. tccli/services/cynosdb/v20190107/api.json +29 -7
  13. tccli/services/dnspod/v20210323/api.json +85 -65
  14. tccli/services/dnspod/v20210323/examples.json +28 -28
  15. tccli/services/domain/v20180808/api.json +10 -10
  16. tccli/services/domain/v20180808/examples.json +1 -1
  17. tccli/services/dsgc/v20190723/api.json +45 -35
  18. tccli/services/dts/v20180330/api.json +2 -2
  19. tccli/services/es/v20180416/api.json +49 -0
  20. tccli/services/ess/ess_client.py +53 -0
  21. tccli/services/ess/v20201111/api.json +83 -1
  22. tccli/services/ess/v20201111/examples.json +8 -0
  23. tccli/services/essbasic/v20210526/api.json +2 -2
  24. tccli/services/essbasic/v20210526/examples.json +9 -3
  25. tccli/services/goosefs/goosefs_client.py +386 -68
  26. tccli/services/goosefs/v20220519/api.json +510 -0
  27. tccli/services/goosefs/v20220519/examples.json +48 -0
  28. tccli/services/hai/v20230812/api.json +5 -5
  29. tccli/services/iotexplorer/v20190423/api.json +13 -3
  30. tccli/services/keewidb/v20220308/api.json +11 -2
  31. tccli/services/lighthouse/v20200324/api.json +1 -1
  32. tccli/services/lke/v20231130/api.json +12 -68
  33. tccli/services/lkeap/lkeap_client.py +53 -53
  34. tccli/services/lkeap/v20240522/api.json +90 -70
  35. tccli/services/lkeap/v20240522/examples.json +8 -8
  36. tccli/services/mps/v20190612/api.json +163 -0
  37. tccli/services/mps/v20190612/examples.json +1 -1
  38. tccli/services/mrs/v20200910/api.json +30 -0
  39. tccli/services/postgres/postgres_client.py +8 -114
  40. tccli/services/postgres/v20170312/api.json +0 -197
  41. tccli/services/postgres/v20170312/examples.json +0 -22
  42. tccli/services/privatedns/v20201028/api.json +2 -2
  43. tccli/services/scf/v20180416/api.json +2 -2
  44. tccli/services/sqlserver/v20180328/api.json +2 -2
  45. tccli/services/ssl/v20191205/api.json +18 -0
  46. tccli/services/ssl/v20191205/examples.json +2 -2
  47. tccli/services/tbaas/v20180416/api.json +3 -3
  48. tccli/services/tbaas/v20180416/examples.json +1 -1
  49. tccli/services/tcbr/v20220217/api.json +16 -16
  50. tccli/services/teo/v20220901/api.json +34 -6
  51. tccli/services/teo/v20220901/examples.json +1 -1
  52. tccli/services/tke/v20180525/api.json +7 -7
  53. tccli/services/tke/v20220501/api.json +61 -1
  54. tccli/services/tke/v20220501/examples.json +1 -1
  55. tccli/services/trtc/v20190722/api.json +19 -1
  56. tccli/services/tse/v20201207/api.json +78 -4
  57. tccli/services/vpc/v20170312/api.json +1 -1
  58. tccli/services/waf/v20180125/api.json +78 -22
  59. tccli/services/waf/v20180125/examples.json +1 -1
  60. {tccli-3.0.1316.1.dist-info → tccli-3.0.1318.1.dist-info}/METADATA +2 -2
  61. {tccli-3.0.1316.1.dist-info → tccli-3.0.1318.1.dist-info}/RECORD +64 -64
  62. {tccli-3.0.1316.1.dist-info → tccli-3.0.1318.1.dist-info}/WHEEL +0 -0
  63. {tccli-3.0.1316.1.dist-info → tccli-3.0.1318.1.dist-info}/entry_points.txt +0 -0
  64. {tccli-3.0.1316.1.dist-info → tccli-3.0.1318.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "CreateApplication": {
4
- "document": "本接口(CreateApplicaiton)用于对HAI实例制作自定义应用。",
4
+ "document": "本接口(CreateApplication)用于对HAI实例制作自定义应用。",
5
5
  "input": "CreateApplicationRequest",
6
6
  "name": "创建自定义应用",
7
7
  "output": "CreateApplicationResponse",
@@ -1100,7 +1100,7 @@
1100
1100
  },
1101
1101
  {
1102
1102
  "disabled": false,
1103
- "document": "时长单位,默认值MONTH",
1103
+ "document": "时长单位,枚举: MONTH, DAY, HOUR;释义:月,日,小时",
1104
1104
  "example": "MONTH",
1105
1105
  "member": "string",
1106
1106
  "name": "TimeUnit",
@@ -1115,7 +1115,7 @@
1115
1115
  "members": [
1116
1116
  {
1117
1117
  "disabled": false,
1118
- "document": "原单价",
1118
+ "document": "原单价,元",
1119
1119
  "example": "100.00",
1120
1120
  "member": "float",
1121
1121
  "name": "UnitPrice",
@@ -1125,7 +1125,7 @@
1125
1125
  },
1126
1126
  {
1127
1127
  "disabled": false,
1128
- "document": "折扣后单价",
1128
+ "document": "折扣后单价,元",
1129
1129
  "example": "50.00",
1130
1130
  "member": "float",
1131
1131
  "name": "DiscountUnitPrice",
@@ -1146,7 +1146,7 @@
1146
1146
  {
1147
1147
  "disabled": false,
1148
1148
  "document": "单位:时/月\n",
1149
- "example": "HOUR",
1149
+ "example": "HOUR,释义:小时",
1150
1150
  "member": "string",
1151
1151
  "name": "ChargeUnit",
1152
1152
  "output_required": true,
@@ -16920,7 +16920,7 @@
16920
16920
  "members": [
16921
16921
  {
16922
16922
  "disabled": false,
16923
- "document": "任务状态(1:失败;2:成功但结果为空;3:成功且结果非空)",
16923
+ "document": "任务状态(1:分析失败;2:下载/读取视频/图片失败;3:成功)",
16924
16924
  "example": "3",
16925
16925
  "member": "int64",
16926
16926
  "name": "Status",
@@ -16931,7 +16931,7 @@
16931
16931
  {
16932
16932
  "disabled": false,
16933
16933
  "document": "识别到的目标类型。可能取值:\n\n- `person`:人\n- `vehicle`:车辆\n- `dog`:狗\n- `cat`:猫\n- `fire`:火焰\n- `smoke`:烟雾\n- `package`:快递包裹\n- `license_plate`:车牌\n",
16934
- "example": "[\"person\", \"vehicle\"]",
16934
+ "example": "[\"person\"]",
16935
16935
  "member": "string",
16936
16936
  "name": "DetectedClassifications",
16937
16937
  "output_required": false,
@@ -16940,13 +16940,23 @@
16940
16940
  },
16941
16941
  {
16942
16942
  "disabled": false,
16943
- "document": "视频摘要文本",
16943
+ "document": "摘要文本",
16944
16944
  "example": "一人在水泥地面上行走",
16945
16945
  "member": "string",
16946
16946
  "name": "Summary",
16947
16947
  "output_required": false,
16948
16948
  "type": "string",
16949
16949
  "value_allowed_null": false
16950
+ },
16951
+ {
16952
+ "disabled": false,
16953
+ "document": "摘要文本(次选语言)",
16954
+ "example": "A person walking on the concrete floor",
16955
+ "member": "string",
16956
+ "name": "AlternativeSummary",
16957
+ "output_required": false,
16958
+ "type": "string",
16959
+ "value_allowed_null": false
16950
16960
  }
16951
16961
  ],
16952
16962
  "usage": "out"
@@ -1788,8 +1788,8 @@
1788
1788
  "type": "string"
1789
1789
  },
1790
1790
  {
1791
- "disabled": false,
1792
- "document": "根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。",
1791
+ "disabled": true,
1792
+ "document": "废弃字段。请使用TagList传参。",
1793
1793
  "example": "具体参考数据结构。",
1794
1794
  "member": "InstanceTagInfo",
1795
1795
  "name": "InstanceTags",
@@ -1804,6 +1804,15 @@
1804
1804
  "name": "TagKeys",
1805
1805
  "required": false,
1806
1806
  "type": "list"
1807
+ },
1808
+ {
1809
+ "disabled": false,
1810
+ "document": "根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。",
1811
+ "example": "无",
1812
+ "member": "InstanceTagInfo",
1813
+ "name": "TagList",
1814
+ "required": false,
1815
+ "type": "list"
1807
1816
  }
1808
1817
  ],
1809
1818
  "type": "object"
@@ -8480,7 +8480,7 @@
8480
8480
  "members": [
8481
8481
  {
8482
8482
  "disabled": false,
8483
- "document": "续费周期。",
8483
+ "document": "续费周期。\n单位:月。\n取值范围: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]",
8484
8484
  "example": "1",
8485
8485
  "member": "int64",
8486
8486
  "name": "Period",
@@ -659,7 +659,7 @@
659
659
  "status": "online"
660
660
  },
661
661
  "SaveDoc": {
662
- "document": "知识库文档问答保存。\n将文件存储到应用的知识库内需要三步:\n1.获取临时密钥,参考[接口文档](https://cloud.tencent.com/document/product/1759/105050)。获取临时密钥不同参数组合权限不一样,可参考 [知识引擎操作 cos 指南](https://cloud.tencent.com/document/product/1759/116238)\n2.调用腾讯云提供的 cos 存储接口,将文件存储到知识引擎 cos 中:具体可参考[ COS SDK 概览](https://cloud.tencent.com/document/product/436/6474), 注意使用的是临时密钥的方式操作 COS \n3.调用本接口,将文件的基础信息存储到知识引擎中。\n以上步骤可参考[文档](https://cloud.tencent.com/document/product/1759/108903),文档最后有[代码demo](https://cloud.tencent.com/document/product/1759/108903#demo),可作为参考。",
662
+ "document": "知识库文档问答保存。\n将文件存储到应用的知识库内需要三步:\n1.获取临时密钥,参考[接口文档](https://cloud.tencent.com/document/product/1759/105050)。获取临时密钥不同参数组合权限不一样,可参考 [智能体开发平台操作 cos 指南](https://cloud.tencent.com/document/product/1759/116238)\n2.调用腾讯云提供的 cos 存储接口,将文件存储到智能体开发平台 cos 中:具体可参考[ COS SDK 概览](https://cloud.tencent.com/document/product/436/6474), 注意使用的是临时密钥的方式操作 COS \n3.调用本接口,将文件的基础信息存储到智能体开发平台中。\n以上步骤可参考[文档](https://cloud.tencent.com/document/product/1759/108903),文档最后有[代码demo](https://cloud.tencent.com/document/product/1759/108903#demo),可作为参考。",
663
663
  "input": "SaveDocRequest",
664
664
  "name": "知识库文档录入",
665
665
  "output": "SaveDocResponse",
@@ -4554,26 +4554,6 @@
4554
4554
  "type": "string",
4555
4555
  "value_allowed_null": false
4556
4556
  },
4557
- {
4558
- "disabled": false,
4559
- "document": "文档的用户自定义ID",
4560
- "example": "无",
4561
- "member": "string",
4562
- "name": "CustomerKnowledgeId",
4563
- "output_required": false,
4564
- "type": "string",
4565
- "value_allowed_null": false
4566
- },
4567
- {
4568
- "disabled": false,
4569
- "document": "文档的属性标记,0: 不做用户外部权限校验",
4570
- "example": "无",
4571
- "member": "uint64",
4572
- "name": "AttributeFlags",
4573
- "output_required": false,
4574
- "type": "list",
4575
- "value_allowed_null": false
4576
- },
4577
4557
  {
4578
4558
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4579
4559
  "member": "string",
@@ -7213,7 +7193,7 @@
7213
7193
  },
7214
7194
  {
7215
7195
  "disabled": false,
7216
- "document": "数量, 数量需大于2",
7196
+ "document": "数量, 数量需大于2, 最大1000",
7217
7197
  "example": "2",
7218
7198
  "member": "uint64",
7219
7199
  "name": "Count",
@@ -7229,15 +7209,6 @@
7229
7209
  "required": true,
7230
7210
  "type": "string"
7231
7211
  },
7232
- {
7233
- "disabled": false,
7234
- "document": "最后一条记录ID",
7235
- "example": "无",
7236
- "member": "string",
7237
- "name": "LastRecordId",
7238
- "required": false,
7239
- "type": "string"
7240
- },
7241
7212
  {
7242
7213
  "disabled": false,
7243
7214
  "document": "应用AppKey, 当Type=5[API访客]时, 该字段必填 :</br> 获取方式:</br> 1、应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取</br> 2、参考 https://cloud.tencent.com/document/product/1759/109469 第二项",
@@ -7258,7 +7229,16 @@
7258
7229
  },
7259
7230
  {
7260
7231
  "disabled": false,
7261
- "document": "传该值,代表拉取该记录id的前后总共count条消息记录",
7232
+ "document": "最后一条记录ID, 消息从后往前获取\n\nMidRecordId与LastRecordId只能选择一个\n",
7233
+ "example": "无",
7234
+ "member": "string",
7235
+ "name": "LastRecordId",
7236
+ "required": false,
7237
+ "type": "string"
7238
+ },
7239
+ {
7240
+ "disabled": false,
7241
+ "document": "传该值,代表拉取该记录id的前后总共count条消息记录\n\nMidRecordId与LastRecordId只能选择一个\n",
7262
7242
  "example": "无",
7263
7243
  "member": "string",
7264
7244
  "name": "MidRecordId",
@@ -11711,24 +11691,6 @@
11711
11691
  "name": "CateBizId",
11712
11692
  "required": false,
11713
11693
  "type": "string"
11714
- },
11715
- {
11716
- "disabled": false,
11717
- "document": "文档的用户自定义ID",
11718
- "example": "无",
11719
- "member": "string",
11720
- "name": "CustomerKnowledgeId",
11721
- "required": false,
11722
- "type": "string"
11723
- },
11724
- {
11725
- "disabled": false,
11726
- "document": "文档的属性标记,0: 不做用户外部权限校验",
11727
- "example": "无",
11728
- "member": "uint64",
11729
- "name": "AttributeFlags",
11730
- "required": false,
11731
- "type": "list"
11732
11694
  }
11733
11695
  ],
11734
11696
  "type": "object"
@@ -14340,24 +14302,6 @@
14340
14302
  "name": "CateBizId",
14341
14303
  "required": false,
14342
14304
  "type": "string"
14343
- },
14344
- {
14345
- "disabled": false,
14346
- "document": "文档的用户自定义ID",
14347
- "example": "无",
14348
- "member": "string",
14349
- "name": "CustomerKnowledgeId",
14350
- "required": false,
14351
- "type": "string"
14352
- },
14353
- {
14354
- "disabled": false,
14355
- "document": "文档的属性标记,0: 不做用户外部权限校验",
14356
- "example": "无",
14357
- "member": "uint64",
14358
- "name": "AttributeFlags",
14359
- "required": false,
14360
- "type": "list"
14361
14305
  }
14362
14306
  ],
14363
14307
  "type": "object"
@@ -173,6 +173,58 @@ def doGetReconstructDocumentResult(args, parsed_globals):
173
173
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
174
174
 
175
175
 
176
+ def doRetrieveKnowledgeRealtime(args, parsed_globals):
177
+ g_param = parse_global_arg(parsed_globals)
178
+
179
+ if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
180
+ cred = credential.CVMRoleCredential()
181
+ elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
182
+ cred = credential.STSAssumeRoleCredential(
183
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
184
+ g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
185
+ )
186
+ 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):
187
+ cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
188
+ else:
189
+ cred = credential.Credential(
190
+ g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
191
+ )
192
+ http_profile = HttpProfile(
193
+ reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
194
+ reqMethod="POST",
195
+ endpoint=g_param[OptionsDefine.Endpoint],
196
+ proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
197
+ )
198
+ profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
199
+ if g_param[OptionsDefine.Language]:
200
+ profile.language = g_param[OptionsDefine.Language]
201
+ mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
202
+ client = mod.LkeapClient(cred, g_param[OptionsDefine.Region], profile)
203
+ client._sdkVersion += ("_CLI_" + __version__)
204
+ models = MODELS_MAP[g_param[OptionsDefine.Version]]
205
+ model = models.RetrieveKnowledgeRealtimeRequest()
206
+ model.from_json_string(json.dumps(args))
207
+ start_time = time.time()
208
+ while True:
209
+ rsp = client.RetrieveKnowledgeRealtime(model)
210
+ result = rsp.to_json_string()
211
+ try:
212
+ json_obj = json.loads(result)
213
+ except TypeError as e:
214
+ json_obj = json.loads(result.decode('utf-8')) # python3.3
215
+ if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
216
+ break
217
+ cur_time = time.time()
218
+ if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
219
+ raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
220
+ (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
221
+ search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
222
+ else:
223
+ print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
224
+ time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
225
+ FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
226
+
227
+
176
228
  def doGetSplitDocumentResult(args, parsed_globals):
177
229
  g_param = parse_global_arg(parsed_globals)
178
230
 
@@ -1265,58 +1317,6 @@ def doGetCharacterUsage(args, parsed_globals):
1265
1317
  FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1266
1318
 
1267
1319
 
1268
- def doUploadDocRealtime(args, parsed_globals):
1269
- g_param = parse_global_arg(parsed_globals)
1270
-
1271
- if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
1272
- cred = credential.CVMRoleCredential()
1273
- elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
1274
- cred = credential.STSAssumeRoleCredential(
1275
- g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
1276
- g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
1277
- )
1278
- 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):
1279
- cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
1280
- else:
1281
- cred = credential.Credential(
1282
- g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
1283
- )
1284
- http_profile = HttpProfile(
1285
- reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
1286
- reqMethod="POST",
1287
- endpoint=g_param[OptionsDefine.Endpoint],
1288
- proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
1289
- )
1290
- profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
1291
- if g_param[OptionsDefine.Language]:
1292
- profile.language = g_param[OptionsDefine.Language]
1293
- mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
1294
- client = mod.LkeapClient(cred, g_param[OptionsDefine.Region], profile)
1295
- client._sdkVersion += ("_CLI_" + __version__)
1296
- models = MODELS_MAP[g_param[OptionsDefine.Version]]
1297
- model = models.UploadDocRealtimeRequest()
1298
- model.from_json_string(json.dumps(args))
1299
- start_time = time.time()
1300
- while True:
1301
- rsp = client.UploadDocRealtime(model)
1302
- result = rsp.to_json_string()
1303
- try:
1304
- json_obj = json.loads(result)
1305
- except TypeError as e:
1306
- json_obj = json.loads(result.decode('utf-8')) # python3.3
1307
- if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
1308
- break
1309
- cur_time = time.time()
1310
- if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
1311
- raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
1312
- (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
1313
- search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
1314
- else:
1315
- print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
1316
- time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
1317
- FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
1318
-
1319
-
1320
1320
  def doUploadDoc(args, parsed_globals):
1321
1321
  g_param = parse_global_arg(parsed_globals)
1322
1322
 
@@ -1435,6 +1435,7 @@ ACTION_MAP = {
1435
1435
  "RetrieveKnowledge": doRetrieveKnowledge,
1436
1436
  "ModifyQA": doModifyQA,
1437
1437
  "GetReconstructDocumentResult": doGetReconstructDocumentResult,
1438
+ "RetrieveKnowledgeRealtime": doRetrieveKnowledgeRealtime,
1438
1439
  "GetSplitDocumentResult": doGetSplitDocumentResult,
1439
1440
  "DescribeDoc": doDescribeDoc,
1440
1441
  "ReconstructDocumentSSE": doReconstructDocumentSSE,
@@ -1456,7 +1457,6 @@ ACTION_MAP = {
1456
1457
  "DeleteKnowledgeBase": doDeleteKnowledgeBase,
1457
1458
  "CreateSplitDocumentFlow": doCreateSplitDocumentFlow,
1458
1459
  "GetCharacterUsage": doGetCharacterUsage,
1459
- "UploadDocRealtime": doUploadDocRealtime,
1460
1460
  "UploadDoc": doUploadDoc,
1461
1461
  "ChatCompletions": doChatCompletions,
1462
1462
 
@@ -168,6 +168,13 @@
168
168
  "output": "RetrieveKnowledgeResponse",
169
169
  "status": "online"
170
170
  },
171
+ "RetrieveKnowledgeRealtime": {
172
+ "document": "用于实时检索在UploadDocRealtime接口上传的实时文档内容。 使用场景:适用于在会话中对文档进行问答的场景",
173
+ "input": "RetrieveKnowledgeRealtimeRequest",
174
+ "name": "实时检索知识库内容",
175
+ "output": "RetrieveKnowledgeRealtimeResponse",
176
+ "status": "online"
177
+ },
171
178
  "RunRerank": {
172
179
  "document": "基于知识引擎精调模型技术的rerank模型,支持对多路召回的结果进行重排序,根据query与切片内容的相关性,按分数由高到低对切片进行排序,并输出对应的打分结果。",
173
180
  "input": "RunRerankRequest",
@@ -181,13 +188,6 @@
181
188
  "name": "上传文档",
182
189
  "output": "UploadDocResponse",
183
190
  "status": "online"
184
- },
185
- "UploadDocRealtime": {
186
- "document": "用于上传实时文档内容。\n实时文档在上传后可以立即通过SearchRealtime进行实时检索,适用于在会话中对文档进行问答的场景。",
187
- "input": "UploadDocRealtimeRequest",
188
- "name": "实时文档上传",
189
- "output": "UploadDocRealtimeResponse",
190
- "status": "online"
191
191
  }
192
192
  },
193
193
  "metadata": {
@@ -2371,6 +2371,89 @@
2371
2371
  ],
2372
2372
  "usage": "in"
2373
2373
  },
2374
+ "RetrieveKnowledgeRealtimeRequest": {
2375
+ "document": "RetrieveKnowledgeRealtime请求参数结构体",
2376
+ "members": [
2377
+ {
2378
+ "disabled": false,
2379
+ "document": "知识库ID。",
2380
+ "example": "1840331836752986944",
2381
+ "member": "string",
2382
+ "name": "KnowledgeBaseId",
2383
+ "required": true,
2384
+ "type": "string"
2385
+ },
2386
+ {
2387
+ "disabled": false,
2388
+ "document": "用于检索的文本。",
2389
+ "example": "国庆放几天假",
2390
+ "member": "string",
2391
+ "name": "Query",
2392
+ "required": true,
2393
+ "type": "string"
2394
+ },
2395
+ {
2396
+ "disabled": false,
2397
+ "document": "实时文件ID列表。",
2398
+ "example": "[\"1828720159590123264\"]",
2399
+ "member": "string",
2400
+ "name": "DocIds",
2401
+ "required": false,
2402
+ "type": "list"
2403
+ },
2404
+ {
2405
+ "disabled": false,
2406
+ "document": "检索方法,默认使用`HYBRID`混合检索。\n- `SEMANTIC`:语义检索\n- `FULL_TEXT`:全文检索\n- `HYBRID`:混合检索",
2407
+ "example": "SEMANTIC",
2408
+ "member": "string",
2409
+ "name": "RetrievalMethod",
2410
+ "required": false,
2411
+ "type": "string"
2412
+ },
2413
+ {
2414
+ "disabled": false,
2415
+ "document": "检索设置。",
2416
+ "example": "{\"TopK\":3,\"ScoreThreshold\":0.7}",
2417
+ "member": "RetrievalSetting",
2418
+ "name": "RetrievalSetting",
2419
+ "required": false,
2420
+ "type": "object"
2421
+ }
2422
+ ],
2423
+ "type": "object"
2424
+ },
2425
+ "RetrieveKnowledgeRealtimeResponse": {
2426
+ "document": "RetrieveKnowledgeRealtime返回参数结构体",
2427
+ "members": [
2428
+ {
2429
+ "disabled": false,
2430
+ "document": "检索结果",
2431
+ "example": "[{\"Metadata\":{\"Type\":\"DOC\",\"ResultSource\":\"SEMANTIC\",\"ChunkPageNumbers\":[1,2]},\"Score\":0,\"Title\":\"example.pdf\",\"Content\":\"国庆放7天假\"}]",
2432
+ "member": "RetrievalRecord",
2433
+ "name": "Records",
2434
+ "output_required": false,
2435
+ "type": "list",
2436
+ "value_allowed_null": false
2437
+ },
2438
+ {
2439
+ "disabled": false,
2440
+ "document": "检索结果数量",
2441
+ "example": "3",
2442
+ "member": "uint64",
2443
+ "name": "TotalCount",
2444
+ "output_required": false,
2445
+ "type": "int",
2446
+ "value_allowed_null": false
2447
+ },
2448
+ {
2449
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2450
+ "member": "string",
2451
+ "name": "RequestId",
2452
+ "type": "string"
2453
+ }
2454
+ ],
2455
+ "type": "object"
2456
+ },
2374
2457
  "RetrieveKnowledgeRequest": {
2375
2458
  "document": "RetrieveKnowledge请求参数结构体",
2376
2459
  "members": [
@@ -2633,69 +2716,6 @@
2633
2716
  ],
2634
2717
  "usage": "out"
2635
2718
  },
2636
- "UploadDocRealtimeRequest": {
2637
- "document": "UploadDocRealtime请求参数结构体",
2638
- "members": [
2639
- {
2640
- "disabled": false,
2641
- "document": "知识库ID",
2642
- "example": "4901991032",
2643
- "member": "string",
2644
- "name": "KnowledgeBaseId",
2645
- "required": true,
2646
- "type": "string"
2647
- },
2648
- {
2649
- "disabled": false,
2650
- "document": "文件名,可选。\n**需带文件类型后缀**,当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。",
2651
- "example": "example.pdf",
2652
- "member": "string",
2653
- "name": "FileName",
2654
- "required": true,
2655
- "type": "string"
2656
- },
2657
- {
2658
- "disabled": false,
2659
- "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",
2660
- "example": "PDF",
2661
- "member": "string",
2662
- "name": "FileType",
2663
- "required": true,
2664
- "type": "string"
2665
- },
2666
- {
2667
- "disabled": false,
2668
- "document": "文件的 URL 地址。\n文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。\n参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
2669
- "example": "https://example.com/example.pdf",
2670
- "member": "string",
2671
- "name": "FileUrl",
2672
- "required": true,
2673
- "type": "string"
2674
- },
2675
- {
2676
- "disabled": false,
2677
- "document": "过期时间的秒数,最长24小时,默认24小时",
2678
- "example": "86400",
2679
- "member": "int64",
2680
- "name": "ExpireTime",
2681
- "required": false,
2682
- "type": "int"
2683
- }
2684
- ],
2685
- "type": "object"
2686
- },
2687
- "UploadDocRealtimeResponse": {
2688
- "document": "UploadDocRealtime返回参数结构体",
2689
- "members": [
2690
- {
2691
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header \"X-TC-RequestId\" 中。",
2692
- "member": "string",
2693
- "name": "RequestId",
2694
- "type": "string"
2695
- }
2696
- ],
2697
- "type": "object"
2698
- },
2699
2719
  "UploadDocRequest": {
2700
2720
  "document": "UploadDoc请求参数结构体",
2701
2721
  "members": [
@@ -216,6 +216,14 @@
216
216
  "title": "语义检索(问答对)"
217
217
  }
218
218
  ],
219
+ "RetrieveKnowledgeRealtime": [
220
+ {
221
+ "document": "实时语义检索",
222
+ "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}",
223
+ "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}",
224
+ "title": "实时语义检索"
225
+ }
226
+ ],
219
227
  "RunRerank": [
220
228
  {
221
229
  "document": "重排序",
@@ -231,14 +239,6 @@
231
239
  "output": "{\n \"Response\": {\n \"DocId\": \"1830996257459865536\",\n \"RequestId\": \"804c3fe0-05b1-48f9-8003-ab118658fec7\"\n }\n}",
232
240
  "title": "上传无属性标签文档"
233
241
  }
234
- ],
235
- "UploadDocRealtime": [
236
- {
237
- "document": "实时文档上传",
238
- "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}",
239
- "output": "{\n\t\"IsFinal\": true,\n\t\"DocId\": \"1828430526517084160\",\n\t\"Progress\": 80,\n\t\"PageNum\": 0,\n\t\"Status\": \"SUCCESS\"\n}",
240
- "title": "实时文档上传"
241
- }
242
242
  ]
243
243
  },
244
244
  "version": "1.0"