tencentcloud-sdk-nodejs 4.0.1005 → 4.0.1007

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 (92) hide show
  1. package/CHANGELOG.md +303 -0
  2. package/SERVICE_CHANGELOG.md +343 -134
  3. package/package.json +1 -1
  4. package/products.md +24 -23
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdb/v20170320/cdb_client.ts +13 -1
  7. package/src/services/cdb/v20170320/cdb_models.ts +55 -19
  8. package/src/services/dbbrain/v20210527/dbbrain_client.ts +13 -0
  9. package/src/services/dbbrain/v20210527/dbbrain_models.ts +70 -0
  10. package/src/services/dbdc/v20201029/dbdc_models.ts +36 -36
  11. package/src/services/dcdb/v20180411/dcdb_models.ts +2 -2
  12. package/src/services/essbasic/v20210526/essbasic_client.ts +3 -3
  13. package/src/services/hunyuan/v20230901/hunyuan_models.ts +1 -1
  14. package/src/services/index.ts +1 -0
  15. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +49 -1
  16. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +95 -11
  17. package/src/services/lighthouse/v20200324/lighthouse_models.ts +1 -1
  18. package/src/services/lke/v20231130/lke_models.ts +12 -0
  19. package/src/services/lkeap/index.ts +5 -0
  20. package/src/services/lkeap/v20240522/index.ts +6 -0
  21. package/src/services/lkeap/v20240522/lkeap_client.ts +342 -0
  22. package/src/services/lkeap/v20240522/lkeap_models.ts +1112 -0
  23. package/src/services/monitor/v20180724/monitor_client.ts +1 -0
  24. package/src/services/monitor/v20180724/monitor_models.ts +34 -0
  25. package/src/services/ocr/v20181119/ocr_client.ts +106 -92
  26. package/src/services/ocr/v20181119/ocr_models.ts +209 -113
  27. package/src/services/sqlserver/v20180328/sqlserver_models.ts +19 -2
  28. package/src/services/tcb/v20180608/tcb_models.ts +26 -26
  29. package/src/services/tcm/v20210413/tcm_models.ts +1 -1
  30. package/src/services/tcr/v20190924/tcr_models.ts +21 -21
  31. package/src/services/teo/v20220901/teo_models.ts +10 -7
  32. package/src/services/tke/v20180525/tke_models.ts +148 -133
  33. package/src/services/trocket/v20230308/trocket_client.ts +14 -0
  34. package/src/services/trocket/v20230308/trocket_models.ts +45 -0
  35. package/src/services/vclm/v20240523/vclm_models.ts +3 -2
  36. package/src/services/vpc/v20170312/vpc_client.ts +2 -2
  37. package/src/services/vpc/v20170312/vpc_models.ts +13 -13
  38. package/src/services/waf/v20180125/waf_models.ts +1 -1
  39. package/src/services/wedata/v20210820/wedata_models.ts +25 -1
  40. package/tencentcloud/common/sdk_version.d.ts +1 -1
  41. package/tencentcloud/common/sdk_version.js +1 -1
  42. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -1
  43. package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -0
  44. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +53 -19
  45. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +5 -1
  46. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +6 -0
  47. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +67 -0
  48. package/tencentcloud/services/dbdc/v20201029/dbdc_models.d.ts +36 -36
  49. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +2 -2
  50. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -3
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -3
  52. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +1 -1
  53. package/tencentcloud/services/index.d.ts +1 -0
  54. package/tencentcloud/services/index.js +2 -0
  55. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +17 -1
  56. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +24 -0
  57. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +87 -11
  58. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +1 -1
  59. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +12 -0
  60. package/tencentcloud/services/lkeap/index.d.ts +6 -0
  61. package/tencentcloud/services/lkeap/index.js +7 -0
  62. package/tencentcloud/services/lkeap/v20240522/index.d.ts +6 -0
  63. package/tencentcloud/services/lkeap/v20240522/index.js +9 -0
  64. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +111 -0
  65. package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +180 -0
  66. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +1030 -0
  67. package/tencentcloud/services/lkeap/v20240522/lkeap_models.js +18 -0
  68. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +33 -0
  69. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +79 -73
  70. package/tencentcloud/services/ocr/v20181119/ocr_client.js +84 -76
  71. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +206 -112
  72. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +19 -2
  73. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +26 -26
  74. package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +1 -1
  75. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +21 -21
  76. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +10 -7
  77. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +148 -133
  78. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +7 -1
  79. package/tencentcloud/services/trocket/v20230308/trocket_client.js +8 -0
  80. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +43 -0
  81. package/tencentcloud/services/vclm/v20240523/vclm_models.d.ts +3 -2
  82. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  83. package/tencentcloud/services/vpc/v20170312/vpc_client.js +2 -2
  84. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +13 -13
  85. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +1 -1
  86. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +25 -1
  87. package/test/cdb.v20170320.test.js +10 -0
  88. package/test/dbbrain.v20210527.test.js +10 -0
  89. package/test/iotexplorer.v20190423.test.js +40 -0
  90. package/test/lkeap.v20240522.test.js +261 -0
  91. package/test/ocr.v20181119.test.js +24 -14
  92. package/test/trocket.v20230308.test.js +10 -0
