@alicloud/bailian20231229 1.4.0 → 1.5.0

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.
package/dist/client.d.ts CHANGED
@@ -1,12 +1,117 @@
1
1
  /**
2
- *
3
2
  */
4
3
  import * as $Util from '@alicloud/tea-util';
5
4
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
6
5
  import * as $tea from '@alicloud/tea-typescript';
6
+ export declare class AddCategoryRequest extends $tea.Model {
7
+ /**
8
+ * @remarks
9
+ * This parameter is required.
10
+ */
11
+ categoryName?: string;
12
+ /**
13
+ * @remarks
14
+ * This parameter is required.
15
+ *
16
+ * @example
17
+ * UNSTRUCTURED
18
+ */
19
+ categoryType?: string;
20
+ /**
21
+ * @example
22
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
23
+ */
24
+ parentCategoryId?: string;
25
+ static names(): {
26
+ [key: string]: string;
27
+ };
28
+ static types(): {
29
+ [key: string]: any;
30
+ };
31
+ constructor(map?: {
32
+ [key: string]: any;
33
+ });
34
+ }
35
+ export declare class AddCategoryResponseBody extends $tea.Model {
36
+ /**
37
+ * @example
38
+ * success
39
+ */
40
+ code?: string;
41
+ data?: AddCategoryResponseBodyData;
42
+ /**
43
+ * @example
44
+ * Requests throttling triggered.
45
+ */
46
+ message?: string;
47
+ /**
48
+ * @remarks
49
+ * Id of the request
50
+ *
51
+ * @example
52
+ * 778C0B3B-03C1-5FC1-A947-36EDD13606AB
53
+ */
54
+ requestId?: string;
55
+ /**
56
+ * @example
57
+ * 200
58
+ */
59
+ status?: string;
60
+ /**
61
+ * @example
62
+ * true
63
+ */
64
+ success?: boolean;
65
+ static names(): {
66
+ [key: string]: string;
67
+ };
68
+ static types(): {
69
+ [key: string]: any;
70
+ };
71
+ constructor(map?: {
72
+ [key: string]: any;
73
+ });
74
+ }
75
+ export declare class AddCategoryResponse extends $tea.Model {
76
+ headers?: {
77
+ [key: string]: string;
78
+ };
79
+ statusCode?: number;
80
+ body?: AddCategoryResponseBody;
81
+ static names(): {
82
+ [key: string]: string;
83
+ };
84
+ static types(): {
85
+ [key: string]: any;
86
+ };
87
+ constructor(map?: {
88
+ [key: string]: any;
89
+ });
90
+ }
7
91
  export declare class AddFileRequest extends $tea.Model {
92
+ /**
93
+ * @remarks
94
+ * This parameter is required.
95
+ *
96
+ * @example
97
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3510024405
98
+ */
8
99
  categoryId?: string;
100
+ /**
101
+ * @remarks
102
+ * This parameter is required.
103
+ *
104
+ * @example
105
+ * 68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847
106
+ */
9
107
  leaseId?: string;
108
+ /**
109
+ * @remarks
110
+ * This parameter is required.
111
+ *
112
+ * @example
113
+ * DASHSCOPE_DOCMIND
114
+ */
10
115
  parser?: string;
11
116
  static names(): {
12
117
  [key: string]: string;
@@ -19,11 +124,31 @@ export declare class AddFileRequest extends $tea.Model {
19
124
  });
20
125
  }
21
126
  export declare class AddFileResponseBody extends $tea.Model {
127
+ /**
128
+ * @example
129
+ * DataCenter.FileTooLarge
130
+ */
22
131
  code?: string;
23
132
  data?: AddFileResponseBodyData;
133
+ /**
134
+ * @example
135
+ * User not authorized to operate on the specified resource.
136
+ */
24
137
  message?: string;
138
+ /**
139
+ * @example
140
+ * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
141
+ */
25
142
  requestId?: string;
143
+ /**
144
+ * @example
145
+ * 200
146
+ */
26
147
  status?: string;
148
+ /**
149
+ * @example
150
+ * true
151
+ */
27
152
  success?: string;
28
153
  static names(): {
29
154
  [key: string]: string;
@@ -52,8 +177,26 @@ export declare class AddFileResponse extends $tea.Model {
52
177
  });
53
178
  }
54
179
  export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
180
+ /**
181
+ * @remarks
182
+ * This parameter is required.
183
+ */
55
184
  fileName?: string;
185
+ /**
186
+ * @remarks
187
+ * This parameter is required.
188
+ *
189
+ * @example
190
+ * 19657c391f6c70bcea63c154d8606bb3
191
+ */
56
192
  md5?: string;
193
+ /**
194
+ * @remarks
195
+ * This parameter is required.
196
+ *
197
+ * @example
198
+ * 1000
199
+ */
57
200
  sizeInBytes?: string;
58
201
  static names(): {
59
202
  [key: string]: string;
@@ -66,11 +209,31 @@ export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
66
209
  });
67
210
  }
