tccli 3.0.1388.1__py2.py3-none-any.whl → 3.0.1390.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 (85) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/ai3d/ai3d_client.py +106 -0
  4. tccli/services/ai3d/v20250513/api.json +172 -0
  5. tccli/services/ai3d/v20250513/examples.json +16 -0
  6. tccli/services/batch/v20170312/api.json +3 -3
  7. tccli/services/batch/v20170312/examples.json +3 -3
  8. tccli/services/bi/v20220105/api.json +8 -8
  9. tccli/services/bi/v20220105/examples.json +4 -4
  10. tccli/services/cam/v20190116/api.json +11 -1
  11. tccli/services/ccc/v20200210/api.json +10 -10
  12. tccli/services/cdb/v20170320/api.json +40 -2
  13. tccli/services/cdc/v20201214/api.json +1 -1
  14. tccli/services/cdc/v20201214/examples.json +2 -2
  15. tccli/services/cdn/v20180606/api.json +1 -1
  16. tccli/services/cdz/v20221123/api.json +1 -1
  17. tccli/services/chc/v20230418/api.json +69 -1
  18. tccli/services/ckafka/v20190819/api.json +141 -124
  19. tccli/services/ckafka/v20190819/examples.json +8 -8
  20. tccli/services/cloudapp/cloudapp_client.py +53 -0
  21. tccli/services/cloudapp/v20220530/api.json +68 -0
  22. tccli/services/cloudapp/v20220530/examples.json +14 -0
  23. tccli/services/cls/cls_client.py +167 -8
  24. tccli/services/cls/v20201016/api.json +373 -6
  25. tccli/services/cls/v20201016/examples.json +25 -1
  26. tccli/services/ctem/v20231128/api.json +40 -0
  27. tccli/services/dc/v20180410/api.json +26 -6
  28. tccli/services/dts/v20211206/api.json +21 -21
  29. tccli/services/dts/v20211206/examples.json +2 -2
  30. tccli/services/emr/v20190103/api.json +172 -11
  31. tccli/services/es/v20180416/api.json +4 -4
  32. tccli/services/es/v20250101/api.json +218 -13
  33. tccli/services/ess/v20201111/api.json +175 -5
  34. tccli/services/ess/v20201111/examples.json +1 -1
  35. tccli/services/essbasic/v20210526/api.json +21 -3
  36. tccli/services/gme/gme_client.py +509 -32
  37. tccli/services/gme/v20180711/api.json +1179 -53
  38. tccli/services/gme/v20180711/examples.json +72 -0
  39. tccli/services/hunyuan/v20230901/api.json +18 -0
  40. tccli/services/igtm/v20231024/api.json +3 -3
  41. tccli/services/ioa/v20220601/api.json +44 -8
  42. tccli/services/ioa/v20220601/examples.json +4 -4
  43. tccli/services/iotexplorer/iotexplorer_client.py +432 -8
  44. tccli/services/iotexplorer/v20190423/api.json +990 -36
  45. tccli/services/iotexplorer/v20190423/examples.json +65 -1
  46. tccli/services/lighthouse/lighthouse_client.py +53 -0
  47. tccli/services/lighthouse/v20200324/api.json +246 -35
  48. tccli/services/lighthouse/v20200324/examples.json +8 -0
  49. tccli/services/live/v20180801/api.json +3 -3
  50. tccli/services/live/v20180801/examples.json +1 -1
  51. tccli/services/lkeap/v20240522/api.json +18 -0
  52. tccli/services/lowcode/lowcode_client.py +163 -4
  53. tccli/services/lowcode/v20210108/api.json +1373 -96
  54. tccli/services/lowcode/v20210108/examples.json +24 -0
  55. tccli/services/mps/v20190612/api.json +804 -47
  56. tccli/services/mqtt/v20240516/api.json +89 -0
  57. tccli/services/ocr/ocr_client.py +114 -8
  58. tccli/services/ocr/v20181119/api.json +225 -0
  59. tccli/services/ocr/v20181119/examples.json +28 -0
  60. tccli/services/sqlserver/v20180328/api.json +4 -4
  61. tccli/services/tcbr/v20220217/api.json +51 -0
  62. tccli/services/tdai/__init__.py +4 -0
  63. tccli/services/tdai/tdai_client.py +1108 -0
  64. tccli/services/tdai/v20250717/api.json +1930 -0
  65. tccli/services/tdai/v20250717/examples.json +149 -0
  66. tccli/services/teo/teo_client.py +53 -0
  67. tccli/services/teo/v20220901/api.json +111 -3
  68. tccli/services/teo/v20220901/examples.json +8 -0
  69. tccli/services/thpc/v20230321/api.json +1 -1
  70. tccli/services/thpc/v20230321/examples.json +2 -2
  71. tccli/services/tione/v20211111/api.json +9 -9
  72. tccli/services/tmt/v20180321/api.json +3 -3
  73. tccli/services/tsf/v20180326/api.json +2 -2
  74. tccli/services/tts/v20190823/api.json +11 -11
  75. tccli/services/vpc/v20170312/api.json +37 -7
  76. tccli/services/vpc/v20170312/examples.json +7 -7
  77. tccli/services/vtc/v20240223/api.json +3 -1
  78. tccli/services/vtc/v20240223/examples.json +1 -1
  79. tccli/services/waf/v20180125/api.json +6 -6
  80. tccli/services/wsa/v20250508/api.json +2 -2
  81. {tccli-3.0.1388.1.dist-info → tccli-3.0.1390.1.dist-info}/METADATA +2 -2
  82. {tccli-3.0.1388.1.dist-info → tccli-3.0.1390.1.dist-info}/RECORD +85 -81
  83. {tccli-3.0.1388.1.dist-info → tccli-3.0.1390.1.dist-info}/WHEEL +0 -0
  84. {tccli-3.0.1388.1.dist-info → tccli-3.0.1390.1.dist-info}/entry_points.txt +0 -0
  85. {tccli-3.0.1388.1.dist-info → tccli-3.0.1390.1.dist-info}/license_files/LICENSE +0 -0
