@alicloud/bailian20231229 2.14.2 → 2.14.4

package/src/client.ts

@@ -12,10 +12,6 @@ export default class Client extends OpenApi {
   constructor(config: $OpenApiUtil.Config) {
     super(config);
     this._endpointRule = "regional";
-    this._endpointMap = {
-      'cn-beijing': "bailian.cn-beijing.aliyuncs.com",
-      'ap-southeast-1': "bailian.ap-southeast-1.aliyuncs.com",
-    };
     this.checkConfig(config);
     this._endpoint = this.getEndpoint("bailian", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
   }
@@ -256,10 +252,10 @@ export default class Client extends OpenApi {
    * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
    * 
    * @remarks
-   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
+   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
    * - This operation is not idempotent.
-   * **Throttling:**
-   * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
+   * **Rate limiting:**
+   * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
    * 
    * @param tmpReq - AddFileRequest
    * @param headers - map
@@ -329,10 +325,10 @@ export default class Client extends OpenApi {
    * Imports a file from the temporary storage of Alibaba Cloud Model Studio into an Alibaba Cloud Model Studio data connection (formerly known as application data).
    * 
    * @remarks
-   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
+   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:AddFile permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Call this operation by using the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
    * - This operation is not idempotent.
-   * **Throttling:**
-   * This operation is subject to throttling. Do not exceed 10 calls per second. If you are throttled, retry later.
+   * **Rate limiting:**
+   * This operation is rate-limited. Do not exceed 10 calls per second. If you are throttled, retry later.
    * 
    * @param request - AddFileRequest
    * @returns AddFileResponse
@@ -646,7 +642,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * This operation updates document tags in a data connection in batches.
+   * Batch updates document tags in a data connection.
    * 
    * @param tmpReq - BatchUpdateFileTagRequest
    * @param headers - map
@@ -689,7 +685,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * This operation updates document tags in a data connection in batches.
+   * Batch updates document tags in a data connection.
    * 
    * @param request - BatchUpdateFileTagRequest
    * @returns BatchUpdateFileTagResponse
@@ -847,17 +843,17 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a knowledge base, either an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
+   * Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
    * 
    * @remarks
    * - **Permission requirements**:
-   *   - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
+   *   - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
    *   - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
-   * - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK has encapsulated the complex signature calculation logic and simplifies the invocation procedure.
-   * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, refer to [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
-   * - **Idempotence**: This operation does not have idempotence. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent invocations by querying first and then creating.
-   * **Rate limit:**
-   * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are throttled, retry later.
+   * - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
+   * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
+   * - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
+   * **Rate limiting:**
+   * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
    * 
    * @param tmpReq - CreateIndexRequest
    * @param headers - map
@@ -1044,17 +1040,17 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a knowledge base, either an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
+   * Creates a knowledge base of either type: an unstructured knowledge base based on documents or audio/video, or a structured knowledge base for data queries or image-based Q&A.
    * 
    * @remarks
    * - **Permission requirements**:
-   *   - **Resource Access Management (RAM) user**: Obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio first (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation.
+   *   - **Resource Access Management (RAM) user**: Before invoking this operation, obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (you can use the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required by this operation), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html).
    *   - **Alibaba Cloud account**: Has permissions by default and can invoke this operation directly.
-   * - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK has encapsulated the complex signature calculation logic and simplifies the invocation procedure.
-   * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, refer to [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
-   * - **Idempotence**: This operation does not have idempotence. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent invocations by querying first and then creating.
-   * **Rate limit:**
-   * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are throttled, retry later.
+   * - **Calling method**: Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK provides encapsulation of complex signature calculation logic and simplifies the invocation procedure.
+   * - **What to do next**: This operation only performs initialization of the knowledge base creation job. After invoking this operation, you must invoke the **SubmitIndexJob** operation to complete the creation (otherwise, you will get an empty knowledge base). For code examples, see [Knowledge Base API Guide](https://help.aliyun.com/document_detail/2852772.html).
+   * - **Idempotence**: This operation is not idempotent. Repeated invocations may create multiple knowledge bases with the same name. Implement idempotent calls by using a "query first, then create" approach.
+   * **Rate limiting:**
+   * This operation is subject to rate limiting. Do not exceed 10 calls per second. If you are rate-limited, retry later.
    * 
    * @param request - CreateIndexRequest
    * @returns CreateIndexResponse
@@ -2847,12 +2843,12 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the files in a specified knowledge base along with their details.
+   * Retrieves files and their details from a specified knowledge base.
    * 
    * @remarks
-   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
-   * - Before calling this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
-   * - This operation is idempotent.
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation through the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
+   * - Before invoking this operation, make sure your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
+   * - This operation has idempotence.
    * 
    * @param request - ListIndexFileDetailsRequest
    * @param headers - map
@@ -2905,12 +2901,12 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the files in a specified knowledge base along with their details.
+   * Retrieves files and their details from a specified knowledge base.
    * 
    * @remarks
-   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
-   * - Before calling this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
-   * - This operation is idempotent.
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndexFiles permission), before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Invoke this operation through the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29).
+   * - Before invoking this operation, make sure your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
+   * - This operation has idempotence.
    * 
    * @param request - ListIndexFileDetailsRequest
    * @returns ListIndexFileDetailsResponse
@@ -2925,10 +2921,10 @@ export default class Client extends OpenApi {
    * Retrieves the list of knowledge bases in a specified workspace.
    * 
    * @remarks
-   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
    * - This operation is idempotent.
    * **Rate limit:**
-   * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
+   * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
    * 
    * @param request - ListIndicesRequest
    * @param headers - map
@@ -2972,10 +2968,10 @@ export default class Client extends OpenApi {
    * Retrieves the list of knowledge bases in a specified workspace.
    * 
    * @remarks
-   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * - RAM users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:ListIndex permission). Only then can they call this operation. Alibaba Cloud accounts (primary accounts) can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
    * - This operation is idempotent.
    * **Rate limit:**
-   * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If throttled, retry later.
+   * This operation is throttled if called too frequently. Do not exceed 10 calls per second. If you are throttled, retry later.
    * 
    * @param request - ListIndicesRequest
    * @returns ListIndicesResponse
@@ -3370,19 +3366,20 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Adds parsed files to the specified knowledge base.
+   * Appends parsed files to a specified knowledge base.
    * 
    * @remarks
    * <props="china">
-   * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
+   * - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
    * <props="intl">
-   * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
-   * - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API.
-   * - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
-   * - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
-   * - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
-   * - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
-   * **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
+   * - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:SubmitIndexAddDocumentsJob permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
+   * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
+   * - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
+   * - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node is complete. To query the node execution status, invoke the **GetIndexJobStatus** operation. The `Documents` file list returned by this operation contains all files in this append job (uniquely identified by the `job_id` you provide), and you can check whether each file was imported (parsed) successfully. Note that invoking GetIndexJobStatus too frequently will trigger rate limiting. Do not exceed a frequency of 20 times per minute.
+   * - After this operation is invoked successfully, it takes some time to execute. Do not submit duplicate requests before the response is returned. This operation does not have idempotence.
+   * **Rate limit:**
+   * Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
    * 
    * @param tmpReq - SubmitIndexAddDocumentsJobRequest
    * @param headers - map
@@ -3465,19 +3462,20 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Adds parsed files to the specified knowledge base.
+   * Appends parsed files to a specified knowledge base.
    * 
    * @remarks
    * <props="china">
-   * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
+   * - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
    * <props="intl">
-   * - This API does not support knowledge bases for data queries or image Q\\&A. To update these knowledge bases, see the [knowledge base](https://help.aliyun.com/document_detail/2807740.html) documentation.
-   * - A RAM user (sub-account) can call this API only after being granted the required [api permission](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (specifically, the `AliyunBailianDataFullAccess` policy, which includes the `sfm:SubmitIndexAddDocumentsJob` permission) and joining a [workspace](https://help.aliyun.com/document_detail/2851098.html). An Alibaba Cloud account can call this API directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this API.
-   * - Before calling this API, ensure your knowledge base exists and has a valid knowledge base ID (`IndexId`).
-   * - Before calling this API, you must first upload files to Alibaba Cloud Model Studio using the **AddFile** API.
-   * - After calling this API, the job runs in the background and may take several hours to complete, especially during peak times. Do not submit duplicate requests until the job is complete. To check the job status, call the **GetIndexJobStatus** API. The `Documents` file list returned by the GetIndexJobStatus API contains all files for the job, which is uniquely identified by the `job_id` you provided. You can check this list to verify whether each file was imported (parsed) successfully. Note that frequent calls to the GetIndexJobStatus API are subject to rate limiting. Do not exceed 20 calls per minute.
-   * - A successful API call indicates the job has been submitted for processing, which takes time. This API is not idempotent, so do not send duplicate requests; doing so will create multiple jobs.
-   * **Rate limiting:** This API is limited to 10 calls per second. If you exceed this limit, wait before retrying.
+   * - This operation does not support data query or image Q&A knowledge bases. For information about how to update data query or image Q&A knowledge bases, see the knowledge base update instructions in [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Model Studio (requiring `AliyunBailianDataFullAccess`, which includes the sfm:SubmitIndexAddDocumentsJob permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest <props="china">[Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to invoke this operation.
+   * - Before invoking this operation, make sure that your knowledge base has been created and has not been deleted (that is, the knowledge base ID `IndexId` is valid).
+   * - Before invoking this operation, invoke the **AddFile** operation to upload the files you want to append to Model Studio.
+   * - After invoking this operation, the node requires time to execute and may take several hours during peak periods. Do not submit duplicate requests before the node is complete. To query the node execution status, invoke the **GetIndexJobStatus** operation. The `Documents` file list returned by this operation contains all files in this append job (uniquely identified by the `job_id` you provide), and you can check whether each file was imported (parsed) successfully. Note that invoking GetIndexJobStatus too frequently will trigger rate limiting. Do not exceed a frequency of 20 times per minute.
+   * - After this operation is invoked successfully, it takes some time to execute. Do not submit duplicate requests before the response is returned. This operation does not have idempotence.
+   * **Rate limit:**
+   * Frequent calls to this operation will be throttled. Do not exceed 10 calls per second. If throttled, retry later.
    * 
    * @param request - SubmitIndexAddDocumentsJobRequest
    * @returns SubmitIndexAddDocumentsJobResponse
@@ -3840,11 +3838,12 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Updates the tags for a specified file.
+   * Updates the tags of a specified file.
    * 
    * @remarks
-   * - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
-   * **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * **Rate limiting:**
+   * This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
    * 
    * @param tmpReq - UpdateFileTagRequest
    * @param headers - map
@@ -3883,11 +3882,12 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Updates the tags for a specified file.
+   * Updates the tags of a specified file.
    * 
    * @remarks
-   * - A RAM User (sub-account) must be granted the required [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (the `AliyunBailianDataFullAccess` policy, which includes the `sfm:UpdateFileTag` permission) and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. An Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend using the latest version of the <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
-   * **Throttling:** Do not call this operation more than 5 times per second. If a request is throttled, try again later.
+   * - Resource Access Management (RAM) users must first obtain [API permissions](https://help.aliyun.com/document_detail/2848578.html) for Alibaba Cloud Model Studio (requires `AliyunBailianDataFullAccess`, which includes the sfm:UpdateFileTag permission), and [join a workspace](https://help.aliyun.com/document_detail/2851098.html) before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest <props="china">[Alibaba Cloud Model Studio SDK](https://api.aliyun.com/api-tools/sdk/bailian?version=2023-12-29)<props="intl">[Alibaba Cloud Model Studio SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+   * **Rate limiting:**
+   * This operation is rate-limited. Do not exceed 5 calls per second. If you are throttled, retry later.
    * 
    * @param request - UpdateFileTagRequest
    * @returns UpdateFileTagResponse

package/src/models/AddFileRequest.ts

@@ -16,10 +16,10 @@ export class AddFileRequestParserConfig extends $dara.Model {
    * The prompt used when calling Qwen VL parsing.
    * 
    * @example
-   * #角色
-   * 你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。
-   * # 任务目标
-   * 请结合输入图片，详细描述图片中的内容。
+   * # Role
+   * You are a professional image content annotator who excels at identifying and describing the content in images.
+   * # Task objective
+   * Based on the input image, describe the content in the image in detail
    */
   modelPrompt?: string;
   static names(): { [key: string]: string } {
@@ -50,14 +50,14 @@ export class AddFileRequest extends $dara.Model {
    * @remarks
    * <props="china">
    * 
-   * - When CategoryType is set to UNSTRUCTURED, set this parameter to the category ID of the uploaded file, which is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center), click the File tab, and then click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
+   * - When CategoryType is set to UNSTRUCTURED, specify the category ID to which the uploaded file belongs. This is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center) > Files tab and click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
    * 
    * - When CategoryType is set to SESSION_FILE, set this parameter to "default".
    * 
    * 
    * <props="intl">
    * 
-   * Set this parameter to the category ID of the uploaded file, which is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center), click the File tab, and then click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
+   * Specify the category ID to which the uploaded file belongs. This is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) > Files tab and click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
    * 
    * This parameter is required.
    * 
@@ -68,12 +68,12 @@ export class AddFileRequest extends $dara.Model {
   /**
    * @remarks
    * The category type. This parameter is optional. Default value: UNSTRUCTURED. Valid values:
-   * - UNSTRUCTURED: category used for building knowledge base scenarios.
+   * - UNSTRUCTURED: Category. Used for knowledge base scenarios.
    * 
    * <props="china">
-   * - SESSION_FILE: file used for [session interaction](https://www.alibabacloud.com/help/en/model-studio/user-guide/file-interaction) in agent applications.
+   * - SESSION_FILE: A file used for [conversation interaction](https://www.alibabacloud.com/help/en/model-studio/user-guide/file-interaction) in agent applications.
    * <note>When using `SESSION_FILE`, set the CategoryType parameter to `SESSION_FILE` when calling the ApplyFileUploadLease operation as well.</note>
-   * <note>The file is valid only for the current user session. After the user closes the session, the file expires. The maximum validity period is 7 days. Long-term storage is not supported.</note>
+   * <note>The file is valid only for the current user session. After the user closes the session, the file expires (maximum validity period is 7 days) and cannot be retained for long-term storage.</note>
    * 
    * @example
    * UNSTRUCTURED
@@ -93,17 +93,17 @@ export class AddFileRequest extends $dara.Model {
    * @remarks
    * <props="china">
    * 
-   * Specifies a URL for the file. The system records this URL when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to interact with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this URL is returned with the retrieval results of the file through the `docUrl` field.
+   * Adds a URL to the file. The system records this link when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to chat with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this link is returned with the file retrieval results through the `docUrl` field.
    * 
-   * > The agent application must have **Knowledge Base** enabled and the **Show answer sources** feature turned on. Otherwise, this parameter does not take effect.
+   * > The agent application must have **Knowledge Base** enabled and the **Display answer sources** feature turned on. Otherwise, this parameter does not take effect.
    * 
    * 
    * 
    * <props="intl">
    * 
-   * Specifies a URL for the file. The system records this URL when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to interact with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this URL is returned with the retrieval results of the file through the `docUrl` field.
+   * Adds a URL to the file. The system records this link when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to chat with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this link is returned with the file retrieval results through the `docUrl` field.
    * 
-   * > The agent application must have **Knowledge Base** enabled and the **Show answer sources** feature turned on. Otherwise, this parameter does not take effect.
+   * > The agent application must have **Knowledge Base** enabled and the **Display answer sources** feature turned on. Otherwise, this parameter does not take effect.
    * 
    * @example
    * www.test.com/111.docx
@@ -113,15 +113,15 @@ export class AddFileRequest extends $dara.Model {
    * @remarks
    * The parser type. Valid values:
    * 
-   * - DOCMIND: intelligent document parsing
-   * - DOCMIND_DIGITAL: electronic document parsing
-   * - DOCMIND_LLM_VERSION: large language model document parsing
-   * - DASH_QWEN_VL_PARSER: Qwen VL parsing
-   * - DOCMIND_LLM_VERSION_MEDIA: audio and video parsing
-   * - AUTO_SELECT: automatic parser selection
+   * - DOCMIND: Intelligent document parsing.
+   * - DOCMIND_DIGITAL: Electronic document parsing.
+   * - DOCMIND_LLM_VERSION: Large language model (LLM) document parsing.
+   * - DASH_QWEN_VL_PARSER: Qwen VL parsing.
+   * - DOCMIND_LLM_VERSION_MEDIA: Audio and video parsing.
+   * - AUTO_SELECT: Automatic parser selection.
    * 
    * <props="intl">
-   * <note>The uploaded file is parsed by using the currently specified parser. If you set this parameter to AUTO_SELECT, the parser configured for the category is used.</note>
+   * <note>The file you upload is parsed by using the currently specified parser. If you set this parameter to AUTO_SELECT, the parser configured for the category is used.</note>
    * 
    * 
    * <props="china">

package/src/models/AddFileResponseBody.ts

@@ -46,7 +46,7 @@ export class AddFileResponseBodyData extends $dara.Model {
 export class AddFileResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code.
+   * The error status code.
    * 
    * @example
    * DataCenter.FileTooLarge
@@ -54,7 +54,7 @@ export class AddFileResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The data field returned by the operation.
+   * The business data field of the operation.
    */
   data?: AddFileResponseBodyData;
   /**
@@ -83,9 +83,9 @@ export class AddFileResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful. Valid values:
-   * - true: The call was successful.
-   * - false: The call failed.
+   * Indicates whether the operation was successful. Valid values:
+   * - true: Successful.
+   * - false: Failed.
    * 
    * @example
    * true

package/src/models/AddFileShrinkRequest.ts

@@ -7,14 +7,14 @@ export class AddFileShrinkRequest extends $dara.Model {
    * @remarks
    * <props="china">
    * 
-   * - When CategoryType is set to UNSTRUCTURED, set this parameter to the category ID of the uploaded file, which is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center), click the File tab, and then click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
+   * - When CategoryType is set to UNSTRUCTURED, specify the category ID to which the uploaded file belongs. This is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center) > Files tab and click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
    * 
    * - When CategoryType is set to SESSION_FILE, set this parameter to "default".
    * 
    * 
    * <props="intl">
    * 
-   * Set this parameter to the category ID of the uploaded file, which is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center), click the File tab, and then click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
+   * Specify the category ID to which the uploaded file belongs. This is the `CategoryId` returned by the **AddCategory** operation. You can also go to [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) > Files tab and click the ID icon next to the category name to obtain the category ID. You can set this parameter to default to use the system-created default category.
    * 
    * This parameter is required.
    * 
@@ -25,12 +25,12 @@ export class AddFileShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The category type. This parameter is optional. Default value: UNSTRUCTURED. Valid values:
-   * - UNSTRUCTURED: category used for building knowledge base scenarios.
+   * - UNSTRUCTURED: Category. Used for knowledge base scenarios.
    * 
    * <props="china">
-   * - SESSION_FILE: file used for [session interaction](https://www.alibabacloud.com/help/en/model-studio/user-guide/file-interaction) in agent applications.
+   * - SESSION_FILE: A file used for [conversation interaction](https://www.alibabacloud.com/help/en/model-studio/user-guide/file-interaction) in agent applications.
    * <note>When using `SESSION_FILE`, set the CategoryType parameter to `SESSION_FILE` when calling the ApplyFileUploadLease operation as well.</note>
-   * <note>The file is valid only for the current user session. After the user closes the session, the file expires. The maximum validity period is 7 days. Long-term storage is not supported.</note>
+   * <note>The file is valid only for the current user session. After the user closes the session, the file expires (maximum validity period is 7 days) and cannot be retained for long-term storage.</note>
    * 
    * @example
    * UNSTRUCTURED
@@ -50,17 +50,17 @@ export class AddFileShrinkRequest extends $dara.Model {
    * @remarks
    * <props="china">
    * 
-   * Specifies a URL for the file. The system records this URL when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to interact with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this URL is returned with the retrieval results of the file through the `docUrl` field.
+   * Adds a URL to the file. The system records this link when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to chat with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this link is returned with the file retrieval results through the `docUrl` field.
    * 
-   * > The agent application must have **Knowledge Base** enabled and the **Show answer sources** feature turned on. Otherwise, this parameter does not take effect.
+   * > The agent application must have **Knowledge Base** enabled and the **Display answer sources** feature turned on. Otherwise, this parameter does not take effect.
    * 
    * 
    * 
    * <props="intl">
    * 
-   * Specifies a URL for the file. The system records this URL when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to interact with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this URL is returned with the retrieval results of the file through the `docUrl` field.
+   * Adds a URL to the file. The system records this link when building a [document search knowledge base](https://help.aliyun.com/document_detail/2807740.html). When you use the Alibaba Cloud Model Studio console to chat with an [agent application](https://help.aliyun.com/document_detail/2842749.html), this link is returned with the file retrieval results through the `docUrl` field.
    * 
-   * > The agent application must have **Knowledge Base** enabled and the **Show answer sources** feature turned on. Otherwise, this parameter does not take effect.
+   * > The agent application must have **Knowledge Base** enabled and the **Display answer sources** feature turned on. Otherwise, this parameter does not take effect.
    * 
    * @example
    * www.test.com/111.docx
@@ -70,15 +70,15 @@ export class AddFileShrinkRequest extends $dara.Model {
    * @remarks
    * The parser type. Valid values:
    * 
-   * - DOCMIND: intelligent document parsing
-   * - DOCMIND_DIGITAL: electronic document parsing
-   * - DOCMIND_LLM_VERSION: large language model document parsing
-   * - DASH_QWEN_VL_PARSER: Qwen VL parsing
-   * - DOCMIND_LLM_VERSION_MEDIA: audio and video parsing
-   * - AUTO_SELECT: automatic parser selection
+   * - DOCMIND: Intelligent document parsing.
+   * - DOCMIND_DIGITAL: Electronic document parsing.
+   * - DOCMIND_LLM_VERSION: Large language model (LLM) document parsing.
+   * - DASH_QWEN_VL_PARSER: Qwen VL parsing.
+   * - DOCMIND_LLM_VERSION_MEDIA: Audio and video parsing.
+   * - AUTO_SELECT: Automatic parser selection.
    * 
    * <props="intl">
-   * <note>The uploaded file is parsed by using the currently specified parser. If you set this parameter to AUTO_SELECT, the parser configured for the category is used.</note>
+   * <note>The file you upload is parsed by using the currently specified parser. If you set this parameter to AUTO_SELECT, the parser configured for the category is used.</note>
    * 
    * 
    * <props="china">

package/src/models/BatchUpdateFileTagRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BatchUpdateFileTagRequestFileInfos extends $dara.Model {
   /**
    * @remarks
-   * The file ID. To get this ID, go to the <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) page and click the ID icon next to the file name.
+   * The file ID in the data center. On the <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) page, click the ID icon next to the file name to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class BatchUpdateFileTagRequestFileInfos extends $dara.Model {
   fileId?: string;
   /**
    * @remarks
-   * - A list of up to 100 tags to associate with the file. The total length of all tags cannot exceed 700 characters.
+   * - The list of tags associated with the file. You can specify up to 100 tags, and the total character length of all tags cannot exceed 700.
    * 
    * This parameter is required.
    */
@@ -49,14 +49,16 @@ export class BatchUpdateFileTagRequestFileInfos extends $dara.Model {
 export class BatchUpdateFileTagRequest extends $dara.Model {
   /**
    * @remarks
-   * A list of files to update.
+   * The list of documents to update.
    * 
    * This parameter is required.
    */
   fileInfos?: BatchUpdateFileTagRequestFileInfos[];
   /**
    * @remarks
-   * The update mode. Valid values are APPEND and OVERWRITE.
+   * The update mode. Valid values:
+   * - APPEND: appends tags to existing tags.
+   * - OVERWRITE: overwrites existing tags.
    * 
    * @example
    * OVERWRITE