68
211
  export declare class ApplyFileUploadLeaseResponseBody extends $tea.Model {
212
+ /**
213
+ * @example
214
+ * DataCenter.FileTooLarge
215
+ */
69
216
  code?: string;
70
217
  data?: ApplyFileUploadLeaseResponseBodyData;
218
+ /**
219
+ * @example
220
+ * User not authorized to operate on the specified resource
221
+ */
71
222
  message?: string;
223
+ /**
224
+ * @example
225
+ * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
226
+ */
72
227
  requestId?: string;
228
+ /**
229
+ * @example
230
+ * 200
231
+ */
73
232
  status?: string;
233
+ /**
234
+ * @example
235
+ * true
236
+ */
74
237
  success?: boolean;
75
238
  static names(): {
76
239
  [key: string]: string;
@@ -100,20 +263,80 @@ export declare class ApplyFileUploadLeaseResponse extends $tea.Model {
100
263
  }
101
264
  export declare class CreateIndexRequest extends $tea.Model {
102
265
  categoryIds?: string[];
266
+ /**
267
+ * @example
268
+ * 128
269
+ */
103
270
  chunkSize?: number;
104
271
  columns?: CreateIndexRequestColumns[];
105
272
  description?: string;
106
273
  documentIds?: string[];
274
+ /**
275
+ * @example
276
+ * text-embedding-v2
277
+ */
107
278
  embeddingModelName?: string;
279
+ /**
280
+ * @remarks
281
+ * This parameter is required.
282
+ */
108
283
  name?: string;
284
+ /**
285
+ * @example
286
+ * 16
287
+ */
109
288
  overlapSize?: number;
289
+ /**
290
+ * @example
291
+ * 0.20
292
+ */
110
293
  rerankMinScore?: number;
294
+ /**
295
+ * @example
296
+ * gte-rerank-hybrid
297
+ */
111
298
  rerankModelName?: string;
299
+ /**
300
+ * @example
301
+ * ,
302
+ */
112
303
  separator?: string;
304
+ /**
305
+ * @example
306
+ * gp-bp321093j84
307
+ */
113
308
  sinkInstanceId?: string;
309
+ /**
310
+ * @example
311
+ * cn-hangzhou
312
+ */
114
313
  sinkRegion?: string;
314
+ /**
315
+ * @remarks
316
+ * This parameter is required.
317
+ *
318
+ * @example
319
+ * DEFAULT
320
+ */
115
321
  sinkType?: string;
322
+ /**
323
+ * @remarks
324
+ * This parameter is required.
325
+ *
326
+ * @example
327
+ * DATA_CENTER_FILE
328
+ *
329
+ * **if can be null:**
330
+ * false
331
+ */
116
332
  sourceType?: string;
333
+ /**
334
+ * @remarks
335
+ * This parameter is required.
336
+ *
337
+ * @example
338
+ * structured
339
+ */
117
340
  structureType?: string;
118
341
  static names(): {
119
342
  [key: string]: string;
@@ -127,20 +350,80 @@ export declare class CreateIndexRequest extends $tea.Model {
127
350
  }
128
351
  export declare class CreateIndexShrinkRequest extends $tea.Model {
129
352
  categoryIdsShrink?: string;
353
+ /**
354
+ * @example
355
+ * 128
356
+ */
130
357
  chunkSize?: number;
131
358
  columnsShrink?: string;
132
359
  description?: string;
133
360
  documentIdsShrink?: string;
361
+ /**
362
+ * @example
363
+ * text-embedding-v2
364
+ */
134
365
  embeddingModelName?: string;
366
+ /**
367
+ * @remarks
368
+ * This parameter is required.
369
+ */
135
370
  name?: string;
371
+ /**
372
+ * @example
373
+ * 16
374
+ */
136
375
  overlapSize?: number;
376
+ /**
377
+ * @example
378
+ * 0.20
379
+ */
137
380
  rerankMinScore?: number;
381
+ /**
382
+ * @example
383
+ * gte-rerank-hybrid
384
+ */
138
385
  rerankModelName?: string;
386
+ /**
387
+ * @example
388
+ * ,
389
+ */
139
390
  separator?: string;
391
+ /**
392
+ * @example
393
+ * gp-bp321093j84
394
+ */
140
395
  sinkInstanceId?: string;
396
+ /**
397
+ * @example
398
+ * cn-hangzhou
399
+ */
141
400
  sinkRegion?: string;
401
+ /**
402
+ * @remarks
403
+ * This parameter is required.
404
+ *
405
+ * @example
406
+ * DEFAULT
407
+ */
142
408
  sinkType?: string;
409
+ /**
410
+ * @remarks
411
+ * This parameter is required.
412
+ *
413
+ * @example
414
+ * DATA_CENTER_FILE
415
+ *
416
+ * **if can be null:**
417
+ * false
418
+ */
143
419
  sourceType?: string;
420
+ /**
421
+ * @remarks
422
+ * This parameter is required.
423
+ *
424
+ * @example
425
+ * structured
426
+ */
144
427
  structureType?: string;
145
428
  static names(): {
146
429
  [key: string]: string;
@@ -153,11 +436,34 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
153
436
  });
154
437
  }
155
438
  export declare class CreateIndexResponseBody extends $tea.Model {
439
+ /**
440
+ * @example
441
+ * Forbidden
442
+ */
156
443
  code?: string;
157
444
  data?: CreateIndexResponseBodyData;
445
+ /**
446
+ * @example
447
+ * Invalid input, variable name is missing
448
+ */
158
449
  message?: string;
450
+ /**
451
+ * @remarks
452
+ * Id of the request
453
+ *
454
+ * @example
455
+ * 17204B98-7734-4F9A-8464-2446A84821CA
456
+ */
159
457
  requestId?: string;
458
+ /**
459
+ * @example
460
+ * 200
461
+ */
160
462
  status?: string;
463
+ /**
464
+ * @example
465
+ * true
466
+ */
161
467
  success?: boolean;
162
468
  static names(): {
163
469
  [key: string]: string;
@@ -185,12 +491,95 @@ export declare class CreateIndexResponse extends $tea.Model {
185
491
  [key: string]: any;
186
492
  });
187
493
  }
494
+ export declare class DeleteCategoryResponseBody extends $tea.Model {
495
+ /**
496
+ * @example
497
+ * success
498
+ */
499
+ code?: string;
500
+ /**
501
+ * @remarks
502
+ * data
503
+ */
504
+ data?: DeleteCategoryResponseBodyData;
505
+ /**
506
+ * @example
507
+ * workspace id is null or invalid.
508
+ */
509
+ message?: string;
510
+ /**
511
+ * @remarks
512
+ * Id of the request
513
+ *
514
+ * @example
515
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
516
+ */
517
+ requestId?: string;
518
+ /**
519
+ * @example
520
+ * 200
521
+ */
522
+ status?: string;
523
+ /**
524
+ * @example
525
+ * true
526
+ */
527
+ success?: boolean;
528
+ static names(): {
529
+ [key: string]: string;
530
+ };
531
+ static types(): {
532
+ [key: string]: any;
533
+ };
534
+ constructor(map?: {
535
+ [key: string]: any;
536
+ });
537
+ }
538
+ export declare class DeleteCategoryResponse extends $tea.Model {
539
+ headers?: {
540
+ [key: string]: string;
541
+ };
542
+ statusCode?: number;
543
+ body?: DeleteCategoryResponseBody;
544
+ static names(): {
545
+ [key: string]: string;
546
+ };
547
+ static types(): {
548
+ [key: string]: any;
549
+ };
550
+ constructor(map?: {
551
+ [key: string]: any;
552
+ });
553
+ }
188
554
  export declare class DeleteFileResponseBody extends $tea.Model {
555
+ /**
556
+ * @example
557
+ * InvalidParameter
558
+ */
189
559
  code?: string;
190
560
  data?: DeleteFileResponseBodyData;
561
+ /**
562
+ * @example
563
+ * Current file status does not support delete.
564
+ */
191
565
  message?: string;
566
+ /**
567
+ * @remarks
568
+ * Id of the request
569
+ *
570
+ * @example
571
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
572
+ */
192
573
  requestId?: string;
574
+ /**
575
+ * @example
576
+ * 200
577
+ */
193
578
  status?: string;
579
+ /**
580
+ * @example
581
+ * true
582
+ */
194
583
  success?: boolean;
195
584
  static names(): {
196
585
  [key: string]: string;
@@ -219,6 +608,13 @@ export declare class DeleteFileResponse extends $tea.Model {
219
608
  });
220
609
  }
221
610
  export declare class DeleteIndexRequest extends $tea.Model {
611
+ /**
612
+ * @remarks
613
+ * This parameter is required.
614
+ *
615
+ * @example
616
+ * f89ie0fj5a
617
+ */
222
618
  indexId?: string;
223
619
  static names(): {
224
620
  [key: string]: string;
@@ -231,10 +627,33 @@ export declare class DeleteIndexRequest extends $tea.Model {
231
627
  });
232
628
  }
233
629
  export declare class DeleteIndexResponseBody extends $tea.Model {
630
+ /**
631
+ * @example
632
+ * Index.InvalidParameter
633
+ */
234
634
  code?: string;
635
+ /**
636
+ * @example
637
+ * Required parameter(%s) missing or invalid, please check the request parameters.
638
+ */
235
639
  message?: string;
640
+ /**
641
+ * @remarks
642
+ * Id of the request
643
+ *
644
+ * @example
645
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
646
+ */
236
647
  requestId?: string;
648
+ /**
649
+ * @example
650
+ * 200
651
+ */
237
652
  status?: string;
653
+ /**
654
+ * @example
655
+ * true
656
+ */
238
657
  success?: boolean;
239
658
  static names(): {
240
659
  [key: string]: string;
@@ -263,7 +682,18 @@ export declare class DeleteIndexResponse extends $tea.Model {
263
682
  });
264
683
  }
265
684
  export declare class DeleteIndexDocumentRequest extends $tea.Model {
685
+ /**
686
+ * @remarks
687
+ * This parameter is required.
688
+ */
266
689
  documentIds?: string[];
690
+ /**
691
+ * @remarks
692
+ * This parameter is required.
693
+ *
694
+ * @example
695
+ * 79c0aly8zw
696
+ */
267
697
  indexId?: string;
268
698
  static names(): {
269
699
  [key: string]: string;
@@ -276,7 +706,18 @@ export declare class DeleteIndexDocumentRequest extends $tea.Model {
276
706
  });
277
707
  }
278
708
  export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
709
+ /**
710
+ * @remarks
711
+ * This parameter is required.
712
+ */
279
713
  documentIdsShrink?: string;
714
+ /**
715
+ * @remarks
716
+ * This parameter is required.
717
+ *
718
+ * @example
719
+ * 79c0aly8zw
720
+ */
280
721
  indexId?: string;
281
722
  static names(): {
282
723
  [key: string]: string;
@@ -289,11 +730,34 @@ export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
289
730
  });
290
731
  }
291
732
  export declare class DeleteIndexDocumentResponseBody extends $tea.Model {
733
+ /**
734
+ * @example
735
+ * Index.InvalidParameter
736
+ */
292
737
  code?: string;
293
738
  data?: DeleteIndexDocumentResponseBodyData;
739
+ /**
740
+ * @example
741
+ * Required parameter(%s) missing or invalid, please check the request parameters.
742
+ */
294
743
  message?: string;
744
+ /**
745
+ * @remarks
746
+ * Id of the request
747
+ *
748
+ * @example
749
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
750
+ */
295
751
  requestId?: string;
752
+ /**
753
+ * @example
754
+ * 200
755
+ */
296
756
  status?: string;
757
+ /**
758
+ * @example
759
+ * true
760
+ */
297
761
  success?: boolean;
298
762
  static names(): {
299
763
  [key: string]: string;
@@ -322,11 +786,31 @@ export declare class DeleteIndexDocumentResponse extends $tea.Model {
322
786
  });
323
787
  }
324
788
  export declare class DescribeFileResponseBody extends $tea.Model {
789
+ /**
790
+ * @example
791
+ * Success
792
+ */
325
793
  code?: string;
326
794
  data?: DescribeFileResponseBodyData;
795
+ /**
796
+ * @example
797
+ * Requests throttling triggered.
798
+ */
327
799
  message?: string;
800
+ /**
801
+ * @example
802
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
803
+ */
328
804
  requestId?: string;
805
+ /**
806
+ * @example
807
+ * 200
808
+ */
329
809
  status?: string;
810
+ /**
811
+ * @example
812
+ * true
813
+ */
330
814
  success?: boolean;
331
815
  static names(): {
332
816
  [key: string]: string;
@@ -355,7 +839,21 @@ export declare class DescribeFileResponse extends $tea.Model {
355
839
  });
356
840
  }
357
841
  export declare class GetIndexJobStatusRequest extends $tea.Model {
842
+ /**
843
+ * @remarks
844
+ * This parameter is required.
845
+ *
846
+ * @example
847
+ * 79c0aly8zw
848
+ */
358
849
  indexId?: string;
850
+ /**
851
+ * @remarks
852
+ * This parameter is required.
853
+ *
854
+ * @example
855
+ * 20230718xxxx-146c93bf
856
+ */
359
857
  jobId?: string;
360
858
  static names(): {
361
859
  [key: string]: string;
@@ -368,11 +866,31 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
368
866
  });
369
867
  }