@@ -77,7 +77,7 @@
77
77
  {
78
78
  "disabled": false,
79
79
  "document": "会话内容,按对话时间从旧到新在数组中排列,长度受模型窗口大小限制。",
80
- "example": "[{}]",
80
+ "example": "",
81
81
  "member": "Message",
82
82
  "name": "Messages",
83
83
  "required": true,
@@ -95,7 +95,7 @@
95
95
  {
96
96
  "disabled": false,
97
97
  "document": "是否以流式接口的形式返回数据,默认true。",
98
- "example": "是否以流式接口的形式返回数据,默认false",
98
+ "example": "true",
99
99
  "member": "bool",
100
100
  "name": "Stream",
101
101
  "required": false,
@@ -131,11 +131,38 @@
131
131
  {
132
132
  "disabled": false,
133
133
  "document": "当 OnlineSearch 为 true 时,指定的搜索引擎,默认为 bing。",
134
- "example": "{\"Engine\": \"bing\"}",
134
+ "example": "",
135
135
  "member": "OnlineSearchOptions",
136
136
  "name": "OnlineSearchOptions",
137
137
  "required": false,
138
138
  "type": "object"
139
+ },
140
+ {
141
+ "disabled": false,
142
+ "document": "可调用的工具列表,当前支持模型:hunyuan-turbo, deepseek-v3。",
143
+ "example": "无",
144
+ "member": "Tool",
145
+ "name": "Tools",
146
+ "required": false,
147
+ "type": "list"
148
+ },
149
+ {
150
+ "disabled": false,
151
+ "document": "工具使用选项,可选值包括 none、auto、custom。说明:1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none:不调用工具;auto:模型自行选择生成回复或调用工具;custom:强制模型调用指定的工具。3. 未设置时,默认值为auto",
152
+ "example": "auto",
153
+ "member": "string",
154
+ "name": "ToolChoice",
155
+ "required": false,
156
+ "type": "string"
157
+ },
158
+ {
159
+ "disabled": false,
160
+ "document": "强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填",
161
+ "example": "无",
162
+ "member": "Tool",
163
+ "name": "CustomTool",
164
+ "required": false,
165
+ "type": "object"
139
166
  }
140
167
  ],
141
168
  "type": "object"
@@ -166,7 +193,7 @@
166
193
  {
167
194
  "disabled": false,
168
195
  "document": "token使用量",
169
- "example": "{\"PromptTokens\":324,\"CompletionTokens\":309,\"TotalTokens\":633}",
196
+ "example": "",
170
197
  "member": "TokenUsage",
171
198
  "name": "Usage",
172
199
  "output_required": false,
@@ -176,7 +203,7 @@
176
203
  {
177
204
  "disabled": false,
178
205
  "document": "联网搜索结果。\n注意:此字段可能返回 null,表示取不到有效值。",
179
- "example": "[{}]",
206
+ "example": "",
180
207
  "member": "WebContent",
181
208
  "name": "OnlineSearchContent",
182
209
  "output_required": false,
@@ -299,7 +326,7 @@
299
326
  {
300
327
  "disabled": false,
301
328
  "document": "文件类型,支持 MD,TXT 格式。",
302
- "example": "MD",
329
+ "example": "TXT",
303
330
  "member": "string",
304
331
  "name": "FileType",
305
332
  "output_required": false,
@@ -310,7 +337,7 @@
310
337
  {
311
338
  "disabled": false,
312
339
  "document": "文本原文,使用字符串格式输入。",
313
- "example": "53847824487347829",
340
+ "example": "hello,world",
314
341
  "member": "string",
315
342
  "name": "FileContent",
316
343
  "output_required": false,
@@ -446,8 +473,8 @@
446
473
  "members": [
447
474
  {
448
475
  "disabled": false,
449
- "document": "文件类型。\n支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2\n支持的文件大小:\n- PDF、DOC、DOCX、PPT、PPTX 支持100M\n- MD、TXT、XLS、XLSX、CSV 支持10M\n- 其他支持20M",
450
- "example": "md",
476
+ "document": "支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、\nXLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、\nIM、PCX、PPM、TIFF、XBM、HEIF、JP2\n\n文档解析支持的文件大小:\n-PDF、DOC、DOCX、PPT、PPTX支持100M\n-MD、TXT、XLS、XLSX、CSV支特10M\n-其他支持20M\n\n文本切片支持的文件大小:\n-PDF最大300M\n-D0CX、D0C、PPT、PPTX最大200M\n-TXT、MD最大10M\n-其他最大20M",
477
+ "example": "DOC",
451
478
  "member": "string",
452
479
  "name": "FileType",
453
480
  "output_required": false,
@@ -769,7 +796,7 @@
769
796
  "members": [
770
797
  {
771
798
  "disabled": false,
772
- "document": "角色, system', ‘user','assistant'或者'tool', 在message中, 除了system,其他必须是user与assistant交替(一问一答) ",
799
+ "document": "角色,可选值包括 systemuserassistanttool",
773
800
  "example": "user",
774
801
  "member": "string",
775
802
  "name": "Role",
@@ -788,6 +815,28 @@
788
815
  "required": false,
789
816
  "type": "string",
790
817
  "value_allowed_null": false
818
+ },
819
+ {
820
+ "disabled": false,
821
+ "document": "当role为tool时传入,标识具体的函数调用",
822
+ "example": "call_cq16e7k2c3m1v",
823
+ "member": "string",
824
+ "name": "ToolCallId",
825
+ "output_required": false,
826
+ "required": false,
827
+ "type": "string",
828
+ "value_allowed_null": false
829
+ },
830
+ {
831
+ "disabled": false,
832
+ "document": "模型生成的工具调用",
833
+ "example": "无",
834
+ "member": "ToolCall",
835
+ "name": "ToolCalls",
836
+ "output_required": false,
837
+ "required": false,
838
+ "type": "list",
839
+ "value_allowed_null": false
791
840
  }
792
841
  ],
793
842
  "usage": "both"
@@ -844,6 +893,17 @@
844
893
  "required": false,
845
894
  "type": "string",
846
895
  "value_allowed_null": false
896
+ },
897
+ {
898
+ "disabled": false,
899
+ "document": "模型生成的工具调用",
900
+ "example": "无",
901
+ "member": "ToolCall",
902
+ "name": "ToolCalls",
903
+ "output_required": false,
904
+ "required": false,
905
+ "type": "list",
906
+ "value_allowed_null": false
847
907
  }
848
908
  ],
849
909
  "usage": "both"
@@ -870,8 +930,8 @@
870
930
  "members": [
871
931
  {
872
932
  "disabled": false,
873
- "document": "文件类型。\n支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2\n支持的文件大小:\n- PDF、DOC、DOCX、PPT、PPTX 支持100M\n- MD、TXT、XLS、XLSX、CSV 支持10M\n- 其他支持20M",
874
- "example": "md",
933
+ "document": "支持的文件类型:PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、\nXLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、\nIM、PCX、PPM、TIFF、XBM、HEIF、JP2\n\n文档解析支持的文件大小:\n-PDF、DOC、DOCX、PPT、PPTX支持100M\n-MD、TXT、XLS、XLSX、CSV支特10M\n-其他支持20M\n\n文本切片支持的文件大小:\n-PDF最大300M\n-D0CX、D0C、PPT、PPTX最大200M\n-TXT、MD最大10M\n-其他最大20M",
934
+ "example": "PDF",
875
935
  "member": "string",
876
936
  "name": "FileType",
877
937
  "output_required": false,
@@ -892,7 +952,7 @@
892
952
  },
893
953
  {
894
954
  "disabled": false,
895
- "document": "文件的 base64 值,携带 MineType前缀信息。编码后的后的文件不超过 10M。\n支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。\n支持的图片像素:单边介于20-10000px之间。",
955
+ "document": "文件的 base64 值,携带 MineType前缀信息。编码后的后的文件不超过 10M。\n支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。\n支持的图片像素:单边介于20-10000px之间。\n文件的 FileUrl、FileContent必须提供一个,如果都提供只使用 FileUrl。",
896
956
  "example": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==",
897
957
  "member": "string",
898
958
  "name": "FileContent",
@@ -1217,6 +1277,151 @@
1217
1277
  ],
1218
1278
  "usage": "both"
1219
1279
  },
1280
+ "Tool": {
1281
+ "document": "用户指定模型使用的工具",
1282
+ "members": [
1283
+ {
1284
+ "disabled": false,
1285
+ "document": "工具类型,当前只支持function",
1286
+ "example": "function",
1287
+ "member": "string",
1288
+ "name": "Type",
1289
+ "output_required": false,
1290
+ "required": true,
1291
+ "type": "string",
1292
+ "value_allowed_null": false
1293
+ },
1294
+ {
1295
+ "disabled": false,
1296
+ "document": "具体要调用的function",
1297
+ "example": "无",
1298
+ "member": "ToolFunction",
1299
+ "name": "Function",
1300
+ "output_required": false,
1301
+ "required": true,
1302
+ "type": "object",
1303
+ "value_allowed_null": false
1304
+ }
1305
+ ],
1306
+ "usage": "both"
1307
+ },
1308
+ "ToolCall": {
1309
+ "document": "模型生成的工具调用",
1310
+ "members": [
1311
+ {
1312
+ "disabled": false,
1313
+ "document": "工具调用id",
1314
+ "example": "call_cpv320k2c3m8fgcs8ja0",
1315
+ "member": "string",
1316
+ "name": "Id",
1317
+ "output_required": true,
1318
+ "required": false,
1319
+ "type": "string",
1320
+ "value_allowed_null": false
1321
+ },
1322
+ {
1323
+ "disabled": false,
1324
+ "document": "工具调用类型,当前只支持function",
1325
+ "example": "function",
1326
+ "member": "string",
1327
+ "name": "Type",
1328
+ "output_required": true,
1329
+ "required": false,
1330
+ "type": "string",
1331
+ "value_allowed_null": false
1332
+ },
1333
+ {
1334
+ "disabled": false,
1335
+ "document": "具体的function调用",
1336
+ "example": "无",
1337
+ "member": "ToolCallFunction",
1338
+ "name": "Function",
1339
+ "output_required": true,
1340
+ "required": false,
1341
+ "type": "object",
1342
+ "value_allowed_null": false
1343
+ },
1344
+ {
1345
+ "disabled": false,
1346
+ "document": "索引值",
1347
+ "example": "0",
1348
+ "member": "uint64",
1349
+ "name": "Index",
1350
+ "output_required": false,
1351
+ "required": false,
1352
+ "type": "int",
1353
+ "value_allowed_null": false
1354
+ }
1355
+ ],
1356
+ "usage": "both"
1357
+ },
1358
+ "ToolCallFunction": {
1359
+ "document": "具体的function调用",
1360
+ "members": [
1361
+ {
1362
+ "disabled": false,
1363
+ "document": "function名称",
1364
+ "example": "get_current_weather",
1365
+ "member": "string",
1366
+ "name": "Name",
1367
+ "output_required": true,
1368
+ "required": false,
1369
+ "type": "string",
1370
+ "value_allowed_null": false
1371
+ },
1372
+ {
1373
+ "disabled": false,
1374
+ "document": "function参数,一般为json字符串",
1375
+ "example": "{\"location\":[\"北京\",\"深圳\"],\"unit\":\"celsius\"}",
1376
+ "member": "string",
1377
+ "name": "Arguments",
1378
+ "output_required": true,
1379
+ "required": false,
1380
+ "type": "string",
1381
+ "value_allowed_null": false
1382
+ }
1383
+ ],
1384
+ "usage": "both"
1385
+ },
1386
+ "ToolFunction": {
1387
+ "document": "function定义",
1388
+ "members": [
1389
+ {
1390
+ "disabled": false,
1391
+ "document": "function名称,只能包含a-z,A-Z,0-9,_或-",
1392
+ "example": "get_current_weather",
1393
+ "member": "string",
1394
+ "name": "Name",
1395
+ "output_required": false,
1396
+ "required": true,
1397
+ "type": "string",
1398
+ "value_allowed_null": false
1399
+ },
1400
+ {
1401
+ "disabled": false,
1402
+ "document": "function参数,一般为json字符串",
1403
+ "example": "{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"}},\"required\":[\"location\",\"unit\"]}",
1404
+ "member": "string",
1405
+ "name": "Parameters",
1406
+ "output_required": false,
1407
+ "required": true,
1408
+ "type": "string",
1409
+ "value_allowed_null": false
1410
+ },
1411
+ {
1412
+ "disabled": false,
1413
+ "document": "function的简单描述",
1414
+ "example": "获取当前地点的天气",
1415
+ "member": "string",
1416
+ "name": "Description",
1417
+ "output_required": false,
1418
+ "required": false,
1419
+ "type": "string",
1420
+ "value_allowed_null": false
1421
+ }
1422
+ ],
1423
+ "usage": "both"
1424
+ },
1220
1425
  "Usage": {
1221
1426
  "document": "token消耗总数",
1222
1427
  "members": [
@@ -1144,6 +1144,15 @@
1144
1144
  "name": "SignEndpoints",
1145
1145
  "required": false,
1146
1146
  "type": "list"
1147
+ },
1148
+ {
1149
+ "disabled": false,
1150
+ "document": "快速注册相关信息\n",
1151
+ "example": "无",
1152
+ "member": "RegisterInfo",
1153
+ "name": "RegisterInfo",
1154
+ "required": false,
1155
+ "type": "object"
1147
1156
  }
1148
1157
  ],
1149
1158
  "usage": "in"
@@ -3628,7 +3637,7 @@
3628
3637
  },
3629
3638
  {
3630
3639
  "disabled": false,
3631
- "document": "是否为预览模式,取值如下:\n<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> \n<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color=\"red\">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font> </li></ul>\n注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`",
3640
+ "document": "是否为预览模式,取值如下:<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color=\"red\">注意: 1.以预览模式创建的合同仅供查看,因此参与方无法进行签署操作;;2.以预览模式调用该接口返回的FlowId为临时Flowld,无法用于发起和拉取信息。</font> </li></ul>注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容,动态表格合成完后会触发文档合成完成的回调通知`",
3632
3641
  "example": "false",
3633
3642
  "member": "bool",
3634
3643
  "name": "NeedPreview",
@@ -6317,7 +6326,7 @@
6317
6326
  "type": "int"
6318
6327
  },
6319
6328
  {
6320
- "disabled": false,
6329
+ "disabled": true,
6321
6330
  "document": "二维码的有效期限,默认为7天,最高设定不得超过90天。\n一旦超过二维码的有效期限,该二维码将自动失效。",
6322
6331
  "example": "7",
6323
6332
  "member": "int64",
@@ -6405,6 +6414,24 @@
6405
6414
  "name": "FlowNameAppendScannerInfo",
6406
6415
  "required": false,
6407
6416
  "type": "bool"
6417
+ },
6418
+ {
6419
+ "disabled": false,
6420
+ "document": "签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName",
6421
+ "example": "测试签署码",
6422
+ "member": "string",
6423
+ "name": "QrCodeName",
6424
+ "required": false,
6425
+ "type": "string"
6426
+ },
6427
+ {
6428
+ "disabled": false,
6429
+ "document": "签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。",
6430
+ "example": "1757416261",
6431
+ "member": "int64",
6432
+ "name": "QrCodeExpiredOn",
6433
+ "required": false,
6434
+ "type": "int"
6408
6435
  }
6409
6436
  ],
6410
6437
  "type": "object"
@@ -10862,8 +10889,8 @@
10862
10889
  "members": [
10863
10890
  {
10864
10891
  "disabled": false,
10865
- "document": "信息提取任务结果",
10866
- "example": "[{\"Description\":\"PDF文件中的机构名称\",\"Name\":\"机构名称\",\"Type\":\"TEXT\",\"Values\":[\"广州xxxx有限公司\"]},{\"Description\":\"\",\"Name\":\"社会信用代码\",\"Type\":\"TEXT\",\"Values\":[\"91440xxxxT\"]}]",
10892
+ "document": "合同信息提取字段信息",
10893
+ "example": "",
10867
10894
  "member": "ExtractionField",
10868
10895
  "name": "Fields",
10869
10896
  "output_required": false,
@@ -10890,6 +10917,16 @@
10890
10917
  "type": "string",
10891
10918
  "value_allowed_null": false
10892
10919
  },
10920
+ {
10921
+ "disabled": false,
10922
+ "document": "合同信息提取结果信息",
10923
+ "example": "无",
10924
+ "member": "ExtractionTaskResult",
10925
+ "name": "Results",
10926
+ "output_required": false,
10927
+ "type": "list",
10928
+ "value_allowed_null": false
10929
+ },
10893
10930
  {
10894
10931
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
10895
10932
  "member": "string",
@@ -12334,6 +12371,117 @@
12334
12371
  ],
12335
12372
  "usage": "both"
12336
12373
  },
12374
+ "ExtractionFieldResult": {
12375
+ "document": "合同信息提取字段值信息。",
12376
+ "members": [
12377
+ {
12378
+ "disabled": false,
12379
+ "document": "字段ID",
12380
+ "example": "yDxxxxx",
12381
+ "member": "string",
12382
+ "name": "Id",
12383
+ "output_required": false,
12384
+ "required": false,
12385
+ "type": "string",
12386
+ "value_allowed_null": false
12387
+ },
12388
+ {
12389
+ "disabled": false,
12390
+ "document": "用于合同智能提取的字段名称。",
12391
+ "example": "甲方",
12392
+ "member": "string",
12393
+ "name": "Name",
12394
+ "output_required": false,
12395
+ "required": false,
12396
+ "type": "string",
12397
+ "value_allowed_null": false
12398
+ },
12399
+ {
12400
+ "disabled": false,
12401
+ "document": "合同智能提取的字段类型,目前仅支持TEXT、DATE、NUMBER、OPTION类型。\n\n类型支持如下: 1、TEXT(文本) 2、DATE(日期) 3、NUMBER(数字) 4、OPTION(选项值)",
12402
+ "example": "TEXT",
12403
+ "member": "string",
12404
+ "name": "Type",
12405
+ "output_required": false,
12406
+ "required": false,
12407
+ "type": "string",
12408
+ "value_allowed_null": false
12409
+ },
12410
+ {
12411
+ "disabled": false,
12412
+ "document": "提取出合同中的字段信息。",
12413
+ "example": "[\"张三\"]",
12414
+ "member": "string",
12415
+ "name": "Values",
12416
+ "output_required": false,
12417
+ "required": false,
12418
+ "type": "list",
12419
+ "value_allowed_null": false
12420
+ },
12421
+ {
12422
+ "disabled": false,
12423
+ "document": "是否需要语义提取,默认为false",
12424
+ "example": "false",
12425
+ "member": "bool",
12426
+ "name": "RequiresSemanticExtraction",
12427
+ "output_required": false,
12428
+ "required": false,
12429
+ "type": "bool",
12430
+ "value_allowed_null": false
12431
+ },
12432
+ {
12433
+ "disabled": false,
12434
+ "document": "提取出值在合同中的坐标位置信息",
12435
+ "example": "无",
12436
+ "member": "PositionInfo",
12437
+ "name": "Positions",
12438
+ "output_required": false,
12439
+ "required": false,
12440
+ "type": "list",
12441
+ "value_allowed_null": false
12442
+ }
12443
+ ],
12444
+ "usage": "both"
12445
+ },
12446
+ "ExtractionTaskResult": {
12447
+ "document": "合同信息提取结果",
12448
+ "members": [
12449
+ {
12450
+ "disabled": false,
12451
+ "document": "用于合同信息提取的资源ID。",
12452
+ "example": "yDtIgUU2vxu",
12453
+ "member": "string",
12454
+ "name": "ResourceId",
12455
+ "output_required": false,
12456
+ "required": false,
12457
+ "type": "string",
12458
+ "value_allowed_null": false
12459
+ },
12460
+ {
12461
+ "disabled": false,
12462
+ "document": "用于合同信息提取的资源名称。",
12463
+ "example": "示例文件.pdf",
12464
+ "member": "string",
12465
+ "name": "ResourceName",
12466
+ "output_required": false,
12467
+ "required": false,
12468
+ "type": "string",
12469
+ "value_allowed_null": false
12470
+ },
12471
+ {
12472
+ "disabled": false,
12473
+ "document": "根据当前合同提取出的字段信息",
12474
+ "example": "无",
12475
+ "member": "ExtractionFieldResult",
12476
+ "name": "ExtractionFieldResults",
12477
+ "output_required": false,
12478
+ "required": false,
12479
+ "type": "list",
12480
+ "value_allowed_null": false
12481
+ }
12482
+ ],
12483
+ "usage": "both"
12484
+ },
12337
12485
  "FailedCreateRoleData": {
12338
12486
  "document": "绑定角色失败信息",
12339
12487
  "members": [
@@ -14608,6 +14756,17 @@
14608
14756
  "required": false,
14609
14757
  "type": "int",
14610
14758
  "value_allowed_null": false
14759
+ },
14760
+ {
14761
+ "disabled": false,
14762
+ "document": "小程序集成发起,是否禁止发起时修改合同内容\n<ul>\n<li>false:默认值,不禁止发起时修改合同内容</li>\n<li>true:禁止发起时修改合同内容</li>\n</ul>",
14763
+ "example": "true",
14764
+ "member": "bool",
14765
+ "name": "ForbidEditFlow",
14766
+ "output_required": false,
14767
+ "required": false,
14768
+ "type": "bool",
14769
+ "value_allowed_null": false
14611
14770
  }
14612
14771
  ],
14613
14772
  "usage": "both"
@@ -16531,7 +16690,7 @@
16531
16690
  {
16532
16691
  "disabled": true,
16533
16692
  "document": "社会统一信用代码\n注意:此字段可能返回 null,表示取不到有效值。",
16534
- "example": "",
16693
+ "example": "91110108772551611J",
16535
16694
  "member": "string",
16536
16695
  "name": "Uscc",
16537
16696
  "output_required": false,
@@ -16550,6 +16709,17 @@
16550
16709
  "type": "string",
16551
16710
  "value_allowed_null": false
16552
16711
  },
16712
+ {
16713
+ "disabled": false,
16714
+ "document": "组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。",
16715
+ "example": "深圳市南山区高新区科技中一路腾讯大厦",
16716
+ "member": "string",
16717
+ "name": "OrganizationAddress",
16718
+ "output_required": false,
16719
+ "required": false,
16720
+ "type": "string",
16721
+ "value_allowed_null": false
16722
+ },
16553
16723
  {
16554
16724
  "disabled": true,
16555
16725
  "document": "指定企业认证的授权方式 支持多选:\n\n<ul>\n<li><strong>2</strong>: 法人授权方式</li>\n<li><strong>5</strong>: 授权书+对公打款方式</li>\n</ul>",
@@ -1654,7 +1654,7 @@
1654
1654
  {
1655
1655
  "document": "",
1656
1656
  "input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInformationExtractionTask\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDx************************xxx\"\n },\n \"TaskId\": \"yDx************************yyy\"\n}",
1657
- "output": "{\n \"Response\": {\n \"Fields\": [\n {\n \"Name\": \"甲方\",\n \"Values\": [\n \"张三\",\n \"李四\"\n ],\n \"Type\": \"Text\",\n \"Description\": \"提取甲方信息\"\n }\n ],\n \"Status\": 3,\n \"Url\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=c83cf852247f9075f675f350e6d6ebeda61fa2d74d136f8efccdde201dc72cb280dcd8992c91808c55817c57c4bf87f718adfa54bf152500e9a45beb6cc9f697a0c938dc46f2abe3288a77d1fddf145d4cd2027ed8e4b6030b2f95355be37221\",\n \"RequestId\": \"s1735294966632123121\"\n }\n}",
1657
+ "output": "{\n \"Response\": {\n \"Fields\": [\n {\n \"Description\": \"\",\n \"Name\": \"甲方姓名\",\n \"Type\": \"TEXT\"\n },\n {\n \"Description\": \"\",\n \"Name\": \"甲方证件类型\",\n \"Type\": \"TEXT\"\n },\n {\n \"Description\": \"\",\n \"Name\": \"甲方证件号码\",\n \"Type\": \"TEXT\"\n },\n {\n \"Description\": \"\",\n \"Name\": \"甲方联系电话\",\n \"Type\": \"TEXT\"\n }\n ],\n \"RequestId\": \"s1757917252782050716\",\n \"Results\": [\n {\n \"ExtractionFieldResults\": [\n {\n \"Id\": \"yDtrwUUckp9wybmjUut60LQwZBsJBCb7\",\n \"Name\": \"甲方姓名\",\n \"Positions\": [\n {\n \"Height\": 62.85014245014244,\n \"Id\": \"c356ac4e-e519-4926-96e8-3f3802068587\",\n \"PageIndex\": 0,\n \"Width\": 276.866935483871,\n \"X\": 87.81048387096774,\n \"Y\": 101.7116809116809\n }\n ],\n \"RequiresSemanticExtraction\": true,\n \"Type\": \"TEXT\",\n \"Values\": [\n \"张三\"\n ]\n },\n {\n \"Id\": \"yDtrwUUckp9wybm8Uut60LQ8gfPP8SwF\",\n \"Name\": \"甲方证件类型\",\n \"Positions\": [\n {\n \"Height\": 62.85014245014244,\n \"Id\": \"41355563-8548-4295-b71c-4c2d5933a743\",\n \"PageIndex\": 0,\n \"Width\": 276.866935483871,\n \"X\": 87.81048387096774,\n \"Y\": 101.7116809116809\n }\n ],\n \"RequiresSemanticExtraction\": true,\n \"Type\": \"TEXT\",\n \"Values\": [\n \"统一社会信用代码/注册号\"\n ]\n },\n {\n \"Id\": \"yDtrwUUckp9wybmhUut60LQuyWcyz0XK\",\n \"Name\": \"甲方证件号码\",\n \"Positions\": [\n {\n \"Height\": 62.85014245014244,\n \"Id\": \"18c51f7f-0052-4918-839c-09f3ee53dfb5\",\n \"PageIndex\": 0,\n \"Width\": 276.866935483871,\n \"X\": 87.81048387096774,\n \"Y\": 101.7116809116809\n }\n ],\n \"RequiresSemanticExtraction\": true,\n \"Type\": \"TEXT\",\n \"Values\": [\n \"91xxxx3\"\n ]\n },\n {\n \"Id\": \"yDtrwUUckp9wybm2Uut60LQBKQ75zwdk\",\n \"Name\": \"甲方联系电话\",\n \"Positions\": [\n {\n \"Height\": 39.34131054131055,\n \"Id\": \"be7257bc-e35f-4ac9-9911-121870978a05\",\n \"PageIndex\": 0,\n \"Width\": 341.6451612903226,\n \"X\": 87.81048387096774,\n \"Y\": 174.15726495726494\n }\n ],\n \"RequiresSemanticExtraction\": true,\n \"Type\": \"TEXT\",\n \"Values\": [\n \"18888889999\"\n ]\n }\n ],\n \"ResourceId\": \"yDtrwUUckp9wa8mhUxBlpETSqyoBrgzT\",\n \"ResourceName\": \"【示例】某企业办公设备采购协议.pdf\"\n }\n ],\n \"Status\": 3,\n \"Url\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=c83cf852247f9075f675f350e6d6ebed68667f1e41dc9a6a5c2217df8e41ee87e0de0559839c7737f186b6aa90c51814914e54ef9a4d669e56c01d6442b0cb21c7fbdf6ad38dfcee4c1d4dce9f6bf8f429f525fe2506634e16c8d3a57959978c\"\n }\n}",
1658
1658
  "title": "获取合同智能提取任务详情"
1659
1659
  }
1660
1660
  ],
@@ -3260,7 +3260,7 @@
3260
3260
  "type": "int"
3261
3261
  },