@@ -0,0 +1,1112 @@
1
+ /*
2
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing,
11
+ * software distributed under the License is distributed on an
12
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
+ * KIND, either express or implied. See the License for the
14
+ * specific language governing permissions and limitations
15
+ * under the License.
16
+ */
17
+
18
+ /**
19
+ * CreateSplitDocumentFlow请求参数结构体
20
+ */
21
+ export interface CreateSplitDocumentFlowRequest {
22
+ /**
23
+ * 文件类型。支持的文件类型:PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、MD、TXT、PNG、JPG、JPEG、CSV
24
+ */
25
+ FileType: string
26
+ /**
27
+ * 文件的 Url 地址。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
28
+ */
29
+ FileUrl: string
30
+ /**
31
+ * 文件名,可选,当文件名无法从传入的FileUrl获取时需要通过该字段来明确
32
+ */
33
+ FileName?: string
34
+ /**
35
+ * 文件的 Base64 值。支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。支持的图片像素:单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
36
+ * @deprecated
37
+ */
38
+ FileBase64?: string
39
+ /**
40
+ * 当传入文件是PDF类型时,用来指定pdf识别的起始页码,识别的页码包含当前值
41
+ */
42
+ FileStartPageNumber?: number
43
+ /**
44
+ * 当传入文件是PDF类型时,用来指定pdf识别的结束页码,识别的页码包含当前值。
45
+ */
46
+ FileEndPageNumber?: number
47
+ /**
48
+ * 创建文档拆分任务配置信息创建文档解析任务配置信息
49
+ */
50
+ Config?: CreateSplitDocumentFlowConfig
51
+ }
52
+
53
+ /**
54
+ * ImportQAs返回参数结构体
55
+ */
56
+ export interface ImportQAsResponse {
57
+ /**
58
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
59
+ */
60
+ RequestId?: string
61
+ }
62
+
63
+ /**
64
+ * 检索结果的元数据
65
+ */
66
+ export interface RetrievalRecordMetadata {
67
+ /**
68
+ * 结果的类型。
69
+ - `DOC`:文档
70
+ - `QA`:问答对
71
+ */
72
+ Type?: string
73
+ /**
74
+ * 检索结果的来源。
75
+ - `SEMANTIC`:从语义检索中得到的结果
76
+ - `FULL_TEXT`:从全文检索中得到的结果
77
+ */
78
+ ResultSource?: string
79
+ /**
80
+ * 切片在文档中的页码,仅部分文档支持
81
+ */
82
+ ChunkPageNumbers?: Array<number | bigint>
83
+ }
84
+
85
+ /**
86
+ * ListQAs请求参数结构体
87
+ */
88
+ export type ListQAsRequest = null
89
+
90
+ /**
91
+ * ReconstructDocumentSSE返回参数结构体
92
+ */
93
+ export interface ReconstructDocumentSSEResponse {
94
+ /**
95
+ * 任务ID。本次请求的唯一标识
96
+ */
97
+ TaskId?: string
98
+ /**
99
+ * 响应类型。1:返回进度信息,2:返回解析结果
100
+ */
101
+ ResponseType?: string
102
+ /**
103
+ * 进度。0~100
104
+ */
105
+ Progress?: string
106
+ /**
107
+ * 进度信息。
108
+ */
109
+ ProgressMessage?: string
110
+ /**
111
+ * 文档解析结果URL。存储在腾讯云cos,可以通过http请求下载,URL十分钟内有效。
112
+ */
113
+ DocumentRecognizeResultUrl?: string
114
+ /**
115
+ * 文档解析失败的页码。
116
+ */
117
+ FailedPages?: Array<ReconstructDocumentFailedPage>
118
+ /**
119
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
120
+ */
121
+ RequestId?: string
122
+ }
123
+
124
+ /**
125
+ * 离线文档列表回包
126
+ */
127
+ export interface DocItem {
128
+ /**
129
+ * 文档id
130
+ 注意:此字段可能返回 null,表示取不到有效值。
131
+ */
132
+ DocId?: string
133
+ /**
134
+ * 状态,
135
+ - Uploading 上传中
136
+ - Parsing 解析中
137
+ - ParseFailed 解析失败
138
+ - Indexing 创建索引中
139
+ - IndexFailed 创建索引失败
140
+ - Success 发布成功
141
+ - Failed 失败
142
+ 注意:此字段可能返回 null,表示取不到有效值。
143
+ */
144
+ Status?: string
145
+ /**
146
+ * 文件名
147
+ 注意:此字段可能返回 null,表示取不到有效值。
148
+ */
149
+ FileName?: string
150
+ /**
151
+ * 更新时间
152
+ 注意:此字段可能返回 null,表示取不到有效值。
153
+ */
154
+ UpdateTime?: string
155
+ /**
156
+ * 属性标签
157
+ 注意:此字段可能返回 null,表示取不到有效值。
158
+ */
159
+ AttributeLabels?: Array<AttributeLabelReferItem>
160
+ }
161
+
162
+ /**
163
+ * GetEmbedding请求参数结构体
164
+ */
165
+ export interface GetEmbeddingRequest {
166
+ /**
167
+ * 模型名称
168
+ */
169
+ Model: string
170
+ /**
171
+ * 需要 embedding 的文本, 单条文本最大长度500个字符, 总条数最大7条
172
+ */
173
+ Inputs: Array<string>
174
+ }
175
+
176
+ /**
177
+ * UploadDocRealtime请求参数结构体
178
+ */
179
+ export type UploadDocRealtimeRequest = null
180
+
181
+ /**
182
+ * DescribeDoc返回参数结构体
183
+ */
184
+ export interface DescribeDocResponse {
185
+ /**
186
+ * 属性标签
187
+ */
188
+ AttributeLabels?: Array<AttributeLabelReferItem>
189
+ /**
190
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
191
+ */
192
+ RequestId?: string
193
+ }
194
+
195
+ /**
196
+ * 属性标签引用
197
+ */
198
+ export interface AttributeLabelReferItem {
199
+ /**
200
+ * 属性id
201
+ 注意:此字段可能返回 null,表示取不到有效值。
202
+ */
203
+ AttributeId?: string
204
+ /**
205
+ * 标签id
206
+ 注意:此字段可能返回 null,表示取不到有效值。
207
+ */
208
+ LabelIds?: Array<string>
209
+ }
210
+
211
+ /**
212
+ * DeleteQAs请求参数结构体
213
+ */
214
+ export type DeleteQAsRequest = null
215
+
216
+ /**
217
+ * ModifyQA请求参数结构体
218
+ */
219
+ export interface ModifyQARequest {
220
+ /**
221
+ * 属性标签
222
+ */
223
+ AttributeLabels?: Array<AttributeLabelReferItem>
224
+ }
225
+
226
+ /**
227
+ * 消耗量
228
+ */
229
+ export interface Usage {
230
+ /**
231
+ * 文档页数
232
+ */
233
+ TotalPages?: number
234
+ /**
235
+ * 输入token数
236
+ */
237
+ InputTokens?: number
238
+ /**
239
+ * 输出token数
240
+ */
241
+ OutputTokens?: number
242
+ /**
243
+ * 总token数
244
+ */
245
+ TotalTokens?: number
246
+ }
247
+
248
+ /**
249
+ * GetReconstructDocumentResult请求参数结构体
250
+ */
251
+ export interface GetReconstructDocumentResultRequest {
252
+ /**
253
+ * 解析任务ID
254
+ */
255
+ TaskId: string
256
+ }
257
+
258
+ /**
259
+ * ListQAs返回参数结构体
260
+ */
261
+ export interface ListQAsResponse {
262
+ /**
263
+ * 问答对信息
264
+ */
265
+ List?: Array<QaItem>
266
+ /**
267
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
268
+ */
269
+ RequestId?: string
270
+ }
271
+
272
+ /**
273
+ * DeleteAttributeLabels返回参数结构体
274
+ */
275
+ export interface DeleteAttributeLabelsResponse {
276
+ /**
277
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
278
+ */
279
+ RequestId?: string
280
+ }
281
+
282
+ /**
283
+ * 检索参数设置
284
+ */
285
+ export interface RetrievalSetting {
286
+ /**
287
+ * 检索的类型,不填该参数则检索全部。
288
+ - `DOC`:文档
289
+ - `QA`:QA
290
+
291
+ 仅RetrieveKnowledge接口支持该参数
292
+ */
293
+ Type?: string
294
+ /**
295
+ * 返回个数
296
+ */
297
+ TopK?: number
298
+ /**
299
+ * 分数过滤
300
+ */
301
+ ScoreThreshold?: number
302
+ }
303
+
304
+ /**
305
+ * ListDocs请求参数结构体
306
+ */
307
+ export type ListDocsRequest = null
308
+
309
+ /**
310
+ * CreateAttributeLabel返回参数结构体
311
+ */
312
+ export interface CreateAttributeLabelResponse {
313
+ /**
314
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
315
+ */
316
+ RequestId?: string
317
+ }
318
+
319
+ /**
320
+ * RetrieveKnowledge返回参数结构体
321
+ */
322
+ export interface RetrieveKnowledgeResponse {
323
+ /**
324
+ * 检索结果
325
+ */
326
+ Records?: Array<RetrievalRecord>
327
+ /**
328
+ * 检索结果数量
329
+ */
330
+ TotalCount?: number
331
+ /**
332
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
333
+ */
334
+ RequestId?: string
335
+ }
336
+
337
+ /**
338
+ * CreateSplitDocumentFlow返回参数结构体
339
+ */
340
+ export interface CreateSplitDocumentFlowResponse {
341
+ /**
342
+ * 任务唯一id。30天内可以通过GetSplitDocumentResult接口查询TaskId对应的处理结果。
343
+ */
344
+ TaskId?: string
345
+ /**
346
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
347
+ */
348
+ RequestId?: string
349
+ }
350
+
351
+ /**
352
+ * 分段配置
353
+ */
354
+ export interface SegmentationConfig {
355
+ /**
356
+ * 最大分片长度
357
+ */
358
+ MaxChunkSize?: number
359
+ }
360
+
361
+ /**
362
+ * CreateQA返回参数结构体
363
+ */
364
+ export interface CreateQAResponse {
365
+ /**
366
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
367
+ */
368
+ RequestId?: string
369
+ }
370
+
371
+ /**
372
+ * ModifyAttributeLabel请求参数结构体
373
+ */
374
+ export interface ModifyAttributeLabelRequest {
375
+ /**
376
+ * 属性标签
377
+ */
378
+ Labels?: Array<AttributeLabelItem>
379
+ }
380
+
381
+ /**
382
+ * ReconstructDocumentSSE 功能配置参数
383
+ */
384
+ export interface ReconstructDocumentSSEConfig {
385
+ /**
386
+ * Markdown文件中表格返回的形式
387
+ 0,表格以MD形式返回
388
+ 1,表格以HTML形式返回
389
+ 默认为0
390
+ */
391
+ TableResultType?: string
392
+ /**
393
+ * Markdown文件中图片返回的形式
394
+ 0:markdown中图片以链接形式返回
395
+ 1:markdown中图片只返回图片中提取的文本内容
396
+ 默认是0
397
+ */
398
+ MarkdownImageResponseType?: string
399
+ /**
400
+ * Markdown文件中是否包含页码信息
401
+ */
402
+ ReturnPageFormat?: boolean
403
+ /**
404
+ * 自定义输出页码样式,{{p}}为页码占位符,开启ReturnPageFormat生效。未填默认样式:<page_num>page {{p}}</page_num>
405
+ */
406
+ PageFormat?: string
407
+ }
408
+
409
+ /**
410
+ * ListDocs返回参数结构体
411
+ */
412
+ export interface ListDocsResponse {
413
+ /**
414
+ * 文档信息
415
+ */
416
+ List?: Array<DocItem>
417
+ /**
418
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
419
+ */
420
+ RequestId?: string
421
+ }
422
+
423
+ /**
424
+ * 文档拆分任务的用量
425
+ */
426
+ export interface DocumentUsage {
427
+ /**
428
+ * 文档拆分任务的页数
429
+ */
430
+ PageNumber?: number
431
+ /**
432
+ * 文档拆分任务消耗的总token数
433
+ * @deprecated
434
+ */
435
+ TotalToken?: number
436
+ /**
437
+ * 文档拆分任务消耗的总token数
438
+ */
439
+ TotalTokens?: number
440
+ }
441
+
442
+ /**
443
+ * ListAttributeLabels请求参数结构体
444
+ */
445
+ export type ListAttributeLabelsRequest = null
446
+
447
+ /**
448
+ * DeleteAttributeLabels请求参数结构体
449
+ */
450
+ export type DeleteAttributeLabelsRequest = null
451
+
452
+ /**
453
+ * RetrieveKnowledge请求参数结构体
454
+ */
455
+ export interface RetrieveKnowledgeRequest {
456
+ /**
457
+ * 知识库ID。
458
+ */
459
+ KnowledgeBaseId: string
460
+ /**
461
+ * 用于检索的文本。
462
+ */
463
+ Query: string
464
+ /**
465
+ * 检索方法,默认使用`HYBRID`混合检索。
466
+ - `SEMANTIC`:语义检索
467
+ - `FULL_TEXT`:全文检索
468
+ - `HYBRID`:混合检索
469
+ */
470
+ RetrievalMethod?: string
471
+ /**
472
+ * 检索设置。
473
+ */
474
+ RetrievalSetting?: RetrievalSetting
475
+ /**
476
+ * 标签过滤。
477
+ */
478
+ AttributeLabels?: Array<LabelItem>
479
+ }
480
+
481
+ /**
482
+ * GetReconstructDocumentResult返回参数结构体
483
+ */
484
+ export interface GetReconstructDocumentResultResponse {
485
+ /**
486
+ * 任务状态。- `Success`:执行完成- `Processing`:执行中- `Pause`: 暂停- `Failed`:执行失败- `WaitExecute`:等待执行
487
+ */
488
+ Status?: string
489
+ /**
490
+ * 解析结果的临时下载地址。文件类型为zip压缩包,下载链接有效期30分钟
491
+ */
492
+ DocumentRecognizeResultUrl?: string
493
+ /**
494
+ * 文档解析失败的页码
495
+ */
496
+ FailedPages?: Array<ReconstructDocumentFailedPage>
497
+ /**
498
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
499
+ */
500
+ RequestId?: string
501
+ }
502
+
503
+ /**
504
+ * 创建智能文档解析任务的配置信息
505
+ */
506
+ export interface CreateReconstructDocumentFlowConfig {
507
+ /**
508
+ * Markdown文件中表格返回的形式
509
+ 0,表格以MD形式返回
510
+ 1,表格以HTML形式返回
511
+ 默认为1
512
+ */
513
+ TableResultType?: string
514
+ /**
515
+ * 智能文档解析返回结果的格式
516
+ 0:只返回全文MD;
517
+ 1:只返回每一页的OCR原始Json;
518
+ 2:只返回每一页的MD,
519
+ 3:返回全文MD + 每一页的OCR原始Json;
520
+ 4:返回全文MD + 每一页的MD,
521
+ 默认值为3(返回全文MD + 每一页的OCR原始Json)
522
+
523
+
524
+ */
525
+ ResultType?: string
526
+ }
527
+
528
+ /**
529
+ * RunRerank请求参数结构体
530
+ */
531
+ export interface RunRerankRequest {
532
+ /**
533
+ * 查询内容
534
+ */
535
+ Query: string
536
+ /**
537
+ * 文档列表,最多20个
538
+ */
539
+ Docs: Array<string>
540
+ /**
541
+ * 模型名称, 默认: lke-reranker-base
542
+ */
543
+ Model?: string
544
+ }
545
+
546
+ /**
547
+ * GetSplitDocumentResult请求参数结构体
548
+ */
549
+ export interface GetSplitDocumentResultRequest {
550
+ /**
551
+ * 拆分任务ID
552
+ */
553
+ TaskId: string
554
+ }
555
+
556
+ /**
557
+ * ReconstructDocumentSSE请求参数结构体
558
+ */
559
+ export interface ReconstructDocumentSSERequest {
560
+ /**
561
+ * 文件类型。
562
+ **支持的文件类型**: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
563
+ **支持的文件大小**:
564
+ - PDF、DOC、DOCX、PPT、PPTX 支持100M
565
+ - MD、TXT 支持10M
566
+ - 其他支持20M
567
+
568
+ */
569
+ FileType: string
570
+ /**
571
+ * 文件的 URL 地址。
572
+ 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
573
+ 参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
574
+ */
575
+ FileUrl?: string
576
+ /**
577
+ * 文件的 Base64 值。
578
+ 支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。
579
+ 支持的图片像素:单边介于20-10000px之间。
580
+ 文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
581
+ */
582
+ FileBase64?: string
583
+ /**
584
+ * 文档的起始页码。
585
+ 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的起始页码,识别的页码包含当前值。
586
+ */
587
+ FileStartPageNumber?: number
588
+ /**
589
+ * 文档的结束页码。
590
+ 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的结束页码,识别的页码包含当前值。
591
+ */
592
+ FileEndPageNumber?: number
593
+ /**
594
+ * 文档解析配置信息
595
+ */
596
+ Config?: ReconstructDocumentSSEConfig
597
+ }
598
+
599
+ /**
600
+ * ListAttributeLabels返回参数结构体
601
+ */
602
+ export interface ListAttributeLabelsResponse {
603
+ /**
604
+ * 属性标签列表
605
+ */
606
+ List?: Array<AttributeItem>
607
+ /**
608
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
609
+ */
610
+ RequestId?: string
611
+ }
612
+
613
+ /**
614
+ * 检索的结果
615
+ */
616
+ export interface RetrievalRecord {
617
+ /**
618
+ * 检索结果的元数据
619
+ */
620
+ Metadata?: RetrievalRecordMetadata
621
+ /**
622
+ * 检索到的标题
623
+ */
624
+ Title?: string
625
+ /**
626
+ * 检索到的内容
627
+ */
628
+ Content?: string
629
+ }
630
+
631
+ /**
632
+ * 属性标签信息
633
+ */
634
+ export interface AttributeLabelItem {
635
+ /**
636
+ * 标签id
637
+ 注意:此字段可能返回 null,表示取不到有效值。
638
+ */
639
+ LabelId?: string
640
+ /**
641
+ * 标签名称,最大80个英文字符
642
+ 注意:此字段可能返回 null,表示取不到有效值。
643
+ */
644
+ LabelName?: string
645
+ }
646
+
647
+ /**
648
+ * CreateAttributeLabel请求参数结构体
649
+ */
650
+ export interface CreateAttributeLabelRequest {
651
+ /**
652
+ * 属性标签信息
653
+ */
654
+ Labels?: Array<AttributeLabelItem>
655
+ }
656
+
657
+ /**
658
+ * ImportQAs请求参数结构体
659
+ */
660
+ export type ImportQAsRequest = null
661
+
662
+ /**
663
+ * DescribeDoc请求参数结构体
664
+ */
665
+ export type DescribeDocRequest = null
666
+
667
+ /**
668
+ * DeleteKnowledgeBase返回参数结构体
669
+ */
670
+ export interface DeleteKnowledgeBaseResponse {
671
+ /**
672
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
673
+ */
674
+ RequestId?: string
675
+ }
676
+
677
+ /**
678
+ * DeleteDocs返回参数结构体
679
+ */
680
+ export interface DeleteDocsResponse {
681
+ /**
682
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
683
+ */
684
+ RequestId?: string
685
+ }
686
+
687
+ /**
688
+ * 属性标签
689
+ */
690
+ export interface LabelItem {
691
+ /**
692
+ * 属性key
693
+ */
694
+ Name?: string
695
+ /**
696
+ * 标签值
697
+ */
698
+ Values?: Array<string>
699
+ }
700
+
701
+ /**
702
+ * CreateReconstructDocumentFlow请求参数结构体
703
+ */
704
+ export interface CreateReconstructDocumentFlowRequest {
705
+ /**
706
+ * 文件类型。
707
+
708
+ **支持的文件类型:**
709
+ - `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2`
710
+
711
+ **支持的文件大小:**
712
+ - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M
713
+ - `TXT`、`MD` 最大10M
714
+ - 其他 最大20M
715
+
716
+ */
717
+ FileType: string
718
+ /**
719
+ * 文件的 URL 地址。
720
+ 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
721
+ 参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
722
+ */
723
+ FileUrl?: string
724
+ /**
725
+ * 文件的 Base64 值。
726
+ 支持的文件大小:所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。
727
+ 支持的图片像素:单边介于20-10000px之间。
728
+ 文件的 FileUrl、FileBase64 必须提供一个,如果都提供,只使用 FileUrl。
729
+ */
730
+ FileBase64?: string
731
+ /**
732
+ * 文档的起始页码。
733
+ 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的起始页码,识别的页码包含当前值。
734
+ */
735
+ FileStartPageNumber?: number
736
+ /**
737
+ * 文档的结束页码。
738
+ 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时,用来指定识别的结束页码,识别的页码包含当前值。
739
+ */
740
+ FileEndPageNumber?: number
741
+ /**
742
+ * 创建文档解析任务配置信息。
743
+ */
744
+ Config?: CreateReconstructDocumentFlowConfig
745
+ }
746
+
747
+ /**
748
+ * GetSplitDocumentResult返回参数结构体
749
+ */
750
+ export interface GetSplitDocumentResultResponse {
751
+ /**
752
+ * 任务状态。
753
+
754
+ - `Success`:执行完成
755
+ - `Processing`:执行中
756
+ - `Pause`: 暂停
757
+ - `Failed`:执行失败
758
+ - `WaitExecute`:等待执行
759
+ */
760
+ Status?: string
761
+ /**
762
+ * 拆分结果的临时下载地址。
763
+ 文件类型为zip压缩包,下载链接有效期30分钟。
764
+ 压缩包内包含\*.md、\*.jsonl、\*mllm.json以及images文件夹。
765
+
766
+ > **jsonl** 结构说明:
767
+ - `page_content`:
768
+ 用于生成嵌入(embedding)库,以便于检索使用。该字段中的图片将使用占位符替换。
769
+ - `org_data`:
770
+ 表示与 page_content 对应的最小语义完整性块,用于问答模型的处理。
771
+ - `big_data`:
772
+ 表示与 page_content 对应的最大语义完整性块,也用于问答模型的处理。
773
+ */
774
+ DocumentRecognizeResultUrl?: string
775
+ /**
776
+ * 文档拆分失败的页码
777
+ * @deprecated
778
+ */
779
+ FailedPages?: Array<SplitDocumentFailedPage>
780
+ /**
781
+ * 文档拆分任务的用量
782
+ */
783
+ Usage?: DocumentUsage
784
+ /**
785
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
786
+ */
787
+ RequestId?: string
788
+ }
789
+
790
+ /**
791
+ * ModifyQA返回参数结构体
792
+ */
793
+ export interface ModifyQAResponse {
794
+ /**
795
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
796
+ */
797
+ RequestId?: string
798
+ }
799
+
800
+ /**
801
+ * 文档解析失败记录
802
+ */
803
+ export interface ReconstructDocumentFailedPage {
804
+ /**
805
+ * 失败页码
806
+ 注意:此字段可能返回 null,表示取不到有效值。
807
+ */
808
+ PageNumber?: number
809
+ }
810
+
811
+ /**
812
+ * UploadDocRealtime返回参数结构体
813
+ */
814
+ export interface UploadDocRealtimeResponse {
815
+ /**
816
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
817
+ */
818
+ RequestId?: string
819
+ }
820
+
821
+ /**
822
+ * 文档解析失败记录
823
+ */
824
+ export interface SplitDocumentFailedPage {
825
+ /**
826
+ * 失败页码
827
+ 注意:此字段可能返回 null,表示取不到有效值。
828
+ */
829
+ PageNumber?: number
830
+ }
831
+
832
+ /**
833
+ * ModifyAttributeLabel返回参数结构体
834
+ */
835
+ export interface ModifyAttributeLabelResponse {
836
+ /**
837
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
838
+ */
839
+ RequestId?: string
840
+ }
841
+
842
+ /**
843
+ * DeleteQAs返回参数结构体
844
+ */
845
+ export interface DeleteQAsResponse {
846
+ /**
847
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
848
+ */
849
+ RequestId?: string
850
+ }
851
+
852
+ /**
853
+ * CreateKnowledgeBase返回参数结构体
854
+ */
855
+ export interface CreateKnowledgeBaseResponse {
856
+ /**
857
+ * 知识库ID
858
+ */
859
+ KnowledgeBaseId?: string
860
+ /**
861
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
862
+ */
863
+ RequestId?: string
864
+ }
865
+
866
+ /**
867
+ * GetEmbedding返回参数结构体
868
+ */
869
+ export interface GetEmbeddingResponse {
870
+ /**
871
+ * 特征
872
+ */
873
+ Data?: Array<EmbeddingObject>
874
+ /**
875
+ * 消耗量,返回TotalToken
876
+ */
877
+ Usage?: Usage
878
+ /**
879
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
880
+ */
881
+ RequestId?: string
882
+ }
883
+
884
+ /**
885
+ * 问答对信息
886
+ */
887
+ export interface QaItem {
888
+ /**
889
+ * 问答id
890
+ 注意:此字段可能返回 null,表示取不到有效值。
891
+ */
892
+ QaId?: string
893
+ /**
894
+ * 问题
895
+ 注意:此字段可能返回 null,表示取不到有效值。
896
+ */
897
+ Question?: string
898
+ /**
899
+ * 答案
900
+ 注意:此字段可能返回 null,表示取不到有效值。
901
+ */
902
+ Answer?: string
903
+ /**
904
+ * 属性标签
905
+ 注意:此字段可能返回 null,表示取不到有效值。
906
+ */
907
+ AttributeLabels?: Array<AttributeLabelReferItem>
908
+ /**
909
+ * 创建时间
910
+ 注意:此字段可能返回 null,表示取不到有效值。
911
+ */
912
+ CreateTime?: string
913
+ /**
914
+ * 更新时间
915
+ 注意:此字段可能返回 null,表示取不到有效值。
916
+ */
917
+ UpdateTime?: string
918
+ }
919
+
920
+ /**
921
+ * 创建智能文档拆分任务的配置信息
922
+ */
923
+ export interface CreateSplitDocumentFlowConfig {
924
+ /**
925
+ * Markdown文件中表格返回的形式
926
+ 0,表格以MD形式返回
927
+ 1,表格以HTML形式返回
928
+ 默认为
929
+ * @deprecated
930
+ */
931
+ TableResultType?: string
932
+ /**
933
+ * 智能文档解析返回结果的格式
934
+ 0:只返回全文MD;
935
+ 1:只返回每一页的OCR原始Json;
936
+ 2:只返回每一页的MD,
937
+ 3:返回全文MD + 每一页的OCR原始Json;
938
+ 4:返回全文MD + 每一页的MD,
939
+ 默认值为3(返回全文MD + 每一页的OCR原始Json)
940
+
941
+
942
+ * @deprecated
943
+ */
944
+ ResultType?: string
945
+ /**
946
+ * 是否开启mllm
947
+ */
948
+ EnableMllm?: boolean
949
+ /**
950
+ * 最大分片长度
951
+ */
952
+ MaxChunkSize?: number
953
+ }
954
+
955
+ /**
956
+ * RunRerank返回参数结构体
957
+ */
958
+ export interface RunRerankResponse {
959
+ /**
960
+ * 相关性, 数值越大越相关
961
+ */
962
+ ScoreList?: Array<number>
963
+ /**
964
+ * 消耗量,仅返回TotalToken
965
+ */
966
+ Usage?: Usage
967
+ /**
968
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
969
+ */
970
+ RequestId?: string
971
+ }
972
+
973
+ /**
974
+ * CreateReconstructDocumentFlow返回参数结构体
975
+ */
976
+ export interface CreateReconstructDocumentFlowResponse {
977
+ /**
978
+ * 任务唯一id。30天内可以通过GetReconstructDocumentResult接口查询TaskId对应的处理结果。
979
+ */
980
+ TaskId?: string
981
+ /**
982
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
983
+ */
984
+ RequestId?: string
985
+ }
986
+
987
+ /**
988
+ * CreateQA请求参数结构体
989
+ */
990
+ export interface CreateQARequest {
991
+ /**
992
+ * 属性标签
993
+ */
994
+ AttributeLabels?: Array<AttributeLabelReferItem>
995
+ }
996
+
997
+ /**
998
+ * UploadDoc返回参数结构体
999
+ */
1000
+ export interface UploadDocResponse {
1001
+ /**
1002
+ * 文档ID
1003
+ */
1004
+ DocId?: string
1005
+ /**
1006
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1007
+ */
1008
+ RequestId?: string
1009
+ }
1010
+
1011
+ /**
1012
+ * 属性信息
1013
+ */
1014
+ export interface AttributeItem {
1015
+ /**
1016
+ * 属性id
1017
+ 注意:此字段可能返回 null,表示取不到有效值。
1018
+ */
1019
+ AttributeId?: string
1020
+ /**
1021
+ * 属性标识
1022
+ 注意:此字段可能返回 null,表示取不到有效值。
1023
+ */
1024
+ AttributeKey?: string
1025
+ /**
1026
+ * 属性名称
1027
+ 注意:此字段可能返回 null,表示取不到有效值。
1028
+ */
1029
+ AttributeName?: string
1030
+ /**
1031
+ * 标签名称
1032
+ 注意:此字段可能返回 null,表示取不到有效值。
1033
+ */
1034
+ Labels?: Array<AttributeLabelItem>
1035
+ }
1036
+
1037
+ /**
1038
+ * 向量
1039
+ */
1040
+ export interface EmbeddingObject {
1041
+ /**
1042
+ * 向量
1043
+ */
1044
+ Embedding?: Array<number>
1045
+ }
1046
+
1047
+ /**
1048
+ * UploadDoc请求参数结构体
1049
+ */
1050
+ export interface UploadDocRequest {
1051
+ /**
1052
+ * 知识库ID
1053
+ */
1054
+ KnowledgeBaseId: string
1055
+ /**
1056
+ * 文件名,可选。
1057
+ **需带文件类型后缀**,当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。
1058
+ */
1059
+ FileName: string
1060
+ /**
1061
+ * 文件类型。
1062
+
1063
+ **支持的文件类型:**
1064
+ - `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`
1065
+
1066
+ **支持的文件大小:**
1067
+ - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M
1068
+ - `TXT`、`MD` 最大10M
1069
+ - 其他 最大20M
1070
+
1071
+ */
1072
+ FileType: string
1073
+ /**
1074
+ * 文件的 URL 地址。
1075
+ 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。
1076
+ 参考:[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)
1077
+ */
1078
+ FileUrl: string
1079
+ /**
1080
+ * 属性标签引用
1081
+ * @deprecated
1082
+ */
1083
+ AttributeLabel?: Array<AttributeLabelReferItem>
1084
+ /**
1085
+ * 属性标签引用
1086
+ */
1087
+ AttributeLabels?: Array<AttributeLabelReferItem>
1088
+ /**
1089
+ * 分段信息
1090
+ */
1091
+ Config?: SegmentationConfig
1092
+ }
1093
+
1094
+ /**
1095
+ * CreateKnowledgeBase请求参数结构体
1096
+ */
1097
+ export type CreateKnowledgeBaseRequest = null
1098
+
1099
+ /**
1100
+ * DeleteKnowledgeBase请求参数结构体
1101
+ */
1102
+ export interface DeleteKnowledgeBaseRequest {
1103
+ /**
1104
+ * 知识库ID
1105
+ */
1106
+ KnowledgeBaseId: string
1107
+ }
1108
+
1109
+ /**
1110
+ * DeleteDocs请求参数结构体
1111
+ */
1112
+ export type DeleteDocsRequest = null