370
868
  export declare class GetIndexJobStatusResponseBody extends $tea.Model {
869
+ /**
870
+ * @example
871
+ * Index.Forbidden
872
+ */
371
873
  code?: string;
372
874
  data?: GetIndexJobStatusResponseBodyData;
875
+ /**
876
+ * @example
877
+ * User not authorized to operate on the specified resource.
878
+ */
373
879
  message?: string;
880
+ /**
881
+ * @example
882
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
883
+ */
374
884
  requestId?: string;
885
+ /**
886
+ * @example
887
+ * 200
888
+ */
375
889
  status?: string;
890
+ /**
891
+ * @example
892
+ * true
893
+ */
376
894
  success?: boolean;
377
895
  static names(): {
378
896
  [key: string]: string;
@@ -400,11 +918,120 @@ export declare class GetIndexJobStatusResponse extends $tea.Model {
400
918
  [key: string]: any;
401
919
  });
402
920
  }
921
+ export declare class ListCategoryRequest extends $tea.Model {
922
+ /**
923
+ * @remarks
924
+ * This parameter is required.
925
+ *
926
+ * @example
927
+ * UNSTRUCTURED
928
+ */
929
+ categoryType?: string;
930
+ /**
931
+ * @example
932
+ * 20
933
+ */
934
+ maxResults?: number;
935
+ /**
936
+ * @example
937
+ * AAAAAdH70eOCSCKtacdomNzak4U=
938
+ */
939
+ nextToken?: string;
940
+ /**
941
+ * @example
942
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
943
+ */
944
+ parentCategoryId?: string;
945
+ static names(): {
946
+ [key: string]: string;
947
+ };
948
+ static types(): {
949
+ [key: string]: any;
950
+ };
951
+ constructor(map?: {
952
+ [key: string]: any;
953
+ });
954
+ }
955
+ export declare class ListCategoryResponseBody extends $tea.Model {
956
+ /**
957
+ * @example
958
+ * success
959
+ */
960
+ code?: string;
961
+ data?: ListCategoryResponseBodyData;
962
+ /**
963
+ * @example
964
+ * workspace id is null or invalid.
965
+ */
966
+ message?: string;
967
+ /**
968
+ * @remarks
969
+ * Id of the request
970
+ *
971
+ * @example
972
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
973
+ */
974
+ requestId?: string;
975
+ /**
976
+ * @example
977
+ * 200
978
+ */
979
+ status?: string;
980
+ /**
981
+ * @example
982
+ * true
983
+ */
984
+ success?: boolean;
985
+ static names(): {
986
+ [key: string]: string;
987
+ };
988
+ static types(): {
989
+ [key: string]: any;
990
+ };
991
+ constructor(map?: {
992
+ [key: string]: any;
993
+ });
994
+ }
995
+ export declare class ListCategoryResponse extends $tea.Model {
996
+ headers?: {
997
+ [key: string]: string;
998
+ };
999
+ statusCode?: number;
1000
+ body?: ListCategoryResponseBody;
1001
+ static names(): {
1002
+ [key: string]: string;
1003
+ };
1004
+ static types(): {
1005
+ [key: string]: any;
1006
+ };
1007
+ constructor(map?: {
1008
+ [key: string]: any;
1009
+ });
1010
+ }
403
1011
  export declare class ListChunksRequest extends $tea.Model {
404
1012
  fields?: string[];
1013
+ /**
1014
+ * @example
1015
+ * file_5f03dfea56da4050ab68d61871fc4cb3_10151493
1016
+ */
405
1017
  filed?: string;
1018
+ /**
1019
+ * @remarks
1020
+ * This parameter is required.
1021
+ *
1022
+ * @example
1023
+ * otoru9en4v
1024
+ */
406
1025
  indexId?: string;
1026
+ /**
1027
+ * @example
1028
+ * 1
1029
+ */
407
1030
  pageNum?: number;
1031
+ /**
1032
+ * @example
1033
+ * 10
1034
+ */
408
1035
  pageSize?: number;
409
1036
  static names(): {
410
1037
  [key: string]: string;
@@ -417,11 +1044,34 @@ export declare class ListChunksRequest extends $tea.Model {
417
1044
  });
418
1045
  }
