@alicloud/bailian20231229 1.8.4 → 1.10.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
@@ -91,6 +91,8 @@ export declare class AddCategoryResponse extends $tea.Model {
91
91
  export declare class AddFileRequest extends $tea.Model {
92
92
  /**
93
93
  * @remarks
94
+ * The primary key ID of the category to which the document is uploaded. This parameter corresponds to the `CategoryId` returned by the [AddCategory](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addcategory) operation. You can also click the ID icon next to the category name on the Unstructured Data tab of the [Data Management](https://bailian.console.aliyun.com/#/data-center) page to view the ID. You can set the parameter to default, which specifies the Default Category created by the system.
95
+ *
94
96
  * This parameter is required.
95
97
  *
96
98
  * @example
@@ -99,6 +101,8 @@ export declare class AddFileRequest extends $tea.Model {
99
101
  categoryId?: string;
100
102
  /**
101
103
  * @remarks
104
+ * The lease ID, which corresponds to the `FileUploadLeaseId` parameter returned by the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation.
105
+ *
102
106
  * This parameter is required.
103
107
  *
104
108
  * @example
@@ -107,12 +111,20 @@ export declare class AddFileRequest extends $tea.Model {
107
111
  leaseId?: string;
108
112
  /**
109
113
  * @remarks
114
+ * The parser. Valid value:
115
+ *
116
+ * * DASHSCOPE_DOCMIND: Intelligent document parsing by Alibaba Cloud.
117
+ *
110
118
  * This parameter is required.
111
119
  *
112
120
  * @example
113
121
  * DASHSCOPE_DOCMIND
114
122
  */
115
123
  parser?: string;
124
+ /**
125
+ * @remarks
126
+ * A list of tags associated with the document. The default value is null, which means no tags. You can specify up to 10 tags.
127
+ */
116
128
  tags?: string[];
117
129
  static names(): {
118
130
  [key: string]: string;
@@ -127,6 +139,8 @@ export declare class AddFileRequest extends $tea.Model {
127
139
  export declare class AddFileShrinkRequest extends $tea.Model {
128
140
  /**
129
141
  * @remarks
142
+ * The primary key ID of the category to which the document is uploaded. This parameter corresponds to the `CategoryId` returned by the [AddCategory](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addcategory) operation. You can also click the ID icon next to the category name on the Unstructured Data tab of the [Data Management](https://bailian.console.aliyun.com/#/data-center) page to view the ID. You can set the parameter to default, which specifies the Default Category created by the system.
143
+ *
130
144
  * This parameter is required.
131
145
  *
132
146
  * @example
@@ -135,6 +149,8 @@ export declare class AddFileShrinkRequest extends $tea.Model {
135
149
  categoryId?: string;
136
150
  /**
137
151
  * @remarks
152
+ * The lease ID, which corresponds to the `FileUploadLeaseId` parameter returned by the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation.
153
+ *
138
154
  * This parameter is required.
139
155
  *
140
156
  * @example
@@ -143,12 +159,20 @@ export declare class AddFileShrinkRequest extends $tea.Model {
143
159
  leaseId?: string;
144
160
  /**
145
161
  * @remarks
162
+ * The parser. Valid value:
163
+ *
164
+ * * DASHSCOPE_DOCMIND: Intelligent document parsing by Alibaba Cloud.
165
+ *
146
166
  * This parameter is required.
147
167
  *
148
168
  * @example
149
169
  * DASHSCOPE_DOCMIND
150
170
  */
151
171
  parser?: string;
172
+ /**
173
+ * @remarks
174
+ * A list of tags associated with the document. The default value is null, which means no tags. You can specify up to 10 tags.
175
+ */
152
176
  tagsShrink?: string;
153
177
  static names(): {
154
178
  [key: string]: string;
@@ -162,27 +186,49 @@ export declare class AddFileShrinkRequest extends $tea.Model {
162
186
  }
163
187
  export declare class AddFileResponseBody extends $tea.Model {
164
188
  /**
189
+ * @remarks
190
+ * The status code.
191
+ *
165
192
  * @example
166
193
  * DataCenter.FileTooLarge
167
194
  */
168
195
  code?: string;
196
+ /**
197
+ * @remarks
198
+ * The returned data fields.
199
+ */
169
200
  data?: AddFileResponseBodyData;
170
201
  /**
202
+ * @remarks
203
+ * The error message.
204
+ *
171
205
  * @example
172
206
  * User not authorized to operate on the specified resource.
173
207
  */
174
208
  message?: string;
175
209
  /**
210
+ * @remarks
211
+ * The request ID.
212
+ *
176
213
  * @example
177
214
  * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
178
215
  */
179
216
  requestId?: string;
180
217
  /**
218
+ * @remarks
219
+ * The HTTP status code.
220
+ *
181
221
  * @example
182
222
  * 200
183
223
  */
184
224
  status?: string;
185
225
  /**
226
+ * @remarks
227
+ * Indications whether the call is successful. Valid values:
228
+ *
229
+ * * true
230
+ * * false
231
+ *
186
232
  * @example
187
233
  * true
188
234
  */
@@ -216,11 +262,15 @@ export declare class AddFileResponse extends $tea.Model {
216
262
  export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
217
263
  /**
218
264
  * @remarks
265
+ * The name of the uploaded document, including the extension. Supported formats: pdf, doc, docx, md, txt, ppt, and pptx. The document name must be 4 to 128 characters in length.
266
+ *
219
267
  * This parameter is required.
220
268
  */
221
269
  fileName?: string;
222
270
  /**
223
271
  * @remarks
272
+ * The MD5 value of the uploaded document. This parameter is verified by the server (not in the current version).
273
+ *
224
274
  * This parameter is required.
225
275
  *
226
276
  * @example
@@ -229,6 +279,8 @@ export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
229
279
  md5?: string;
230
280
  /**
231
281
  * @remarks
282
+ * The size of the uploaded document, in bytes. This parameter is verified by the server (not in the current version). Valid values: 1 to 100000000.
283
+ *
232
284
  * This parameter is required.
233
285
  *
234
286
  * @example
@@ -247,27 +299,49 @@ export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
247
299
  }
248
300
  export declare class ApplyFileUploadLeaseResponseBody extends $tea.Model {
249
301
  /**
302
+ * @remarks
303
+ * The status code.
304
+ *
250
305
  * @example
251
306
  * DataCenter.FileTooLarge
252
307
  */
253
308
  code?: string;
309
+ /**
310
+ * @remarks
311
+ * The returned data fields.
312
+ */
254
313
  data?: ApplyFileUploadLeaseResponseBodyData;
255
314
  /**
315
+ * @remarks
316
+ * The error message.
317
+ *
256
318
  * @example
257
319
  * User not authorized to operate on the specified resource
258
320
  */
259
321
  message?: string;
260
322
  /**
323
+ * @remarks
324
+ * The request ID.
325
+ *
261
326
  * @example
262
327
  * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
263
328
  */
264
329
  requestId?: string;
265
330
  /**
331
+ * @remarks
332
+ * The HTTP status code.
333
+ *
266
334
  * @example
267
335
  * 200
268
336
  */
269
337
  status?: string;
270
338
  /**
339
+ * @remarks
340
+ * Indications whether the call is successful. Valid values:
341
+ *
342
+ * * true
343
+ * * false
344
+ *
271
345
  * @example
272
346
  * true
273
347
  */
@@ -362,58 +436,140 @@ export declare class CreateAndPulishAgentResponse extends $tea.Model {
362
436
  });
363
437
  }
364
438
  export declare class CreateIndexRequest extends $tea.Model {
439
+ /**
440
+ * @remarks
441
+ * The list of primary key IDs of the categories to be imported into the knowledge base.
442
+ */
365
443
  categoryIds?: string[];
366
444
  /**
445
+ * @remarks
446
+ * The estimated length of chunks. The maximum number of characters for a chunk. Texts exceeding this limit are splited. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [1-2048].
447
+ *
448
+ * The default value is empty, which means using the intelligent splitting method.
449
+ *
450
+ * > If you specify the `ChunkSize` parameter, you must also specify the `OverlapSize` and `Separator` parameters. If you do not specify these three parameters, the system uses the intelligent splitting method by default.
451
+ *
367
452
  * @example
368
453
  * 128
369
454
  */
370
455
  chunkSize?: number;
371
456
  columns?: CreateIndexRequestColumns[];
457
+ /**
458
+ * @remarks
459
+ * > This parameter is not available. Do not specify this parameter.
460
+ */
372
461
  dataSource?: CreateIndexRequestDataSource;
462
+ /**
463
+ * @remarks
464
+ * The description of the knowledge base. The description must be 0 to 1,000 characters in length. This parameter is empty by default.
465
+ */
373
466
  description?: string;
467
+ /**
468
+ * @remarks
469
+ * The list of primary key IDs of the documents to be imported into the knowledge base.
470
+ */
374
471
  documentIds?: string[];
375
472
  /**
473
+ * @remarks
474
+ * The name of the embedding model. The embedding model converts the original input prompt and knowledge text into numerical vectors for similarity comparison. The default and only model available is DashScope text-embedding-v2. It supports multiple languages including Chinese and English and normalizes the vector results. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid value:
475
+ *
476
+ * * text-embedding-v2
477
+ *
478
+ * The default value is null, which means using the text-embedding-v2 model.
479
+ *
376
480
  * @example
377
481
  * text-embedding-v2
378
482
  */
379
483
  embeddingModelName?: string;
380
484
  /**
381
485
  * @remarks
486
+ * The name of the knowledge base. The name must be 1 to 20 characters in length and can contain characters classified as letter in Unicode, including English letters, Chinese characters, digits, among others. The name can also contain colons (:), underscores (_), periods (.), and hyphens (-).
487
+ *
382
488
  * This parameter is required.
383
489
  */
384
490
  name?: string;
385
491
  /**
492
+ * @remarks
493
+ * The overlap length. The number of overlapping characters between two consecutive chunks. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: 0 to 1024.
494
+ *
495
+ * The default value is empty, which means using the intelligent splitting method.
496
+ *
386
497
  * @example
387
498
  * 16
388
499
  */
389
500
  overlapSize?: number;
390
501
  /**
502
+ * @remarks
503
+ * Similarity Threshold. The lowest similarity score of chunks that can be returned. This parameter is used to filter text chunks returned by the rank model. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00].
504
+ *
505
+ * Default value: 0.20.
506
+ *
391
507
  * @example
392
508
  * 0.20
393
509
  */
394
510
  rerankMinScore?: number;
395
511
  /**
512
+ * @remarks
513
+ * The name of the rank model. The rank model is a scoring system outside the knowledge base. It calculates the similarity score of each text chunk in the input question and knowledge base and ranks them in descending order. Then, the model returns the top K chunks with the highest scores. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
514
+ *
515
+ * * gte-rerank-hybrid
516
+ * * gte-rerank
517
+ *
518
+ * The default value is empty, which means using the official gte-rerank-hybrid model.
519
+ *
520
+ * > If you need only semantic ranking, we recommend that you use gte-rerank. If you need both semantic ranking and text matching features to ensure relevance, we recommend that you use gte-rerank-hybrid.
521
+ *
396
522
  * @example
397
523
  * gte-rerank-hybrid
398
524
  */
399
525
  rerankModelName?: string;
400
526
  /**
527
+ * @remarks
528
+ * The clause identifier. The document is split into chunks based on this identifier. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). You can specify multiple identifiers and do not need to add any other characters to separate them. For example: !,\\\\\\n. Valid values:
529
+ *
530
+ * * \\n: line break
531
+ * * ,: Chinese comma
532
+ * * ,: English comma
533
+ * * 。 : Chinese full stop
534
+ * * .: English full stop
535
+ * * ! : Chinese exclamation point
536
+ * * ! : English exclamation point
537
+ * * ;: Chinese semicolon
538
+ * * ;: English semicolon
539
+ * * ? : Chinese question mark
540
+ * * ?: English question mark
541
+ *
542
+ * The default value is empty, which means using the intelligent splitting method.
543
+ *
401
544
  * @example
402
545
  * ,
403
546
  */
404
547
  separator?: string;
405
548
  /**
549
+ * @remarks
550
+ * The ID of the vector storage instance. This parameter is available only when SinkType is set to ADB. You can view the ID on the [Instances](https://gpdbnext.console.aliyun.com/gpdb/list) page of AnalyticDB for PostgreSQL.
551
+ *
406
552
  * @example
407
553
  * gp-bp321093j84
408
554
  */
409
555
  sinkInstanceId?: string;
410
556
  /**
557
+ * @remarks
558
+ * The region of the vector storage instance. This parameter is available only when SinkType is set to ADB. You can call the [DescribeRegions](https://help.aliyun.com/zh/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions) operation to query the most recent region list.
559
+ *
411
560
  * @example
412
561
  * cn-hangzhou
413
562
  */
414
563
  sinkRegion?: string;
415
564
  /**
416
565
  * @remarks
566
+ * The vector storage type of the knowledge base. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
567
+ *
568
+ * * DEFAULT: The built-in vector database.
569
+ * * ADB: AnalyticDB for PostgreSQL database. If you need advanced features, such as managing, auditing, and monitoring, we recommend that you specify ADB.
570
+ *
571
+ * > If you have not used AnalyticDB for AnalyticDB in Model Studio before, go to the [Create Knowledge Base](https://bailian.console.aliyun.com/#/knowledge-base/create) page, select ADB-PG as Vector Storage Type, and follow the instructions to grant permissions. If you specify ADB, you must also specify the `SinkInstanceId` and `SinkRegion` parameters.
572
+ *
417
573
  * This parameter is required.
418
574
  *
419
575
  * @example
@@ -422,6 +578,15 @@ export declare class CreateIndexRequest extends $tea.Model {
422
578
  sinkType?: string;
423
579
  /**
424
580
  * @remarks
581
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
582
+ *
583
+ * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
584
+ * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
585
+ *
586
+ * > If this parameter is set to DATA_CENTER_CATEGORY, you must specify the `CategoryIds` parameter. If this parameter is set to DATA_CENTER_FILE, you must specify the `DocumentIds` parameter.
587
+ *
588
+ * > If you want to create an empty knowledge base, you can use an empty category. Set this parameter to DATA_CENTER_CATEGORY. And specify the ID of an empty category for the `CategoryIds` parameter.
589
+ *
425
590
  * This parameter is required.
426
591
  *
427
592
  * @example
@@ -433,6 +598,12 @@ export declare class CreateIndexRequest extends $tea.Model {
433
598
  sourceType?: string;
434
599
  /**
435
600
  * @remarks
601
+ * The data type of the knowledge base. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid value:
602
+ *
603
+ * * unstructured
604
+ *
605
+ * > After a knowledge base is created, its data type cannot be changed. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
606
+ *
436
607
  * This parameter is required.
437
608
  *
438
609
  * @example
@@ -450,58 +621,140 @@ export declare class CreateIndexRequest extends $tea.Model {
450
621
  });
451
622
  }
452
623
  export declare class CreateIndexShrinkRequest extends $tea.Model {
624
+ /**
625
+ * @remarks
626
+ * The list of primary key IDs of the categories to be imported into the knowledge base.
627
+ */
453
628
  categoryIdsShrink?: string;
454
629
  /**
630
+ * @remarks
631
+ * The estimated length of chunks. The maximum number of characters for a chunk. Texts exceeding this limit are splited. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [1-2048].
632
+ *
633
+ * The default value is empty, which means using the intelligent splitting method.
634
+ *
635
+ * > If you specify the `ChunkSize` parameter, you must also specify the `OverlapSize` and `Separator` parameters. If you do not specify these three parameters, the system uses the intelligent splitting method by default.
636
+ *
455
637
  * @example
456
638
  * 128
457
639
  */
458
640
  chunkSize?: number;
459
641
  columnsShrink?: string;
642
+ /**
643
+ * @remarks
644
+ * > This parameter is not available. Do not specify this parameter.
645
+ */
460
646
  dataSourceShrink?: string;
647
+ /**
648
+ * @remarks
649
+ * The description of the knowledge base. The description must be 0 to 1,000 characters in length. This parameter is empty by default.
650
+ */
461
651
  description?: string;
652
+ /**
653
+ * @remarks
654
+ * The list of primary key IDs of the documents to be imported into the knowledge base.
655
+ */
462
656
  documentIdsShrink?: string;
463
657
  /**
658
+ * @remarks
659
+ * The name of the embedding model. The embedding model converts the original input prompt and knowledge text into numerical vectors for similarity comparison. The default and only model available is DashScope text-embedding-v2. It supports multiple languages including Chinese and English and normalizes the vector results. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid value:
660
+ *
661
+ * * text-embedding-v2
662
+ *
663
+ * The default value is null, which means using the text-embedding-v2 model.
664
+ *
464
665
  * @example
465
666
  * text-embedding-v2
466
667
  */
467
668
  embeddingModelName?: string;
468
669
  /**
469
670
  * @remarks
671
+ * The name of the knowledge base. The name must be 1 to 20 characters in length and can contain characters classified as letter in Unicode, including English letters, Chinese characters, digits, among others. The name can also contain colons (:), underscores (_), periods (.), and hyphens (-).
672
+ *
470
673
  * This parameter is required.
471
674
  */
472
675
  name?: string;
473
676
  /**
677
+ * @remarks
678
+ * The overlap length. The number of overlapping characters between two consecutive chunks. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: 0 to 1024.
679
+ *
680
+ * The default value is empty, which means using the intelligent splitting method.
681
+ *
474
682
  * @example
475
683
  * 16
476
684
  */
477
685
  overlapSize?: number;
478
686
  /**
687
+ * @remarks
688
+ * Similarity Threshold. The lowest similarity score of chunks that can be returned. This parameter is used to filter text chunks returned by the rank model. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00].
689
+ *
690
+ * Default value: 0.20.
691
+ *
479
692
  * @example
480
693
  * 0.20
481
694
  */
482
695
  rerankMinScore?: number;
483
696
  /**
697
+ * @remarks
698
+ * The name of the rank model. The rank model is a scoring system outside the knowledge base. It calculates the similarity score of each text chunk in the input question and knowledge base and ranks them in descending order. Then, the model returns the top K chunks with the highest scores. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
699
+ *
700
+ * * gte-rerank-hybrid
701
+ * * gte-rerank
702
+ *
703
+ * The default value is empty, which means using the official gte-rerank-hybrid model.
704
+ *
705
+ * > If you need only semantic ranking, we recommend that you use gte-rerank. If you need both semantic ranking and text matching features to ensure relevance, we recommend that you use gte-rerank-hybrid.
706
+ *
484
707
  * @example
485
708
  * gte-rerank-hybrid
486
709
  */
487
710
  rerankModelName?: string;
488
711
  /**
712
+ * @remarks
713
+ * The clause identifier. The document is split into chunks based on this identifier. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). You can specify multiple identifiers and do not need to add any other characters to separate them. For example: !,\\\\\\n. Valid values:
714
+ *
715
+ * * \\n: line break
716
+ * * ,: Chinese comma
717
+ * * ,: English comma
718
+ * * 。 : Chinese full stop
719
+ * * .: English full stop
720
+ * * ! : Chinese exclamation point
721
+ * * ! : English exclamation point
722
+ * * ;: Chinese semicolon
723
+ * * ;: English semicolon
724
+ * * ? : Chinese question mark
725
+ * * ?: English question mark
726
+ *
727
+ * The default value is empty, which means using the intelligent splitting method.
728
+ *
489
729
  * @example
490
730
  * ,
491
731
  */
492
732
  separator?: string;
493
733
  /**
734
+ * @remarks
735
+ * The ID of the vector storage instance. This parameter is available only when SinkType is set to ADB. You can view the ID on the [Instances](https://gpdbnext.console.aliyun.com/gpdb/list) page of AnalyticDB for PostgreSQL.
736
+ *
494
737
  * @example
495
738
  * gp-bp321093j84
496
739
  */
497
740
  sinkInstanceId?: string;
498
741
  /**
742
+ * @remarks
743
+ * The region of the vector storage instance. This parameter is available only when SinkType is set to ADB. You can call the [DescribeRegions](https://help.aliyun.com/zh/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions) operation to query the most recent region list.
744
+ *
499
745
  * @example
500
746
  * cn-hangzhou
501
747
  */
502
748
  sinkRegion?: string;
503
749
  /**
504
750
  * @remarks
751
+ * The vector storage type of the knowledge base. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
752
+ *
753
+ * * DEFAULT: The built-in vector database.
754
+ * * ADB: AnalyticDB for PostgreSQL database. If you need advanced features, such as managing, auditing, and monitoring, we recommend that you specify ADB.
755
+ *
756
+ * > If you have not used AnalyticDB for AnalyticDB in Model Studio before, go to the [Create Knowledge Base](https://bailian.console.aliyun.com/#/knowledge-base/create) page, select ADB-PG as Vector Storage Type, and follow the instructions to grant permissions. If you specify ADB, you must also specify the `SinkInstanceId` and `SinkRegion` parameters.
757
+ *
505
758
  * This parameter is required.
506
759
  *
507
760
  * @example
@@ -510,6 +763,15 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
510
763
  sinkType?: string;
511
764
  /**
512
765
  * @remarks
766
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
767
+ *
768
+ * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
769
+ * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
770
+ *
771
+ * > If this parameter is set to DATA_CENTER_CATEGORY, you must specify the `CategoryIds` parameter. If this parameter is set to DATA_CENTER_FILE, you must specify the `DocumentIds` parameter.
772
+ *
773
+ * > If you want to create an empty knowledge base, you can use an empty category. Set this parameter to DATA_CENTER_CATEGORY. And specify the ID of an empty category for the `CategoryIds` parameter.
774
+ *
513
775
  * This parameter is required.
514
776
  *
515
777
  * @example
@@ -521,6 +783,12 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
521
783
  sourceType?: string;
522
784
  /**
523
785
  * @remarks
786
+ * The data type of the knowledge base. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid value:
787
+ *
788
+ * * unstructured
789
+ *
790
+ * > After a knowledge base is created, its data type cannot be changed. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
791
+ *
524
792
  * This parameter is required.
525
793
  *
526
794
  * @example
@@ -539,30 +807,49 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
539
807
  }
540
808
  export declare class CreateIndexResponseBody extends $tea.Model {
541
809
  /**
810
+ * @remarks
811
+ * HTTP status code
812
+ *
542
813
  * @example
543
814
  * Forbidden
544
815
  */
545
816
  code?: string;
817
+ /**
818
+ * @remarks
819
+ * The returned data.
820
+ */
546
821
  data?: CreateIndexResponseBodyData;
547
822
  /**
823
+ * @remarks
824
+ * The error message.
825
+ *
548
826
  * @example
549
827
  * Invalid input, variable name is missing
550
828
  */
551
829
  message?: string;
552
830
  /**
553
831
  * @remarks
554
- * Id of the request
832
+ * The request ID.
555
833
  *
556
834
  * @example
557
835
  * 17204B98-7734-4F9A-8464-2446A84821CA
558
836
  */
559
837
  requestId?: string;
560
838
  /**
839
+ * @remarks
840
+ * The status code.
841
+ *
561
842
  * @example
562
843
  * 200
563
844
  */
564
845
  status?: string;
565
846
  /**
847
+ * @remarks
848
+ * Indications whether the API call is successful. Valid values:
849
+ *
850
+ * * true
851
+ * * false
852
+ *
566
853
  * @example
567
854
  * true
568
855
  */
@@ -695,6 +982,64 @@ export declare class CreateMemoryNodeResponse extends $tea.Model {
695
982
  [key: string]: any;
696
983
  });
697
984
  }
985
+ export declare class CreatePromptTemplateRequest extends $tea.Model {
986
+ /**
987
+ * @remarks
988
+ * This parameter is required.
989
+ */
990
+ content?: string;
991
+ /**
992
+ * @remarks
993
+ * This parameter is required.
994
+ */
995
+ name?: string;
996
+ static names(): {
997
+ [key: string]: string;
998
+ };
999
+ static types(): {
1000
+ [key: string]: any;
1001
+ };
1002
+ constructor(map?: {
1003
+ [key: string]: any;
1004
+ });
1005
+ }
1006
+ export declare class CreatePromptTemplateResponseBody extends $tea.Model {
1007
+ /**
1008
+ * @example
1009
+ * 6e49109bfeb94a39bb268f4e483ccxxx
1010
+ */
1011
+ promptTemplateId?: string;
1012
+ /**
1013
+ * @example
1014
+ * FE9B6CBF-47E6-5D76-9C5D-B814DD5ABxxx
1015
+ */
1016
+ requestId?: string;
1017
+ static names(): {
1018
+ [key: string]: string;
1019
+ };
1020
+ static types(): {
1021
+ [key: string]: any;
1022
+ };
1023
+ constructor(map?: {
1024
+ [key: string]: any;
1025
+ });
1026
+ }
1027
+ export declare class CreatePromptTemplateResponse extends $tea.Model {
1028
+ headers?: {
1029
+ [key: string]: string;
1030
+ };
1031
+ statusCode?: number;
1032
+ body?: CreatePromptTemplateResponseBody;
1033
+ static names(): {
1034
+ [key: string]: string;
1035
+ };
1036
+ static types(): {
1037
+ [key: string]: any;
1038
+ };
1039
+ constructor(map?: {
1040
+ [key: string]: any;
1041
+ });
1042
+ }
698
1043
  export declare class DeleteAgentResponseBody extends $tea.Model {
699
1044
  code?: string;
700
1045
  data?: string;
@@ -847,6 +1192,8 @@ export declare class DeleteFileResponse extends $tea.Model {
847
1192
  export declare class DeleteIndexRequest extends $tea.Model {
848
1193
  /**
849
1194
  * @remarks
1195
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1196
+ *
850
1197
  * This parameter is required.
851
1198
  *
852
1199
  * @example
@@ -865,29 +1212,44 @@ export declare class DeleteIndexRequest extends $tea.Model {
865
1212
  }
866
1213
  export declare class DeleteIndexResponseBody extends $tea.Model {
867
1214
  /**
1215
+ * @remarks
1216
+ * HTTP status code
1217
+ *
868
1218
  * @example
869
1219
  * Index.InvalidParameter
870
1220
  */
871
1221
  code?: string;
872
1222
  /**
1223
+ * @remarks
1224
+ * The error message.
1225
+ *
873
1226
  * @example
874
1227
  * Required parameter(%s) missing or invalid, please check the request parameters.
875
1228
  */
876
1229
  message?: string;
877
1230
  /**
878
1231
  * @remarks
879
- * Id of the request
1232
+ * The request ID.
880
1233
  *
881
1234
  * @example
882
1235
  * 17204B98-xxxx-4F9A-8464-2446A84821CA
883
1236
  */
884
1237
  requestId?: string;
885
1238
  /**
1239
+ * @remarks
1240
+ * The status code.
1241
+ *
886
1242
  * @example
887
1243
  * 200
888
1244
  */
889
1245
  status?: string;
890
1246
  /**
1247
+ * @remarks
1248
+ * Indications whether the API call is successful. Valid values:
1249
+ *
1250
+ * * true
1251
+ * * false
1252
+ *
891
1253
  * @example
892
1254
  * true
893
1255
  */
@@ -921,11 +1283,15 @@ export declare class DeleteIndexResponse extends $tea.Model {
921
1283
  export declare class DeleteIndexDocumentRequest extends $tea.Model {
922
1284
  /**
923
1285
  * @remarks
1286
+ * The list of the primary key IDs of the documents.
1287
+ *
924
1288
  * This parameter is required.
925
1289
  */
926
1290
  documentIds?: string[];
927
1291
  /**
928
1292
  * @remarks
1293
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1294
+ *
929
1295
  * This parameter is required.
930
1296
  *
931
1297
  * @example
@@ -945,11 +1311,15 @@ export declare class DeleteIndexDocumentRequest extends $tea.Model {
945
1311
  export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
946
1312
  /**
947
1313
  * @remarks
1314
+ * The list of the primary key IDs of the documents.
1315
+ *
948
1316
  * This parameter is required.
949
1317
  */
950
1318
  documentIdsShrink?: string;
951
1319
  /**
952
1320
  * @remarks
1321
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1322
+ *
953
1323
  * This parameter is required.
954
1324
  *
955
1325
  * @example
@@ -968,30 +1338,49 @@ export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
968
1338
  }
969
1339
  export declare class DeleteIndexDocumentResponseBody extends $tea.Model {
970
1340
  /**
1341
+ * @remarks
1342
+ * HTTP status code
1343
+ *
971
1344
  * @example
972
1345
  * Index.InvalidParameter
973
1346
  */
974
1347
  code?: string;
1348
+ /**
1349
+ * @remarks
1350
+ * The parameters returned by the operation.
1351
+ */
975
1352
  data?: DeleteIndexDocumentResponseBodyData;
976
1353
  /**
1354
+ * @remarks
1355
+ * The error message.
1356
+ *
977
1357
  * @example
978
1358
  * Required parameter(%s) missing or invalid, please check the request parameters.
979
1359
  */
980
1360
  message?: string;
981
1361
  /**
982
1362
  * @remarks
983
- * Id of the request
1363
+ * The request ID.
984
1364
  *
985
1365
  * @example
986
1366
  * 17204B98-xxxx-4F9A-8464-2446A84821CA
987
1367
  */
988
1368
  requestId?: string;
989
1369
  /**
1370
+ * @remarks
1371
+ * The status code.
1372
+ *
990
1373
  * @example
991
1374
  * 200
992
1375
  */
993
1376
  status?: string;
994
1377
  /**
1378
+ * @remarks
1379
+ * Indications whether the API call is successful. Valid values:
1380
+ *
1381
+ * * true
1382
+ * * false
1383
+ *
995
1384
  * @example
996
1385
  * true
997
1386
  */
@@ -1086,29 +1475,83 @@ export declare class DeleteMemoryNodeResponse extends $tea.Model {
1086
1475
  [key: string]: any;
1087
1476
  });
1088
1477
  }
1089
- export declare class DescribeFileResponseBody extends $tea.Model {
1090
- /**
1091
- * @example
1092
- * Success
1093
- */
1094
- code?: string;
1095
- data?: DescribeFileResponseBodyData;
1096
- /**
1097
- * @example
1098
- * Requests throttling triggered.
1099
- */
1100
- message?: string;
1478
+ export declare class DeletePromptTemplateResponseBody extends $tea.Model {
1101
1479
  /**
1102
1480
  * @example
1103
- * 17204B98-xxxx-4F9A-8464-2446A84821CA
1481
+ * FE9B6CBF-47E6-5D76-9C5D-B814DD5ABxxx
1104
1482
  */
1105
1483
  requestId?: string;
1106
- /**
1107
- * @example
1108
- * 200
1109
- */
1110
- status?: string;
1111
- /**
1484
+ static names(): {
1485
+ [key: string]: string;
1486
+ };
1487
+ static types(): {
1488
+ [key: string]: any;
1489
+ };
1490
+ constructor(map?: {
1491
+ [key: string]: any;
1492
+ });
1493
+ }
1494
+ export declare class DeletePromptTemplateResponse extends $tea.Model {
1495
+ headers?: {
1496
+ [key: string]: string;
1497
+ };
1498
+ statusCode?: number;
1499
+ body?: DeletePromptTemplateResponseBody;
1500
+ static names(): {
1501
+ [key: string]: string;
1502
+ };
1503
+ static types(): {
1504
+ [key: string]: any;
1505
+ };
1506
+ constructor(map?: {
1507
+ [key: string]: any;
1508
+ });
1509
+ }
1510
+ export declare class DescribeFileResponseBody extends $tea.Model {
1511
+ /**
1512
+ * @remarks
1513
+ * The status code.
1514
+ *
1515
+ * @example
1516
+ * Success
1517
+ */
1518
+ code?: string;
1519
+ /**
1520
+ * @remarks
1521
+ * The returned data fields.
1522
+ */
1523
+ data?: DescribeFileResponseBodyData;
1524
+ /**
1525
+ * @remarks
1526
+ * The error message.
1527
+ *
1528
+ * @example
1529
+ * Requests throttling triggered.
1530
+ */
1531
+ message?: string;
1532
+ /**
1533
+ * @remarks
1534
+ * The request ID.
1535
+ *
1536
+ * @example
1537
+ * 17204B98-xxxx-4F9A-8464-2446A84821CA
1538
+ */
1539
+ requestId?: string;
1540
+ /**
1541
+ * @remarks
1542
+ * The HTTP status code.
1543
+ *
1544
+ * @example
1545
+ * 200
1546
+ */
1547
+ status?: string;
1548
+ /**
1549
+ * @remarks
1550
+ * Indications whether the API call is successful. Valid values:
1551
+ *
1552
+ * * true
1553
+ * * false
1554
+ *
1112
1555
  * @example
1113
1556
  * true
1114
1557
  */
@@ -1142,6 +1585,8 @@ export declare class DescribeFileResponse extends $tea.Model {
1142
1585
  export declare class GetIndexJobStatusRequest extends $tea.Model {
1143
1586
  /**
1144
1587
  * @remarks
1588
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1589
+ *
1145
1590
  * This parameter is required.
1146
1591
  *
1147
1592
  * @example
@@ -1150,13 +1595,29 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
1150
1595
  indexId?: string;
1151
1596
  /**
1152
1597
  * @remarks
1598
+ * The knowledge base job ID, which is the `Data.Id` parameter returned by the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) or [SubmitIndexAddDocumentsJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operations.
1599
+ *
1153
1600
  * This parameter is required.
1154
1601
  *
1155
1602
  * @example
1156
1603
  * 20230718xxxx-146c93bf
1157
1604
  */
1158
1605
  jobId?: string;
1606
+ /**
1607
+ * @remarks
1608
+ * Both the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) and [SubmitIndexAddDocumentsJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operations support batch import of documents. This operation returns both the overall `Status` of the job and the `Document.Status` of each document. If there are a large number of documents, you can use the `PageNumber` parameter to perform a paged query. Pages start from page 1. Default value: 1.
1609
+ *
1610
+ * @example
1611
+ * 1
1612
+ */
1159
1613
  pageNumber?: number;
1614
+ /**
1615
+ * @remarks
1616
+ * The number of document import jobs that are displayed on each page. No maximum value. Default value: 10.
1617
+ *
1618
+ * @example
1619
+ * 10
1620
+ */
1160
1621
  pageSize?: number;
1161
1622
  static names(): {
1162
1623
  [key: string]: string;
@@ -1170,27 +1631,49 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
1170
1631
  }
1171
1632
  export declare class GetIndexJobStatusResponseBody extends $tea.Model {
1172
1633
  /**
1634
+ * @remarks
1635
+ * HTTP status code
1636
+ *
1173
1637
  * @example
1174
1638
  * Index.Forbidden
1175
1639
  */
1176
1640
  code?: string;
1641
+ /**
1642
+ * @remarks
1643
+ * The returned data.
1644
+ */
1177
1645
  data?: GetIndexJobStatusResponseBodyData;
1178
1646
  /**
1647
+ * @remarks
1648
+ * The error message.
1649
+ *
1179
1650
  * @example
1180
1651
  * User not authorized to operate on the specified resource.
1181
1652
  */
1182
1653
  message?: string;
1183
1654
  /**
1655
+ * @remarks
1656
+ * The request ID.
1657
+ *
1184
1658
  * @example
1185
1659
  * 17204B98-xxxx-4F9A-8464-2446A84821CA
1186
1660
  */
1187
1661
  requestId?: string;
1188
1662
  /**
1663
+ * @remarks
1664
+ * The HTTP status code returned.
1665
+ *
1189
1666
  * @example
1190
1667
  * 200
1191
1668
  */
1192
1669
  status?: string;
1193
1670
  /**
1671
+ * @remarks
1672
+ * Indications whether the API call is successful. Valid values:
1673
+ *
1674
+ * * true
1675
+ * * false
1676
+ *
1194
1677
  * @example
1195
1678
  * true
1196
1679
  */
@@ -1312,6 +1795,55 @@ export declare class GetMemoryNodeResponse extends $tea.Model {
1312
1795
  [key: string]: any;
1313
1796
  });
1314
1797
  }
1798
+ export declare class GetPromptTemplateResponseBody extends $tea.Model {
1799
+ content?: string;
1800
+ name?: string;
1801
+ /**
1802
+ * @example
1803
+ * 6e49109bfeb94a39bb268f4e483ccxxx
1804
+ */
1805
+ promptTemplateId?: string;
1806
+ /**
1807
+ * @example
1808
+ * 8C56C7AF-6573-19CE-B018-E05E1EDCF4C5
1809
+ */
1810
+ requestId?: string;
1811
+ /**
1812
+ * @example
1813
+ * ["theme"]
1814
+ */
1815
+ variables?: string[];
1816
+ /**
1817
+ * @example
1818
+ * llm-us9hjmt32nysdxxx
1819
+ */
1820
+ workspaceId?: string;
1821
+ static names(): {
1822
+ [key: string]: string;
1823
+ };
1824
+ static types(): {
1825
+ [key: string]: any;
1826
+ };
1827
+ constructor(map?: {
1828
+ [key: string]: any;
1829
+ });
1830
+ }
1831
+ export declare class GetPromptTemplateResponse extends $tea.Model {
1832
+ headers?: {
1833
+ [key: string]: string;
1834
+ };
1835
+ statusCode?: number;
1836
+ body?: GetPromptTemplateResponseBody;
1837
+ static names(): {
1838
+ [key: string]: string;
1839
+ };
1840
+ static types(): {
1841
+ [key: string]: any;
1842
+ };
1843
+ constructor(map?: {
1844
+ [key: string]: any;
1845
+ });
1846
+ }
1315
1847
  export declare class GetPublishedAgentResponseBody extends $tea.Model {
1316
1848
  code?: string;
1317
1849
  data?: GetPublishedAgentResponseBodyData;
@@ -1436,14 +1968,23 @@ export declare class ListCategoryResponse extends $tea.Model {
1436
1968
  });
1437
1969
  }
1438
1970
  export declare class ListChunksRequest extends $tea.Model {
1971
+ /**
1972
+ * @remarks
1973
+ * An array of field names. This parameter is used to filter non-private fields (prefixed with_underscores) in the Metadata parameter returned by this operation. By default, this parameter is left empty, which means all non-private fields in the Metadata parameter are returned. If you only want specified non-private fields, such as title, set this parameter to title.
1974
+ */
1439
1975
  fields?: string[];
1440
1976
  /**
1977
+ * @remarks
1978
+ * The primary key ID of the document, which is the `FieldID` parameter returned by the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation. This parameter is not required for structured knowledge base, but is required for unstructured knowledge base. To view the ID, you can click the ID icon next to the file name on the [Data Management](https://bailian.console.aliyun.com/#/data-center) page. You can filter returned chunks by the document ID. This parameter is left empty by default.
1979
+ *
1441
1980
  * @example
1442
1981
  * file_5f03dfea56da4050ab68d61871fc4cb3_10151493
1443
1982
  */
1444
1983
  filed?: string;
1445
1984
  /**
1446
1985
  * @remarks
1986
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1987
+ *
1447
1988
  * This parameter is required.
1448
1989
  *
1449
1990
  * @example
@@ -1451,11 +1992,17 @@ export declare class ListChunksRequest extends $tea.Model {
1451
1992
  */
1452
1993
  indexId?: string;
1453
1994
  /**
1995
+ * @remarks
1996
+ * The number of the pages to return. Pages start from page 1. Default value: 1.
1997
+ *
1454
1998
  * @example
1455
1999
  * 1
1456
2000
  */
1457
2001
  pageNum?: number;
1458
2002
  /**
2003
+ * @remarks
2004
+ * The number of chunks to display on each page. Maximum value: 100. Default value: 10.
2005
+ *
1459
2006
  * @example
1460
2007
  * 10
1461
2008
  */
@@ -1472,30 +2019,49 @@ export declare class ListChunksRequest extends $tea.Model {
1472
2019
  }
1473
2020
  export declare class ListChunksResponseBody extends $tea.Model {
1474
2021
  /**
2022
+ * @remarks
2023
+ * The error code.
2024
+ *
1475
2025
  * @example
1476
2026
  * Index.InvalidParameter
1477
2027
  */
1478
2028
  code?: string;
2029
+ /**
2030
+ * @remarks
2031
+ * The data returned.
2032
+ */
1479
2033
  data?: ListChunksResponseBodyData;
1480
2034
  /**
2035
+ * @remarks
2036
+ * The error message.
2037
+ *
1481
2038
  * @example
1482
2039
  * Required parameter(%s) missing or invalid, please check the request parameters.
1483
2040
  */
1484
2041
  message?: string;
1485
2042
  /**
1486
2043
  * @remarks
1487
- * Id of the request
2044
+ * The request ID.
1488
2045
  *
1489
2046
  * @example
1490
2047
  * 8F97A63B-55F1-527F-9D6E-467B6A7E8CF1
1491
2048
  */
1492
2049
  requestId?: string;
1493
2050
  /**
2051
+ * @remarks
2052
+ * The HTTP status code returned.
2053
+ *
1494
2054
  * @example
1495
2055
  * 200
1496
2056
  */
1497
2057
  status?: string;
1498
2058
  /**
2059
+ * @remarks
2060
+ * Indications whether the API call is successful. Valid values:
2061
+ *
2062
+ * * true
2063
+ * * false
2064
+ *
1499
2065
  * @example
1500
2066
  * true
1501
2067
  */
@@ -1535,6 +2101,7 @@ export declare class ListFileRequest extends $tea.Model {
1535
2101
  * cate_cdd11b1b79a74e8bbd675c356a91ee3510024405
1536
2102
  */
1537
2103
  categoryId?: string;
2104
+ fileName?: string;
1538
2105
  /**
1539
2106
  * @example
1540
2107
  * 20
@@ -1612,14 +2179,30 @@ export declare class ListFileResponse extends $tea.Model {
1612
2179
  });
1613
2180
  }
1614
2181
  export declare class ListIndexDocumentsRequest extends $tea.Model {
2182
+ /**
2183
+ * @remarks
2184
+ * The names of the queried documents. The default value is null, which means the names are not used to filter the results.
2185
+ */
1615
2186
  documentName?: string;
1616
2187
  /**
2188
+ * @remarks
2189
+ * The import status of the documents to be queried. Valid values:
2190
+ *
2191
+ * * INSERT_ERROR
2192
+ * * RUNNING
2193
+ * * DELETED
2194
+ * * FINISH
2195
+ *
2196
+ * The default value is null, which means the import status is not used to filter the results.
2197
+ *
1617
2198
  * @example
1618
2199
  * FINISH
1619
2200
  */
1620
2201
  documentStatus?: string;
1621
2202
  /**
1622
2203
  * @remarks
2204
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2205
+ *
1623
2206
  * This parameter is required.
1624
2207
  *
1625
2208
  * @example
@@ -1627,11 +2210,17 @@ export declare class ListIndexDocumentsRequest extends $tea.Model {
1627
2210
  */
1628
2211
  indexId?: string;
1629
2212
  /**
2213
+ * @remarks
2214
+ * The page numbers of the pages to return. Pages start from page 1. Default value: 1.
2215
+ *
1630
2216
  * @example
1631
2217
  * 1
1632
2218
  */
1633
2219
  pageNumber?: number;
1634
2220
  /**
2221
+ * @remarks
2222
+ * The number of documents displayed on each page. No maximum value. Default value: 10.
2223
+ *
1635
2224
  * @example
1636
2225
  * 10
1637
2226
  */
@@ -1648,30 +2237,49 @@ export declare class ListIndexDocumentsRequest extends $tea.Model {
1648
2237
  }
1649
2238
  export declare class ListIndexDocumentsResponseBody extends $tea.Model {
1650
2239
  /**
2240
+ * @remarks
2241
+ * HTTP status code
2242
+ *
1651
2243
  * @example
1652
2244
  * InvalidParameter
1653
2245
  */
1654
2246
  code?: string;
2247
+ /**
2248
+ * @remarks
2249
+ * The returned data.
2250
+ */
1655
2251
  data?: ListIndexDocumentsResponseBodyData;
1656
2252
  /**
2253
+ * @remarks
2254
+ * The error message.
2255
+ *
1657
2256
  * @example
1658
2257
  * Required parameter(%s) missing or invalid, please check the request parameters.
1659
2258
  */
1660
2259
  message?: string;
1661
2260
  /**
1662
2261
  * @remarks
1663
- * Id of the request
2262
+ * The request ID.
1664
2263
  *
1665
2264
  * @example
1666
2265
  * 35A267BF-xxxx-54DB-8394-AA3B0742D833
1667
2266
  */
1668
2267
  requestId?: string;
1669
2268
  /**
2269
+ * @remarks
2270
+ * The status code.
2271
+ *
1670
2272
  * @example
1671
2273
  * 200
1672
2274
  */
1673
2275
  status?: string;
1674
2276
  /**
2277
+ * @remarks
2278
+ * Indications whether the API call is successful. Valid values:
2279
+ *
2280
+ * * true
2281
+ * * false
2282
+ *
1675
2283
  * @example
1676
2284
  * true
1677
2285
  */
@@ -1704,16 +2312,27 @@ export declare class ListIndexDocumentsResponse extends $tea.Model {
1704
2312
  }
1705
2313
  export declare class ListIndicesRequest extends $tea.Model {
1706
2314
  /**
2315
+ * @remarks
2316
+ * The name of the knowledge base. You can query knowledge base by name. The name must be 1 to 20 characters in length and can contain characters classified as letter in Unicode, including English letters, Chinese characters, digits, among others. The name can also contain colons (:), underscores (_), periods (.), and hyphens (-).
2317
+ *
2318
+ * This parameter is left empty by default, which means that all knowledge bases in the specified workspace are queried.
2319
+ *
1707
2320
  * @example
1708
2321
  * idx_status_score
1709
2322
  */
1710
2323
  indexName?: string;
1711
2324
  /**
2325
+ * @remarks
2326
+ * The number of the pages to return. Pages start from page 1. Default value: 1.
2327
+ *
1712
2328
  * @example
1713
2329
  * 1
1714
2330
  */
1715
2331
  pageNumber?: string;
1716
2332
  /**
2333
+ * @remarks
2334
+ * The number of knowledge bases to display on each page. No maximum value. Default value: 10.
2335
+ *
1717
2336
  * @example
1718
2337
  * 10
1719
2338
  */
@@ -1730,30 +2349,49 @@ export declare class ListIndicesRequest extends $tea.Model {
1730
2349
  }
1731
2350
  export declare class ListIndicesResponseBody extends $tea.Model {
1732
2351
  /**
2352
+ * @remarks
2353
+ * HTTP status code
2354
+ *
1733
2355
  * @example
1734
2356
  * Index.InvalidParameter
1735
2357
  */
1736
2358
  code?: string;
2359
+ /**
2360
+ * @remarks
2361
+ * The returned data.
2362
+ */
1737
2363
  data?: ListIndicesResponseBodyData;
1738
2364
  /**
2365
+ * @remarks
2366
+ * The error message.
2367
+ *
1739
2368
  * @example
1740
2369
  * Required parameter(%s) missing or invalid, please check the request parameters.
1741
2370
  */
1742
2371
  message?: string;
1743
2372
  /**
1744
2373
  * @remarks
1745
- * Id of the request
2374
+ * The request ID.
1746
2375
  *
1747
2376
  * @example
1748
2377
  * 17204B98-xxxx-4F9A-8464-2446A84821CA
1749
2378
  */
1750
2379
  requestId?: string;
1751
2380
  /**
2381
+ * @remarks
2382
+ * The HTTP status code returned.
2383
+ *
1752
2384
  * @example
1753
2385
  * 200
1754
2386
  */
1755
2387
  status?: string;
1756
2388
  /**
2389
+ * @remarks
2390
+ * Indications whether the API call is successful. Valid values:
2391
+ *
2392
+ * * true
2393
+ * * false
2394
+ *
1757
2395
  * @example
1758
2396
  * true
1759
2397
  */
@@ -1927,9 +2565,23 @@ export declare class ListMemoryNodesResponse extends $tea.Model {
1927
2565
  [key: string]: any;
1928
2566
  });
1929
2567
  }
1930
- export declare class ListPublishedAgentRequest extends $tea.Model {
1931
- pageNo?: number;
1932
- pageSize?: number;
2568
+ export declare class ListPromptTemplatesRequest extends $tea.Model {
2569
+ /**
2570
+ * @example
2571
+ * 10
2572
+ */
2573
+ maxResults?: number;
2574
+ name?: string;
2575
+ /**
2576
+ * @example
2577
+ * dc270401186b433f975d7e1faaa34e0e
2578
+ */
2579
+ nextToken?: string;
2580
+ /**
2581
+ * @example
2582
+ * System
2583
+ */
2584
+ type?: string;
1933
2585
  static names(): {
1934
2586
  [key: string]: string;
1935
2587
  };
@@ -1940,13 +2592,33 @@ export declare class ListPublishedAgentRequest extends $tea.Model {
1940
2592
  [key: string]: any;
1941
2593
  });
1942
2594
  }
1943
- export declare class ListPublishedAgentResponseBody extends $tea.Model {
1944
- code?: string;
1945
- data?: ListPublishedAgentResponseBodyData;
1946
- httpStatusCode?: number;
1947
- message?: string;
2595
+ export declare class ListPromptTemplatesResponseBody extends $tea.Model {
2596
+ /**
2597
+ * @example
2598
+ * 10
2599
+ */
2600
+ maxResults?: number;
2601
+ /**
2602
+ * @example
2603
+ * dc270401186b433f975d7e1faaa34e0e
2604
+ */
2605
+ nextToken?: string;
2606
+ promptTemplates?: ListPromptTemplatesResponseBodyPromptTemplates[];
2607
+ /**
2608
+ * @example
2609
+ * FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071
2610
+ */
1948
2611
  requestId?: string;
1949
- success?: string;
2612
+ /**
2613
+ * @example
2614
+ * 15
2615
+ */
2616
+ totalCount?: number;
2617
+ /**
2618
+ * @example
2619
+ * llm-us9hjmt32nysdxxx
2620
+ */
2621
+ workspaceId?: string;
1950
2622
  static names(): {
1951
2623
  [key: string]: string;
1952
2624
  };
@@ -1957,12 +2629,12 @@ export declare class ListPublishedAgentResponseBody extends $tea.Model {
1957
2629
  [key: string]: any;
1958
2630
  });
1959
2631
  }
1960
- export declare class ListPublishedAgentResponse extends $tea.Model {
2632
+ export declare class ListPromptTemplatesResponse extends $tea.Model {
1961
2633
  headers?: {
1962
2634
  [key: string]: string;
1963
2635
  };
1964
2636
  statusCode?: number;
1965
- body?: ListPublishedAgentResponseBody;
2637
+ body?: ListPromptTemplatesResponseBody;
1966
2638
  static names(): {
1967
2639
  [key: string]: string;
1968
2640
  };
@@ -1973,18 +2645,85 @@ export declare class ListPublishedAgentResponse extends $tea.Model {
1973
2645
  [key: string]: any;
1974
2646
  });
1975
2647
  }
1976
- export declare class RetrieveRequest extends $tea.Model {
1977
- /**
1978
- * @example
1979
- * 100
1980
- */
1981
- denseSimilarityTopK?: number;
1982
- /**
1983
- * @example
1984
- * true
1985
- */
2648
+ export declare class ListPublishedAgentRequest extends $tea.Model {
2649
+ pageNo?: number;
2650
+ pageSize?: number;
2651
+ static names(): {
2652
+ [key: string]: string;
2653
+ };
2654
+ static types(): {
2655
+ [key: string]: any;
2656
+ };
2657
+ constructor(map?: {
2658
+ [key: string]: any;
2659
+ });
2660
+ }
2661
+ export declare class ListPublishedAgentResponseBody extends $tea.Model {
2662
+ code?: string;
2663
+ data?: ListPublishedAgentResponseBodyData;
2664
+ httpStatusCode?: number;
2665
+ message?: string;
2666
+ requestId?: string;
2667
+ success?: string;
2668
+ static names(): {
2669
+ [key: string]: string;
2670
+ };
2671
+ static types(): {
2672
+ [key: string]: any;
2673
+ };
2674
+ constructor(map?: {
2675
+ [key: string]: any;
2676
+ });
2677
+ }
2678
+ export declare class ListPublishedAgentResponse extends $tea.Model {
2679
+ headers?: {
2680
+ [key: string]: string;
2681
+ };
2682
+ statusCode?: number;
2683
+ body?: ListPublishedAgentResponseBody;
2684
+ static names(): {
2685
+ [key: string]: string;
2686
+ };
2687
+ static types(): {
2688
+ [key: string]: any;
2689
+ };
2690
+ constructor(map?: {
2691
+ [key: string]: any;
2692
+ });
2693
+ }
2694
+ export declare class RetrieveRequest extends $tea.Model {
2695
+ /**
2696
+ * @remarks
2697
+ * Vector retrieval top K. After generating vectors based on input text, the top K chunks in the knowledge base that are most similar to the vector representation of the input text are retrieved. Valid values: 0 to 100. The sum of the `DenseSimilarityTopK` and `SparseSimilarityTopK` parameters must be less than or equal to 200.
2698
+ *
2699
+ * Default value: 100.
2700
+ *
2701
+ * @example
2702
+ * 100
2703
+ */
2704
+ denseSimilarityTopK?: number;
2705
+ /**
2706
+ * @remarks
2707
+ * Specifies whether to enable reranking. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
2708
+ *
2709
+ * * true
2710
+ * * false
2711
+ *
2712
+ * Default value: true.
2713
+ *
2714
+ * @example
2715
+ * true
2716
+ */
1986
2717
  enableReranking?: boolean;
1987
2718
  /**
2719
+ * @remarks
2720
+ * Specifies whether to enable multi-round conversation rewriting. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
2721
+ *
2722
+ * * true
2723
+ * * false
2724
+ *
2725
+ * Default value: false.
2726
+ *
1988
2727
  * @example
1989
2728
  * false
1990
2729
  */
@@ -1992,34 +2731,73 @@ export declare class RetrieveRequest extends $tea.Model {
1992
2731
  images?: string[];
1993
2732
  /**
1994
2733
  * @remarks
2734
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2735
+ *
1995
2736
  * This parameter is required.
1996
2737
  *
1997
2738
  * @example
1998
2739
  * 5pwe0m2g6t
1999
2740
  */
2000
2741
  indexId?: string;
2742
+ /**
2743
+ * @remarks
2744
+ * The input query prompt. The length and characters of the query are not limited.
2745
+ */
2001
2746
  query?: string;
2747
+ /**
2748
+ * @remarks
2749
+ * Ranking configurations.
2750
+ */
2002
2751
  rerank?: RetrieveRequestRerank[];
2003
2752
  /**
2753
+ * @remarks
2754
+ * Similarity Threshold The lowest similarity score of chunks that can be returned. This parameter is used to filter text chunks returned by the rank model. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00]. The priority of this parameter is greater than the similarity threshold configured for the knowledge base.
2755
+ *
2756
+ * By default, this parameter is left empty. In this case, the similarity threshold of the knowledge base is used.
2757
+ *
2004
2758
  * @example
2005
2759
  * 0.20
2006
2760
  */
2007
2761
  rerankMinScore?: number;
2008
2762
  /**
2763
+ * @remarks
2764
+ * The top N return data after reranking. Valid values: 1 to 20. Default value: 5.
2765
+ *
2009
2766
  * @example
2010
2767
  * 5
2011
2768
  */
2012
2769
  rerankTopN?: number;
2770
+ /**
2771
+ * @remarks
2772
+ * Conversation rewriting configurations.
2773
+ */
2013
2774
  rewrite?: RetrieveRequestRewrite[];
2014
2775
  /**
2776
+ * @remarks
2777
+ * Specifies whether to save the retrieve test history. Valid values:
2778
+ *
2779
+ * * true
2780
+ * * false
2781
+ *
2782
+ * Default value: false.
2783
+ *
2015
2784
  * @example
2016
2785
  * false
2017
2786
  */
2018
2787
  saveRetrieverHistory?: boolean;
2788
+ /**
2789
+ * @remarks
2790
+ * Specifies complex filter conditions. For more information about the syntax of SearchFilters, see the SearchFilter syntax section of this topic.
2791
+ */
2019
2792
  searchFilters?: {
2020
2793
  [key: string]: string;
2021
2794
  }[];
2022
2795
  /**
2796
+ * @remarks
2797
+ * The top K of keyword retrieval. Chunks that exactly match the keywords of the input text are retrieved from the knowledge base. This filters out irrelevant chunks and boosts accuracy. Valid values: 0 to 100. The sum of the `DenseSimilarityTopK` and `SparseSimilarityTopK` parameters must be less than or equal to 200.
2798
+ *
2799
+ * Default value: 100.
2800
+ *
2023
2801
  * @example
2024
2802
  * 100
2025
2803
  */
@@ -2036,16 +2814,37 @@ export declare class RetrieveRequest extends $tea.Model {
2036
2814
  }
2037
2815
  export declare class RetrieveShrinkRequest extends $tea.Model {
2038
2816
  /**
2817
+ * @remarks
2818
+ * Vector retrieval top K. After generating vectors based on input text, the top K chunks in the knowledge base that are most similar to the vector representation of the input text are retrieved. Valid values: 0 to 100. The sum of the `DenseSimilarityTopK` and `SparseSimilarityTopK` parameters must be less than or equal to 200.
2819
+ *
2820
+ * Default value: 100.
2821
+ *
2039
2822
  * @example
2040
2823
  * 100
2041
2824
  */
2042
2825
  denseSimilarityTopK?: number;
2043
2826
  /**
2827
+ * @remarks
2828
+ * Specifies whether to enable reranking. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
2829
+ *
2830
+ * * true
2831
+ * * false
2832
+ *
2833
+ * Default value: true.
2834
+ *
2044
2835
  * @example
2045
2836
  * true
2046
2837
  */
2047
2838
  enableReranking?: boolean;
2048
2839
  /**
2840
+ * @remarks
2841
+ * Specifies whether to enable multi-round conversation rewriting. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
2842
+ *
2843
+ * * true
2844
+ * * false
2845
+ *
2846
+ * Default value: false.
2847
+ *
2049
2848
  * @example
2050
2849
  * false
2051
2850
  */
@@ -2053,32 +2852,71 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2053
2852
  imagesShrink?: string;
2054
2853
  /**
2055
2854
  * @remarks
2855
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2856
+ *
2056
2857
  * This parameter is required.
2057
2858
  *
2058
2859
  * @example
2059
2860
  * 5pwe0m2g6t
2060
2861
  */
2061
2862
  indexId?: string;
2863
+ /**
2864
+ * @remarks
2865
+ * The input query prompt. The length and characters of the query are not limited.
2866
+ */
2062
2867
  query?: string;
2868
+ /**
2869
+ * @remarks
2870
+ * Ranking configurations.
2871
+ */
2063
2872
  rerankShrink?: string;
2064
2873
  /**
2874
+ * @remarks
2875
+ * Similarity Threshold The lowest similarity score of chunks that can be returned. This parameter is used to filter text chunks returned by the rank model. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00]. The priority of this parameter is greater than the similarity threshold configured for the knowledge base.
2876
+ *
2877
+ * By default, this parameter is left empty. In this case, the similarity threshold of the knowledge base is used.
2878
+ *
2065
2879
  * @example
2066
2880
  * 0.20
2067
2881
  */
2068
2882
  rerankMinScore?: number;
2069
2883
  /**
2884
+ * @remarks
2885
+ * The top N return data after reranking. Valid values: 1 to 20. Default value: 5.
2886
+ *
2070
2887
  * @example
2071
2888
  * 5
2072
2889
  */
2073
2890
  rerankTopN?: number;
2891
+ /**
2892
+ * @remarks
2893
+ * Conversation rewriting configurations.
2894
+ */
2074
2895
  rewriteShrink?: string;
2075
2896
  /**
2897
+ * @remarks
2898
+ * Specifies whether to save the retrieve test history. Valid values:
2899
+ *
2900
+ * * true
2901
+ * * false
2902
+ *
2903
+ * Default value: false.
2904
+ *
2076
2905
  * @example
2077
2906
  * false
2078
2907
  */
2079
2908
  saveRetrieverHistory?: boolean;
2909
+ /**
2910
+ * @remarks
2911
+ * Specifies complex filter conditions. For more information about the syntax of SearchFilters, see the SearchFilter syntax section of this topic.
2912
+ */
2080
2913
  searchFiltersShrink?: string;
2081
2914
  /**
2915
+ * @remarks
2916
+ * The top K of keyword retrieval. Chunks that exactly match the keywords of the input text are retrieved from the knowledge base. This filters out irrelevant chunks and boosts accuracy. Valid values: 0 to 100. The sum of the `DenseSimilarityTopK` and `SparseSimilarityTopK` parameters must be less than or equal to 200.
2917
+ *
2918
+ * Default value: 100.
2919
+ *
2082
2920
  * @example
2083
2921
  * 100
2084
2922
  */
@@ -2095,30 +2933,49 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2095
2933
  }
2096
2934
  export declare class RetrieveResponseBody extends $tea.Model {
2097
2935
  /**
2936
+ * @remarks
2937
+ * HTTP status code
2938
+ *
2098
2939
  * @example
2099
2940
  * Index.InvalidParameter
2100
2941
  */
2101
2942
  code?: string;
2943
+ /**
2944
+ * @remarks
2945
+ * The returned data.
2946
+ */
2102
2947
  data?: RetrieveResponseBodyData;
2103
2948
  /**
2949
+ * @remarks
2950
+ * The error message.
2951
+ *
2104
2952
  * @example
2105
2953
  * Required parameter(%s) missing or invalid, please check the request parameters.
2106
2954
  */
2107
2955
  message?: string;
2108
2956
  /**
2109
2957
  * @remarks
2110
- * Id of the request
2958
+ * The request ID.
2111
2959
  *
2112
2960
  * @example
2113
2961
  * 17204B98-7734-4F9A-8464-2446A84821CA
2114
2962
  */
2115
2963
  requestId?: string;
2116
2964
  /**
2965
+ * @remarks
2966
+ * The HTTP status code returned.
2967
+ *
2117
2968
  * @example
2118
2969
  * 200
2119
2970
  */
2120
2971
  status?: string;
2121
2972
  /**
2973
+ * @remarks
2974
+ * Indications whether the API call is successful. Valid values:
2975
+ *
2976
+ * * true
2977
+ * * false
2978
+ *
2122
2979
  * @example
2123
2980
  * true
2124
2981
  */
@@ -2150,10 +3007,20 @@ export declare class RetrieveResponse extends $tea.Model {
2150
3007
  });
2151
3008
  }
2152
3009
  export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
3010
+ /**
3011
+ * @remarks
3012
+ * The list of primary key IDs of the category.
3013
+ */
2153
3014
  categoryIds?: string[];
3015
+ /**
3016
+ * @remarks
3017
+ * The list of the primary key IDs of the documents.
3018
+ */
2154
3019
  documentIds?: string[];
2155
3020
  /**
2156
3021
  * @remarks
3022
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3023
+ *
2157
3024
  * This parameter is required.
2158
3025
  *
2159
3026
  * @example
@@ -2162,6 +3029,13 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
2162
3029
  indexId?: string;
2163
3030
  /**
2164
3031
  * @remarks
3032
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
3033
+ *
3034
+ * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
3035
+ * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
3036
+ *
3037
+ * > If this parameter is set to DATA_CENTER_CATEGORY, you must specify the `CategoryIds` parameter. If this parameter is set to DATA_CENTER_FILE, you must specify the `DocumentIds` parameter.
3038
+ *
2165
3039
  * This parameter is required.
2166
3040
  *
2167
3041
  * @example
@@ -2179,10 +3053,20 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
2179
3053
  });
2180
3054
  }
2181
3055
  export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model {
3056
+ /**
3057
+ * @remarks
3058
+ * The list of primary key IDs of the category.
3059
+ */
2182
3060
  categoryIdsShrink?: string;
3061
+ /**
3062
+ * @remarks
3063
+ * The list of the primary key IDs of the documents.
3064
+ */
2183
3065
  documentIdsShrink?: string;
2184
3066
  /**
2185
3067
  * @remarks
3068
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3069
+ *
2186
3070
  * This parameter is required.
2187
3071
  *
2188
3072
  * @example
@@ -2191,6 +3075,13 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
2191
3075
  indexId?: string;
2192
3076
  /**
2193
3077
  * @remarks
3078
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
3079
+ *
3080
+ * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
3081
+ * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
3082
+ *
3083
+ * > If this parameter is set to DATA_CENTER_CATEGORY, you must specify the `CategoryIds` parameter. If this parameter is set to DATA_CENTER_FILE, you must specify the `DocumentIds` parameter.
3084
+ *
2194
3085
  * This parameter is required.
2195
3086
  *
2196
3087
  * @example
@@ -2209,30 +3100,49 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
2209
3100
  }
2210
3101
  export declare class SubmitIndexAddDocumentsJobResponseBody extends $tea.Model {
2211
3102
  /**
3103
+ * @remarks
3104
+ * HTTP status code
3105
+ *
2212
3106
  * @example
2213
3107
  * Index.InvalidParameter
2214
3108
  */
2215
3109
  code?: string;
3110
+ /**
3111
+ * @remarks
3112
+ * The data returned.
3113
+ */
2216
3114
  data?: SubmitIndexAddDocumentsJobResponseBodyData;
2217
3115
  /**
3116
+ * @remarks
3117
+ * The error message.
3118
+ *
2218
3119
  * @example
2219
3120
  * Required parameter(%s) missing or invalid, please check the request parameters.
2220
3121
  */
2221
3122
  message?: string;
2222
3123
  /**
2223
3124
  * @remarks
2224
- * Id of the request
3125
+ * The request ID.
2225
3126
  *
2226
3127
  * @example
2227
3128
  * 778C0B3B-03C1-5FC1-A947-36EDD13606AB
2228
3129
  */
2229
3130
  requestId?: string;
2230
3131
  /**
3132
+ * @remarks
3133
+ * The HTTP status code returned.
3134
+ *
2231
3135
  * @example
2232
3136
  * 200
2233
3137
  */
2234
3138
  status?: string;
2235
3139
  /**
3140
+ * @remarks
3141
+ * Indications whether the API call is successful. Valid values:
3142
+ *
3143
+ * * true
3144
+ * * false
3145
+ *
2236
3146
  * @example
2237
3147
  * true
2238
3148
  */
@@ -2266,6 +3176,8 @@ export declare class SubmitIndexAddDocumentsJobResponse extends $tea.Model {
2266
3176
  export declare class SubmitIndexJobRequest extends $tea.Model {
2267
3177
  /**
2268
3178
  * @remarks
3179
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3180
+ *
2269
3181
  * This parameter is required.
2270
3182
  *
2271
3183
  * @example
@@ -2284,30 +3196,49 @@ export declare class SubmitIndexJobRequest extends $tea.Model {
2284
3196
  }
2285
3197
  export declare class SubmitIndexJobResponseBody extends $tea.Model {
2286
3198
  /**
3199
+ * @remarks
3200
+ * HTTP status code
3201
+ *
2287
3202
  * @example
2288
3203
  * InvalidParameter
2289
3204
  */
2290
3205
  code?: string;
3206
+ /**
3207
+ * @remarks
3208
+ * The data returned.
3209
+ */
2291
3210
  data?: SubmitIndexJobResponseBodyData;
2292
3211
  /**
3212
+ * @remarks
3213
+ * The error message.
3214
+ *
2293
3215
  * @example
2294
3216
  * Required parameter(%s) missing or invalid, please check the request parameters.
2295
3217
  */
2296
3218
  message?: string;
2297
3219
  /**
2298
3220
  * @remarks
2299
- * Id of the request
3221
+ * The request ID.
2300
3222
  *
2301
3223
  * @example
2302
3224
  * 17204B98-xxxx-4F9A-8464-2446A84821CA
2303
3225
  */
2304
3226
  requestId?: string;
2305
3227
  /**
3228
+ * @remarks
3229
+ * The status code.
3230
+ *
2306
3231
  * @example
2307
3232
  * Success
2308
3233
  */
2309
3234
  status?: string;
2310
3235
  /**
3236
+ * @remarks
3237
+ * Indications whether the API call is successful. Valid values:
3238
+ *
3239
+ * * true
3240
+ * * false
3241
+ *
2311
3242
  * @example
2312
3243
  * True
2313
3244
  */
@@ -2401,6 +3332,94 @@ export declare class UpdateAndPublishAgentResponse extends $tea.Model {
2401
3332
  [key: string]: any;
2402
3333
  });
2403
3334
  }
3335
+ export declare class UpdateFileTagRequest extends $tea.Model {
3336
+ /**
3337
+ * @remarks
3338
+ * This parameter is required.
3339
+ */
3340
+ tags?: string[];
3341
+ static names(): {
3342
+ [key: string]: string;
3343
+ };
3344
+ static types(): {
3345
+ [key: string]: any;
3346
+ };
3347
+ constructor(map?: {
3348
+ [key: string]: any;
3349
+ });
3350
+ }
3351
+ export declare class UpdateFileTagShrinkRequest extends $tea.Model {
3352
+ /**
3353
+ * @remarks
3354
+ * This parameter is required.
3355
+ */
3356
+ tagsShrink?: string;
3357
+ static names(): {
3358
+ [key: string]: string;
3359
+ };
3360
+ static types(): {
3361
+ [key: string]: any;
3362
+ };
3363
+ constructor(map?: {
3364
+ [key: string]: any;
3365
+ });
3366
+ }
3367
+ export declare class UpdateFileTagResponseBody extends $tea.Model {
3368
+ /**
3369
+ * @example
3370
+ * Success
3371
+ */
3372
+ code?: string;
3373
+ data?: UpdateFileTagResponseBodyData;
3374
+ /**
3375
+ * @example
3376
+ * Requests throttling triggered.
3377
+ */
3378
+ message?: string;
3379
+ /**
3380
+ * @remarks
3381
+ * RequestId
3382
+ *
3383
+ * @example
3384
+ * 35A267BF-xxxx-54DB-8394-AA3B0742D833
3385
+ */
3386
+ requestId?: string;
3387
+ /**
3388
+ * @example
3389
+ * 200
3390
+ */
3391
+ status?: string;
3392
+ /**
3393
+ * @example
3394
+ * true
3395
+ */
3396
+ success?: boolean;
3397
+ static names(): {
3398
+ [key: string]: string;
3399
+ };
3400
+ static types(): {
3401
+ [key: string]: any;
3402
+ };
3403
+ constructor(map?: {
3404
+ [key: string]: any;
3405
+ });
3406
+ }
3407
+ export declare class UpdateFileTagResponse extends $tea.Model {
3408
+ headers?: {
3409
+ [key: string]: string;
3410
+ };
3411
+ statusCode?: number;
3412
+ body?: UpdateFileTagResponseBody;
3413
+ static names(): {
3414
+ [key: string]: string;
3415
+ };
3416
+ static types(): {
3417
+ [key: string]: any;
3418
+ };
3419
+ constructor(map?: {
3420
+ [key: string]: any;
3421
+ });
3422
+ }
2404
3423
  export declare class UpdateMemoryRequest extends $tea.Model {
2405
3424
  description?: string;
2406
3425
  static names(): {
@@ -2493,6 +3512,51 @@ export declare class UpdateMemoryNodeResponse extends $tea.Model {
2493
3512
  [key: string]: any;
2494
3513
  });
2495
3514
  }
3515
+ export declare class UpdatePromptTemplateRequest extends $tea.Model {
3516
+ content?: string;
3517
+ name?: string;
3518
+ static names(): {
3519
+ [key: string]: string;
3520
+ };
3521
+ static types(): {
3522
+ [key: string]: any;
3523
+ };
3524
+ constructor(map?: {
3525
+ [key: string]: any;
3526
+ });
3527
+ }
3528
+ export declare class UpdatePromptTemplateResponseBody extends $tea.Model {
3529
+ /**
3530
+ * @example
3531
+ * FE9B6CBF-47E6-5D76-9C5D-B814DD5ABxxx
3532
+ */
3533
+ requestId?: string;
3534
+ static names(): {
3535
+ [key: string]: string;
3536
+ };
3537
+ static types(): {
3538
+ [key: string]: any;
3539
+ };
3540
+ constructor(map?: {
3541
+ [key: string]: any;
3542
+ });
3543
+ }
3544
+ export declare class UpdatePromptTemplateResponse extends $tea.Model {
3545
+ headers?: {
3546
+ [key: string]: string;
3547
+ };
3548
+ statusCode?: number;
3549
+ body?: UpdatePromptTemplateResponseBody;
3550
+ static names(): {
3551
+ [key: string]: string;
3552
+ };
3553
+ static types(): {
3554
+ [key: string]: any;
3555
+ };
3556
+ constructor(map?: {
3557
+ [key: string]: any;
3558
+ });
3559
+ }
2496
3560
  export declare class AddCategoryResponseBodyData extends $tea.Model {
2497
3561
  /**
2498
3562
  * @example
@@ -2512,11 +3576,19 @@ export declare class AddCategoryResponseBodyData extends $tea.Model {
2512
3576
  }
2513
3577
  export declare class AddFileResponseBodyData extends $tea.Model {
2514
3578
  /**
3579
+ * @remarks
3580
+ * The primary key ID of the document. We recommend that you store the ID because it is required for all subsequent API operations related to this document.
3581
+ *
2515
3582
  * @example
2516
3583
  * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
2517
3584
  */
2518
3585
  fileId?: string;
2519
3586
  /**
3587
+ * @remarks
3588
+ * The parser that is used to parse the document. Valid value:
3589
+ *
3590
+ * * DASHSCOPE_DOCMIND: Intelligent document parsing by Alibaba Cloud.
3591
+ *
2520
3592
  * @example
2521
3593
  * DASHSCOPE_DOCMIND
2522
3594
  */
@@ -2533,17 +3605,29 @@ export declare class AddFileResponseBodyData extends $tea.Model {
2533
3605
  }
2534
3606
  export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Model {
2535
3607
  /**
3608
+ * @remarks
3609
+ * The key-value pair to be placed in the Header. Both the key and the value are strings.
3610
+ *
2536
3611
  * @example
2537
3612
  * "X-bailian-extra": "MTAwNTQyNjQ5NTE2OTE3OA==",
2538
3613
  * "Content-Type": "application/pdf"
2539
3614
  */
2540
3615
  headers?: any;
2541
3616
  /**
3617
+ * @remarks
3618
+ * The HTTP call method. Valid values:
3619
+ *
3620
+ * * PUT
3621
+ * * POST
3622
+ *
2542
3623
  * @example
2543
3624
  * PUT
2544
3625
  */
2545
3626
  method?: string;
2546
3627
  /**
3628
+ * @remarks
3629
+ * The upload URL of the document.
3630
+ *
2547
3631
  * @example
2548
3632
  * https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
2549
3633
  */
@@ -2560,12 +3644,25 @@ export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Mode
2560
3644
  }
2561
3645
  export declare class ApplyFileUploadLeaseResponseBodyData extends $tea.Model {
2562
3646
  /**
3647
+ * @remarks
3648
+ * The unique ID of the lease. You need to specify this parameter when you call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation.
3649
+ *
2563
3650
  * @example
2564
3651
  * 1e6a159107384782be5e45ac4759b247.1719325231035
2565
3652
  */
2566
3653
  fileUploadLeaseId?: string;
3654
+ /**
3655
+ * @remarks
3656
+ * The HTTP request parameters used to upload the document.
3657
+ */
2567
3658
  param?: ApplyFileUploadLeaseResponseBodyDataParam;
2568
3659
  /**
3660
+ * @remarks
3661
+ * The upload method of the document. Valid values:
3662
+ *
3663
+ * * OSS.PreSignedURL
3664
+ * * HTTP
3665
+ *
2569
3666
  * @example
2570
3667
  * HTTP
2571
3668
  */
@@ -2708,15 +3805,55 @@ export declare class CreateIndexRequestColumns extends $tea.Model {
2708
3805
  });
2709
3806
  }
2710
3807
  export declare class CreateIndexRequestDataSource extends $tea.Model {
3808
+ /**
3809
+ * @remarks
3810
+ * > This parameter is not available. Do not specify this parameter.
3811
+ */
2711
3812
  credentialId?: string;
3813
+ /**
3814
+ * @remarks
3815
+ * > This parameter is not available. Do not specify this parameter.
3816
+ */
2712
3817
  credentialKey?: string;
3818
+ /**
3819
+ * @remarks
3820
+ * > This parameter is not available. Do not specify this parameter.
3821
+ */
2713
3822
  database?: string;
3823
+ /**
3824
+ * @remarks
3825
+ * > This parameter is not available. Do not specify this parameter.
3826
+ */
2714
3827
  endpoint?: string;
3828
+ /**
3829
+ * @remarks
3830
+ * > This parameter is not available. Do not specify this parameter.
3831
+ */
2715
3832
  isPrivateLink?: boolean;
3833
+ /**
3834
+ * @remarks
3835
+ * > This parameter is not available. Do not specify this parameter.
3836
+ */
2716
3837
  region?: string;
3838
+ /**
3839
+ * @remarks
3840
+ * > This parameter is not available. Do not specify this parameter.
3841
+ */
2717
3842
  subPath?: string;
3843
+ /**
3844
+ * @remarks
3845
+ * > This parameter is not available. Do not specify this parameter.
3846
+ */
2718
3847
  subType?: string;
3848
+ /**
3849
+ * @remarks
3850
+ * > This parameter is not available. Do not specify this parameter.
3851
+ */
2719
3852
  table?: string;
3853
+ /**
3854
+ * @remarks
3855
+ * > This parameter is not available. Do not specify this parameter.
3856
+ */
2720
3857
  type?: string;
2721
3858
  static names(): {
2722
3859
  [key: string]: string;
@@ -2730,6 +3867,11 @@ export declare class CreateIndexRequestDataSource extends $tea.Model {
2730
3867
  }
2731
3868
  export declare class CreateIndexResponseBodyData extends $tea.Model {
2732
3869
  /**
3870
+ * @remarks
3871
+ * The primary key ID of the knowledge base, `IndexId`.
3872
+ *
3873
+ * > We recommend that you store this ID. It is required for all subsequent API operations related to this knowledge base.
3874
+ *
2733
3875
  * @example
2734
3876
  * jkurxhju6b
2735
3877
  */
@@ -2777,6 +3919,10 @@ export declare class DeleteFileResponseBodyData extends $tea.Model {
2777
3919
  });
2778
3920
  }
2779
3921
  export declare class DeleteIndexDocumentResponseBodyData extends $tea.Model {
3922
+ /**
3923
+ * @remarks
3924
+ * The list of primary key IDs of documents that are deleted.
3925
+ */
2780
3926
  deletedDocument?: string[];
2781
3927
  static names(): {
2782
3928
  [key: string]: string;
@@ -2790,45 +3936,80 @@ export declare class DeleteIndexDocumentResponseBodyData extends $tea.Model {
2790
3936
  }
2791
3937
  export declare class DescribeFileResponseBodyData extends $tea.Model {
2792
3938
  /**
3939
+ * @remarks
3940
+ * The ID of the category to which the document belongs.
3941
+ *
2793
3942
  * @example
2794
3943
  * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
2795
3944
  */
2796
3945
  categoryId?: string;
2797
3946
  /**
3947
+ * @remarks
3948
+ * The timestamp when the document was uploaded to Model Studio. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC + 8.
3949
+ *
2798
3950
  * @example
2799
3951
  * 2024-05-26 12:45:43
2800
3952
  */
2801
3953
  createTime?: string;
2802
3954
  /**
3955
+ * @remarks
3956
+ * The primary key ID of the document.
3957
+ *
2803
3958
  * @example
2804
3959
  * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
2805
3960
  */
2806
3961
  fileId?: string;
2807
3962
  /**
3963
+ * @remarks
3964
+ * The name of the document.
3965
+ *
2808
3966
  * @example
2809
3967
  * test.pdf
2810
3968
  */
2811
3969
  fileName?: string;
2812
3970
  /**
3971
+ * @remarks
3972
+ * The file type of the document. The value is an extension. Valid values: pdf, docx, doc, txt, md, pptx, and ppt.
3973
+ *
2813
3974
  * @example
2814
3975
  * pdf
2815
3976
  */
2816
3977
  fileType?: string;
2817
3978
  /**
3979
+ * @remarks
3980
+ * The parser that is used to parse the document. Valid value:
3981
+ *
3982
+ * * DASHSCOPE_DOCMIND: The default document parser.
3983
+ *
2818
3984
  * @example
2819
3985
  * DASHSCOPE_DOCMIND
2820
3986
  */
2821
3987
  parser?: string;
2822
3988
  /**
3989
+ * @remarks
3990
+ * The size of the document. Unit: bytes.
3991
+ *
2823
3992
  * @example
2824
3993
  * 1234
2825
3994
  */
2826
3995
  sizeInBytes?: number;
2827
3996
  /**
3997
+ * @remarks
3998
+ * The status of the document. Valid values:
3999
+ *
4000
+ * * INIT: pending parsing.
4001
+ * * PARSING
4002
+ * * PARSE_SUCCESS
4003
+ * * PARSE_FAILED
4004
+ *
2828
4005
  * @example
2829
4006
  * PARSE_SUCCESS
2830
4007
  */
2831
4008
  status?: string;
4009
+ /**
4010
+ * @remarks
4011
+ * The tags that are associated with the document. A document can be associated with multiple tags.
4012
+ */
2832
4013
  tags?: string[];
2833
4014
  static names(): {
2834
4015
  [key: string]: string;
@@ -2842,22 +4023,43 @@ export declare class DescribeFileResponseBodyData extends $tea.Model {
2842
4023
  }
2843
4024
  export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Model {
2844
4025
  /**
4026
+ * @remarks
4027
+ * HTTP status code
4028
+ *
2845
4029
  * @example
2846
4030
  * Index.Document.ChunkError
2847
4031
  */
2848
4032
  code?: string;
2849
4033
  /**
4034
+ * @remarks
4035
+ * The primary key ID of the document.
4036
+ *
2850
4037
  * @example
2851
4038
  * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
2852
4039
  */
2853
4040
  docId?: string;
4041
+ /**
4042
+ * @remarks
4043
+ * The name of the document.
4044
+ */
2854
4045
  docName?: string;
2855
4046
  /**
4047
+ * @remarks
4048
+ * The error message.
4049
+ *
2856
4050
  * @example
2857
4051
  * document parse error
2858
4052
  */
2859
4053
  message?: string;
2860
4054
  /**
4055
+ * @remarks
4056
+ * The import status of the document. Valid values:
4057
+ *
4058
+ * * INSERT_ERROR
4059
+ * * RUNNING
4060
+ * * DELETED
4061
+ * * FINISH
4062
+ *
2861
4063
  * @example
2862
4064
  * RUNNING
2863
4065
  */
@@ -2873,13 +4075,28 @@ export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Mod
2873
4075
  });
2874
4076
  }
2875
4077
  export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
4078
+ /**
4079
+ * @remarks
4080
+ * The list of imported documents.
4081
+ */
2876
4082
  documents?: GetIndexJobStatusResponseBodyDataDocuments[];
2877
4083
  /**
4084
+ * @remarks
4085
+ * The ID of the job.
4086
+ *
2878
4087
  * @example
2879
4088
  * 66122af12a4e45ddae6bd6c845556647
2880
4089
  */
2881
4090
  jobId?: string;
2882
4091
  /**
4092
+ * @remarks
4093
+ * The status of the knowledge base job. Valid values:
4094
+ *
4095
+ * * COMPLETED
4096
+ * * FAILED
4097
+ * * RUNNING
4098
+ * * PENDING
4099
+ *
2883
4100
  * @example
2884
4101
  * PENDING
2885
4102
  */
@@ -3086,12 +4303,23 @@ export declare class ListCategoryResponseBodyData extends $tea.Model {
3086
4303
  });
3087
4304
  }
3088
4305
  export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
4306
+ /**
4307
+ * @remarks
4308
+ * The metadata map of the chunk.
4309
+ */
3089
4310
  metadata?: any;
3090
4311
  /**
4312
+ * @remarks
4313
+ * The similarity score of the chunk.
4314
+ *
3091
4315
  * @example
3092
4316
  * 0.3
3093
4317
  */
3094
4318
  score?: number;
4319
+ /**
4320
+ * @remarks
4321
+ * The text of the chunk.
4322
+ */
3095
4323
  text?: string;
3096
4324
  static names(): {
3097
4325
  [key: string]: string;
@@ -3104,8 +4332,15 @@ export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
3104
4332
  });
3105
4333
  }
3106
4334
  export declare class ListChunksResponseBodyData extends $tea.Model {
4335
+ /**
4336
+ * @remarks
4337
+ * The list of chunks.
4338
+ */
3107
4339
  nodes?: ListChunksResponseBodyDataNodes[];
3108
4340
  /**
4341
+ * @remarks
4342
+ * The total number of chunks returned.
4343
+ *
3109
4344
  * @example
3110
4345
  * 16
3111
4346
  */
@@ -3206,37 +4441,69 @@ export declare class ListFileResponseBodyData extends $tea.Model {
3206
4441
  }
3207
4442
  export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Model {
3208
4443
  /**
4444
+ * @remarks
4445
+ * The error status code of document import.
4446
+ *
3209
4447
  * @example
3210
4448
  * 110002
3211
4449
  */
3212
4450
  code?: string;
3213
4451
  /**
4452
+ * @remarks
4453
+ * The format of the document. Valid values: pdf, docx, doc, txt, md, pptx, ppt, and EXCEL.
4454
+ *
3214
4455
  * @example
3215
4456
  * pdf
3216
4457
  */
3217
4458
  documentType?: string;
3218
4459
  /**
4460
+ * @remarks
4461
+ * The primary key ID of the document.
4462
+ *
3219
4463
  * @example
3220
4464
  * doc_c134aa2073204a5d936d870bf960f56a10024701
3221
4465
  */
3222
4466
  id?: string;
3223
4467
  /**
4468
+ * @remarks
4469
+ * The error message of document import.
4470
+ *
3224
4471
  * @example
3225
4472
  * check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
3226
4473
  */
3227
4474
  message?: string;
4475
+ /**
4476
+ * @remarks
4477
+ * The name of the document.
4478
+ */
3228
4479
  name?: string;
3229
4480
  /**
4481
+ * @remarks
4482
+ * The size of the document. Unit: bytes.
4483
+ *
3230
4484
  * @example
3231
4485
  * 996764
3232
4486
  */
3233
4487
  size?: number;
3234
4488
  /**
4489
+ * @remarks
4490
+ * For unstructured knowledge base, this parameter is the category ID, which is the `CategoryId` returned by the [AddCategory](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addcategory) interface. To view the category ID, you can click the ID icon next to the category name on the Unstructured Data tab of the [Data Management](https://bailian.console.aliyun.com/#/data-center) page.
4491
+ *
4492
+ * For structured knowledge base, this parameter is the data table ID. To view the table ID, you can click the ID icon next to the table name on the Structured Data tab of the [Data Management](https://bailian.console.aliyun.com/#/data-center) page.
4493
+ *
3235
4494
  * @example
3236
4495
  * cate_21a407a3372c4ba7aedc649709143f0c10021401
3237
4496
  */
3238
4497
  sourceId?: string;
3239
4498
  /**
4499
+ * @remarks
4500
+ * The import status of the document. Valid values:
4501
+ *
4502
+ * * INSERT_ERROR
4503
+ * * RUNNING
4504
+ * * DELETED
4505
+ * * FINISH
4506
+ *
3240
4507
  * @example
3241
4508
  * RUNNING
3242
4509
  */
@@ -3252,23 +4519,39 @@ export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Mo
3252
4519
  });
3253
4520
  }
3254
4521
  export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
4522
+ /**
4523
+ * @remarks
4524
+ * The list of documents in the knowledge base.
4525
+ */
3255
4526
  documents?: ListIndexDocumentsResponseBodyDataDocuments[];
3256
4527
  /**
4528
+ * @remarks
4529
+ * The primary key ID of the knowledge base.
4530
+ *
3257
4531
  * @example
3258
4532
  * pno97tn8iu
3259
4533
  */
3260
4534
  indexId?: string;
3261
4535
  /**
4536
+ * @remarks
4537
+ * The specified page number.
4538
+ *
3262
4539
  * @example
3263
4540
  * 1
3264
4541
  */
3265
4542
  pageNumber?: number;
3266
4543
  /**
4544
+ * @remarks
4545
+ * The specified number of documents on each page.
4546
+ *
3267
4547
  * @example
3268
4548
  * 10
3269
4549
  */
3270
4550
  pageSize?: number;
3271
4551
  /**
4552
+ * @remarks
4553
+ * The total number of documents returned.
4554
+ *
3272
4555
  * @example
3273
4556
  * 2437
3274
4557
  */
@@ -3285,72 +4568,148 @@ export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
3285
4568
  }
3286
4569
  export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
3287
4570
  /**
4571
+ * @remarks
4572
+ * The estimated length of chunks. Valid values: [1-2048].
4573
+ *
3288
4574
  * @example
3289
4575
  * 5
3290
4576
  */
3291
4577
  chunkSize?: number;
3292
4578
  /**
4579
+ * @remarks
4580
+ * The description of the knowledge base.
4581
+ *
3293
4582
  * @example
3294
4583
  * If each RAM user belongs to a RAM group, the configuration is considered compliant.
3295
4584
  */
3296
4585
  description?: string;
4586
+ /**
4587
+ * @remarks
4588
+ * The list of the primary key IDs of the documents.
4589
+ */
3297
4590
  documentIds?: string[];
3298
4591
  /**
4592
+ * @remarks
4593
+ * The name of the embedding model. Valid values:
4594
+ *
4595
+ * * text-embedding-v2
4596
+ *
3299
4597
  * @example
3300
4598
  * conv-rewrite-qwen-1.8b
3301
4599
  */
3302
4600
  embeddingModelName?: string;
3303
4601
  /**
4602
+ * @remarks
4603
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
4604
+ *
3304
4605
  * @example
3305
4606
  * 259899
3306
4607
  */
3307
4608
  id?: string;
3308
4609
  /**
4610
+ * @remarks
4611
+ * The name of the knowledge base.
4612
+ *
3309
4613
  * @example
3310
4614
  * temp_mUB4j
3311
4615
  */
3312
4616
  name?: string;
3313
4617
  /**
4618
+ * @remarks
4619
+ * The overlap length. Valid values: [0-1024].
4620
+ *
3314
4621
  * @example
3315
4622
  * 10
3316
4623
  */
3317
4624
  overlapSize?: number;
3318
4625
  /**
4626
+ * @remarks
4627
+ * Similarity Threshold Valid values: [0.01-1.00].
4628
+ *
3319
4629
  * @example
3320
4630
  * 0.01
3321
4631
  */
3322
4632
  rerankMinScore?: string;
3323
4633
  /**
4634
+ * @remarks
4635
+ * The name of the rank model. Valid values:
4636
+ *
4637
+ * * gte-rerank-hybrid
4638
+ * * gte-rerank
4639
+ *
3324
4640
  * @example
3325
4641
  * gte-rerank-hybrid
3326
4642
  */
3327
4643
  rerankModelName?: string;
3328
4644
  /**
4645
+ * @remarks
4646
+ * The clause identifier. Separate multiple clause identifiers with |. Valid values:
4647
+ *
4648
+ * * \\n: line break
4649
+ * * ,: Chinese comma
4650
+ * * ,: English comma
4651
+ * * 。 : Chinese full stop
4652
+ * * .: English full stop
4653
+ * * ! : Chinese exclamation point
4654
+ * * ! : English exclamation point
4655
+ * * ;: Chinese semicolon
4656
+ * * ;: English semicolon
4657
+ * * ? : Chinese question mark
4658
+ * * ?: English question mark
4659
+ *
3329
4660
  * @example
3330
4661
  * \\n
3331
4662
  */
3332
4663
  separator?: string;
3333
4664
  /**
4665
+ * @remarks
4666
+ * The ID of the vector storage instance.
4667
+ *
3334
4668
  * @example
3335
4669
  * gp-bp1gq62t1788yw2ol
3336
4670
  */
3337
4671
  sinkInstanceId?: string;
3338
4672
  /**
4673
+ * @remarks
4674
+ * The region of the vector storage instance.
4675
+ *
3339
4676
  * @example
3340
4677
  * cn-hangzhou
3341
4678
  */
3342
4679
  sinkRegion?: string;
3343
4680
  /**
4681
+ * @remarks
4682
+ * The vector storage type of the knowledge base. Valid values:
4683
+ *
4684
+ * * ES: Built-in vector database.
4685
+ * * BUILT_IN: Built-in vector database.
4686
+ * * ADB: AnalyticDB for PostgreSQL database.
4687
+ *
3344
4688
  * @example
3345
4689
  * es
3346
4690
  */
3347
4691
  sinkType?: string;
3348
4692
  /**
4693
+ * @remarks
4694
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For unstructured knowledge base, possible values:
4695
+ *
4696
+ * * DATA_CENTER_CATEGORY: The category type.
4697
+ * * DATA_CENTER_FILE: The document type.
4698
+ *
4699
+ * For structured knowledge base, possible values:
4700
+ *
4701
+ * * DATA_CENTER_STRUCTURED_TABLE: The data table type.
4702
+ *
3349
4703
  * @example
3350
4704
  * DATA_CENTER_FILE
3351
4705
  */
3352
4706
  sourceType?: string;
3353
4707
  /**
4708
+ * @remarks
4709
+ * The vector storage type of the knowledge base. Valid values:
4710
+ *
4711
+ * * UNSTRUCTURED
4712
+ *
3354
4713
  * @example
3355
4714
  * structured
3356
4715
  */
@@ -3366,18 +4725,31 @@ export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
3366
4725
  });
3367
4726
  }
3368
4727
  export declare class ListIndicesResponseBodyData extends $tea.Model {
4728
+ /**
4729
+ * @remarks
4730
+ * The list of knowledge bases.
4731
+ */
3369
4732
  indices?: ListIndicesResponseBodyDataIndices[];
3370
4733
  /**
4734
+ * @remarks
4735
+ * The specified page number.
4736
+ *
3371
4737
  * @example
3372
4738
  * 1
3373
4739
  */
3374
4740
  pageNumber?: number;
3375
4741
  /**
4742
+ * @remarks
4743
+ * The specified number of documents on each page.
4744
+ *
3376
4745
  * @example
3377
4746
  * 10
3378
4747
  */
3379
4748
  pageSize?: number;
3380
4749
  /**
4750
+ * @remarks
4751
+ * The total number of knowledge bases returned.
4752
+ *
3381
4753
  * @example
3382
4754
  * 48
3383
4755
  */
@@ -3426,6 +4798,30 @@ export declare class ListMemoryNodesResponseBodyMemoryNodes extends $tea.Model {
3426
4798
  [key: string]: any;
3427
4799
  });
3428
4800
  }
4801
+ export declare class ListPromptTemplatesResponseBodyPromptTemplates extends $tea.Model {
4802
+ content?: string;
4803
+ name?: string;
4804
+ /**
4805
+ * @example
4806
+ * d6935b7efbe34d11b13df9307151cf8c
4807
+ */
4808
+ promptTemplateId?: string;
4809
+ /**
4810
+ * @example
4811
+ * "System"
4812
+ */
4813
+ type?: string;
4814
+ variables?: string[];
4815
+ static names(): {
4816
+ [key: string]: string;
4817
+ };
4818
+ static types(): {
4819
+ [key: string]: any;
4820
+ };
4821
+ constructor(map?: {
4822
+ [key: string]: any;
4823
+ });
4824
+ }
3429
4825
  export declare class ListPublishedAgentResponseBodyDataListApplicationConfigHistoryConfig extends $tea.Model {
3430
4826
  enableAdbRecord?: boolean;
3431
4827
  enableRecord?: boolean;
@@ -3570,6 +4966,12 @@ export declare class ListPublishedAgentResponseBodyData extends $tea.Model {
3570
4966
  }
3571
4967
  export declare class RetrieveRequestRerank extends $tea.Model {
3572
4968
  /**
4969
+ * @remarks
4970
+ * The name of the rank model. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base). Valid values:
4971
+ *
4972
+ * * gte-rerank-hybrid: Recommended official model.
4973
+ * * gte-rerank
4974
+ *
3573
4975
  * @example
3574
4976
  * gte-rerank-hybrid
3575
4977
  */
@@ -3585,6 +4987,17 @@ export declare class RetrieveRequestRerank extends $tea.Model {
3585
4987
  });
3586
4988
  }
3587
4989
  export declare class RetrieveRequestRewrite extends $tea.Model {
4990
+ /**
4991
+ * @remarks
4992
+ * Conversation rewriting model name. The query rewriting model automatically adjusts the original prompt based on the context to improve retrieval performance. Valid value:
4993
+ *
4994
+ * * conv-rewrite-qwen-1.8b
4995
+ *
4996
+ * By default, this parameter is left empty, which means conv-rewrite-qwen-1.8b is used.
4997
+ *
4998
+ * @example
4999
+ * conv-rewrite-qwen-1.8b
5000
+ */
3588
5001
  modelName?: string;
3589
5002
  static names(): {
3590
5003
  [key: string]: string;
@@ -3597,12 +5010,23 @@ export declare class RetrieveRequestRewrite extends $tea.Model {
3597
5010
  });
3598
5011
  }
3599
5012
  export declare class RetrieveResponseBodyDataNodes extends $tea.Model {
5013
+ /**
5014
+ * @remarks
5015
+ * The metadata map of the chunk.
5016
+ */
3600
5017
  metadata?: any;
3601
5018
  /**
5019
+ * @remarks
5020
+ * The similarity score of the chunk. Valid values:[0-1].
5021
+ *
3602
5022
  * @example
3603
5023
  * 0.3
3604
5024
  */
3605
5025
  score?: number;
5026
+ /**
5027
+ * @remarks
5028
+ * The text of the chunk.
5029
+ */
3606
5030
  text?: string;
3607
5031
  static names(): {
3608
5032
  [key: string]: string;
@@ -3615,6 +5039,10 @@ export declare class RetrieveResponseBodyDataNodes extends $tea.Model {
3615
5039
  });
3616
5040
  }
3617
5041
  export declare class RetrieveResponseBodyData extends $tea.Model {
5042
+ /**
5043
+ * @remarks
5044
+ * The list of queried chunks.
5045
+ */
3618
5046
  nodes?: RetrieveResponseBodyDataNodes[];
3619
5047
  static names(): {
3620
5048
  [key: string]: string;
@@ -3628,6 +5056,9 @@ export declare class RetrieveResponseBodyData extends $tea.Model {
3628
5056
  }
3629
5057
  export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Model {
3630
5058
  /**
5059
+ * @remarks
5060
+ * The primary key ID of the task, `JobId`.
5061
+ *
3631
5062
  * @example
3632
5063
  * 42687eb254a34802bed398357f5498ae
3633
5064
  */
@@ -3644,11 +5075,17 @@ export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Mod
3644
5075
  }
3645
5076
  export declare class SubmitIndexJobResponseBodyData extends $tea.Model {
3646
5077
  /**
5078
+ * @remarks
5079
+ * The primary key ID of the job, which is the `JobId` parameter of the [GetIndexJobStatus](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5080
+ *
3647
5081
  * @example
3648
5082
  * eFDr2fGRzP9gdDZWAdo3YQ==
3649
5083
  */
3650
5084
  id?: string;
3651
5085
  /**
5086
+ * @remarks
5087
+ * The primary key ID of the knowledge base.
5088
+ *
3652
5089
  * @example
3653
5090
  * khdyak1uuj
3654
5091
  */
@@ -3774,6 +5211,22 @@ export declare class UpdateAndPublishAgentRequestApplicationConfig extends $tea.
3774
5211
  [key: string]: any;
3775
5212
  });
3776
5213
  }
5214
+ export declare class UpdateFileTagResponseBodyData extends $tea.Model {
5215
+ /**
5216
+ * @example
5217
+ * file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
5218
+ */
5219
+ fileId?: string;
5220
+ static names(): {
5221
+ [key: string]: string;
5222
+ };
5223
+ static types(): {
5224
+ [key: string]: any;
5225
+ };
5226
+ constructor(map?: {
5227
+ [key: string]: any;
5228
+ });
5229
+ }
3777
5230
  export default class Client extends OpenApi {
3778
5231
  constructor(config: $OpenApi.Config);
3779
5232
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
@@ -3794,7 +5247,14 @@ export default class Client extends OpenApi {
3794
5247
  */
3795
5248
  addCategory(WorkspaceId: string, request: AddCategoryRequest): Promise<AddCategoryResponse>;
3796
5249
  /**
3797
- * 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
5250
+ * Imports an unstructured document stored in the temporary storage space to Data Management.
5251
+ *
5252
+ * @remarks
5253
+ * Before you call this operation, make sure that you have obtained the lease and uploaded the document to the temporary storage space by using the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. For more information, see [Upload files by calling API](https://help.aliyun.com/zh/model-studio/developer-reference/upload-files-by-calling-api).
5254
+ * > After you call this operation, the used lease ID expires immediately. Do not use the same lease ID to submit new requests.
5255
+ * * You must call this operation within 12 hours after you call the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. Otherwise, the lease expires and the request fails.
5256
+ * * After you call this operation, the system parses and imports your document. The process takes some time.
5257
+ * * This interface is not idempotent.
3798
5258
  *
3799
5259
  * @param tmpReq - AddFileRequest
3800
5260
  * @param headers - map
@@ -3805,14 +5265,27 @@ export default class Client extends OpenApi {
3805
5265
  [key: string]: string;
3806
5266
  }, runtime: $Util.RuntimeOptions): Promise<AddFileResponse>;
3807
5267
  /**
3808
- * 将临时上传的文档导入百炼数据中心,导入成功之后会自动触发文档解析。
5268
+ * Imports an unstructured document stored in the temporary storage space to Data Management.
5269
+ *
5270
+ * @remarks
5271
+ * Before you call this operation, make sure that you have obtained the lease and uploaded the document to the temporary storage space by using the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. For more information, see [Upload files by calling API](https://help.aliyun.com/zh/model-studio/developer-reference/upload-files-by-calling-api).
5272
+ * > After you call this operation, the used lease ID expires immediately. Do not use the same lease ID to submit new requests.
5273
+ * * You must call this operation within 12 hours after you call the [ApplyFileUploadLease](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-applyfileuploadlease) operation. Otherwise, the lease expires and the request fails.
5274
+ * * After you call this operation, the system parses and imports your document. The process takes some time.
5275
+ * * This interface is not idempotent.
3809
5276
  *
3810
5277
  * @param request - AddFileRequest
3811
5278
  * @returns AddFileResponse
3812
5279
  */
3813
5280
  addFile(WorkspaceId: string, request: AddFileRequest): Promise<AddFileResponse>;
3814
5281
  /**
3815
- * 请求文档上传租约,进行文档上传。
5282
+ * Applies for a document upload lease to upload a document.
5283
+ *
5284
+ * @remarks
5285
+ * This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
5286
+ * * The HTTP URL returned by this operation is valid only for minutes. Upload the document before the URL expires.
5287
+ * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours. Call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) interface in time to import the document to the [Data Management](https://bailian.console.aliyun.com/#/data-center) page.
5288
+ * * This interface is not idempotent.
3816
5289
  *
3817
5290
  * @param request - ApplyFileUploadLeaseRequest
3818
5291
  * @param headers - map
@@ -3823,7 +5296,13 @@ export default class Client extends OpenApi {
3823
5296
  [key: string]: string;
3824
5297
  }, runtime: $Util.RuntimeOptions): Promise<ApplyFileUploadLeaseResponse>;
3825
5298
  /**
3826
- * 请求文档上传租约,进行文档上传。
5299
+ * Applies for a document upload lease to upload a document.
5300
+ *
5301
+ * @remarks
5302
+ * This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
5303
+ * * The HTTP URL returned by this operation is valid only for minutes. Upload the document before the URL expires.
5304
+ * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours. Call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) interface in time to import the document to the [Data Management](https://bailian.console.aliyun.com/#/data-center) page.
5305
+ * * This interface is not idempotent.
3827
5306
  *
3828
5307
  * @param request - ApplyFileUploadLeaseRequest
3829
5308
  * @returns ApplyFileUploadLeaseResponse
@@ -3848,7 +5327,12 @@ export default class Client extends OpenApi {
3848
5327
  */
3849
5328
  createAndPulishAgent(workspaceId: string, request: CreateAndPulishAgentRequest): Promise<CreateAndPulishAgentResponse>;
3850
5329
  /**
3851
- * 创建并运行pipeline
5330
+ * Creates an unstructured knowledge base and imports one or more parsed documents into the knowledge base. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
5331
+ *
5332
+ * @remarks
5333
+ * 1. You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. To upload documents, call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation.
5334
+ * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
5335
+ * 3. This interface is not idempotent.
3852
5336
  *
3853
5337
  * @param tmpReq - CreateIndexRequest
3854
5338
  * @param headers - map
@@ -3859,7 +5343,12 @@ export default class Client extends OpenApi {
3859
5343
  [key: string]: string;
3860
5344
  }, runtime: $Util.RuntimeOptions): Promise<CreateIndexResponse>;
3861
5345
  /**
3862
- * 创建并运行pipeline
5346
+ * Creates an unstructured knowledge base and imports one or more parsed documents into the knowledge base. You cannot create a structured knowledge base by calling an API operation. Use the console instead.
5347
+ *
5348
+ * @remarks
5349
+ * 1. You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. To upload documents, call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation.
5350
+ * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
5351
+ * 3. This interface is not idempotent.
3863
5352
  *
3864
5353
  * @param request - CreateIndexRequest
3865
5354
  * @returns CreateIndexResponse
@@ -3901,6 +5390,24 @@ export default class Client extends OpenApi {
3901
5390
  * @returns CreateMemoryNodeResponse
3902
5391
  */
3903
5392
  createMemoryNode(workspaceId: string, memoryId: string, request: CreateMemoryNodeRequest): Promise<CreateMemoryNodeResponse>;
5393
+ /**
5394
+ * 创建Prompt模板
5395
+ *
5396
+ * @param request - CreatePromptTemplateRequest
5397
+ * @param headers - map
5398
+ * @param runtime - runtime options for this request RuntimeOptions
5399
+ * @returns CreatePromptTemplateResponse
5400
+ */
5401
+ createPromptTemplateWithOptions(workspaceId: string, request: CreatePromptTemplateRequest, headers: {
5402
+ [key: string]: string;
5403
+ }, runtime: $Util.RuntimeOptions): Promise<CreatePromptTemplateResponse>;
5404
+ /**
5405
+ * 创建Prompt模板
5406
+ *
5407
+ * @param request - CreatePromptTemplateRequest
5408
+ * @returns CreatePromptTemplateResponse
5409
+ */
5410
+ createPromptTemplate(workspaceId: string, request: CreatePromptTemplateRequest): Promise<CreatePromptTemplateResponse>;
3904
5411
  /**
3905
5412
  * 删除智能体
3906
5413
  *
@@ -3944,7 +5451,14 @@ export default class Client extends OpenApi {
3944
5451
  */
3945
5452
  deleteFile(FileId: string, WorkspaceId: string): Promise<DeleteFileResponse>;
3946
5453
  /**
3947
- * 删除Index
5454
+ * Deletes a specified knowledge base permanently.
5455
+ *
5456
+ * @remarks
5457
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5458
+ * * If a knowledge base is being called by an application, disassociate the knowledge base before you can delete it. To disassociate the knowledge base, you must use the console. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base).
5459
+ * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
5460
+ * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5461
+ * * This interface is idempotent.
3948
5462
  *
3949
5463
  * @param request - DeleteIndexRequest
3950
5464
  * @param headers - map
@@ -3955,14 +5469,28 @@ export default class Client extends OpenApi {
3955
5469
  [key: string]: string;
3956
5470
  }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexResponse>;
3957
5471
  /**
3958
- * 删除Index
5472
+ * Deletes a specified knowledge base permanently.
5473
+ *
5474
+ * @remarks
5475
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5476
+ * * If a knowledge base is being called by an application, disassociate the knowledge base before you can delete it. To disassociate the knowledge base, you must use the console. For more information, see [Create a knowledge base](https://help.aliyun.com/zh/model-studio/user-guide/rag-knowledge-base).
5477
+ * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
5478
+ * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5479
+ * * This interface is idempotent.
3959
5480
  *
3960
5481
  * @param request - DeleteIndexRequest
3961
5482
  * @returns DeleteIndexResponse
3962
5483
  */
3963
5484
  deleteIndex(WorkspaceId: string, request: DeleteIndexRequest): Promise<DeleteIndexResponse>;
3964
5485
  /**
3965
- * 删除index doc
5486
+ * Deletes one or more documents from a specified unstructured knowledge base permanently.
5487
+ *
5488
+ * @remarks
5489
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5490
+ * * Only documents with the INSERT_ERROR and FINISH states can be deleted. To query the status of documents in a specified knowledge base, call the [ListIndexDocuments](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
5491
+ * * After you delete a document, it cannot be recovered and the [Retrieve](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-retrieve) operation cannot query information about the document. We recommend that you proceed with caution.
5492
+ * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5493
+ * * This interface is idempotent.
3966
5494
  *
3967
5495
  * @param tmpReq - DeleteIndexDocumentRequest
3968
5496
  * @param headers - map
@@ -3973,7 +5501,14 @@ export default class Client extends OpenApi {
3973
5501
  [key: string]: string;
3974
5502
  }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexDocumentResponse>;
3975
5503
  /**
3976
- * 删除index doc
5504
+ * Deletes one or more documents from a specified unstructured knowledge base permanently.
5505
+ *
5506
+ * @remarks
5507
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5508
+ * * Only documents with the INSERT_ERROR and FINISH states can be deleted. To query the status of documents in a specified knowledge base, call the [ListIndexDocuments](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
5509
+ * * After you delete a document, it cannot be recovered and the [Retrieve](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-retrieve) operation cannot query information about the document. We recommend that you proceed with caution.
5510
+ * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5511
+ * * This interface is idempotent.
3977
5512
  *
3978
5513
  * @param request - DeleteIndexDocumentRequest
3979
5514
  * @returns DeleteIndexDocumentResponse
@@ -4010,7 +5545,29 @@ export default class Client extends OpenApi {
4010
5545
  */
4011
5546
  deleteMemoryNode(workspaceId: string, memoryId: string, memoryNodeId: string): Promise<DeleteMemoryNodeResponse>;
4012
5547
  /**
4013
- * 获取文档基本信息,包括文档名称、类型、状态等。
5548
+ * 基于模板Id删除Prompt模板。
5549
+ *
5550
+ * @param headers - map
5551
+ * @param runtime - runtime options for this request RuntimeOptions
5552
+ * @returns DeletePromptTemplateResponse
5553
+ */
5554
+ deletePromptTemplateWithOptions(workspaceId: string, promptTemplateId: string, headers: {
5555
+ [key: string]: string;
5556
+ }, runtime: $Util.RuntimeOptions): Promise<DeletePromptTemplateResponse>;
5557
+ /**
5558
+ * 基于模板Id删除Prompt模板。
5559
+ * @returns DeletePromptTemplateResponse
5560
+ */
5561
+ deletePromptTemplate(workspaceId: string, promptTemplateId: string): Promise<DeletePromptTemplateResponse>;
5562
+ /**
5563
+ * Queries the details of an unstructured document.
5564
+ *
5565
+ * @remarks
5566
+ * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
5567
+ * * If you upload the document by calling an API, make sure that you have called the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation to obtain `FileId`.
5568
+ * * You can also call this operation to query unstructured documents that you upload on the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page.
5569
+ * * This operation is idempotent.
5570
+ * **Throttling:** Make sure that the interval between the two queries is at least 15 seconds. Otherwise, you may trigger system throttling. If throttling is triggered, try again later.
4014
5571
  *
4015
5572
  * @param headers - map
4016
5573
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4020,12 +5577,24 @@ export default class Client extends OpenApi {
4020
5577
  [key: string]: string;
4021
5578
  }, runtime: $Util.RuntimeOptions): Promise<DescribeFileResponse>;
4022
5579
  /**
4023
- * 获取文档基本信息,包括文档名称、类型、状态等。
5580
+ * Queries the details of an unstructured document.
5581
+ *
5582
+ * @remarks
5583
+ * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
5584
+ * * If you upload the document by calling an API, make sure that you have called the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation to obtain `FileId`.
5585
+ * * You can also call this operation to query unstructured documents that you upload on the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page.
5586
+ * * This operation is idempotent.
5587
+ * **Throttling:** Make sure that the interval between the two queries is at least 15 seconds. Otherwise, you may trigger system throttling. If throttling is triggered, try again later.
4024
5588
  * @returns DescribeFileResponse
4025
5589
  */
4026
5590
  describeFile(WorkspaceId: string, FileId: string): Promise<DescribeFileResponse>;
4027
5591
  /**
4028
- * 获取Index运行状态
5592
+ * Queries the current status of a specified knowledge base creation or add document job.
5593
+ *
5594
+ * @remarks
5595
+ * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operation to create a add document job. Then, obtain the `JobId` returned by the operations.
5596
+ * 2. We recommend that you call this operation at intervals of more than 5 seconds.
5597
+ * 3. This interface is idempotent.
4029
5598
  *
4030
5599
  * @param request - GetIndexJobStatusRequest
4031
5600
  * @param headers - map
@@ -4036,7 +5605,12 @@ export default class Client extends OpenApi {
4036
5605
  [key: string]: string;
4037
5606
  }, runtime: $Util.RuntimeOptions): Promise<GetIndexJobStatusResponse>;
4038
5607
  /**
4039
- * 获取Index运行状态
5608
+ * Queries the current status of a specified knowledge base creation or add document job.
5609
+ *
5610
+ * @remarks
5611
+ * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operation to create a add document job. Then, obtain the `JobId` returned by the operations.
5612
+ * 2. We recommend that you call this operation at intervals of more than 5 seconds.
5613
+ * 3. This interface is idempotent.
4040
5614
  *
4041
5615
  * @param request - GetIndexJobStatusRequest
4042
5616
  * @returns GetIndexJobStatusResponse
@@ -4072,6 +5646,21 @@ export default class Client extends OpenApi {
4072
5646
  * @returns GetMemoryNodeResponse
4073
5647
  */
4074
5648
  getMemoryNode(workspaceId: string, memoryId: string, memoryNodeId: string): Promise<GetMemoryNodeResponse>;
5649
+ /**
5650
+ * 基于模板Id获取Prompt模板。
5651
+ *
5652
+ * @param headers - map
5653
+ * @param runtime - runtime options for this request RuntimeOptions
5654
+ * @returns GetPromptTemplateResponse
5655
+ */
5656
+ getPromptTemplateWithOptions(workspaceId: string, promptTemplateId: string, headers: {
5657
+ [key: string]: string;
5658
+ }, runtime: $Util.RuntimeOptions): Promise<GetPromptTemplateResponse>;
5659
+ /**
5660
+ * 基于模板Id获取Prompt模板。
5661
+ * @returns GetPromptTemplateResponse
5662
+ */
5663
+ getPromptTemplate(workspaceId: string, promptTemplateId: string): Promise<GetPromptTemplateResponse>;
4075
5664
  /**
4076
5665
  * 获取发布态智能体应用
4077
5666
  *
@@ -4106,7 +5695,11 @@ export default class Client extends OpenApi {
4106
5695
  */
4107
5696
  listCategory(WorkspaceId: string, request: ListCategoryRequest): Promise<ListCategoryResponse>;
4108
5697
  /**
4109
- * Chunk
5698
+ * For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the details of all chunks.
5699
+ *
5700
+ * @remarks
5701
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5702
+ * * This interface is idempotent.
4110
5703
  *
4111
5704
  * @param request - ListChunksRequest
4112
5705
  * @param headers - map
@@ -4117,7 +5710,11 @@ export default class Client extends OpenApi {
4117
5710
  [key: string]: string;
4118
5711
  }, runtime: $Util.RuntimeOptions): Promise<ListChunksResponse>;
4119
5712
  /**
4120
- * Chunk
5713
+ * For unstructured knowledge base, obtains the details of all chunks of a specified document; for structured knowledge base, obtains the details of all chunks.
5714
+ *
5715
+ * @remarks
5716
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5717
+ * * This interface is idempotent.
4121
5718
  *
4122
5719
  * @param request - ListChunksRequest
4123
5720
  * @returns ListChunksResponse
@@ -4142,7 +5739,11 @@ export default class Client extends OpenApi {
4142
5739
  */
4143
5740
  listFile(WorkspaceId: string, request: ListFileRequest): Promise<ListFileResponse>;
4144
5741
  /**
4145
- * 查询Index文件
5742
+ * Queries the details of one or more documents in a specified knowledge base.
5743
+ *
5744
+ * @remarks
5745
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5746
+ * * This interface is idempotent.
4146
5747
  *
4147
5748
  * @param request - ListIndexDocumentsRequest
4148
5749
  * @param headers - map
@@ -4153,14 +5754,21 @@ export default class Client extends OpenApi {
4153
5754
  [key: string]: string;
4154
5755
  }, runtime: $Util.RuntimeOptions): Promise<ListIndexDocumentsResponse>;
4155
5756
  /**
4156
- * 查询Index文件
5757
+ * Queries the details of one or more documents in a specified knowledge base.
5758
+ *
5759
+ * @remarks
5760
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5761
+ * * This interface is idempotent.
4157
5762
  *
4158
5763
  * @param request - ListIndexDocumentsRequest
4159
5764
  * @returns ListIndexDocumentsResponse
4160
5765
  */
4161
5766
  listIndexDocuments(WorkspaceId: string, request: ListIndexDocumentsRequest): Promise<ListIndexDocumentsResponse>;
4162
5767
  /**
4163
- * 查询pipeline
5768
+ * Lists knowledge bases in a specified workspace.
5769
+ *
5770
+ * @remarks
5771
+ * This interface is idempotent.
4164
5772
  *
4165
5773
  * @param request - ListIndicesRequest
4166
5774
  * @param headers - map
@@ -4171,7 +5779,10 @@ export default class Client extends OpenApi {
4171
5779
  [key: string]: string;
4172
5780
  }, runtime: $Util.RuntimeOptions): Promise<ListIndicesResponse>;
4173
5781
  /**
4174
- * 查询pipeline
5782
+ * Lists knowledge bases in a specified workspace.
5783
+ *
5784
+ * @remarks
5785
+ * This interface is idempotent.
4175
5786
  *
4176
5787
  * @param request - ListIndicesRequest
4177
5788
  * @returns ListIndicesResponse
@@ -4213,6 +5824,24 @@ export default class Client extends OpenApi {
4213
5824
  * @returns ListMemoryNodesResponse
4214
5825
  */
4215
5826
  listMemoryNodes(workspaceId: string, memoryId: string, request: ListMemoryNodesRequest): Promise<ListMemoryNodesResponse>;
5827
+ /**
5828
+ * 获取Prompt模板列表。
5829
+ *
5830
+ * @param request - ListPromptTemplatesRequest
5831
+ * @param headers - map
5832
+ * @param runtime - runtime options for this request RuntimeOptions
5833
+ * @returns ListPromptTemplatesResponse
5834
+ */
5835
+ listPromptTemplatesWithOptions(workspaceId: string, request: ListPromptTemplatesRequest, headers: {
5836
+ [key: string]: string;
5837
+ }, runtime: $Util.RuntimeOptions): Promise<ListPromptTemplatesResponse>;
5838
+ /**
5839
+ * 获取Prompt模板列表。
5840
+ *
5841
+ * @param request - ListPromptTemplatesRequest
5842
+ * @returns ListPromptTemplatesResponse
5843
+ */
5844
+ listPromptTemplates(workspaceId: string, request: ListPromptTemplatesRequest): Promise<ListPromptTemplatesResponse>;
4216
5845
  /**
4217
5846
  * 查询已发布的智能体应用列表
4218
5847
  *
@@ -4232,7 +5861,12 @@ export default class Client extends OpenApi {
4232
5861
  */
4233
5862
  listPublishedAgent(workspaceId: string, request: ListPublishedAgentRequest): Promise<ListPublishedAgentResponse>;
4234
5863
  /**
4235
- * 召回测试
5864
+ * Queries information from a specified knowledge base.
5865
+ *
5866
+ * @remarks
5867
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5868
+ * * The response time may be long because this operation involves complex retrieval and matching. We recommend that you set appropriate timeout and retry policy for requests.
5869
+ * * This interface is idempotent.
4236
5870
  *
4237
5871
  * @param tmpReq - RetrieveRequest
4238
5872
  * @param headers - map
@@ -4243,14 +5877,25 @@ export default class Client extends OpenApi {
4243
5877
  [key: string]: string;
4244
5878
  }, runtime: $Util.RuntimeOptions): Promise<RetrieveResponse>;
4245
5879
  /**
4246
- * 召回测试
5880
+ * Queries information from a specified knowledge base.
5881
+ *
5882
+ * @remarks
5883
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5884
+ * * The response time may be long because this operation involves complex retrieval and matching. We recommend that you set appropriate timeout and retry policy for requests.
5885
+ * * This interface is idempotent.
4247
5886
  *
4248
5887
  * @param request - RetrieveRequest
4249
5888
  * @returns RetrieveResponse
4250
5889
  */
4251
5890
  retrieve(WorkspaceId: string, request: RetrieveRequest): Promise<RetrieveResponse>;
4252
5891
  /**
4253
- * 知识索引
5892
+ * Adds parsed documents to an unstructured knowledge base.
5893
+ *
5894
+ * @remarks
5895
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5896
+ * * Before you call this operation, call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation to upload the documents to Model Studio.
5897
+ * * After you call this operation, you can call the [GetIndexJobStatus](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation to query the status of the job. More than 20 calls to the GetIndexJobStatus operation per minute may trigger throttling.
5898
+ * * Execution takes a period of time after this operation is called. Do not make new request before the request is returned. This interface is not idempotent.
4254
5899
  *
4255
5900
  * @param tmpReq - SubmitIndexAddDocumentsJobRequest
4256
5901
  * @param headers - map
@@ -4261,14 +5906,26 @@ export default class Client extends OpenApi {
4261
5906
  [key: string]: string;
4262
5907
  }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexAddDocumentsJobResponse>;
4263
5908
  /**
4264
- * 知识索引
5909
+ * Adds parsed documents to an unstructured knowledge base.
5910
+ *
5911
+ * @remarks
5912
+ * Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
5913
+ * * Before you call this operation, call the [AddFile](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-addfile) operation to upload the documents to Model Studio.
5914
+ * * After you call this operation, you can call the [GetIndexJobStatus](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation to query the status of the job. More than 20 calls to the GetIndexJobStatus operation per minute may trigger throttling.
5915
+ * * Execution takes a period of time after this operation is called. Do not make new request before the request is returned. This interface is not idempotent.
4265
5916
  *
4266
5917
  * @param request - SubmitIndexAddDocumentsJobRequest
4267
5918
  * @returns SubmitIndexAddDocumentsJobResponse
4268
5919
  */
4269
5920
  submitIndexAddDocumentsJob(WorkspaceId: string, request: SubmitIndexAddDocumentsJobRequest): Promise<SubmitIndexAddDocumentsJobResponse>;
4270
5921
  /**
4271
- * 提交索引任务
5922
+ * Submits a specified CreateIndex job to complete knowledge base creation.
5923
+ *
5924
+ * @remarks
5925
+ * 1. Before you call this operation, you must call the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
5926
+ * 2. Execution takes a period of time after this operation is called. Do not make new request before the request is returned.
5927
+ * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5928
+ * 4. This interface is not idempotent.
4272
5929
  *
4273
5930
  * @param request - SubmitIndexJobRequest
4274
5931
  * @param headers - map
@@ -4279,7 +5936,13 @@ export default class Client extends OpenApi {
4279
5936
  [key: string]: string;
4280
5937
  }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexJobResponse>;
4281
5938
  /**
4282
- * 提交索引任务
5939
+ * Submits a specified CreateIndex job to complete knowledge base creation.
5940
+ *
5941
+ * @remarks
5942
+ * 1. Before you call this operation, you must call the [CreateIndex](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
5943
+ * 2. Execution takes a period of time after this operation is called. Do not make new request before the request is returned.
5944
+ * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://help.aliyun.com/zh/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5945
+ * 4. This interface is not idempotent.
4283
5946
  *
4284
5947
  * @param request - SubmitIndexJobRequest
4285
5948
  * @returns SubmitIndexJobResponse
@@ -4303,6 +5966,24 @@ export default class Client extends OpenApi {
4303
5966
  * @returns UpdateAndPublishAgentResponse
4304
5967
  */
4305
5968
  updateAndPublishAgent(workspaceId: string, appCode: string, request: UpdateAndPublishAgentRequest): Promise<UpdateAndPublishAgentResponse>;
5969
+ /**
5970
+ * 更新文档Tag
5971
+ *
5972
+ * @param tmpReq - UpdateFileTagRequest
5973
+ * @param headers - map
5974
+ * @param runtime - runtime options for this request RuntimeOptions
5975
+ * @returns UpdateFileTagResponse
5976
+ */
5977
+ updateFileTagWithOptions(WorkspaceId: string, FileId: string, tmpReq: UpdateFileTagRequest, headers: {
5978
+ [key: string]: string;
5979
+ }, runtime: $Util.RuntimeOptions): Promise<UpdateFileTagResponse>;
5980
+ /**
5981
+ * 更新文档Tag
5982
+ *
5983
+ * @param request - UpdateFileTagRequest
5984
+ * @returns UpdateFileTagResponse
5985
+ */
5986
+ updateFileTag(WorkspaceId: string, FileId: string, request: UpdateFileTagRequest): Promise<UpdateFileTagResponse>;
4306
5987
  /**
4307
5988
  * 更新memory
4308
5989
  *
@@ -4339,4 +6020,22 @@ export default class Client extends OpenApi {
4339
6020
  * @returns UpdateMemoryNodeResponse
4340
6021
  */
4341
6022
  updateMemoryNode(workspaceId: string, memoryId: string, memoryNodeId: string, request: UpdateMemoryNodeRequest): Promise<UpdateMemoryNodeResponse>;
6023
+ /**
6024
+ * 基于模板Id增量更新Prompt模板。
6025
+ *
6026
+ * @param request - UpdatePromptTemplateRequest
6027
+ * @param headers - map
6028
+ * @param runtime - runtime options for this request RuntimeOptions
6029
+ * @returns UpdatePromptTemplateResponse
6030
+ */
6031
+ updatePromptTemplateWithOptions(workspaceId: string, promptTemplateId: string, request: UpdatePromptTemplateRequest, headers: {
6032
+ [key: string]: string;
6033
+ }, runtime: $Util.RuntimeOptions): Promise<UpdatePromptTemplateResponse>;
6034
+ /**
6035
+ * 基于模板Id增量更新Prompt模板。
6036
+ *
6037
+ * @param request - UpdatePromptTemplateRequest
6038
+ * @returns UpdatePromptTemplateResponse
6039
+ */
6040
+ updatePromptTemplate(workspaceId: string, promptTemplateId: string, request: UpdatePromptTemplateRequest): Promise<UpdatePromptTemplateResponse>;
4342
6041
  }