@alicloud/bailian20231229 2.4.1 → 2.6.0

package/dist/client.d.ts

@@ -106,6 +106,42 @@ export default class Client extends OpenApi {
      * @returns ApplyFileUploadLeaseResponse
      */
     applyFileUploadLease(CategoryId: string, WorkspaceId: string, request: $_model.ApplyFileUploadLeaseRequest): Promise<$_model.ApplyFileUploadLeaseResponse>;
+    /**
+     * 申请临时文件存储上传许可
+     *
+     * @param request - ApplyTempStorageLeaseRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ApplyTempStorageLeaseResponse
+     */
+    applyTempStorageLeaseWithOptions(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyTempStorageLeaseResponse>;
+    /**
+     * 申请临时文件存储上传许可
+     *
+     * @param request - ApplyTempStorageLeaseRequest
+     * @returns ApplyTempStorageLeaseResponse
+     */
+    applyTempStorageLease(WorkspaceId: string, request: $_model.ApplyTempStorageLeaseRequest): Promise<$_model.ApplyTempStorageLeaseResponse>;
+    /**
+     * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
+     *
+     * @param tmpReq - ChangeParseSettingRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ChangeParseSettingResponse
+     */
+    changeParseSettingWithOptions(WorkspaceId: string, tmpReq: $_model.ChangeParseSettingRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeParseSettingResponse>;
+    /**
+     * Configure the parsing method for a specific file type. For example, use LLM parsing for .pdf files, or use Qwen VL parsing for .jpg files.
+     *
+     * @param request - ChangeParseSettingRequest
+     * @returns ChangeParseSettingResponse
+     */
+    changeParseSetting(WorkspaceId: string, request: $_model.ChangeParseSettingRequest): Promise<$_model.ChangeParseSettingResponse>;
     /**
      * 创建并发布智能体应用
      *
@@ -125,12 +161,17 @@ export default class Client extends OpenApi {
      */
     createAndPulishAgent(workspaceId: string, request: $_model.CreateAndPulishAgentRequest): Promise<$_model.CreateAndPulishAgentResponse>;
     /**
-     * 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.
+     * Create a knowledge base of the document search type.
      *
      * @remarks
-     * 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).
-     * 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.
-     * 3.  This interface is not idempotent.
+     *   **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
+     * *   **Required permissions**
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
+     * *   **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param tmpReq - CreateIndexRequest
      * @param headers - map
@@ -141,12 +182,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateIndexResponse>;
     /**
-     * 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.
+     * Create a knowledge base of the document search type.
      *
      * @remarks
-     * 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).
-     * 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.
-     * 3.  This interface is not idempotent.
+     *   **Limits**: This operation can create only knowledge base of the document search type. Data query and image Q\\&A types are not supported. Use the console instead.
+     * *   **Required permissions**
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:CreateIndex permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **What to do next**: This operation only initializes knowledge base creation job. After that, call **SubmitIndexJob** to complete the creation. Otherwise, you will get an empty knowledge base. For more information about the sample code, see [Knowledge base API guide](https://help.aliyun.com/document_detail/2852772.html).
+     * *   **Idempotence**: This operation is not idempotent. If you call the operation for multiple times, you may create several knowledge bases with the same name. We recommend following a "query first, then create" logic.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param request - CreateIndexRequest
      * @returns CreateIndexResponse
@@ -237,7 +283,18 @@ export default class Client extends OpenApi {
      */
     deleteCategory(CategoryId: string, WorkspaceId: string): Promise<$_model.DeleteCategoryResponse>;
     /**
-     * 删除切片信息
+     * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
+     *
+     * @remarks
+     * *
+     * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
+     * *   **Required permissions**:
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
+     * *   **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param tmpReq - DeleteChunkRequest
      * @param headers - map
@@ -248,7 +305,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteChunkResponse>;
     /**
-     * 删除切片信息
+     * Deletes a specified text chunk from a knowledge base. The deleted chunk cannot be retrieved or recalled.
+     *
+     * @remarks
+     * *
+     * **Warning** After a text chunk is deleted, it cannot be restored. Proceed with caution.
+     * *   **Required permissions**:
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:DeleteChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
+     * *   **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been deleted, the interface returns a success.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param request - DeleteChunkRequest
      * @returns DeleteChunkResponse
@@ -441,6 +509,24 @@ export default class Client extends OpenApi {
      * @returns GetAlipayUrlResponse
      */
     getAlipayUrl(request: $_model.GetAlipayUrlRequest): Promise<$_model.GetAlipayUrlResponse>;
+    /**
+     * Lists all supported parser types based on the input file type (file extension).
+     *
+     * @param request - GetAvailableParserTypesRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAvailableParserTypesResponse
+     */
+    getAvailableParserTypesWithOptions(WorkspaceId: string, request: $_model.GetAvailableParserTypesRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.GetAvailableParserTypesResponse>;
+    /**
+     * Lists all supported parser types based on the input file type (file extension).
+     *
+     * @param request - GetAvailableParserTypesRequest
+     * @returns GetAvailableParserTypesResponse
+     */
+    getAvailableParserTypes(WorkspaceId: string, request: $_model.GetAvailableParserTypesRequest): Promise<$_model.GetAvailableParserTypesResponse>;
     /**
      * Queries the current status of a specified knowledge base creation or add document job.
      *
@@ -499,6 +585,24 @@ export default class Client extends OpenApi {
      * @returns GetMemoryNodeResponse
      */
     getMemoryNode(workspaceId: string, memoryId: string, memoryNodeId: string): Promise<$_model.GetMemoryNodeResponse>;
+    /**
+     * Queries the data parsing settings in a specified category.
+     *
+     * @param request - GetParseSettingsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetParseSettingsResponse
+     */
+    getParseSettingsWithOptions(WorkspaceId: string, request: $_model.GetParseSettingsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.GetParseSettingsResponse>;
+    /**
+     * Queries the data parsing settings in a specified category.
+     *
+     * @param request - GetParseSettingsRequest
+     * @returns GetParseSettingsResponse
+     */
+    getParseSettings(WorkspaceId: string, request: $_model.GetParseSettingsRequest): Promise<$_model.GetParseSettingsResponse>;
     /**
      * Obtains a prompt template based on the template ID.
      *
@@ -529,6 +633,24 @@ export default class Client extends OpenApi {
      * @returns GetPublishedAgentResponse
      */
     getPublishedAgent(workspaceId: string, appCode: string): Promise<$_model.GetPublishedAgentResponse>;
+    /**
+     * 高代码部署服务
+     *
+     * @param request - HighCodeDeployRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns HighCodeDeployResponse
+     */
+    highCodeDeployWithOptions(workspaceId: string, request: $_model.HighCodeDeployRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.HighCodeDeployResponse>;
+    /**
+     * 高代码部署服务
+     *
+     * @param request - HighCodeDeployRequest
+     * @returns HighCodeDeployResponse
+     */
+    highCodeDeploy(workspaceId: string, request: $_model.HighCodeDeployRequest): Promise<$_model.HighCodeDeployResponse>;
     /**
      * ListCategory
      *
@@ -574,7 +696,13 @@ export default class Client extends OpenApi {
      */
     listChunks(WorkspaceId: string, request: $_model.ListChunksRequest): Promise<$_model.ListChunksResponse>;
     /**
-     * 获取文档列表
+     * Queries the details of one or more documents in a specified category.
+     *
+     * @remarks
+     *   If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+     * *   During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
+     * *   This operation is idempotent.
+     * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
      *
      * @param request - ListFileRequest
      * @param headers - map
@@ -585,7 +713,13 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListFileResponse>;
     /**
-     * 获取文档列表
+     * Queries the details of one or more documents in a specified category.
+     *
+     * @remarks
+     *   If you are using a RAM user, you must first obtain the OpenAPI management permissions (namely sfm:ListFile) of Model Studio. For more information, see [Grant OpenAPI permissions to a RAM user](https://help.aliyun.com/document_detail/2848578.html). If you are using the Alibaba Cloud account, you do not need permissions. We recommend that you use [the latest version of the SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29) to call this operation.
+     * *   During a paged query, set `MaxResults` to specify the maximum number of entries to return. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you query subsequent pages, set the `NextToken` parameter to the `NextToken` obtained in the last returned result. You can also set the `MaxResults` parameter to limit the number of entries to be returned. If no `NextToken` is returned, the result is completely returned and no more requests are required.
+     * *   This operation is idempotent.
+     * **Throttling:** Throttling will be triggered if you call this operation frequently. Do not exceed 5 times per second. If throttling is triggered, try again later.
      *
      * @param request - ListFileRequest
      * @returns ListFileResponse
@@ -856,7 +990,17 @@ export default class Client extends OpenApi {
      */
     updateAndPublishAgentSelective(workspaceId: string, appCode: string, request: $_model.UpdateAndPublishAgentSelectiveRequest): Promise<$_model.UpdateAndPublishAgentSelectiveResponse>;
     /**
-     * 更新切片信息
+     * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
+     *
+     * @remarks
+     *   **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
+     * *   **Required permissions**:
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
+     * *   **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param request - UpdateChunkRequest
      * @param headers - map
@@ -867,7 +1011,17 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateChunkResponse>;
     /**
-     * 更新切片信息
+     * Modifies the content and title of a specified text chunk in the knowledge base, and sets whether the chunk participates in knowledge base retrieval.
+     *
+     * @remarks
+     *   **Limits**: This operation supports only knowledge base of the document search type. Data query and image Q\\&A types are not supported.
+     * *   **Required permissions**:
+     *     *   **RAM users**: Must first obtain the [API permissions](https://help.aliyun.com/document_detail/2848578.html) of Model Studio (such as the `AliyunBailianDataFullAccess` policy, which includes the sfm:UpdateChunk permission required), and [become member of a workspace](https://help.aliyun.com/document_detail/2851098.html).
+     *     *   **Alibaba Cloud account**: Has the permission by default, and can call the operation directly.
+     * *   **Call method**: We recommend using the latest version of the [GenAI Service Platform SDK](https://api.alibabacloud.com/api-tools/sdk/bailian?version=2023-12-29). The SDK encapsulates complex signature computational logic to simplify the call process.
+     * *   **Delay**: The update takes effect immediately. During peak hours, the update may take place in seconds.
+     * *   **Idempotence**: This operation is idempotent. If you perform a repeated operation on a chunk that has already been updated, the interface returns a success.
+     * **Rate limit:** Rate limiting will be triggered if you call this operation frequently. Do not exceed 10 times per second. If limiting is triggered, try again later.
      *
      * @param request - UpdateChunkRequest
      * @returns UpdateChunkResponse