3262
3262
  {
3263
- "disabled": false,
3263
+ "disabled": true,
3264
3264
  "document": "二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。\t",
3265
3265
  "example": "7",
3266
3266
  "member": "int64",
@@ -3280,7 +3280,7 @@
3280
3280
  {
3281
3281
  "disabled": false,
3282
3282
  "document": "指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。",
3283
- "example": "[ { \"RecipientId\": \"yDwJNUUckpkojrssUxTFHk6xvcX2xigb\", \"Values\": [ \"HANDWRITE\", \"SYSTEM_ESIGN\" ] }, { \"RecipientId\": \"yDwJNUUckpkojrsqUxTFHk6yndh20CpW\", \"Values\": [ \"OCR_ESIGN\" ] } ]\t",
3283
+ "example": "",
3284
3284
  "member": "ApproverComponentLimitType",
3285
3285
  "name": "ApproverComponentLimitTypes",
3286
3286
  "required": false,
@@ -3289,7 +3289,7 @@
3289
3289
  {
3290
3290
  "disabled": true,
3291
3291
  "document": "已废弃,回调配置统一使用企业应用管理-应用集成-第三方应用中的配置\n<br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign\n<br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83",
3292
- "example": "",
3292
+ "example": "http://www.qq.com",
3293
3293
  "member": "string",
3294
3294
  "name": "CallbackUrl",
3295
3295
  "required": false,
@@ -3330,6 +3330,24 @@
3330
3330
  "name": "FlowNameAppendScannerInfo",
3331
3331
  "required": false,
3332
3332
  "type": "bool"
3333
+ },
3334
+ {
3335
+ "disabled": false,
3336
+ "document": "签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName\t",
3337
+ "example": "测试签署码",
3338
+ "member": "string",
3339
+ "name": "QrCodeName",
3340
+ "required": false,
3341
+ "type": "string"
3342
+ },
3343
+ {
3344
+ "disabled": false,
3345
+ "document": "签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。\t",
3346
+ "example": "1757416261",
3347
+ "member": "int64",
3348
+ "name": "QrCodeExpiredOn",
3349
+ "required": false,
3350
+ "type": "int"
3333
3351
  }
3334
3352
  ],
3335
3353
  "type": "object"