@alicloud/bailian20231229 2.14.2 → 2.14.4

package/dist/models/CreateIndexRequest.d.ts

@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class CreateIndexRequestColumns extends $dara.Model {
     /**
      * @remarks
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -23,7 +23,7 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -44,7 +44,7 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -60,11 +60,11 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
-     * School.
+     * School
      */
     name?: string;
     /**
@@ -83,7 +83,7 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -107,7 +107,7 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
      * The Chinese description of the metadata field. The description can be up to 1000 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and colons (:). Default value: empty.
      *
      * @example
-     * AuthorName.
+     * AuthorName
      */
     desc?: string;
     /**
@@ -138,7 +138,7 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
     enableSearch?: boolean;
     /**
      * @remarks
-     * The metadata field. The field must be 1 to 50 characters in length and can contain only letters and underscores. If this parameter is specified, you must also specify the `Value` and `Type` parameters.
+     * The metadata field. The field must be 1 to 50 characters in length and contain only letters or underscores. If this parameter is specified, you must also specify the `Value` and `Type` parameters.
      *
      * @example
      * author
@@ -187,21 +187,21 @@ export declare class CreateIndexRequest extends $dara.Model {
      * @remarks
      * <props="china">
      *
-     * The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded:
+     * The chunk size, which is the maximum number of characters per text chunk. When the text exceeds this length:
      *
-     * - **Intelligent chunking** (when `chunkMode` is not specified): The text is likely to be truncated.
-     * - **Custom chunking** (when `chunkMode` is specified): The text is forcibly truncated.
+     * - **Intelligent chunking** (`chunkMode` not specified): The text is likely to be truncated.
+     * - **Custom chunking** (`chunkMode` specified): The text is forcibly truncated.
      *
      *
      *
      * <props="intl">
-     * The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded, the text is likely to be truncated.
+     * The chunk size, which is the maximum number of characters per text chunk. When the text exceeds this length, it is likely to be truncated.
      *
      *
      *
-     * Value range: [1-6000]. If not specified, the default value is 500.
+     * Valid values: [1-6000]. If not specified, the default value is 500.
      *
-     * > If `ChunkSize` is set to a value less than 100, you must also set `OverlapSize`. You can also leave both parameters unspecified, and the system uses default values.
+     * > If `ChunkSize` is set to a value less than 100, you must also set `OverlapSize`. You can also leave both parameters unspecified, and the system uses the default values.
      *
      * @example
      * 128
@@ -210,18 +210,18 @@ export declare class CreateIndexRequest extends $dara.Model {
     /**
      * @remarks
      * <props="china">
-     * The structure of the data table (column names, types, etc.).
+     * The structure of the data table (column names, types, and so on).
      *
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      */
     columns?: CreateIndexRequestColumns[];
     /**
      * @remarks
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -230,23 +230,23 @@ export declare class CreateIndexRequest extends $dara.Model {
     createIndexType?: string;
     /**
      * @remarks
-     * The knowledge base description. The description can be up to 1000 characters in length.
+     * The knowledge base description. The description can be up to 200 characters in length and can contain Chinese and English characters.
      * Default value: empty.
      *
      * @example
-     * The enterprise help document library includes important materials such as company policies and product catalogs.
+     * The enterprise help document library includes important materials such as company policies and product catalogs
      */
     description?: string;
     /**
      * @remarks
-     * The list of files to import when creating the knowledge base. Specify file IDs here. We recommend importing no more than 10,000 files. For remaining files, call the **SubmitIndexAddDocumentsJob** operation to continue importing.
+     * The list of files to import when creating the knowledge base. Specify file IDs. We recommend importing no more than 10,000 files. For remaining files, call the **SubmitIndexAddDocumentsJob** operation to continue importing.
      */
     documentIds?: string[];
     /**
      * @remarks
      * <props="china">
      *
-     * The embedding model used by the knowledge base. The embedding model transforms the original input prompt and knowledge text into numerical vectors for similarity comparison. The text-embedding-v4 model is a comprehensive upgrade over text-embedding-v3 in terms of language support, code snippet quantization, and vector dimensions selection, and is suitable for most scenarios. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
+     * The embedding model used by the knowledge base. The embedding model is used to transform the original input prompt and knowledge text into numerical vectors for similarity comparison. The text-embedding-v4 model is a comprehensive upgrade over text-embedding-v3 in terms of language support, code snippet quantization, and vector dimension selection, and is suitable for most scenarios. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
      * - text-embedding-v4
      * - text-embedding-v3
      *
@@ -257,7 +257,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * <props="intl">
      *
-     * The embedding model used by the knowledge base. The embedding model transforms the original input prompt and knowledge text into numerical vectors for similarity comparison. The default text-embedding-v2 model (cannot be changed) supports Chinese, English, and multiple other languages, and performs normalization on vector results. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
+     * The embedding model used by the knowledge base. The embedding model is used to transform the original input prompt and knowledge text into numerical vectors for similarity comparison. The default text-embedding-v2 model (cannot be changed) supports Chinese, English, and multiple other languages, and performs normalization on vector results. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
      * - text-embedding-v2
      *
      * Default value: empty, which uses the text-embedding-v2 model.
@@ -286,12 +286,12 @@ export declare class CreateIndexRequest extends $dara.Model {
      * This parameter is required.
      *
      * @example
-     * EnterpriseHelpDocLibrary.
+     * EnterpriseHelpDocLibrary
      */
     name?: string;
     /**
      * @remarks
-     * The chunk overlap size, which specifies the number of overlapping characters between the current text chunk and the previous text chunk. Value range: [0-1024].
+     * The chunk overlap size, which is the number of overlapping characters between the current text chunk and the previous text chunk. Valid values: [0-1024].
      *
      * If not specified, the default value is 100.
      * >`OverlapSize` must be less than `ChunkSize`. Otherwise, chunking exceptions occur.
@@ -302,15 +302,15 @@ export declare class CreateIndexRequest extends $dara.Model {
     overlapSize?: number;
     /**
      * @remarks
-     * <props="intl">This parameter is not available. Do not pass this parameter.
+     * <props="intl">This parameter is not yet available. Do not pass in a value.
      *
-     * <props="china">A natural language instruction for fine-grained control of the reranking model\\"s behavior.
+     * <props="china">Provides a natural language instruction to fine-tune the behavior of the reranking model.
      * <notice>This parameter takes effect only when rerank_mode is set to "custom".
      */
     rerankInstruct?: string;
     /**
      * @remarks
-     * The similarity threshold. Only text chunks with similarity scores exceeding this value are recalled. This parameter filters the text chunks returned by the reranking model. Value range: [0.01-1.00].
+     * The similarity threshold. Only text chunks with similarity scores exceeding this value are recalled. This parameter filters the text chunks returned by the reranking model. Valid values: [0.01-1.00].
      *
      * If not specified, the default value is 0.01.
      *
@@ -333,7 +333,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      *
      *
-     * <props="intl">This parameter is not available. Do not pass this parameter.
+     * <props="intl">This parameter is not available. Do not pass in a value.
      * [_single.params.RerankMode.enum.similar: 相似模式。]similar: Similarity mode.
      * [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Custom mode.
      * [_single.params.RerankMode.enum.qa:（默认值） 问答模式。]qa: (Default) Q&A mode.
@@ -361,7 +361,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * <props="intl">
      *
-     * - gte-rerank-hybrid: official reranking.
+     * - gte-rerank-hybrid: Official reranking.
      * - gte-rerank: gte-rerank reranking.
      *
      *
@@ -389,7 +389,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * <props="china">
      *
-     * > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated and are not recommended.
+     * > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated. We do not recommend using them.
      * >
      *
      * @example
@@ -400,16 +400,16 @@ export declare class CreateIndexRequest extends $dara.Model {
      * @remarks
      * <props="china">
      *
-     * The sentence separator, which takes effect only when `chunkMode`=**regex** (it does not take effect in other modes even if specified). You can pass a single regular expression (multiple expressions are not supported) to split files into small text chunks.
+     * The sentence separator. This parameter takes effect only when `chunkMode`=**regex** (it does not take effect in other modes even if specified). You can pass in a single regular expression (multiple expressions are not supported) to split files into small text chunks.
      *
-     * When using intelligent chunking (when `chunkMode` is not specified), keep the default empty value.
+     * When using intelligent chunking (`chunkMode` not specified), keep the default empty value.
      *
      *
      *
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      *
      * @example
      * (?<=。)
@@ -436,7 +436,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      * The vector storage type of the knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values:
      * - BUILT_IN: Vector data is hosted on the Alibaba Cloud Model Studio platform.
      * - ADB: AnalyticDB for PostgreSQL database. If you need advanced features such as database management, auditing, and monitoring, select ADB.
-     * > If you have not used ADB storage on Alibaba Cloud Model Studio before, go to the <props="china">[Create Knowledge Base](https://bailian.console.aliyun.com/#/knowledge-base/create)<props="intl">[Create Knowledge Base](https://bailian.console.alibabacloud.com/#/knowledge-base/create) page, select ADB-PG as the vector storage type, and complete authorization as prompted. If you pass ADB, you must specify the `SinkInstanceId` and `SinkRegion` parameters.
+     * > If you have not used ADB storage on Alibaba Cloud Model Studio before, go to the <props="china">[Create Knowledge Base](https://bailian.console.aliyun.com/#/knowledge-base/create)<props="intl">[Create Knowledge Base](https://bailian.console.alibabacloud.com/#/knowledge-base/create) page, set the vector storage type to ADB-PG, and complete the authorization as prompted. If you pass in ADB, you must specify the `SinkInstanceId` and `SinkRegion` parameters.
      *
      * This parameter is required.
      *
@@ -446,16 +446,16 @@ export declare class CreateIndexRequest extends $dara.Model {
     sinkType?: string;
     /**
      * @remarks
-     * >Notice: This parameter is required in the latest SDK. Otherwise, calling the SubmitIndexJob operation returns an error: Required parameter(data_sources) missing or invalid.
+     * >Notice: This parameter is required in the latest SDK version. Otherwise, calling the SubmitIndexJob operation returns the error: Required parameter(data_sources) missing or invalid.
      *
      * The data source type. Valid values:
-     * - DATA_CENTER_CATEGORY: Category type. Imports all files under specified categories in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). Multiple categories can be imported simultaneously.
-     * - DATA_CENTER_FILE: File type. Imports specified files from <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). Multiple files can be imported simultaneously.
+     * - DATA_CENTER_CATEGORY: Category type. Imports all files under specified categories in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). You can import multiple categories at the same time.
+     * - DATA_CENTER_FILE: File type. Imports specified files from <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). You can import multiple files at the same time.
      *
      * > 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.
      * >
      *
-     * > To create an empty knowledge base, use an empty category that contains no files: set this parameter to DATA_CENTER_CATEGORY and pass the empty category ID in `CategoryIds`.
+     * > To create an empty knowledge base, use an empty category that contains no files: set this parameter to DATA_CENTER_CATEGORY and pass the empty category ID to `CategoryIds`.
      * >
      *
      * @example
@@ -471,7 +471,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * **Valid values:**
      *
-     * - unstructured: A document search or audio/video knowledge base. The default scenario for document search type is basic document Q&A. <props="china">To create other scenarios, pass the knowledgeType and knowledgeScene parameters.
+     * - unstructured: A document search or audio/video knowledge base. The default scenario for the document search type is basic document Q&A. <props="china">To create other scenarios, you must also pass the knowledgeType and knowledgeScene parameters.
      *
      * <props="china">
      *
@@ -492,14 +492,14 @@ export declare class CreateIndexRequest extends $dara.Model {
      * @remarks
      * <props="china">
      *
-     * Obtained by clicking the ID icon next to the table name on the Tables tab of [Data Connections](https://bailian.console.aliyun.com/cn-beijing?tab=app#/connector/list) table connector. If the list contains multiple IDs, only the first one is used.
+     * Obtained by clicking the ID icon next to the table name on the Tables tab of [Data Connection](https://bailian.console.aliyun.com/cn-beijing?tab=app#/connector/list) table connector. If the list contains multiple IDs, only the first one is used.
      *
      *
      *
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      */
     tableIds?: string[];
@@ -516,11 +516,11 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * Valid values (only one value can be passed at a time):
      *
-     * - **length**: Chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If these two parameters are not passed, the system uses default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (it does not take effect even if specified).
-     * - **page**: Chunk by page. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by page does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
-     * - **h1**: Chunk by first-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by first-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
-     * - **h2**: Chunk by second-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by second-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
-     * - **regex**: Chunk by regular expression. The `Separator` parameter must be specified. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by regular expression does not support `OverlapSize` (it does not take effect even if specified).
+     * - **length**: Chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If you do not pass in these two parameters, the system uses the default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (it does not take effect even if specified).
+     * - **page**: Chunk by page. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by page does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
+     * - **h1**: Chunk by first-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by first-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
+     * - **h2**: Chunk by second-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by second-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
+     * - **regex**: Chunk by regular expression. You must specify the `Separator` parameter. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by regular expression does not support `OverlapSize` (it does not take effect even if specified).
      *
      * If not specified, intelligent chunking is used by default.
      *
@@ -529,7 +529,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      *
      * @example
      * regex
@@ -544,7 +544,7 @@ export declare class CreateIndexRequest extends $dara.Model {
     datasourceCode?: string;
     /**
      * @remarks
-     * Specifies whether to treat the first row of all xlsx and xls files as headers and concatenate them into each text chunk, preventing the large language model from treating headers as regular data rows.
+     * Specifies whether to treat the first row of all xlsx and xls files as headers and append them to each text chunk, preventing the large language model from treating headers as regular data rows.
      *
      *
      * > Enable this feature only when all imported files are in .xlsx or .xls format and contain headers. Otherwise, do not enable it.
@@ -564,12 +564,12 @@ export declare class CreateIndexRequest extends $dara.Model {
     /**
      * @remarks
      * <props="china">
-     * The specific knowledge type, which further specifies the type of data processed by the knowledge base.
-     * <notice>This parameter and knowledgeScene must be provided together or omitted together. They cannot be set independently. If both are omitted, the system uses default configurations based on structureType.
+     * The specific knowledge type that further specifies the data type processed by the knowledge base.
+     * <notice>This parameter and knowledgeScene must be provided together or omitted together. They cannot be set individually. If both are omitted, the system uses the default configurations based on structureType.
      *
      * **Settings constraint**: The value of this parameter must match the selected structureType and determines the active values for knowledgeScene.
      *
-     * **Valid values**:
+     * **Valid values:**
      * - document: Document search. Must be used with structureType: unstructured.
      * - table: Data query. Must be used with structureType: structured.
      * - image: Image-based Q&A. Must be used with structureType: structured.
@@ -578,7 +578,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      *
      *
-     * <props="intl">This parameter is not available. Do not pass this parameter.
+     * <props="intl">This parameter is not available. Do not pass in a value.
      *
      * @example
      * document
@@ -586,17 +586,17 @@ export declare class CreateIndexRequest extends $dara.Model {
     knowledgeType?: string;
     /**
      * @remarks
-     * The metadata extraction configuration. Metadata is a set of additional attributes related to unstructured data content. These attributes are integrated into text chunks as key-value pairs. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
+     * The metadata extraction configuration. Metadata consists of additional attributes related to unstructured data content. These attributes are integrated into text chunks as key-value pairs. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
      */
     metaExtractColumns?: CreateIndexRequestMetaExtractColumns[];
     /**
      * @remarks
-     * <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Value range: [1-200].
+     * <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Valid values: [1-200].
      *
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -607,7 +607,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      * @remarks
      * <props="china">
      *
-     * The [specification type](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
+     * The [edition](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
      * - standard: Standard Edition.
      * - enterprise: Ultimate Edition.
      *
@@ -615,7 +615,7 @@ export declare class CreateIndexRequest extends $dara.Model {
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example
@@ -624,15 +624,15 @@ export declare class CreateIndexRequest extends $dara.Model {
     pipelineCommercialType?: string;
     /**
      * @remarks
-     * <props="china">The rate limiting strategy for knowledge base dependent links (required only when pipelineCommercialType is set to enterprise).
+     * <props="china">The rate limiting strategy for the knowledge base dependency chain (required only when pipelineCommercialType is set to enterprise).
      * Valid values:
-     * downgrade: Downgrade processing (switch to lightweight link retrieval).
+     * downgrade: Downgrade processing (switch to lightweight chain retrieval).
      * If not specified, the default value is downgrade.
      *
      *
      * <props="intl">
      *
-     * > This parameter is not available. Do not pass this parameter.
+     * > This parameter is not available. Do not pass in a value.
      * >
      *
      * @example

package/dist/models/CreateIndexResponseBody.d.ts

@@ -2,8 +2,8 @@ import * as $dara from '@darabonba/typescript';
 export declare class CreateIndexResponseBodyData extends $dara.Model {
     /**
      * @remarks
-     * The knowledge base ID, also known as `IndexId`. This is the unique identifier of the created knowledge base.
-     * > Store this value properly. It is required for all subsequent API operations related to this knowledge base.
+     * The knowledge base ID, also known as `IndexId`, which is the unique identifier of the created knowledge base.
+     * > Store this value properly. It is used in all subsequent API operations related to this knowledge base.
      * >
      *
      * @example
@@ -29,7 +29,7 @@ export declare class CreateIndexResponseBody extends $dara.Model {
     code?: string;
     /**
      * @remarks
-     * The business data returned when the request succeeds.
+     * The business data returned when the request is successful.
      */
     data?: CreateIndexResponseBodyData;
     /**