tencentcloud-sdk-nodejs-lowcode 4.0.781 → 4.0.1040

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.
@@ -16,71 +16,200 @@
16
16
  */
17
17
 
18
18
  /**
19
- * 数据源授权信息
19
+ * DescribeKnowledgeSetList请求参数结构体
20
20
  */
21
- export interface TicketAuthInfo {
21
+ export interface DescribeKnowledgeSetListRequest {
22
22
  /**
23
- * 授权用户
23
+ * 知识库标识,精准查询
24
+ */
25
+ Name?: string
26
+ /**
27
+ * 知识库名称,精准查询
28
+ */
29
+ Title?: string
30
+ /**
31
+ * 查询条数
32
+ */
33
+ Limit?: number
34
+ /**
35
+ * NoPage标识不分页
24
36
  */
25
- AuthUser: string
37
+ QueryMode?: string
26
38
  }
27
39
 
28
40
  /**
29
- * DescribeDataSourceList请求参数结构体
41
+ * 文档信息
30
42
  */
31
- export interface DescribeDataSourceListRequest {
43
+ export interface KnowledgeDocumentSetInfo {
32
44
  /**
33
- * 每页条数
45
+ * 文件的字符数。
46
+ 注意:此字段可能返回 null,表示取不到有效值。
34
47
  */
35
- PageSize: number
48
+ TextLength?: number
36
49
  /**
37
- * 页码
50
+ * 文件的字节数。
51
+ 注意:此字段可能返回 null,表示取不到有效值。
38
52
  */
39
- PageIndex: number
53
+ ByteLength?: number
40
54
  /**
41
- * 环境 id
55
+ * 文件被预处理、Embedding 向量化的进度。
56
+ 注意:此字段可能返回 null,表示取不到有效值。
57
+ */
58
+ IndexedProgress?: number
59
+ /**
60
+ * 文件预处理、Embedding 向量化的状态。
61
+ New:等待解析。
62
+ Loading:文件解析中。
63
+ Failure:文件解析、写入出错。
64
+ Ready:文件解析、写入完成。
65
+
66
+ 注意:此字段可能返回 null,表示取不到有效值。
67
+ */
68
+ IndexedStatus?: string
69
+ /**
70
+ * 文件创建时间。
71
+ 注意:此字段可能返回 null,表示取不到有效值。
72
+ */
73
+ CreateTime?: string
74
+ /**
75
+ * 文件最后更新时间。
76
+ 注意:此字段可能返回 null,表示取不到有效值。
77
+ */
78
+ LastUpdateTime?: string
79
+ /**
80
+ * 文件关键字。
81
+ 注意:此字段可能返回 null,表示取不到有效值。
82
+ */
83
+ Keywords?: string
84
+ }
85
+
86
+ /**
87
+ * 删除文档出参
88
+ */
89
+ export interface DeleteKnowledgeDocumentSetRsp {
90
+ /**
91
+ * 删除文档数量。
92
+ 注意:此字段可能返回 null,表示取不到有效值。
93
+ */
94
+ AffectedCount?: number
95
+ }
96
+
97
+ /**
98
+ * UploadKnowledgeDocumentSet请求参数结构体
99
+ */
100
+ export interface UploadKnowledgeDocumentSetRequest {
101
+ /**
102
+ * 知识库标识
103
+ */
104
+ CollectionView: string
105
+ /**
106
+ * 状态;ENABLED启用;NOT_ENABLED不启用
107
+ */
108
+ FileName: string
109
+ /**
110
+ * 文件存储位置的可读地址
111
+ */
112
+ CosUrl: string
113
+ /**
114
+ * 文件类型,例如: .docx, .md
115
+ */
116
+ DocumentType?: string
117
+ /**
118
+ * 对文件的描述
119
+ */
120
+ DocumentDesc?: string
121
+ /**
122
+ * 文件标题
123
+ */
124
+ FileTitle?: string
125
+ /**
126
+ * 文件元信息,为jsonstring
127
+ */
128
+ FileMetaData?: string
129
+ /**
130
+ * 文件id
131
+ */
132
+ DocumentSetId?: string
133
+ }
134
+
135
+ /**
136
+ * UpdateKnowledgeSet返回参数结构体
137
+ */
138
+ export interface UpdateKnowledgeSetResponse {
139
+ /**
140
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
141
+ */
142
+ RequestId?: string
143
+ }
144
+
145
+ /**
146
+ * SearchDocList请求参数结构体
147
+ */
148
+ export interface SearchDocListRequest {
149
+ /**
150
+ * 环境ID
42
151
  */
43
152
  EnvId: string
44
153
  /**
45
- * 应用id数组
154
+ * 知识库名称
46
155
  */
47
- Appids?: Array<string>
156
+ CollectionView?: string
48
157
  /**
49
- * 数据源id数组
158
+ * 搜索模式
50
159
  */
51
- DataSourceIds?: Array<string>
160
+ SearchKey?: string
52
161
  /**
53
- * 数据源名称数组
162
+ * 搜索值
54
163
  */
55
- DataSourceNames?: Array<string>
164
+ SearchValue?: string
56
165
  /**
57
- * 数据源类型 database-自建数据源;cloud-integration-自定义数据源
166
+ * 页码
58
167
  */
59
- DataSourceType?: string
168
+ PageNo?: number
60
169
  /**
61
- * 数据源模糊查询参数
170
+ * 页大小
62
171
  */
63
- QueryOption?: DataSourceQueryOption
172
+ PageSize?: number
173
+ }
174
+
175
+ /**
176
+ * DescribeKnowledgeDocumentSetList返回参数结构体
177
+ */
178
+ export interface DescribeKnowledgeDocumentSetListResponse {
64
179
  /**
65
- * 数据源视图Id数组
180
+ * 新增文件返回信息
66
181
  */
67
- ViewIds?: Array<string>
182
+ Data?: DescribeKnowledgeDocumentSetListRsp
68
183
  /**
69
- * 查询未关联应用的数据源,0:未关联,该参数配合 AppIds 参数一块使用
184
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
70
185
  */
71
- AppLinkStatus?: number
186
+ RequestId?: string
187
+ }
188
+
189
+ /**
190
+ * 上传知识库文档返回结果
191
+ */
192
+ export interface UploadKnowledgeDocumentSetRsp {
72
193
  /**
73
- * 查询应用绑定数据源: 0: 否,1: 是
194
+ * 给文件分配的 ID 信息。
195
+ 注意:此字段可能返回 null,表示取不到有效值。
74
196
  */
75
- QueryBindToApp?: number
197
+ DocumentSetId?: string
76
198
  /**
77
- * 查询连接器 0 数据模型 1 连接器 2 自定义连接器
199
+ * 文件名
200
+ 注意:此字段可能返回 null,表示取不到有效值。
78
201
  */
79
- QueryConnector?: number
202
+ DocumentSetName?: string
80
203
  /**
81
- * 查询数据源黑名单机制,比如不想要系统数据源["system"]
204
+ * 文件标题
205
+ 注意:此字段可能返回 null,表示取不到有效值。
82
206
  */
83
- NotQuerySubTypeList?: Array<string>
207
+ FileTitle?: string
208
+ /**
209
+ * 文件元信息,为jsonstring
210
+ 注意:此字段可能返回 null,表示取不到有效值。
211
+ */
212
+ FileMetaData?: string
84
213
  }
85
214
 
86
215
  /**
@@ -98,33 +227,139 @@ export interface DataSourceQueryOption {
98
227
  }
99
228
 
100
229
  /**
101
- * 数据源关联App信息
230
+ * 查询条件
102
231
  */
103
- export interface DataSourceLinkApp {
232
+ export interface PageQuery {
104
233
  /**
105
- * 应用Id
234
+ * 文件id数组,表示要查询的文件的所有 ID,支持批量查询,数组元素范围[1,20]。
106
235
  */
107
- Id: string
236
+ DocumentSetId?: Array<string>
108
237
  /**
109
- * 应用名称
110
- 注意:此字段可能返回 null,表示取不到有效值。
238
+ * 表示要查询的文档名称,支持批量查询,数组元素范围[1,20]。
111
239
  */
112
- Title: string
240
+ DocumentSetName?: Array<string>
113
241
  /**
114
- * 是否编辑状态使用
115
- 注意:此字段可能返回 null,表示取不到有效值。
242
+ * 取值范围:[1,16384]
116
243
  */
117
- EditStatusUse: number
244
+ Limit?: number
118
245
  /**
119
- * 是否预览状态使用
120
- 注意:此字段可能返回 null,表示取不到有效值。
246
+ * 设置分页偏移量,用于控制分页查询返回结果的起始位置,方便用户对数据进行分页展示和浏览。
247
+ 取值:为 limit 整数倍。
248
+ 计算公式:offset=limit*(page-1)。
249
+ 例如:当 limit = 10,page = 2 时,分页偏移量 offset = 10 * (2 - 1) = 10,表示从查询结果的第 11 条记录开始返回数据。
250
+
121
251
  */
122
- PreviewStatusUse: number
252
+ Offset?: number
123
253
  /**
124
- * 是否正式状态使用
125
- 注意:此字段可能返回 null,表示取不到有效值。
254
+ * 设置后,其他字段为空值
255
+ */
256
+ OutputFields?: Array<string>
257
+ /**
258
+ * 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。
259
+ */
260
+ Filter?: string
261
+ }
262
+
263
+ /**
264
+ * SearchDocList返回参数结构体
265
+ */
266
+ export interface SearchDocListResponse {
267
+ /**
268
+ * 知识库文档搜索数据
126
269
  */
127
- OnlineStatusUse: number
270
+ Data?: SearchDocRsp
271
+ /**
272
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
273
+ */
274
+ RequestId?: string
275
+ }
276
+
277
+ /**
278
+ * DeleteKnowledgeSet返回参数结构体
279
+ */
280
+ export interface DeleteKnowledgeSetResponse {
281
+ /**
282
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
283
+ */
284
+ RequestId?: string
285
+ }
286
+
287
+ /**
288
+ * 删除文档时查询入参
289
+ */
290
+ export interface DocumentQuery {
291
+ /**
292
+ * 文件ids
293
+ */
294
+ DocumentSetId?: Array<string>
295
+ /**
296
+ * 文件名集合
297
+ */
298
+ DocumentSetName?: Array<string>
299
+ /**
300
+ * 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式
301
+ */
302
+ Filter?: string
303
+ }
304
+
305
+ /**
306
+ * UpdateKnowledgeSet请求参数结构体
307
+ */
308
+ export interface UpdateKnowledgeSetRequest {
309
+ /**
310
+ * 知识库标识
311
+ */
312
+ Name: string
313
+ /**
314
+ * 知识库名称
315
+ */
316
+ Title?: string
317
+ /**
318
+ * 描述
319
+ */
320
+ Desc?: string
321
+ /**
322
+ * 状态;ENABLED启用;NOT_ENABLED不启用
323
+ */
324
+ Active?: string
325
+ }
326
+
327
+ /**
328
+ * 知识库搜索文档信息
329
+ */
330
+ export interface SearchDocInfo {
331
+ /**
332
+ * 知识库名称
333
+ */
334
+ CollectionViewName?: string
335
+ /**
336
+ * 文档Id
337
+ */
338
+ DocSetId?: string
339
+ /**
340
+ * 文档Name
341
+ */
342
+ DocSetName?: string
343
+ /**
344
+ * 文档类型
345
+ */
346
+ DocType?: string
347
+ /**
348
+ * 文档标题
349
+ */
350
+ FileTitle?: string
351
+ /**
352
+ * 文档元信息
353
+ */
354
+ FileMetaData?: string
355
+ /**
356
+ * 文档描述
357
+ */
358
+ DocDesc?: string
359
+ /**
360
+ * 文档大小
361
+ */
362
+ FileSize?: number
128
363
  }
129
364
 
130
365
  /**
@@ -134,177 +369,761 @@ export interface DataSourceDetail {
134
369
  /**
135
370
  * 数据源 ID
136
371
  */
137
- Id: string
372
+ Id?: string
138
373
  /**
139
374
  * 数据源名称
140
375
  */
141
- Title: string
376
+ Title?: string
142
377
  /**
143
378
  * 数据源标识
144
379
  */
145
- Name: string
380
+ Name?: string
146
381
  /**
147
382
  * 数据源类型
148
383
  */
149
- Type: string
384
+ Type?: string
150
385
  /**
151
386
  * 数据源描述
387
+ 注意:此字段可能返回 null,表示取不到有效值。
152
388
  */
153
- Description: string
389
+ Description?: string
154
390
  /**
155
391
  * 数据源配置
156
392
  */
157
- Schema: string
393
+ Schema?: string
158
394
  /**
159
395
  * cms 项目状态, 0: 重新获取详情信息,1: 不需要重新获取详情信息
160
396
  */
161
- CmsProject: string
397
+ CmsProject?: string
162
398
  /**
163
399
  * 当前为环境 id
164
- 注意:此字段可能返回 null,表示取不到有效值。
165
400
  */
166
- PkgId: string
401
+ PkgId?: string
167
402
  /**
168
403
  * schema 版本信息
169
404
  注意:此字段可能返回 null,表示取不到有效值。
170
405
  */
171
- SchemaVersion: string
406
+ SchemaVersion?: string
172
407
  /**
173
408
  * 创建者用户 ID
174
- 注意:此字段可能返回 null,表示取不到有效值。
175
409
  */
176
- CreatorId: string
410
+ CreatorId?: string
177
411
  /**
178
412
  * 创建时间
179
413
  注意:此字段可能返回 null,表示取不到有效值。
180
414
  */
181
- CreatedAt: string
415
+ CreatedAt?: string
182
416
  /**
183
417
  * 更新时间
184
418
  注意:此字段可能返回 null,表示取不到有效值。
185
419
  */
186
- UpdatedAt: string
420
+ UpdatedAt?: string
187
421
  /**
188
422
  * 环境 id
189
- 注意:此字段可能返回 null,表示取不到有效值。
190
423
  */
191
- EnvId: string
424
+ EnvId?: string
192
425
  /**
193
426
  * 版本
194
427
  注意:此字段可能返回 null,表示取不到有效值。
195
428
  */
196
- DataSourceVersion: string
429
+ DataSourceVersion?: string
197
430
  /**
198
431
  * 所属应用数组
199
432
  注意:此字段可能返回 null,表示取不到有效值。
200
433
  */
201
- AppUsageList: Array<DataSourceLinkApp>
434
+ AppUsageList?: Array<DataSourceLinkApp>
202
435
  /**
203
436
  * 发布时间
204
- 注意:此字段可能返回 null,表示取不到有效值。
205
437
  */
206
- PublishedAt: string
438
+ PublishedAt?: string
207
439
  /**
208
440
  * 子数据源ids
209
441
  注意:此字段可能返回 null,表示取不到有效值。
210
442
  */
211
- ChildDataSourceIds: Array<string>
443
+ ChildDataSourceIds?: Array<string>
212
444
  /**
213
445
  * 数据源发布信息
214
446
  注意:此字段可能返回 null,表示取不到有效值。
215
447
  */
216
- Fun: string
448
+ Fun?: string
217
449
  /**
218
450
  * 云函数状态 1 Active 2 Creating 3 Updating 4 Deleting 9 Deleted 11 CreatFailed 12 UpdateFailed 13 DeleteFailed 21 UpdateTimeOut
219
- 注意:此字段可能返回 null,表示取不到有效值。
220
451
  */
221
- ScfStatus: number
452
+ ScfStatus?: number
222
453
  /**
223
454
  * 自定义方法
224
- 注意:此字段可能返回 null,表示取不到有效值。
225
455
  */
226
- Methods: string
456
+ Methods?: string
227
457
  /**
228
458
  * 子数据源名数组
229
459
  注意:此字段可能返回 null,表示取不到有效值。
230
460
  */
231
- ChildDataSourceNames: Array<string>
461
+ ChildDataSourceNames?: Array<string>
232
462
  /**
233
463
  * 是否旧数据源 1 新 0 旧
234
- 注意:此字段可能返回 null,表示取不到有效值。
235
464
  */
236
- IsNewDataSource: number
465
+ IsNewDataSource?: number
237
466
  /**
238
467
  * 数据源视图id
239
468
  注意:此字段可能返回 null,表示取不到有效值。
240
469
  */
241
- ViewId: string
470
+ ViewId?: string
242
471
  /**
243
472
  * 数据源属性配置
244
473
  注意:此字段可能返回 null,表示取不到有效值。
245
474
  */
246
- Configuration: string
475
+ Configuration?: string
247
476
  /**
248
477
  * 外部数据源模板code
249
478
  注意:此字段可能返回 null,表示取不到有效值。
250
479
  */
251
- TemplateCode: string
480
+ TemplateCode?: string
252
481
  /**
253
482
  * 外部数据源模板来源 0 空模板 1 腾讯文档 2 腾讯会议 3 企业微信 4 微信电商
254
483
  注意:此字段可能返回 null,表示取不到有效值。
255
484
  */
256
- Source: number
485
+ Source?: number
257
486
  /**
258
487
  * 发布版本
259
488
  注意:此字段可能返回 null,表示取不到有效值。
489
+ * @deprecated
260
490
  */
261
- PublishVersion: string
491
+ PublishVersion?: string
262
492
  /**
263
493
  * 发布视图id
264
494
  注意:此字段可能返回 null,表示取不到有效值。
265
495
  */
266
- PublishViewId: string
496
+ PublishViewId?: string
267
497
  /**
268
498
  * 数据源子类型 "database" 标准模型 "custom-database" 自定义模型 "system" 系统模型 "connector" 连接器 "custom-connector" 自定义连接器 "hidden" 隐藏数据源
269
- 注意:此字段可能返回 null,表示取不到有效值。
270
499
  */
271
- SubType: string
500
+ SubType?: string
272
501
  /**
273
502
  * 授权状态 0 授权无效 1 授权有效
274
503
  注意:此字段可能返回 null,表示取不到有效值。
275
504
  */
276
- AuthStatus: number
505
+ AuthStatus?: number
277
506
  /**
278
507
  * 数据源授权信息
279
508
  注意:此字段可能返回 null,表示取不到有效值。
280
509
  */
281
- AuthInfo: TicketAuthInfo
510
+ AuthInfo?: TicketAuthInfo
511
+ /**
512
+ * 1发布0未发布
513
+ */
514
+ PublishStatus?: number
515
+ /**
516
+ * 更新版本
517
+ */
518
+ UpdateVersion?: number
519
+ /**
520
+ * 模型关联关系字段列表
521
+ 注意:此字段可能返回 null,表示取不到有效值。
522
+ */
523
+ RelationFieldList?: Array<RelationField>
524
+ /**
525
+ * db实例类型
526
+ 注意:此字段可能返回 null,表示取不到有效值。
527
+ */
528
+ DbInstanceType?: string
529
+ /**
530
+ * 体验环境db表名
531
+ 注意:此字段可能返回 null,表示取不到有效值。
532
+ */
533
+ PreviewTableName?: string
534
+ /**
535
+ * 正式环境db表名
536
+ 注意:此字段可能返回 null,表示取不到有效值。
537
+ */
538
+ PublishedTableName?: string
539
+ /**
540
+ * DB来源类型
541
+ 注意:此字段可能返回 null,表示取不到有效值。
542
+ */
543
+ DbSourceType?: string
282
544
  }
283
545
 
284
546
  /**
285
- * 数据详情列表
547
+ * 知识库信息
286
548
  */
287
- export interface DataSourceDetailItems {
549
+ export interface KnowledgeSet {
288
550
  /**
289
- * 数据详情列表
551
+ * 知识库标识
552
+ 注意:此字段可能返回 null,表示取不到有效值。
290
553
  */
291
- Rows: Array<DataSourceDetail>
554
+ Name?: string
292
555
  /**
293
- * 数据源列表总个数
556
+ * 知识库名称
557
+ 注意:此字段可能返回 null,表示取不到有效值。
558
+ */
559
+ Title?: string
560
+ /**
561
+ * 描述
562
+ 注意:此字段可能返回 null,表示取不到有效值。
563
+ */
564
+ Desc?: string
565
+ /**
566
+ * 状态,
567
+ NOT_ENABLED未启用
568
+ ENABLED 已启用
569
+ 注意:此字段可能返回 null,表示取不到有效值。
294
570
  */
295
- Count: number
571
+ Active?: string
572
+ /**
573
+ * 创建时间
574
+ 注意:此字段可能返回 null,表示取不到有效值。
575
+ */
576
+ CreateTime?: string
577
+ /**
578
+ * 更新时间
579
+ 注意:此字段可能返回 null,表示取不到有效值。
580
+ */
581
+ UpdateTime?: string
296
582
  }
297
583
 
298
584
  /**
299
- * DescribeDataSourceList返回参数结构体
585
+ * 文件拆分信息
300
586
  */
301
- export interface DescribeDataSourceListResponse {
587
+ export interface KnowledgeSplitterPreprocess {
302
588
  /**
303
- * data 数据
589
+ * 在对文件拆分时,配置是否将 Title 追加到切分后的段落后面一并 Embedding。取值如下所示:
590
+ false:不追加。
591
+ true:将段落 Title 追加到切分后的段落。
592
+
593
+ 注意:此字段可能返回 null,表示取不到有效值。
594
+ */
595
+ AppendTitleToChunk?: boolean
596
+ /**
597
+ * 在对文件拆分时,配置是否将关键字 keywords 追加到切分后的段落一并 Embedding。取值如下所示:
598
+ false:不追加。
599
+ true:将全文的 keywords 追加到切分后的段落。
600
+
601
+ 注意:此字段可能返回 null,表示取不到有效值。
602
+ */
603
+ AppendKeywordsToChunk?: boolean
604
+ }
605
+
606
+ /**
607
+ * DescribeKnowledgeDocumentSetDetail请求参数结构体
608
+ */
609
+ export interface DescribeKnowledgeDocumentSetDetailRequest {
610
+ /**
611
+ * 知识库标识
612
+ */
613
+ CollectionView: string
614
+ /**
615
+ * 文件名
616
+ */
617
+ DocumentSetName?: string
618
+ /**
619
+ * 文件id
304
620
  */
305
- Data: DataSourceDetailItems
621
+ DocumentSetId?: string
622
+ }
623
+
624
+ /**
625
+ * CreateKnowledgeSet返回参数结构体
626
+ */
627
+ export interface CreateKnowledgeSetResponse {
306
628
  /**
307
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
629
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
308
630
  */
309
631
  RequestId?: string
310
632
  }
633
+
634
+ /**
635
+ * DeleteKnowledgeSet请求参数结构体
636
+ */
637
+ export interface DeleteKnowledgeSetRequest {
638
+ /**
639
+ * 知识库标识
640
+ */
641
+ Name: string
642
+ }
643
+
644
+ /**
645
+ * 数据源关联的的信息
646
+ */
647
+ export interface RelationField {
648
+ /**
649
+ * 关联关系字段
650
+ */
651
+ Field?: string
652
+ /**
653
+ * 关联关系格式
654
+ */
655
+ Format?: string
656
+ /**
657
+ * 关联数据源名称
658
+ */
659
+ RelateDataSourceName?: string
660
+ }
661
+
662
+ /**
663
+ * DescribeKnowledgeDocumentSetList请求参数结构体
664
+ */
665
+ export interface DescribeKnowledgeDocumentSetListRequest {
666
+ /**
667
+ * 知识库标识
668
+ */
669
+ CollectionView: string
670
+ /**
671
+ * 查询条件
672
+ */
673
+ Query?: PageQuery
674
+ }
675
+
676
+ /**
677
+ * DescribeDataSourceList请求参数结构体
678
+ */
679
+ export interface DescribeDataSourceListRequest {
680
+ /**
681
+ * 每页条数
682
+ */
683
+ PageSize: number
684
+ /**
685
+ * 页码
686
+ */
687
+ PageIndex: number
688
+ /**
689
+ * 环境 id
690
+ */
691
+ EnvId: string
692
+ /**
693
+ * 应用id数组
694
+ */
695
+ Appids?: Array<string>
696
+ /**
697
+ * 数据源id数组
698
+ */
699
+ DataSourceIds?: Array<string>
700
+ /**
701
+ * 数据源名称数组
702
+ */
703
+ DataSourceNames?: Array<string>
704
+ /**
705
+ * 数据源类型 database-自建数据源;cloud-integration-自定义数据源
706
+ */
707
+ DataSourceType?: string
708
+ /**
709
+ * 数据源模糊查询参数
710
+ */
711
+ QueryOption?: DataSourceQueryOption
712
+ /**
713
+ * 数据源视图Id数组
714
+ */
715
+ ViewIds?: Array<string>
716
+ /**
717
+ * 查询未关联应用的数据源,0:未关联,该参数配合 AppIds 参数一块使用
718
+ */
719
+ AppLinkStatus?: number
720
+ /**
721
+ * 查询应用绑定数据源: 0: 否,1: 是
722
+ */
723
+ QueryBindToApp?: number
724
+ /**
725
+ * 查询连接器 0 数据模型 1 连接器 2 自定义连接器
726
+ */
727
+ QueryConnector?: number
728
+ /**
729
+ * 废弃中
730
+ */
731
+ NotQuerySubTypeList?: Array<string>
732
+ /**
733
+ * 查询channelList
734
+ */
735
+ ChannelList?: Array<string>
736
+ /**
737
+ * 是否查询数据源关联关系
738
+ */
739
+ QueryDataSourceRelationList?: boolean
740
+ /**
741
+ * db实例类型
742
+ */
743
+ DbInstanceType?: string
744
+ /**
745
+ * 数据库表名列表
746
+ */
747
+ DatabaseTableNames?: Array<string>
748
+ /**
749
+ * 是否查询系统模型,默认为true,需要显示设置为False才能过滤系统模型
750
+ */
751
+ QuerySystemModel?: boolean
752
+ }
753
+
754
+ /**
755
+ * DeleteKnowledgeDocumentSet请求参数结构体
756
+ */
757
+ export interface DeleteKnowledgeDocumentSetRequest {
758
+ /**
759
+ * 知识库标识
760
+ */
761
+ CollectionView: string
762
+ /**
763
+ * 删除时制定的条件
764
+ */
765
+ Query?: DocumentQuery
766
+ }
767
+
768
+ /**
769
+ * 搜索数据的集合
770
+ */
771
+ export interface QureyKnowledgeDocumentSet {
772
+ /**
773
+ * 文件id
774
+ 注意:此字段可能返回 null,表示取不到有效值。
775
+ */
776
+ DocumentSetId?: string
777
+ /**
778
+ * 文件名
779
+ 注意:此字段可能返回 null,表示取不到有效值。
780
+ */
781
+ DocumentSetName?: string
782
+ /**
783
+ * 文件内容前 200个字符。
784
+ 注意:此字段可能返回 null,表示取不到有效值。
785
+ */
786
+ TextPrefix?: string
787
+ /**
788
+ * 文件拆分信息
789
+ 注意:此字段可能返回 null,表示取不到有效值。
790
+ */
791
+ SplitterPreprocess?: KnowledgeSplitterPreprocess
792
+ /**
793
+ * 文件详情
794
+ 注意:此字段可能返回 null,表示取不到有效值。
795
+ */
796
+ DocumentSetInfo?: QureyKnowledgeDocumentSetInfo
797
+ /**
798
+ * 文件标题
799
+ 注意:此字段可能返回 null,表示取不到有效值。
800
+ */
801
+ FileTitle?: string
802
+ /**
803
+ * 文件元信息,必须为jsonstring
804
+ 注意:此字段可能返回 null,表示取不到有效值。
805
+ */
806
+ FileMetaData?: string
807
+ /**
808
+ * name
809
+ 注意:此字段可能返回 null,表示取不到有效值。
810
+ */
811
+ Name?: string
812
+ /**
813
+ * 作者
814
+ 注意:此字段可能返回 null,表示取不到有效值。
815
+ */
816
+ Author?: string
817
+ }
818
+
819
+ /**
820
+ * DescribeKnowledgeSetList返回参数结构体
821
+ */
822
+ export interface DescribeKnowledgeSetListResponse {
823
+ /**
824
+ * 知识库列表
825
+ 注意:此字段可能返回 null,表示取不到有效值。
826
+ */
827
+ Data?: KnowledgeSetRsp
828
+ /**
829
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
830
+ */
831
+ RequestId?: string
832
+ }
833
+
834
+ /**
835
+ * DescribeDataSourceList返回参数结构体
836
+ */
837
+ export interface DescribeDataSourceListResponse {
838
+ /**
839
+ * data 数据
840
+ */
841
+ Data?: DataSourceDetailItems
842
+ /**
843
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
844
+ */
845
+ RequestId?: string
846
+ }
847
+
848
+ /**
849
+ * UploadKnowledgeDocumentSet返回参数结构体
850
+ */
851
+ export interface UploadKnowledgeDocumentSetResponse {
852
+ /**
853
+ * 新增文件返回信息
854
+ */
855
+ Data?: UploadKnowledgeDocumentSetRsp
856
+ /**
857
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
858
+ */
859
+ RequestId?: string
860
+ }
861
+
862
+ /**
863
+ * DeleteKnowledgeDocumentSet返回参数结构体
864
+ */
865
+ export interface DeleteKnowledgeDocumentSetResponse {
866
+ /**
867
+ * 新增文件返回信息
868
+ */
869
+ Data?: DeleteKnowledgeDocumentSetRsp
870
+ /**
871
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
872
+ */
873
+ RequestId?: string
874
+ }
875
+
876
+ /**
877
+ * 数据源授权信息
878
+ */
879
+ export interface TicketAuthInfo {
880
+ /**
881
+ * 授权用户
882
+ */
883
+ AuthUser?: string
884
+ }
885
+
886
+ /**
887
+ * CreateKnowledgeSet请求参数结构体
888
+ */
889
+ export interface CreateKnowledgeSetRequest {
890
+ /**
891
+ * 知识库标识
892
+ */
893
+ Name: string
894
+ /**
895
+ * 知识库名称
896
+ */
897
+ Title: string
898
+ /**
899
+ * 描述
900
+ */
901
+ Desc?: string
902
+ }
903
+
904
+ /**
905
+ * 上传知识库文档返回结果
906
+ */
907
+ export interface DescribeKnowledgeDocumentSetDetailRsp {
908
+ /**
909
+ * 获取的数量。
910
+ 注意:此字段可能返回 null,表示取不到有效值。
911
+ */
912
+ Count?: number
913
+ /**
914
+ * 文档信息
915
+ 注意:此字段可能返回 null,表示取不到有效值。
916
+ */
917
+ DocumentSet?: KnowledgeDocumentSet
918
+ }
919
+
920
+ /**
921
+ * 查询文件集合信息详情
922
+ */
923
+ export interface QureyKnowledgeDocumentSetInfo {
924
+ /**
925
+ * 文件的字符数。
926
+ 注意:此字段可能返回 null,表示取不到有效值。
927
+ */
928
+ TextLength?: number
929
+ /**
930
+ * 文件的字节数。
931
+ 注意:此字段可能返回 null,表示取不到有效值。
932
+ */
933
+ ByteLength?: number
934
+ /**
935
+ * 文件被预处理、Embedding 向量化的进度。
936
+ 注意:此字段可能返回 null,表示取不到有效值。
937
+ */
938
+ IndexedProgress?: number
939
+ /**
940
+ * 文件预处理、Embedding 向量化的状态。
941
+ New:等待解析。
942
+ Loading:文件解析中。
943
+ Failure:文件解析、写入出错。
944
+ Ready:文件解析、写入完成。
945
+
946
+ 注意:此字段可能返回 null,表示取不到有效值。
947
+ */
948
+ IndexedStatus?: string
949
+ /**
950
+ * 错误信息
951
+ 注意:此字段可能返回 null,表示取不到有效值。
952
+ */
953
+ IndexedErrorMsg?: string
954
+ /**
955
+ * 文件创建时间。
956
+ 注意:此字段可能返回 null,表示取不到有效值。
957
+ */
958
+ CreateTime?: string
959
+ /**
960
+ * 文件最后更新时间。
961
+ 注意:此字段可能返回 null,表示取不到有效值。
962
+ */
963
+ LastUpdateTime?: string
964
+ /**
965
+ * 文件关键字。
966
+ 注意:此字段可能返回 null,表示取不到有效值。
967
+ */
968
+ Keywords?: string
969
+ }
970
+
971
+ /**
972
+ * 删除文档出参
973
+ */
974
+ export interface DescribeKnowledgeDocumentSetListRsp {
975
+ /**
976
+ * 文件集
977
+ 注意:此字段可能返回 null,表示取不到有效值。
978
+ */
979
+ DocumentSets?: Array<QureyKnowledgeDocumentSet>
980
+ /**
981
+ * 条数
982
+ 注意:此字段可能返回 null,表示取不到有效值。
983
+ */
984
+ Count?: number
985
+ }
986
+
987
+ /**
988
+ * 文档信息
989
+ */
990
+ export interface KnowledgeDocumentSet {
991
+ /**
992
+ * 文档id
993
+ 注意:此字段可能返回 null,表示取不到有效值。
994
+ */
995
+ DocumentSetId?: string
996
+ /**
997
+ * 文档名
998
+ 注意:此字段可能返回 null,表示取不到有效值。
999
+ */
1000
+ DocumentSetName?: string
1001
+ /**
1002
+ * 文件完整内容。
1003
+ 注意:此字段可能返回 null,表示取不到有效值。
1004
+ */
1005
+ Text?: string
1006
+ /**
1007
+ * 文件内容前 200个字符。
1008
+ 注意:此字段可能返回 null,表示取不到有效值。
1009
+ */
1010
+ TextPrefix?: string
1011
+ /**
1012
+ * 文件详情
1013
+ 注意:此字段可能返回 null,表示取不到有效值。
1014
+ */
1015
+ DocumentSetInfo?: KnowledgeDocumentSetInfo
1016
+ /**
1017
+ * 文件拆分信息
1018
+ 注意:此字段可能返回 null,表示取不到有效值。
1019
+ */
1020
+ SplitterPreprocess?: KnowledgeSplitterPreprocess
1021
+ /**
1022
+ * 未使用
1023
+ 注意:此字段可能返回 null,表示取不到有效值。
1024
+ */
1025
+ Name?: string
1026
+ /**
1027
+ * 文档标题
1028
+ 注意:此字段可能返回 null,表示取不到有效值。
1029
+ */
1030
+ FileTitle?: string
1031
+ /**
1032
+ * 文档元信息,必须为jsonstring
1033
+ 注意:此字段可能返回 null,表示取不到有效值。
1034
+ */
1035
+ FileMetaData?: string
1036
+ /**
1037
+ * 作者
1038
+ 注意:此字段可能返回 null,表示取不到有效值。
1039
+ */
1040
+ Author?: string
1041
+ }
1042
+
1043
+ /**
1044
+ * DescribeKnowledgeDocumentSetDetail返回参数结构体
1045
+ */
1046
+ export interface DescribeKnowledgeDocumentSetDetailResponse {
1047
+ /**
1048
+ * 新增文件返回信息
1049
+ */
1050
+ Data?: DescribeKnowledgeDocumentSetDetailRsp
1051
+ /**
1052
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1053
+ */
1054
+ RequestId?: string
1055
+ }
1056
+
1057
+ /**
1058
+ * 数据源关联App信息
1059
+ */
1060
+ export interface DataSourceLinkApp {
1061
+ /**
1062
+ * 应用Id
1063
+ */
1064
+ Id?: string
1065
+ /**
1066
+ * 应用名称
1067
+ */
1068
+ Title?: string
1069
+ /**
1070
+ * 是否编辑状态使用
1071
+ */
1072
+ EditStatusUse?: number
1073
+ /**
1074
+ * 是否预览状态使用
1075
+ */
1076
+ PreviewStatusUse?: number
1077
+ /**
1078
+ * 是否正式状态使用
1079
+ */
1080
+ OnlineStatusUse?: number
1081
+ /**
1082
+ * 数据源ID
1083
+ */
1084
+ DataSourceId?: string
1085
+ }
1086
+
1087
+ /**
1088
+ * 知识库文档搜索结果
1089
+ */
1090
+ export interface SearchDocRsp {
1091
+ /**
1092
+ * 文档基本信息
1093
+ */
1094
+ DocInfos?: Array<SearchDocInfo>
1095
+ /**
1096
+ * 文档总数
1097
+ */
1098
+ Total?: number
1099
+ }
1100
+
1101
+ /**
1102
+ * 查询知识库列表返回
1103
+ */
1104
+ export interface KnowledgeSetRsp {
1105
+ /**
1106
+ * 总数
1107
+ 注意:此字段可能返回 null,表示取不到有效值。
1108
+ */
1109
+ Total?: number
1110
+ /**
1111
+ * 知识库列表
1112
+ 注意:此字段可能返回 null,表示取不到有效值。
1113
+ */
1114
+ KnowledgeSets?: Array<KnowledgeSet>
1115
+ }
1116
+
1117
+ /**
1118
+ * 数据详情列表
1119
+ */
1120
+ export interface DataSourceDetailItems {
1121
+ /**
1122
+ * 数据详情列表
1123
+ */
1124
+ Rows?: Array<DataSourceDetail>
1125
+ /**
1126
+ * 数据源列表总个数
1127
+ */
1128
+ Count?: number
1129
+ }