419
1046
  export declare class ListChunksResponseBody extends $tea.Model {
1047
+ /**
1048
+ * @example
1049
+ * Index.InvalidParameter
1050
+ */
420
1051
  code?: string;
421
1052
  data?: ListChunksResponseBodyData;
1053
+ /**
1054
+ * @example
1055
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1056
+ */
422
1057
  message?: string;
1058
+ /**
1059
+ * @remarks
1060
+ * Id of the request
1061
+ *
1062
+ * @example
1063
+ * 8F97A63B-55F1-527F-9D6E-467B6A7E8CF1
1064
+ */
423
1065
  requestId?: string;
1066
+ /**
1067
+ * @example
1068
+ * 200
1069
+ */
424
1070
  status?: string;
1071
+ /**
1072
+ * @example
1073
+ * true
1074
+ */
425
1075
  success?: boolean;
426
1076
  static names(): {
427
1077
  [key: string]: string;
@@ -451,9 +1101,28 @@ export declare class ListChunksResponse extends $tea.Model {
451
1101
  }
452
1102
  export declare class ListIndexDocumentsRequest extends $tea.Model {
453
1103
  documentName?: string;
1104
+ /**
1105
+ * @example
1106
+ * FINISH
1107
+ */
454
1108
  documentStatus?: string;
1109
+ /**
1110
+ * @remarks
1111
+ * This parameter is required.
1112
+ *
1113
+ * @example
1114
+ * 79c0aly8zw
1115
+ */
455
1116
  indexId?: string;
1117
+ /**
1118
+ * @example
1119
+ * 1
1120
+ */
456
1121
  pageNumber?: number;
1122
+ /**
1123
+ * @example
1124
+ * 10
1125
+ */
457
1126
  pageSize?: number;
458
1127
  static names(): {
459
1128
  [key: string]: string;
@@ -466,11 +1135,34 @@ export declare class ListIndexDocumentsRequest extends $tea.Model {
466
1135
  });
467
1136
  }
468
1137
  export declare class ListIndexDocumentsResponseBody extends $tea.Model {
1138
+ /**
1139
+ * @example
1140
+ * InvalidParameter
1141
+ */
469
1142
  code?: string;
470
1143
  data?: ListIndexDocumentsResponseBodyData;
1144
+ /**
1145
+ * @example
1146
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1147
+ */
471
1148
  message?: string;
1149
+ /**
1150
+ * @remarks
1151
+ * Id of the request
1152
+ *
1153
+ * @example
1154
+ * 35A267BF-xxxx-54DB-8394-AA3B0742D833
1155
+ */
472
1156
  requestId?: string;
1157
+ /**
1158
+ * @example
1159
+ * 200
1160
+ */
473
1161
  status?: string;
1162
+ /**
1163
+ * @example
1164
+ * true
1165
+ */
474
1166
  success?: boolean;
475
1167
  static names(): {
476
1168
  [key: string]: string;
@@ -499,8 +1191,20 @@ export declare class ListIndexDocumentsResponse extends $tea.Model {
499
1191
  });
500
1192
  }
501
1193
  export declare class ListIndicesRequest extends $tea.Model {
1194
+ /**
1195
+ * @example
1196
+ * idx_status_score
1197
+ */
502
1198
  indexName?: string;
1199
+ /**
1200
+ * @example
1201
+ * 1
1202
+ */
503
1203
  pageNumber?: string;
1204
+ /**
1205
+ * @example
1206
+ * 10
1207
+ */
504
1208
  pageSize?: string;
505
1209
  static names(): {
506
1210
  [key: string]: string;
@@ -513,11 +1217,34 @@ export declare class ListIndicesRequest extends $tea.Model {
513
1217
  });
514
1218
  }
515
1219
  export declare class ListIndicesResponseBody extends $tea.Model {
1220
+ /**
1221
+ * @example
1222
+ * Index.InvalidParameter
1223
+ */
516
1224
  code?: string;
517
1225
  data?: ListIndicesResponseBodyData;
1226
+ /**
1227
+ * @example
1228
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1229
+ */
518
1230
  message?: string;
1231
+ /**
1232
+ * @remarks
1233
+ * Id of the request
1234
+ *
1235
+ * @example
1236
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
1237
+ */
519
1238
  requestId?: string;
1239
+ /**
1240
+ * @example
1241
+ * 200
1242
+ */
520
1243
  status?: string;
1244
+ /**
1245
+ * @example
1246
+ * true
1247
+ */
521
1248
  success?: boolean;
522
1249
  static names(): {
523
1250
  [key: string]: string;
@@ -546,16 +1273,54 @@ export declare class ListIndicesResponse extends $tea.Model {
546
1273
  });
547
1274
  }
548
1275
  export declare class RetrieveRequest extends $tea.Model {
1276
+ /**
1277
+ * @example
1278
+ * 100
1279
+ */
549
1280
  denseSimilarityTopK?: number;
1281
+ /**
1282
+ * @example
1283
+ * true
1284
+ */
550
1285
  enableReranking?: boolean;
1286
+ /**
1287
+ * @example
1288
+ * false
1289
+ */
551
1290
  enableRewrite?: boolean;
1291
+ /**
1292
+ * @remarks
1293
+ * This parameter is required.
1294
+ *
1295
+ * @example
1296
+ * 5pwe0m2g6t
1297
+ */
552
1298
  indexId?: string;
553
1299
  query?: string;
554
1300
  rerank?: RetrieveRequestRerank[];
1301
+ /**
1302
+ * @example
1303
+ * 0.20
1304
+ */
555
1305
  rerankMinScore?: number;
1306
+ /**
1307
+ * @example
1308
+ * 5
1309
+ */
556
1310
  rerankTopN?: number;
557
1311
  rewrite?: RetrieveRequestRewrite[];
1312
+ /**
1313
+ * @example
1314
+ * false
1315
+ */
558
1316
  saveRetrieverHistory?: boolean;
1317
+ searchFilters?: {
1318
+ [key: string]: string;
1319
+ }[];
1320
+ /**
1321
+ * @example
1322
+ * 100
1323
+ */
559
1324
  sparseSimilarityTopK?: number;
560
1325
  static names(): {
561
1326
  [key: string]: string;
@@ -568,16 +1333,52 @@ export declare class RetrieveRequest extends $tea.Model {
568
1333
  });
569
1334
  }
570
1335
  export declare class RetrieveShrinkRequest extends $tea.Model {
1336
+ /**
1337
+ * @example
1338
+ * 100
1339
+ */
571
1340
  denseSimilarityTopK?: number;
1341
+ /**
1342
+ * @example
1343
+ * true
1344
+ */
572
1345
  enableReranking?: boolean;
1346
+ /**
1347
+ * @example
1348
+ * false
1349
+ */
573
1350
  enableRewrite?: boolean;
1351
+ /**
1352
+ * @remarks
1353
+ * This parameter is required.
1354
+ *
1355
+ * @example
1356
+ * 5pwe0m2g6t
1357
+ */
574
1358
  indexId?: string;
575
1359
  query?: string;
576
1360
  rerankShrink?: string;
1361
+ /**
1362
+ * @example
1363
+ * 0.20
1364
+ */
577
1365
  rerankMinScore?: number;
1366
+ /**
1367
+ * @example
1368
+ * 5
1369
+ */
578
1370
  rerankTopN?: number;
579
1371
  rewriteShrink?: string;
1372
+ /**
1373
+ * @example
1374
+ * false
1375
+ */
580
1376
  saveRetrieverHistory?: boolean;
1377
+ searchFiltersShrink?: string;
1378
+ /**
1379
+ * @example
1380
+ * 100
1381
+ */
581
1382
  sparseSimilarityTopK?: number;
582
1383
  static names(): {
583
1384
  [key: string]: string;
@@ -590,11 +1391,34 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
590
1391
  });
591
1392
  }
592
1393
  export declare class RetrieveResponseBody extends $tea.Model {
1394
+ /**
1395
+ * @example
1396
+ * Index.InvalidParameter
1397
+ */
593
1398
  code?: string;
594
1399
  data?: RetrieveResponseBodyData;
1400
+ /**
1401
+ * @example
1402
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1403
+ */
595
1404
  message?: string;
1405
+ /**
1406
+ * @remarks
1407
+ * Id of the request
1408
+ *
1409
+ * @example
1410
+ * 17204B98-7734-4F9A-8464-2446A84821CA
1411
+ */
596
1412
  requestId?: string;
1413
+ /**
1414
+ * @example
1415
+ * 200
1416
+ */
597
1417
  status?: string;
1418
+ /**
1419
+ * @example
1420
+ * true
1421
+ */
598
1422
  success?: boolean;
599
1423
  static names(): {
600
1424
  [key: string]: string;
@@ -625,7 +1449,21 @@ export declare class RetrieveResponse extends $tea.Model {
625
1449
  export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
626
1450
  categoryIds?: string[];
627
1451
  documentIds?: string[];
1452
+ /**
1453
+ * @remarks
1454
+ * This parameter is required.
1455
+ *
1456
+ * @example
1457
+ * 79c0aly8zw
1458
+ */
628
1459
  indexId?: string;
1460
+ /**
1461
+ * @remarks
1462
+ * This parameter is required.
1463
+ *
1464
+ * @example
1465
+ * DATA_CENTER_FILE
1466
+ */
629
1467
  sourceType?: string;
630
1468
  static names(): {
631
1469
  [key: string]: string;
@@ -640,7 +1478,21 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
640
1478
  export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model {
641
1479
  categoryIdsShrink?: string;
642
1480
  documentIdsShrink?: string;
1481
+ /**
1482
+ * @remarks
1483
+ * This parameter is required.
1484
+ *
1485
+ * @example
1486
+ * 79c0aly8zw
1487
+ */
643
1488
  indexId?: string;
1489
+ /**
1490
+ * @remarks
1491
+ * This parameter is required.
1492
+ *
1493
+ * @example
1494
+ * DATA_CENTER_FILE
1495
+ */
644
1496
  sourceType?: string;
645
1497
  static names(): {
646
1498
  [key: string]: string;
@@ -653,11 +1505,34 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
653
1505
  });
654
1506
  }
655
1507
  export declare class SubmitIndexAddDocumentsJobResponseBody extends $tea.Model {
1508
+ /**
1509
+ * @example
1510
+ * Index.InvalidParameter
1511
+ */
656
1512
  code?: string;
657
1513
  data?: SubmitIndexAddDocumentsJobResponseBodyData;
1514
+ /**
1515
+ * @example
1516
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1517
+ */
658
1518
  message?: string;
1519
+ /**
1520
+ * @remarks
1521
+ * Id of the request
1522
+ *
1523
+ * @example
1524
+ * 778C0B3B-03C1-5FC1-A947-36EDD13606AB
1525
+ */
659
1526
  requestId?: string;
1527
+ /**
1528
+ * @example
1529
+ * 200
1530
+ */
660
1531
  status?: string;
1532
+ /**
1533
+ * @example
1534
+ * true
1535
+ */
661
1536
  success?: boolean;
662
1537
  static names(): {
663
1538
  [key: string]: string;
@@ -686,6 +1561,13 @@ export declare class SubmitIndexAddDocumentsJobResponse extends $tea.Model {
686
1561
  });
687
1562
  }
688
1563
  export declare class SubmitIndexJobRequest extends $tea.Model {
1564
+ /**
1565
+ * @remarks
1566
+ * This parameter is required.
1567
+ *
1568
+ * @example
1569
+ * 79c0aly8zw
1570
+ */
689
1571
  indexId?: string;
690
1572
  static names(): {
691
1573
  [key: string]: string;
@@ -698,11 +1580,34 @@ export declare class SubmitIndexJobRequest extends $tea.Model {
698
1580
  });
699
1581
  }
700
1582
  export declare class SubmitIndexJobResponseBody extends $tea.Model {
1583
+ /**
1584
+ * @example
1585
+ * InvalidParameter
1586
+ */
701
1587
  code?: string;
702
1588
  data?: SubmitIndexJobResponseBodyData;
1589
+ /**
1590
+ * @example
1591
+ * Required parameter(%s) missing or invalid, please check the request parameters.
1592
+ */
703
1593
  message?: string;
1594
+ /**
1595
+ * @remarks
1596
+ * Id of the request
1597
+ *
1598
+ * @example
1599
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
1600
+ */
704
1601
  requestId?: string;
1602
+ /**
1603
+ * @example
1604
+ * Success
1605
+ */
705
1606
  status?: string;
1607
+ /**
1608
+ * @example
1609
+ * True
1610
+ */
706
1611
  success?: boolean;
707
1612
  static names(): {
708
1613
  [key: string]: string;
@@ -730,8 +1635,33 @@ export declare class SubmitIndexJobResponse extends $tea.Model {
730
1635
  [key: string]: any;
731
1636
  });
732
1637
  }
1638
+ export declare class AddCategoryResponseBodyData extends $tea.Model {
1639
+ /**
1640
+ * @example
1641
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
1642
+ */
1643
+ categoryId?: string;
1644
+ categoryName?: string;
1645
+ static names(): {
1646
+ [key: string]: string;
1647
+ };
1648
+ static types(): {
1649
+ [key: string]: any;
1650
+ };
1651
+ constructor(map?: {
1652
+ [key: string]: any;
1653
+ });
1654
+ }
733
1655
  export declare class AddFileResponseBodyData extends $tea.Model {
1656
+ /**
1657
+ * @example
1658
+ * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
1659
+ */
734
1660
  fileId?: string;
1661
+ /**
1662
+ * @example
1663
+ * DASHSCOPE_DOCMIND
1664
+ */
735
1665
  parser?: string;
736
1666
  static names(): {
737
1667
  [key: string]: string;
@@ -744,8 +1674,21 @@ export declare class AddFileResponseBodyData extends $tea.Model {
744
1674
  });
745
1675
  }
746
1676
  export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Model {
1677
+ /**
1678
+ * @example
1679
+ * "X-bailian-extra": "MTAwNTQyNjQ5NTE2OTE3OA==",
1680
+ * "Content-Type": "application/pdf"
1681
+ */
747
1682
  headers?: any;
1683
+ /**
1684
+ * @example
1685
+ * PUT
1686
+ */
748
1687
  method?: string;
1688
+ /**
1689
+ * @example
1690
+ * https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
1691
+ */
749
1692
  url?: string;
750
1693
  static names(): {
751
1694
  [key: string]: string;
@@ -758,8 +1701,16 @@ export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Mode
758
1701
  });
759
1702
  }
760
1703
  export declare class ApplyFileUploadLeaseResponseBodyData extends $tea.Model {
1704
+ /**
1705
+ * @example
1706
+ * 1e6a159107384782be5e45ac4759b247.1719325231035
1707
+ */
761
1708
  fileUploadLeaseId?: string;
762
1709
  param?: ApplyFileUploadLeaseResponseBodyDataParam;
1710
+ /**
1711
+ * @example
1712
+ * HTTP
1713
+ */
763
1714
  type?: string;
764
1715
  static names(): {
765
1716
  [key: string]: string;
@@ -788,6 +1739,10 @@ export declare class CreateIndexRequestColumns extends $tea.Model {
788
1739
  });
789
1740
  }
790
1741
  export declare class CreateIndexResponseBodyData extends $tea.Model {
1742
+ /**
1743
+ * @example
1744
+ * jkurxhju6b
1745
+ */
791
1746
  id?: string;
792
1747
  static names(): {
793
1748
  [key: string]: string;
@@ -799,7 +1754,27 @@ export declare class CreateIndexResponseBodyData extends $tea.Model {
799
1754
  [key: string]: any;
800
1755
  });
801
1756
  }
1757
+ export declare class DeleteCategoryResponseBodyData extends $tea.Model {
1758
+ /**
1759
+ * @example
1760
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
1761
+ */
1762
+ categoryId?: string;
1763
+ static names(): {
1764
+ [key: string]: string;
1765
+ };
1766
+ static types(): {
1767
+ [key: string]: any;
1768
+ };
1769
+ constructor(map?: {
1770
+ [key: string]: any;
1771
+ });
1772
+ }
802
1773
  export declare class DeleteFileResponseBodyData extends $tea.Model {
1774
+ /**
1775
+ * @example
1776
+ * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
1777
+ */
803
1778
  fileId?: string;
804
1779
  static names(): {
805
1780
  [key: string]: string;
@@ -824,13 +1799,45 @@ export declare class DeleteIndexDocumentResponseBodyData extends $tea.Model {
824
1799
  });
825
1800
  }
826
1801
  export declare class DescribeFileResponseBodyData extends $tea.Model {
1802
+ /**
1803
+ * @example
1804
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
1805
+ */
827
1806
  categoryId?: string;
1807
+ /**
1808
+ * @example
1809
+ * 2024-05-26 12:45:43
1810
+ */
828
1811
  createTime?: string;
1812
+ /**
1813
+ * @example
1814
+ * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
1815
+ */
829
1816
  fileId?: string;
1817
+ /**
1818
+ * @example
1819
+ * test.pdf
1820
+ */
830
1821
  fileName?: string;
1822
+ /**
1823
+ * @example
1824
+ * pdf
1825
+ */
831
1826
  fileType?: string;
1827
+ /**
1828
+ * @example
1829
+ * DASHSCOPE_DOCMIND
1830
+ */
832
1831
  parser?: string;
1832
+ /**
1833
+ * @example
1834
+ * 1234
1835
+ */
833
1836
  sizeInBytes?: number;
1837
+ /**
1838
+ * @example
1839
+ * PARSE_SUCCESS
1840
+ */
834
1841
  status?: string;
835
1842
  static names(): {
836
1843
  [key: string]: string;
@@ -843,10 +1850,26 @@ export declare class DescribeFileResponseBodyData extends $tea.Model {
843
1850
  });
844
1851
  }
845
1852
  export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Model {
1853
+ /**
1854
+ * @example
1855
+ * Index.Document.ChunkError
1856
+ */
846
1857
  code?: string;
1858
+ /**
1859
+ * @example
1860
+ * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
1861
+ */
847
1862
  docId?: string;
848
1863
  docName?: string;
1864
+ /**
1865
+ * @example
1866
+ * document parse error
1867
+ */
849
1868
  message?: string;
1869
+ /**
1870
+ * @example
1871
+ * RUNNING
1872
+ */
850
1873
  status?: string;
851
1874
  static names(): {
852
1875
  [key: string]: string;
@@ -860,7 +1883,15 @@ export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Mod
860
1883
  }
861
1884
  export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
862
1885
  documents?: GetIndexJobStatusResponseBodyDataDocuments[];
1886
+ /**
1887
+ * @example
1888
+ * 66122af12a4e45ddae6bd6c845556647
1889
+ */
863
1890
  jobId?: string;
1891
+ /**
1892
+ * @example
1893
+ * PENDING
1894
+ */
864
1895
  status?: string;
865
1896
  static names(): {
866
1897
  [key: string]: string;
@@ -872,8 +1903,76 @@ export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
872
1903
  [key: string]: any;
873
1904
  });
874
1905
  }
1906
+ export declare class ListCategoryResponseBodyDataCategoryList extends $tea.Model {
1907
+ /**
1908
+ * @example
1909
+ * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
1910
+ */
1911
+ categoryId?: string;
1912
+ categoryName?: string;
1913
+ /**
1914
+ * @example
1915
+ * UNSTRUCTURED
1916
+ */
1917
+ categoryType?: string;
1918
+ /**
1919
+ * @example
1920
+ * true
1921
+ */
1922
+ isDefault?: boolean;
1923
+ /**
1924
+ * @example
1925
+ * cate_addd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
1926
+ */
1927
+ parentCategoryId?: string;
1928
+ static names(): {
1929
+ [key: string]: string;
1930
+ };
1931
+ static types(): {
1932
+ [key: string]: any;
1933
+ };
1934
+ constructor(map?: {
1935
+ [key: string]: any;
1936
+ });
1937
+ }
1938
+ export declare class ListCategoryResponseBodyData extends $tea.Model {
1939
+ categoryList?: ListCategoryResponseBodyDataCategoryList[];
1940
+ /**
1941
+ * @example
1942
+ * true
1943
+ */
1944
+ hasNext?: boolean;
1945
+ /**
1946
+ * @example
1947
+ * 20
1948
+ */
1949
+ maxResults?: number;
1950
+ /**
1951
+ * @example
1952
+ * AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ
1953
+ */
1954
+ nextToken?: string;
1955
+ /**
1956
+ * @example
1957
+ * 20
1958
+ */
1959
+ totalCount?: number;
1960
+ static names(): {
1961
+ [key: string]: string;
1962
+ };
1963
+ static types(): {
1964
+ [key: string]: any;
1965
+ };
1966
+ constructor(map?: {
1967
+ [key: string]: any;
1968
+ });
1969
+ }
875
1970
  export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
876
1971
  metadata?: any;
1972
+ /**
1973
+ * @example
1974
+ * 0.3
1975
+ */
877
1976
  score?: number;
878
1977
  text?: string;
879
1978
  static names(): {
@@ -888,6 +1987,10 @@ export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
888
1987
  }
889
1988
  export declare class ListChunksResponseBodyData extends $tea.Model {
890
1989
  nodes?: ListChunksResponseBodyDataNodes[];
1990
+ /**
1991
+ * @example
1992
+ * 16
1993
+ */
891
1994
  total?: number;
892
1995
  static names(): {
893
1996
  [key: string]: string;
@@ -900,13 +2003,41 @@ export declare class ListChunksResponseBodyData extends $tea.Model {
900
2003
  });
901
2004
  }
902
2005
  export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Model {
2006
+ /**
2007
+ * @example
2008
+ * 110002
2009
+ */
903
2010
  code?: string;
2011
+ /**
2012
+ * @example
2013
+ * pdf
2014
+ */
904
2015
  documentType?: string;
2016
+ /**
2017
+ * @example
2018
+ * doc_c134aa2073204a5d936d870bf960f56a10024701
2019
+ */
905
2020
  id?: string;
2021
+ /**
2022
+ * @example
2023
+ * check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
2024
+ */
906
2025
  message?: string;
907
2026
  name?: string;
2027
+ /**
2028
+ * @example
2029
+ * 996764
2030
+ */
908
2031
  size?: number;
2032
+ /**
2033
+ * @example
2034
+ * cate_21a407a3372c4ba7aedc649709143f0c10021401
2035
+ */
909
2036
  sourceId?: string;
2037
+ /**
2038
+ * @example
2039
+ * RUNNING
2040
+ */
910
2041
  status?: string;
911
2042
  static names(): {
912
2043
  [key: string]: string;
@@ -920,9 +2051,25 @@ export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Mo
920
2051
  }
921
2052
  export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
922
2053
  documents?: ListIndexDocumentsResponseBodyDataDocuments[];
2054
+ /**
2055
+ * @example
2056
+ * pno97tn8iu
2057
+ */
923
2058
  indexId?: string;
2059
+ /**
2060
+ * @example
2061
+ * 1
2062
+ */
924
2063
  pageNumber?: number;
2064
+ /**
2065
+ * @example
2066
+ * 10
2067
+ */
925
2068
  pageSize?: number;
2069
+ /**
2070
+ * @example
2071
+ * 2437
2072
+ */
926
2073
  totalCount?: number;
927
2074
  static names(): {
928
2075
  [key: string]: string;
@@ -935,20 +2082,76 @@ export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
935
2082
  });
936
2083
  }
937
2084
  export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
2085
+ /**
2086
+ * @example
2087
+ * 5
2088
+ */
938
2089
  chunkSize?: number;
2090
+ /**
2091
+ * @example
2092
+ * If each RAM user belongs to a RAM group, the configuration is considered compliant.
2093
+ */
939
2094
  description?: string;
940
2095
  documentIds?: string[];
2096
+ /**
2097
+ * @example
2098
+ * conv-rewrite-qwen-1.8b
2099
+ */
941
2100
  embeddingModelName?: string;
2101
+ /**
2102
+ * @example
2103
+ * 259899
2104
+ */
942
2105
  id?: string;
2106
+ /**
2107
+ * @example
2108
+ * temp_mUB4j
2109
+ */
943
2110
  name?: string;
2111
+ /**
2112
+ * @example
2113
+ * 10
2114
+ */
944
2115
  overlapSize?: number;
2116
+ /**
2117
+ * @example
2118
+ * 0.01
2119
+ */
945
2120
  rerankMinScore?: string;
2121
+ /**
2122
+ * @example
2123
+ * gte-rerank-hybrid
2124
+ */
946
2125
  rerankModelName?: string;
2126
+ /**
2127
+ * @example
2128
+ * \\n
2129
+ */
947
2130
  separator?: string;
2131
+ /**
2132
+ * @example
2133
+ * gp-bp1gq62t1788yw2ol
2134
+ */
948
2135
  sinkInstanceId?: string;
2136
+ /**
2137
+ * @example
2138
+ * cn-hangzhou
2139
+ */
949
2140
  sinkRegion?: string;
2141
+ /**
2142
+ * @example
2143
+ * es
2144
+ */
950
2145
  sinkType?: string;
2146
+ /**
2147
+ * @example
2148
+ * DATA_CENTER_FILE
2149
+ */
951
2150
  sourceType?: string;
2151
+ /**
2152
+ * @example
2153
+ * structured
2154
+ */
952
2155
  structureType?: string;
953
2156
  static names(): {
954
2157
  [key: string]: string;
@@ -962,8 +2165,20 @@ export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
962
2165
  }
963
2166
  export declare class ListIndicesResponseBodyData extends $tea.Model {
964
2167
  indices?: ListIndicesResponseBodyDataIndices[];
2168
+ /**
2169
+ * @example
2170
+ * 1
2171
+ */
965
2172
  pageNumber?: number;
2173
+ /**
2174
+ * @example
2175
+ * 10
2176
+ */
966
2177
  pageSize?: number;
2178
+ /**
2179
+ * @example
2180
+ * 48
2181
+ */
967
2182
  totalCount?: number;
968
2183
  static names(): {
969
2184
  [key: string]: string;
@@ -976,6 +2191,10 @@ export declare class ListIndicesResponseBodyData extends $tea.Model {
976
2191
  });
977
2192
  }
978
2193
  export declare class RetrieveRequestRerank extends $tea.Model {
2194
+ /**
2195
+ * @example
2196
+ * gte-rerank-hybrid
2197
+ */
979
2198
  modelName?: string;
980
2199
  static names(): {
981
2200
  [key: string]: string;
@@ -1001,6 +2220,10 @@ export declare class RetrieveRequestRewrite extends $tea.Model {
1001
2220
  }
1002
2221
  export declare class RetrieveResponseBodyDataNodes extends $tea.Model {
1003
2222
  metadata?: any;
2223
+ /**
2224
+ * @example
2225
+ * 0.3
2226
+ */
1004
2227
  score?: number;
1005
2228
  text?: string;
1006
2229
  static names(): {
@@ -1026,6 +2249,10 @@ export declare class RetrieveResponseBodyData extends $tea.Model {
1026
2249
  });
1027
2250
  }
1028
2251
  export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Model {
2252
+ /**
2253
+ * @example
2254
+ * 42687eb254a34802bed398357f5498ae
2255
+ */
1029
2256
  id?: string;
1030
2257
  static names(): {
1031
2258
  [key: string]: string;
@@ -1038,7 +2265,15 @@ export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Mod
1038
2265
  });
1039
2266
  }
1040
2267
  export declare class SubmitIndexJobResponseBodyData extends $tea.Model {
2268
+ /**
2269
+ * @example
2270
+ * eFDr2fGRzP9gdDZWAdo3YQ==
2271
+ */
1041
2272
  id?: string;
2273
+ /**
2274
+ * @example
2275
+ * khdyak1uuj
2276
+ */
1042
2277
  indexId?: string;
1043
2278
  static names(): {
1044
2279
  [key: string]: string;
@@ -1056,251 +2291,293 @@ export default class Client extends OpenApi {
1056
2291
  [key: string]: string;
1057
2292
  }, endpoint: string): string;
1058
2293
  /**
1059
- * @summary 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
2294
+ * @param request - AddCategoryRequest
2295
+ * @param headers - map
2296
+ * @param runtime - runtime options for this request RuntimeOptions
2297
+ * @returns AddCategoryResponse
2298
+ */
2299
+ addCategoryWithOptions(WorkspaceId: string, request: AddCategoryRequest, headers: {
2300
+ [key: string]: string;
2301
+ }, runtime: $Util.RuntimeOptions): Promise<AddCategoryResponse>;
2302
+ /**
2303
+ * @param request - AddCategoryRequest
2304
+ * @returns AddCategoryResponse
2305
+ */
2306
+ addCategory(WorkspaceId: string, request: AddCategoryRequest): Promise<AddCategoryResponse>;
2307
+ /**
2308
+ * 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
1060
2309
  *
1061
- * @param request AddFileRequest
1062
- * @param headers map
1063
- * @param runtime runtime options for this request RuntimeOptions
1064
- * @return AddFileResponse
2310
+ * @param request - AddFileRequest
2311
+ * @param headers - map
2312
+ * @param runtime - runtime options for this request RuntimeOptions
2313
+ * @returns AddFileResponse
1065
2314
  */
1066
2315
  addFileWithOptions(WorkspaceId: string, request: AddFileRequest, headers: {
1067
2316
  [key: string]: string;
1068
2317
  }, runtime: $Util.RuntimeOptions): Promise<AddFileResponse>;
1069
2318
  /**
1070
- * @summary 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
2319
+ * 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
1071
2320
  *
1072
- * @param request AddFileRequest
1073
- * @return AddFileResponse
2321
+ * @param request - AddFileRequest
2322
+ * @returns AddFileResponse
1074
2323
  */
1075
2324
  addFile(WorkspaceId: string, request: AddFileRequest): Promise<AddFileResponse>;
1076
2325
  /**
1077
- * @summary 请求文档上传租约,进行文档上传。
2326
+ * 请求文档上传租约,进行文档上传。
1078
2327
  *
1079
- * @param request ApplyFileUploadLeaseRequest
1080
- * @param headers map
1081
- * @param runtime runtime options for this request RuntimeOptions
1082
- * @return ApplyFileUploadLeaseResponse
2328
+ * @param request - ApplyFileUploadLeaseRequest
2329
+ * @param headers - map
2330
+ * @param runtime - runtime options for this request RuntimeOptions
2331
+ * @returns ApplyFileUploadLeaseResponse
1083
2332
  */
1084
2333
  applyFileUploadLeaseWithOptions(CategoryId: string, WorkspaceId: string, request: ApplyFileUploadLeaseRequest, headers: {
1085
2334
  [key: string]: string;
1086
2335
  }, runtime: $Util.RuntimeOptions): Promise<ApplyFileUploadLeaseResponse>;
1087
2336
  /**
1088
- * @summary 请求文档上传租约,进行文档上传。
2337
+ * 请求文档上传租约,进行文档上传。
1089
2338
  *
1090
- * @param request ApplyFileUploadLeaseRequest
1091
- * @return ApplyFileUploadLeaseResponse
2339
+ * @param request - ApplyFileUploadLeaseRequest
2340
+ * @returns ApplyFileUploadLeaseResponse
1092
2341
  */
1093
2342
  applyFileUploadLease(CategoryId: string, WorkspaceId: string, request: ApplyFileUploadLeaseRequest): Promise<ApplyFileUploadLeaseResponse>;
1094
2343
  /**
1095
- * @summary 创建并运行pipeline
2344
+ * 创建并运行pipeline
1096
2345
  *
1097
- * @param tmpReq CreateIndexRequest
1098
- * @param headers map
1099
- * @param runtime runtime options for this request RuntimeOptions
1100
- * @return CreateIndexResponse
2346
+ * @param tmpReq - CreateIndexRequest
2347
+ * @param headers - map
2348
+ * @param runtime - runtime options for this request RuntimeOptions
2349
+ * @returns CreateIndexResponse
1101
2350
  */
1102
2351
  createIndexWithOptions(WorkspaceId: string, tmpReq: CreateIndexRequest, headers: {
1103
2352
  [key: string]: string;
1104
2353
  }, runtime: $Util.RuntimeOptions): Promise<CreateIndexResponse>;
1105
2354
  /**
1106
- * @summary 创建并运行pipeline
2355
+ * 创建并运行pipeline
1107
2356
  *
1108
- * @param request CreateIndexRequest
1109
- * @return CreateIndexResponse
2357
+ * @param request - CreateIndexRequest
2358
+ * @returns CreateIndexResponse
1110
2359
  */
1111
2360
  createIndex(WorkspaceId: string, request: CreateIndexRequest): Promise<CreateIndexResponse>;
1112
2361
  /**
1113
- * @summary 删除文档
2362
+ * @param headers - map
2363
+ * @param runtime - runtime options for this request RuntimeOptions
2364
+ * @returns DeleteCategoryResponse
2365
+ */
2366
+ deleteCategoryWithOptions(CategoryId: string, WorkspaceId: string, headers: {
2367
+ [key: string]: string;
2368
+ }, runtime: $Util.RuntimeOptions): Promise<DeleteCategoryResponse>;
2369
+ /**
2370
+ * @returns DeleteCategoryResponse
2371
+ */
2372
+ deleteCategory(CategoryId: string, WorkspaceId: string): Promise<DeleteCategoryResponse>;
2373
+ /**
2374
+ * 删除文档
1114
2375
  *
1115
- * @param headers map
1116
- * @param runtime runtime options for this request RuntimeOptions
1117
- * @return DeleteFileResponse
2376
+ * @param headers - map
2377
+ * @param runtime - runtime options for this request RuntimeOptions
2378
+ * @returns DeleteFileResponse
1118
2379
  */
1119
2380
  deleteFileWithOptions(FileId: string, WorkspaceId: string, headers: {
1120
2381
  [key: string]: string;
1121
2382
  }, runtime: $Util.RuntimeOptions): Promise<DeleteFileResponse>;
1122
2383
  /**
1123
- * @summary 删除文档
1124
- *
1125
- * @return DeleteFileResponse
2384
+ * 删除文档
2385
+ * @returns DeleteFileResponse
1126
2386
  */
1127
2387
  deleteFile(FileId: string, WorkspaceId: string): Promise<DeleteFileResponse>;
1128
2388
  /**
1129
- * @summary 删除Index
2389
+ * 删除Index
1130
2390
  *
1131
- * @param request DeleteIndexRequest
1132
- * @param headers map
1133
- * @param runtime runtime options for this request RuntimeOptions
1134
- * @return DeleteIndexResponse
2391
+ * @param request - DeleteIndexRequest
2392
+ * @param headers - map
2393
+ * @param runtime - runtime options for this request RuntimeOptions
2394
+ * @returns DeleteIndexResponse
1135
2395
  */
1136
2396
  deleteIndexWithOptions(WorkspaceId: string, request: DeleteIndexRequest, headers: {
1137
2397
  [key: string]: string;
1138
2398
  }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexResponse>;
1139
2399
  /**
1140
- * @summary 删除Index
2400
+ * 删除Index
1141
2401
  *
1142
- * @param request DeleteIndexRequest
1143
- * @return DeleteIndexResponse
2402
+ * @param request - DeleteIndexRequest
2403
+ * @returns DeleteIndexResponse
1144
2404
  */
1145
2405
  deleteIndex(WorkspaceId: string, request: DeleteIndexRequest): Promise<DeleteIndexResponse>;
1146
2406
  /**
1147
- * @summary 删除index doc
2407
+ * 删除index doc
1148
2408
  *
1149
- * @param tmpReq DeleteIndexDocumentRequest
1150
- * @param headers map
1151
- * @param runtime runtime options for this request RuntimeOptions
1152
- * @return DeleteIndexDocumentResponse
2409
+ * @param tmpReq - DeleteIndexDocumentRequest
2410
+ * @param headers - map
2411
+ * @param runtime - runtime options for this request RuntimeOptions
2412
+ * @returns DeleteIndexDocumentResponse
1153
2413
  */
1154
2414
  deleteIndexDocumentWithOptions(WorkspaceId: string, tmpReq: DeleteIndexDocumentRequest, headers: {
1155
2415
  [key: string]: string;
1156
2416
  }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexDocumentResponse>;
1157
2417
  /**
1158
- * @summary 删除index doc
2418
+ * 删除index doc
1159
2419
  *
1160
- * @param request DeleteIndexDocumentRequest
1161
- * @return DeleteIndexDocumentResponse
2420
+ * @param request - DeleteIndexDocumentRequest
2421
+ * @returns DeleteIndexDocumentResponse
1162
2422
  */
1163
2423
  deleteIndexDocument(WorkspaceId: string, request: DeleteIndexDocumentRequest): Promise<DeleteIndexDocumentResponse>;
1164
2424
  /**
1165
- * @summary 获取文档基本信息,包括文档名称、类型、状态等。
2425
+ * 获取文档基本信息,包括文档名称、类型、状态等。
1166
2426
  *
1167
- * @param headers map
1168
- * @param runtime runtime options for this request RuntimeOptions
1169
- * @return DescribeFileResponse
2427
+ * @param headers - map
2428
+ * @param runtime - runtime options for this request RuntimeOptions
2429
+ * @returns DescribeFileResponse
1170
2430
  */
1171
2431
  describeFileWithOptions(WorkspaceId: string, FileId: string, headers: {
1172
2432
  [key: string]: string;
1173
2433
  }, runtime: $Util.RuntimeOptions): Promise<DescribeFileResponse>;
1174
2434
  /**
1175
- * @summary 获取文档基本信息,包括文档名称、类型、状态等。
1176
- *
1177
- * @return DescribeFileResponse
2435
+ * 获取文档基本信息,包括文档名称、类型、状态等。
2436
+ * @returns DescribeFileResponse
1178
2437
  */
1179
2438
  describeFile(WorkspaceId: string, FileId: string): Promise<DescribeFileResponse>;
1180
2439
  /**
1181
- * @summary 获取Index运行状态
2440
+ * 获取Index运行状态
1182
2441
  *
1183
- * @param request GetIndexJobStatusRequest
1184
- * @param headers map
1185
- * @param runtime runtime options for this request RuntimeOptions
1186
- * @return GetIndexJobStatusResponse
2442
+ * @param request - GetIndexJobStatusRequest
2443
+ * @param headers - map
2444
+ * @param runtime - runtime options for this request RuntimeOptions
2445
+ * @returns GetIndexJobStatusResponse
1187
2446
  */
1188
2447
  getIndexJobStatusWithOptions(WorkspaceId: string, request: GetIndexJobStatusRequest, headers: {
1189
2448
  [key: string]: string;
1190
2449
  }, runtime: $Util.RuntimeOptions): Promise<GetIndexJobStatusResponse>;
1191
2450
  /**
1192
- * @summary 获取Index运行状态
2451
+ * 获取Index运行状态
1193
2452
  *
1194
- * @param request GetIndexJobStatusRequest
1195
- * @return GetIndexJobStatusResponse
2453
+ * @param request - GetIndexJobStatusRequest
2454
+ * @returns GetIndexJobStatusResponse
1196
2455
  */
1197
2456
  getIndexJobStatus(WorkspaceId: string, request: GetIndexJobStatusRequest): Promise<GetIndexJobStatusResponse>;
1198
2457
  /**
1199
- * @summary Chunk
2458
+ * ListCategory
2459
+ *
2460
+ * @param request - ListCategoryRequest
2461
+ * @param headers - map
2462
+ * @param runtime - runtime options for this request RuntimeOptions
2463
+ * @returns ListCategoryResponse
2464
+ */
2465
+ listCategoryWithOptions(WorkspaceId: string, request: ListCategoryRequest, headers: {
2466
+ [key: string]: string;
2467
+ }, runtime: $Util.RuntimeOptions): Promise<ListCategoryResponse>;
2468
+ /**
2469
+ * ListCategory
2470
+ *
2471
+ * @param request - ListCategoryRequest
2472
+ * @returns ListCategoryResponse
2473
+ */
2474
+ listCategory(WorkspaceId: string, request: ListCategoryRequest): Promise<ListCategoryResponse>;
2475
+ /**
2476
+ * Chunk
1200
2477
  *
1201
- * @param request ListChunksRequest
1202
- * @param headers map
1203
- * @param runtime runtime options for this request RuntimeOptions
1204
- * @return ListChunksResponse
2478
+ * @param request - ListChunksRequest
2479
+ * @param headers - map
2480
+ * @param runtime - runtime options for this request RuntimeOptions
2481
+ * @returns ListChunksResponse
1205
2482
  */
1206
2483
  listChunksWithOptions(WorkspaceId: string, request: ListChunksRequest, headers: {
1207
2484
  [key: string]: string;
1208
2485
  }, runtime: $Util.RuntimeOptions): Promise<ListChunksResponse>;
1209
2486
  /**
1210
- * @summary Chunk
2487
+ * Chunk
1211
2488
  *
1212
- * @param request ListChunksRequest
1213
- * @return ListChunksResponse
2489
+ * @param request - ListChunksRequest
2490
+ * @returns ListChunksResponse
1214
2491
  */
1215
2492
  listChunks(WorkspaceId: string, request: ListChunksRequest): Promise<ListChunksResponse>;
1216
2493
  /**
1217
- * @summary 查询Index文件
2494
+ * 查询Index文件
1218
2495
  *
1219
- * @param request ListIndexDocumentsRequest
1220
- * @param headers map
1221
- * @param runtime runtime options for this request RuntimeOptions
1222
- * @return ListIndexDocumentsResponse
2496
+ * @param request - ListIndexDocumentsRequest
2497
+ * @param headers - map
2498
+ * @param runtime - runtime options for this request RuntimeOptions
2499
+ * @returns ListIndexDocumentsResponse
1223
2500
  */
1224
2501
  listIndexDocumentsWithOptions(WorkspaceId: string, request: ListIndexDocumentsRequest, headers: {
1225
2502
  [key: string]: string;
1226
2503
  }, runtime: $Util.RuntimeOptions): Promise<ListIndexDocumentsResponse>;
1227
2504
  /**
1228
- * @summary 查询Index文件
2505
+ * 查询Index文件
1229
2506
  *
1230
- * @param request ListIndexDocumentsRequest
1231
- * @return ListIndexDocumentsResponse
2507
+ * @param request - ListIndexDocumentsRequest
2508
+ * @returns ListIndexDocumentsResponse
1232
2509
  */
1233
2510
  listIndexDocuments(WorkspaceId: string, request: ListIndexDocumentsRequest): Promise<ListIndexDocumentsResponse>;
1234
2511
  /**
1235
- * @summary 查询pipeline
2512
+ * 查询pipeline
1236
2513
  *
1237
- * @param request ListIndicesRequest
1238
- * @param headers map
1239
- * @param runtime runtime options for this request RuntimeOptions
1240
- * @return ListIndicesResponse
2514
+ * @param request - ListIndicesRequest
2515
+ * @param headers - map
2516
+ * @param runtime - runtime options for this request RuntimeOptions
2517
+ * @returns ListIndicesResponse
1241
2518
  */
1242
2519
  listIndicesWithOptions(WorkspaceId: string, request: ListIndicesRequest, headers: {
1243
2520
  [key: string]: string;
1244
2521
  }, runtime: $Util.RuntimeOptions): Promise<ListIndicesResponse>;
1245
2522
  /**
1246
- * @summary 查询pipeline
2523
+ * 查询pipeline
1247
2524
  *
1248
- * @param request ListIndicesRequest
1249
- * @return ListIndicesResponse
2525
+ * @param request - ListIndicesRequest
2526
+ * @returns ListIndicesResponse
1250
2527
  */
1251
2528
  listIndices(WorkspaceId: string, request: ListIndicesRequest): Promise<ListIndicesResponse>;
1252
2529
  /**
1253
- * @summary 召回测试
2530
+ * 召回测试
1254
2531
  *
1255
- * @param tmpReq RetrieveRequest
1256
- * @param headers map
1257
- * @param runtime runtime options for this request RuntimeOptions
1258
- * @return RetrieveResponse
2532
+ * @param tmpReq - RetrieveRequest
2533
+ * @param headers - map
2534
+ * @param runtime - runtime options for this request RuntimeOptions
2535
+ * @returns RetrieveResponse
1259
2536
  */
1260
2537
  retrieveWithOptions(WorkspaceId: string, tmpReq: RetrieveRequest, headers: {
1261
2538
  [key: string]: string;
1262
2539
  }, runtime: $Util.RuntimeOptions): Promise<RetrieveResponse>;
1263
2540
  /**
1264
- * @summary 召回测试
2541
+ * 召回测试
1265
2542
  *
1266
- * @param request RetrieveRequest
1267
- * @return RetrieveResponse
2543
+ * @param request - RetrieveRequest
2544
+ * @returns RetrieveResponse
1268
2545
  */
1269
2546
  retrieve(WorkspaceId: string, request: RetrieveRequest): Promise<RetrieveResponse>;
1270
2547
  /**
1271
- * @summary 知识索引
2548
+ * 知识索引
1272
2549
  *
1273
- * @param tmpReq SubmitIndexAddDocumentsJobRequest
1274
- * @param headers map
1275
- * @param runtime runtime options for this request RuntimeOptions
1276
- * @return SubmitIndexAddDocumentsJobResponse
2550
+ * @param tmpReq - SubmitIndexAddDocumentsJobRequest
2551
+ * @param headers - map
2552
+ * @param runtime - runtime options for this request RuntimeOptions
2553
+ * @returns SubmitIndexAddDocumentsJobResponse
1277
2554
  */
1278
2555
  submitIndexAddDocumentsJobWithOptions(WorkspaceId: string, tmpReq: SubmitIndexAddDocumentsJobRequest, headers: {
1279
2556
  [key: string]: string;
1280
2557
  }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexAddDocumentsJobResponse>;
1281
2558
  /**
1282
- * @summary 知识索引
2559
+ * 知识索引
1283
2560
  *
1284
- * @param request SubmitIndexAddDocumentsJobRequest
1285
- * @return SubmitIndexAddDocumentsJobResponse
2561
+ * @param request - SubmitIndexAddDocumentsJobRequest
2562
+ * @returns SubmitIndexAddDocumentsJobResponse
1286
2563
  */
1287
2564
  submitIndexAddDocumentsJob(WorkspaceId: string, request: SubmitIndexAddDocumentsJobRequest): Promise<SubmitIndexAddDocumentsJobResponse>;
1288
2565
  /**
1289
- * @summary 提交索引任务
2566
+ * 提交索引任务
1290
2567
  *
1291
- * @param request SubmitIndexJobRequest
1292
- * @param headers map
1293
- * @param runtime runtime options for this request RuntimeOptions
1294
- * @return SubmitIndexJobResponse
2568
+ * @param request - SubmitIndexJobRequest
2569
+ * @param headers - map
2570
+ * @param runtime - runtime options for this request RuntimeOptions
2571
+ * @returns SubmitIndexJobResponse
1295
2572
  */
1296
2573
  submitIndexJobWithOptions(WorkspaceId: string, request: SubmitIndexJobRequest, headers: {
1297
2574
  [key: string]: string;
1298
2575
  }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexJobResponse>;
1299
2576
  /**
1300
- * @summary 提交索引任务
2577
+ * 提交索引任务
1301
2578
  *
1302
- * @param request SubmitIndexJobRequest
1303
- * @return SubmitIndexJobResponse
2579
+ * @param request - SubmitIndexJobRequest
2580
+ * @returns SubmitIndexJobResponse
1304
2581
  */
1305
2582
  submitIndexJob(WorkspaceId: string, request: SubmitIndexJobRequest): Promise<SubmitIndexJobResponse>;
1306
2583
  }