@alicloud/bailian20231229 1.10.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/client.d.ts +92 -75
  2. package/dist/client.js +62 -28
  3. package/dist/client.js.map +1 -1
  4. package/package.json +1 -1
  5. package/src/client.ts +121 -75
package/dist/client.d.ts CHANGED
@@ -443,7 +443,7 @@ export declare class CreateIndexRequest extends $tea.Model {
443
443
  categoryIds?: string[];
444
444
  /**
445
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].
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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: [1-2048].
447
447
  *
448
448
  * The default value is empty, which means using the intelligent splitting method.
449
449
  *
@@ -471,7 +471,7 @@ export declare class CreateIndexRequest extends $tea.Model {
471
471
  documentIds?: string[];
472
472
  /**
473
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:
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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid value:
475
475
  *
476
476
  * * text-embedding-v2
477
477
  *
@@ -490,7 +490,7 @@ export declare class CreateIndexRequest extends $tea.Model {
490
490
  name?: string;
491
491
  /**
492
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.
493
+ * The overlap length. The number of overlapping characters between two consecutive chunks. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: 0 to 1024.
494
494
  *
495
495
  * The default value is empty, which means using the intelligent splitting method.
496
496
  *
@@ -500,7 +500,7 @@ export declare class CreateIndexRequest extends $tea.Model {
500
500
  overlapSize?: number;
501
501
  /**
502
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].
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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00].
504
504
  *
505
505
  * Default value: 0.20.
506
506
  *
@@ -510,7 +510,7 @@ export declare class CreateIndexRequest extends $tea.Model {
510
510
  rerankMinScore?: number;
511
511
  /**
512
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:
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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
514
514
  *
515
515
  * * gte-rerank-hybrid
516
516
  * * gte-rerank
@@ -525,7 +525,7 @@ export declare class CreateIndexRequest extends $tea.Model {
525
525
  rerankModelName?: string;
526
526
  /**
527
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:
528
+ * The clause identifier. The document is split into chunks based on this identifier. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/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
529
  *
530
530
  * * \\n: line break
531
531
  * * ，: Chinese comma
@@ -536,7 +536,7 @@ export declare class CreateIndexRequest extends $tea.Model {
536
536
  * * ! : English exclamation point
537
537
  * * ；: Chinese semicolon
538
538
  * * ;: English semicolon
539
- * * ？ : Chinese question mark
539
+ * * ？: Chinese question mark
540
540
  * * ?: English question mark
541
541
  *
542
542
  * The default value is empty, which means using the intelligent splitting method.
@@ -555,7 +555,7 @@ export declare class CreateIndexRequest extends $tea.Model {
555
555
  sinkInstanceId?: string;
556
556
  /**
557
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.
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://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions) operation to query the most recent region list.
559
559
  *
560
560
  * @example
561
561
  * cn-hangzhou
@@ -563,7 +563,7 @@ export declare class CreateIndexRequest extends $tea.Model {
563
563
  sinkRegion?: string;
564
564
  /**
565
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:
566
+ * The vector storage type of the knowledge base. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
567
567
  *
568
568
  * * DEFAULT: The built-in vector database.
569
569
  * * ADB: AnalyticDB for PostgreSQL database. If you need advanced features, such as managing, auditing, and monitoring, we recommend that you specify ADB.
@@ -578,7 +578,7 @@ export declare class CreateIndexRequest extends $tea.Model {
578
578
  sinkType?: string;
579
579
  /**
580
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:
581
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
582
582
  *
583
583
  * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
584
584
  * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
@@ -598,7 +598,7 @@ export declare class CreateIndexRequest extends $tea.Model {
598
598
  sourceType?: string;
599
599
  /**
600
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:
601
+ * The data type of the knowledge base. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid value:
602
602
  *
603
603
  * * unstructured
604
604
  *
@@ -610,6 +610,7 @@ export declare class CreateIndexRequest extends $tea.Model {
610
610
  * structured
611
611
  */
612
612
  structureType?: string;
613
+ metaExtractColumns?: CreateIndexRequestMetaExtractColumns[];
613
614
  static names(): {
614
615
  [key: string]: string;
615
616
  };
@@ -628,7 +629,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
628
629
  categoryIdsShrink?: string;
629
630
  /**
630
631
  * @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
+ * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: [1-2048].
632
633
  *
633
634
  * The default value is empty, which means using the intelligent splitting method.
634
635
  *
@@ -656,7 +657,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
656
657
  documentIdsShrink?: string;
657
658
  /**
658
659
  * @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
+ * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid value:
660
661
  *
661
662
  * * text-embedding-v2
662
663
  *
@@ -675,7 +676,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
675
676
  name?: string;
676
677
  /**
677
678
  * @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
+ * The overlap length. The number of overlapping characters between two consecutive chunks. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: 0 to 1024.
679
680
  *
680
681
  * The default value is empty, which means using the intelligent splitting method.
681
682
  *
@@ -685,7 +686,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
685
686
  overlapSize?: number;
686
687
  /**
687
688
  * @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
+ * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values: [0.01-1.00].
689
690
  *
690
691
  * Default value: 0.20.
691
692
  *
@@ -695,7 +696,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
695
696
  rerankMinScore?: number;
696
697
  /**
697
698
  * @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
+ * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
699
700
  *
700
701
  * * gte-rerank-hybrid
701
702
  * * gte-rerank
@@ -710,7 +711,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
710
711
  rerankModelName?: string;
711
712
  /**
712
713
  * @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
+ * The clause identifier. The document is split into chunks based on this identifier. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/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
  *
715
716
  * * \\n: line break
716
717
  * * ，: Chinese comma
@@ -721,7 +722,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
721
722
  * * ! : English exclamation point
722
723
  * * ；: Chinese semicolon
723
724
  * * ;: English semicolon
724
- * * ？ : Chinese question mark
725
+ * * ？: Chinese question mark
725
726
  * * ?: English question mark
726
727
  *
727
728
  * The default value is empty, which means using the intelligent splitting method.
@@ -740,7 +741,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
740
741
  sinkInstanceId?: string;
741
742
  /**
742
743
  * @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
+ * The region of the vector storage instance. This parameter is available only when SinkType is set to ADB. You can call the [DescribeRegions](https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions) operation to query the most recent region list.
744
745
  *
745
746
  * @example
746
747
  * cn-hangzhou
@@ -748,7 +749,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
748
749
  sinkRegion?: string;
749
750
  /**
750
751
  * @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
+ * The vector storage type of the knowledge base. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
752
753
  *
753
754
  * * DEFAULT: The built-in vector database.
754
755
  * * ADB: AnalyticDB for PostgreSQL database. If you need advanced features, such as managing, auditing, and monitoring, we recommend that you specify ADB.
@@ -763,7 +764,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
763
764
  sinkType?: string;
764
765
  /**
765
766
  * @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
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
767
768
  *
768
769
  * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
769
770
  * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
@@ -783,7 +784,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
783
784
  sourceType?: string;
784
785
  /**
785
786
  * @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
+ * The data type of the knowledge base. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid value:
787
788
  *
788
789
  * * unstructured
789
790
  *
@@ -795,6 +796,7 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
795
796
  * structured
796
797
  */
797
798
  structureType?: string;
799
+ metaExtractColumnsShrink?: string;
798
800
  static names(): {
799
801
  [key: string]: string;
800
802
  };
@@ -1192,7 +1194,7 @@ export declare class DeleteFileResponse extends $tea.Model {
1192
1194
  export declare class DeleteIndexRequest extends $tea.Model {
1193
1195
  /**
1194
1196
  * @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.
1197
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1196
1198
  *
1197
1199
  * This parameter is required.
1198
1200
  *
@@ -1290,7 +1292,7 @@ export declare class DeleteIndexDocumentRequest extends $tea.Model {
1290
1292
  documentIds?: string[];
1291
1293
  /**
1292
1294
  * @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.
1295
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1294
1296
  *
1295
1297
  * This parameter is required.
1296
1298
  *
@@ -1318,7 +1320,7 @@ export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
1318
1320
  documentIdsShrink?: string;
1319
1321
  /**
1320
1322
  * @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.
1323
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1322
1324
  *
1323
1325
  * This parameter is required.
1324
1326
  *
@@ -1585,7 +1587,7 @@ export declare class DescribeFileResponse extends $tea.Model {
1585
1587
  export declare class GetIndexJobStatusRequest extends $tea.Model {
1586
1588
  /**
1587
1589
  * @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.
1590
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1589
1591
  *
1590
1592
  * This parameter is required.
1591
1593
  *
@@ -1595,7 +1597,7 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
1595
1597
  indexId?: string;
1596
1598
  /**
1597
1599
  * @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.
1600
+ * The knowledge base job ID, which is the `Data.Id` parameter returned by the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) or [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexadddocumentsjob) operations.
1599
1601
  *
1600
1602
  * This parameter is required.
1601
1603
  *
@@ -1605,7 +1607,7 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
1605
1607
  jobId?: string;
1606
1608
  /**
1607
1609
  * @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.
1610
+ * Both the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) and [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/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
1611
  *
1610
1612
  * @example
1611
1613
  * 1
@@ -1975,7 +1977,7 @@ export declare class ListChunksRequest extends $tea.Model {
1975
1977
  fields?: string[];
1976
1978
  /**
1977
1979
  * @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.
1980
+ * The primary key ID of the document. 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
1981
  *
1980
1982
  * @example
1981
1983
  * file_5f03dfea56da4050ab68d61871fc4cb3_10151493
@@ -1983,7 +1985,7 @@ export declare class ListChunksRequest extends $tea.Model {
1983
1985
  filed?: string;
1984
1986
  /**
1985
1987
  * @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.
1988
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
1987
1989
  *
1988
1990
  * This parameter is required.
1989
1991
  *
@@ -2201,7 +2203,7 @@ export declare class ListIndexDocumentsRequest extends $tea.Model {
2201
2203
  documentStatus?: string;
2202
2204
  /**
2203
2205
  * @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.
2206
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2205
2207
  *
2206
2208
  * This parameter is required.
2207
2209
  *
@@ -2704,7 +2706,7 @@ export declare class RetrieveRequest extends $tea.Model {
2704
2706
  denseSimilarityTopK?: number;
2705
2707
  /**
2706
2708
  * @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:
2709
+ * Specifies whether to enable reranking. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
2708
2710
  *
2709
2711
  * * true
2710
2712
  * * false
@@ -2717,7 +2719,7 @@ export declare class RetrieveRequest extends $tea.Model {
2717
2719
  enableReranking?: boolean;
2718
2720
  /**
2719
2721
  * @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:
2722
+ * Specifies whether to enable multi-round conversation rewriting. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
2721
2723
  *
2722
2724
  * * true
2723
2725
  * * false
@@ -2731,7 +2733,7 @@ export declare class RetrieveRequest extends $tea.Model {
2731
2733
  images?: string[];
2732
2734
  /**
2733
2735
  * @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.
2736
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2735
2737
  *
2736
2738
  * This parameter is required.
2737
2739
  *
@@ -2751,7 +2753,7 @@ export declare class RetrieveRequest extends $tea.Model {
2751
2753
  rerank?: RetrieveRequestRerank[];
2752
2754
  /**
2753
2755
  * @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.
2756
+ * 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://www.alibabacloud.com/help/en/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
2757
  *
2756
2758
  * By default, this parameter is left empty. In this case, the similarity threshold of the knowledge base is used.
2757
2759
  *
@@ -2825,7 +2827,7 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2825
2827
  denseSimilarityTopK?: number;
2826
2828
  /**
2827
2829
  * @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:
2830
+ * Specifies whether to enable reranking. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
2829
2831
  *
2830
2832
  * * true
2831
2833
  * * false
@@ -2838,7 +2840,7 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2838
2840
  enableReranking?: boolean;
2839
2841
  /**
2840
2842
  * @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:
2843
+ * Specifies whether to enable multi-round conversation rewriting. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
2842
2844
  *
2843
2845
  * * true
2844
2846
  * * false
@@ -2852,7 +2854,7 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2852
2854
  imagesShrink?: string;
2853
2855
  /**
2854
2856
  * @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.
2857
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
2856
2858
  *
2857
2859
  * This parameter is required.
2858
2860
  *
@@ -2872,7 +2874,7 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
2872
2874
  rerankShrink?: string;
2873
2875
  /**
2874
2876
  * @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.
2877
+ * 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://www.alibabacloud.com/help/en/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
2878
  *
2877
2879
  * By default, this parameter is left empty. In this case, the similarity threshold of the knowledge base is used.
2878
2880
  *
@@ -3019,7 +3021,7 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
3019
3021
  documentIds?: string[];
3020
3022
  /**
3021
3023
  * @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.
3024
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3023
3025
  *
3024
3026
  * This parameter is required.
3025
3027
  *
@@ -3029,7 +3031,7 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
3029
3031
  indexId?: string;
3030
3032
  /**
3031
3033
  * @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:
3034
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
3033
3035
  *
3034
3036
  * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
3035
3037
  * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
@@ -3065,7 +3067,7 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
3065
3067
  documentIdsShrink?: string;
3066
3068
  /**
3067
3069
  * @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.
3070
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3069
3071
  *
3070
3072
  * This parameter is required.
3071
3073
  *
@@ -3075,7 +3077,7 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
3075
3077
  indexId?: string;
3076
3078
  /**
3077
3079
  * @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:
3080
+ * The data type of [Data Management](https://bailian.console.aliyun.com/#/data-center). For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
3079
3081
  *
3080
3082
  * * DATA_CENTER_CATEGORY: The category type. Import all documents from one or more categories in Data Center.
3081
3083
  * * DATA_CENTER_FILE: The document type. Import one or more documents from Data Center.
@@ -3176,7 +3178,7 @@ export declare class SubmitIndexAddDocumentsJobResponse extends $tea.Model {
3176
3178
  export declare class SubmitIndexJobRequest extends $tea.Model {
3177
3179
  /**
3178
3180
  * @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.
3181
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
3180
3182
  *
3181
3183
  * This parameter is required.
3182
3184
  *
@@ -3645,7 +3647,7 @@ export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Mode
3645
3647
  export declare class ApplyFileUploadLeaseResponseBodyData extends $tea.Model {
3646
3648
  /**
3647
3649
  * @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.
3650
+ * The unique ID of the lease.
3649
3651
  *
3650
3652
  * @example
3651
3653
  * 1e6a159107384782be5e45ac4759b247.1719325231035
@@ -3865,6 +3867,23 @@ export declare class CreateIndexRequestDataSource extends $tea.Model {
3865
3867
  [key: string]: any;
3866
3868
  });
3867
3869
  }
3870
+ export declare class CreateIndexRequestMetaExtractColumns extends $tea.Model {
3871
+ desc?: string;
3872
+ enableLlm?: boolean;
3873
+ enableSearch?: boolean;
3874
+ key?: string;
3875
+ type?: string;
3876
+ value?: string;
3877
+ static names(): {
3878
+ [key: string]: string;
3879
+ };
3880
+ static types(): {
3881
+ [key: string]: any;
3882
+ };
3883
+ constructor(map?: {
3884
+ [key: string]: any;
3885
+ });
3886
+ }
3868
3887
  export declare class CreateIndexResponseBodyData extends $tea.Model {
3869
3888
  /**
3870
3889
  * @remarks
@@ -4487,7 +4506,7 @@ export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Mo
4487
4506
  size?: number;
4488
4507
  /**
4489
4508
  * @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.
4509
+ * For unstructured knowledge base, this parameter is the category ID. 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
4510
  *
4492
4511
  * 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
4512
  *
@@ -4600,7 +4619,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
4600
4619
  embeddingModelName?: string;
4601
4620
  /**
4602
4621
  * @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.
4622
+ * The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation.
4604
4623
  *
4605
4624
  * @example
4606
4625
  * 259899
@@ -4967,7 +4986,7 @@ export declare class ListPublishedAgentResponseBodyData extends $tea.Model {
4967
4986
  export declare class RetrieveRequestRerank extends $tea.Model {
4968
4987
  /**
4969
4988
  * @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:
4989
+ * The name of the rank model. For more information, see [Create a knowledge base](https://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base). Valid values:
4971
4990
  *
4972
4991
  * * gte-rerank-hybrid: Recommended official model.
4973
4992
  * * gte-rerank
@@ -5076,7 +5095,7 @@ export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Mod
5076
5095
  export declare class SubmitIndexJobResponseBodyData extends $tea.Model {
5077
5096
  /**
5078
5097
  * @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.
5098
+ * The primary key ID of the job, which is the `JobId` parameter of the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5080
5099
  *
5081
5100
  * @example
5082
5101
  * eFDr2fGRzP9gdDZWAdo3YQ==
@@ -5284,7 +5303,7 @@ export default class Client extends OpenApi {
5284
5303
  * @remarks
5285
5304
  * 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
5305
  * * 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.
5306
+ * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours.
5288
5307
  * * This interface is not idempotent.
5289
5308
  *
5290
5309
  * @param request - ApplyFileUploadLeaseRequest
@@ -5301,7 +5320,7 @@ export default class Client extends OpenApi {
5301
5320
  * @remarks
5302
5321
  * 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
5322
  * * 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.
5323
+ * * After you apply for a lease and upload a document, the document is stored in a temporary storage space for 12 hours.
5305
5324
  * * This interface is not idempotent.
5306
5325
  *
5307
5326
  * @param request - ApplyFileUploadLeaseRequest
@@ -5330,8 +5349,8 @@ export default class Client extends OpenApi {
5330
5349
  * 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
5350
  *
5332
5351
  * @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.
5352
+ * 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. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
5353
+ * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
5335
5354
  * 3. This interface is not idempotent.
5336
5355
  *
5337
5356
  * @param tmpReq - CreateIndexRequest
@@ -5346,8 +5365,8 @@ export default class Client extends OpenApi {
5346
5365
  * 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
5366
  *
5348
5367
  * @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.
5368
+ * 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. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
5369
+ * 2. This operation only initializes a knowledge base creation job. You must also call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to complete the job.
5351
5370
  * 3. This interface is not idempotent.
5352
5371
  *
5353
5372
  * @param request - CreateIndexRequest
@@ -5455,7 +5474,7 @@ export default class Client extends OpenApi {
5455
5474
  *
5456
5475
  * @remarks
5457
5476
  * 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).
5477
+ * * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base).
5459
5478
  * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
5460
5479
  * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5461
5480
  * * This interface is idempotent.
@@ -5473,7 +5492,7 @@ export default class Client extends OpenApi {
5473
5492
  *
5474
5493
  * @remarks
5475
5494
  * 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).
5495
+ * * 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://www.alibabacloud.com/help/en/model-studio/user-guide/rag-knowledge-base).
5477
5496
  * * After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
5478
5497
  * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5479
5498
  * * This interface is idempotent.
@@ -5487,8 +5506,8 @@ export default class Client extends OpenApi {
5487
5506
  *
5488
5507
  * @remarks
5489
5508
  * 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.
5509
+ * * 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://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
5510
+ * * After you delete a document, it cannot be recovered and the [Retrieve](https://www.alibabacloud.com/help/en/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
5511
  * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5493
5512
  * * This interface is idempotent.
5494
5513
  *
@@ -5505,8 +5524,8 @@ export default class Client extends OpenApi {
5505
5524
  *
5506
5525
  * @remarks
5507
5526
  * 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.
5527
+ * * 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://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-listindexdocuments) operation.
5528
+ * * After you delete a document, it cannot be recovered and the [Retrieve](https://www.alibabacloud.com/help/en/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
5529
  * * Imported documents are not deleted from the [Data Management](https://bailian.console.aliyun.com/#/data-center) if you call this operation.
5511
5530
  * * This interface is idempotent.
5512
5531
  *
@@ -5564,7 +5583,6 @@ export default class Client extends OpenApi {
5564
5583
  *
5565
5584
  * @remarks
5566
5585
  * 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
5586
  * * 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
5587
  * * This operation is idempotent.
5570
5588
  * **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.
@@ -5581,7 +5599,6 @@ export default class Client extends OpenApi {
5581
5599
  *
5582
5600
  * @remarks
5583
5601
  * 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
5602
  * * 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
5603
  * * This operation is idempotent.
5587
5604
  * **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.
@@ -5592,7 +5609,7 @@ export default class Client extends OpenApi {
5592
5609
  * Queries the current status of a specified knowledge base creation or add document job.
5593
5610
  *
5594
5611
  * @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.
5612
+ * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/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
5613
  * 2. We recommend that you call this operation at intervals of more than 5 seconds.
5597
5614
  * 3. This interface is idempotent.
5598
5615
  *
@@ -5608,7 +5625,7 @@ export default class Client extends OpenApi {
5608
5625
  * Queries the current status of a specified knowledge base creation or add document job.
5609
5626
  *
5610
5627
  * @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.
5628
+ * 1. A knowledge base job is running. You can call the [SubmitIndexJob](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-submitindexjob) operation to create a creation job or the [SubmitIndexAddDocumentsJob](https://www.alibabacloud.com/help/en/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
5629
  * 2. We recommend that you call this operation at intervals of more than 5 seconds.
5613
5630
  * 3. This interface is idempotent.
5614
5631
  *
@@ -5892,9 +5909,9 @@ export default class Client extends OpenApi {
5892
5909
  * Adds parsed documents to an unstructured knowledge base.
5893
5910
  *
5894
5911
  * @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.
5912
+ * 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. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
5913
+ * * 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.
5914
+ * * After you call this operation, you can call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/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
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.
5899
5916
  *
5900
5917
  * @param tmpReq - SubmitIndexAddDocumentsJobRequest
@@ -5909,9 +5926,9 @@ export default class Client extends OpenApi {
5909
5926
  * Adds parsed documents to an unstructured knowledge base.
5910
5927
  *
5911
5928
  * @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.
5929
+ * 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. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
5930
+ * * 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.
5931
+ * * After you call this operation, you can call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/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
5932
  * * 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.
5916
5933
  *
5917
5934
  * @param request - SubmitIndexAddDocumentsJobRequest
@@ -5922,9 +5939,9 @@ export default class Client extends OpenApi {
5922
5939
  * Submits a specified CreateIndex job to complete knowledge base creation.
5923
5940
  *
5924
5941
  * @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`.
5942
+ * 1. Before you call this operation, you must call the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
5926
5943
  * 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.
5944
+ * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5928
5945
  * 4. This interface is not idempotent.
5929
5946
  *
5930
5947
  * @param request - SubmitIndexJobRequest
@@ -5939,9 +5956,9 @@ export default class Client extends OpenApi {
5939
5956
  * Submits a specified CreateIndex job to complete knowledge base creation.
5940
5957
  *
5941
5958
  * @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`.
5959
+ * 1. Before you call this operation, you must call the [CreateIndex](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-createindex) operation and obtain the `IndexId`.
5943
5960
  * 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.
5961
+ * 3. If you want to query the execution status of the job after you call this operation, call the [GetIndexJobStatus](https://www.alibabacloud.com/help/en/model-studio/developer-reference/api-bailian-2023-12-29-getindexjobstatus) operation.
5945
5962
  * 4. This interface is not idempotent.
5946
5963
  *
5947
5964
  * @param request - SubmitIndexJobRequest