@alicloud/adb20211201 5.2.0 → 5.4.0

package/src/client.ts

@@ -11059,7 +11059,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Adds a knowledge base document.
+   * Performs knowledge base recall.
    * 
    * @param request - GetKnowledgeRecallRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -11072,10 +11072,18 @@ export default class Client extends OpenApi {
       query["DBClusterId"] = request.DBClusterId;
     }
 
+    if (!$dara.isNull(request.path)) {
+      query["Path"] = request.path;
+    }
+
     if (!$dara.isNull(request.question)) {
       query["Question"] = request.question;
     }
 
+    if (!$dara.isNull(request.tags)) {
+      query["Tags"] = request.tags;
+    }
+
     if (!$dara.isNull(request.topk)) {
       query["Topk"] = request.topk;
     }
@@ -11102,7 +11110,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Adds a knowledge base document.
+   * Performs knowledge base recall.
    * 
    * @param request - GetKnowledgeRecallRequest
    * @returns GetKnowledgeRecallResponse
@@ -12890,6 +12898,68 @@ export default class Client extends OpenApi {
     return await this.listApsWebhookWithOptions(request, runtime);
   }
 
+  /**
+   * 查询知识库文件
+   * 
+   * @param request - ListKnowledgeFilesRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns ListKnowledgeFilesResponse
+   */
+  async listKnowledgeFilesWithOptions(request: $_model.ListKnowledgeFilesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListKnowledgeFilesResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.DBClusterId)) {
+      query["DBClusterId"] = request.DBClusterId;
+    }
+
+    if (!$dara.isNull(request.fileIds)) {
+      query["FileIds"] = request.fileIds;
+    }
+
+    if (!$dara.isNull(request.page)) {
+      query["Page"] = request.page;
+    }
+
+    if (!$dara.isNull(request.pageSize)) {
+      query["PageSize"] = request.pageSize;
+    }
+
+    if (!$dara.isNull(request.status)) {
+      query["Status"] = request.status;
+    }
+
+    if (!$dara.isNull(request.user)) {
+      query["User"] = request.user;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "ListKnowledgeFiles",
+      version: "2021-12-01",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.ListKnowledgeFilesResponse>(await this.callApi(params, req, runtime), new $_model.ListKnowledgeFilesResponse({}));
+  }
+
+  /**
+   * 查询知识库文件
+   * 
+   * @param request - ListKnowledgeFilesRequest
+   * @returns ListKnowledgeFilesResponse
+   */
+  async listKnowledgeFiles(request: $_model.ListKnowledgeFilesRequest): Promise<$_model.ListKnowledgeFilesResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.listKnowledgeFilesWithOptions(request, runtime);
+  }
+
   /**
    * Queries the tags of a knowledge base document.
    * 
@@ -15251,7 +15321,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Modifies an automatic materialized view recommendation task.
+   * Modifies a materialized view automatic recommendation task.
    * 
    * @param request - ModifyMaterializedViewRecommendRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -15338,7 +15408,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Modifies an automatic materialized view recommendation task.
+   * Modifies a materialized view automatic recommendation task.
    * 
    * @param request - ModifyMaterializedViewRecommendRequest
    * @returns ModifyMaterializedViewRecommendResponse
@@ -15938,6 +16008,56 @@ export default class Client extends OpenApi {
     return await this.removeKnowledgeTagsWithOptions(request, runtime);
   }
 
+  /**
+   * Deletes authorized users from a knowledge base document.
+   * 
+   * @param request - RemoveKnowledgeUploadUserRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns RemoveKnowledgeUploadUserResponse
+   */
+  async removeKnowledgeUploadUserWithOptions(request: $_model.RemoveKnowledgeUploadUserRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RemoveKnowledgeUploadUserResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.DBClusterId)) {
+      query["DBClusterId"] = request.DBClusterId;
+    }
+
+    if (!$dara.isNull(request.fileLocation)) {
+      query["FileLocation"] = request.fileLocation;
+    }
+
+    if (!$dara.isNull(request.users)) {
+      query["Users"] = request.users;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "RemoveKnowledgeUploadUser",
+      version: "2021-12-01",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.RemoveKnowledgeUploadUserResponse>(await this.callApi(params, req, runtime), new $_model.RemoveKnowledgeUploadUserResponse({}));
+  }
+
+  /**
+   * Deletes authorized users from a knowledge base document.
+   * 
+   * @param request - RemoveKnowledgeUploadUserRequest
+   * @returns RemoveKnowledgeUploadUserResponse
+   */
+  async removeKnowledgeUploadUser(request: $_model.RemoveKnowledgeUploadUserRequest): Promise<$_model.RemoveKnowledgeUploadUserResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.removeKnowledgeUploadUserWithOptions(request, runtime);
+  }
+
   /**
    * Modifies the name of a semantic view.
    * 

package/src/models/DescribeDbresourceGroupRequest.ts

@@ -17,7 +17,7 @@ export class DescribeDBResourceGroupRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the resource group.
-   * > If you do not specify this parameter, information about all resource groups in the specified cluster is returned.
+   * > If you do not specify this parameter, the information about all resource groups in the specified cluster is returned.
    * 
    * @example
    * test_group

package/src/models/DescribeDbresourceGroupResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoAtmConfig extends $dar
   authNodeNum?: string;
   /**
    * @remarks
-   * The authentication node specifications.
+   * The node specifications of authentication nodes.
    * 
    * @example
    * 8ACU
@@ -29,7 +29,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoAtmConfig extends $dar
   insertNodeNum?: string;
   /**
    * @remarks
-   * The write node specifications.
+   * The node specifications of write nodes.
    * 
    * @example
    * 8ACU
@@ -53,7 +53,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoAtmConfig extends $dar
   selectNodeNum?: string;
   /**
    * @remarks
-   * The query node specifications.
+   * The node specifications of query nodes.
    * 
    * @example
    * 8ACU
@@ -85,7 +85,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoAtmConfig extends $dar
   storageNodeNum?: string;
   /**
    * @remarks
-   * The storage node specifications.
+   * The node specifications of storage nodes.
    * 
    * @example
    * 8ACU
@@ -135,7 +135,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoAtmConfig extends $dar
 export class DescribeDBResourceGroupResponseBodyGroupsInfoGpuElasticPlanRules extends $dara.Model {
   /**
    * @remarks
-   * The end time in Cron expression format. The interval must be at least 1 hour.
+   * The end time in cron expression format. The interval must be at least 1 hour.
    * 
    * @example
    * 0 0 3 * * ?
@@ -143,7 +143,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoGpuElasticPlanRules ex
   endCronExpression?: string;
   /**
    * @remarks
-   * The start time in Cron expression format. The interval must be at least 1 hour.
+   * The start time in cron expression format. The interval must be at least 1 hour.
    * 
    * @example
    * 0 0 2 * * ?
@@ -369,7 +369,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoRayConfigWorkerGroups
   allocateUnit?: string;
   /**
    * @remarks
-   * The Ray worker group name.
+   * The name of the Ray worker group.
    * 
    * @example
    * g01
@@ -461,9 +461,9 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfoRayConfig extends $dar
    * @remarks
    * The Ray cluster type. Valid values:
    * 
-   * - BASIC: basic type, non-high-availability
+   * - BASIC: basic type, non-high-availability.
    * 
-   * - HIGH_AVAILABILITY: high-availability type
+   * - HIGH_AVAILABILITY: high-availability type.
    * 
    * @example
    * BASIC
@@ -719,7 +719,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfo extends $dara.Model {
   elasticMinComputeResource?: string;
   /**
    * @remarks
-   * Indicates whether the spot instance feature is enabled for the resource group. When the spot instance feature is enabled, the unit price of resources is reduced, but instances may be released. Valid values:
+   * Indicates whether the spot instance feature is enabled for the resource group. After the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. Valid values:
    * - **True**: The spot instance feature is enabled.
    * - **False**: The spot instance feature is disabled.
    * 
@@ -760,7 +760,7 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfo extends $dara.Model {
    * The resource group type. Valid values:
    * - **Interactive**
    * - **Job**
-   * > For more information about resource groups in Data Lakehouse Edition, see [Resource group introduction (Data Lakehouse Edition)](https://help.aliyun.com/document_detail/428610.html).
+   * > For more information about resource groups of the Data Lakehouse Edition, see [Resource group introduction (Data Lakehouse Edition)](https://help.aliyun.com/document_detail/428610.html).
    * 
    * @example
    * Job
@@ -873,12 +873,14 @@ export class DescribeDBResourceGroupResponseBodyGroupsInfo extends $dara.Model {
   /**
    * @remarks
    * The resource group status. Valid values:
-   * - **creating**: being created
-   * - **ok**: created
-   * - **pendingdelete**: pending deletion
+   * - **Pending**: being created.
+   * - **Running**: running.
+   * - **Scaling**: being scaled.
+   * - **Deleting**: being deleted.
+   * - **Deleted**: deleted.
    * 
    * @example
-   * ok
+   * Running
    */
   status?: string;
   /**

package/src/models/GetKnowledgeRecallRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetKnowledgeRecallRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL cluster.
+   * The ID of the ADB MySQL cluster.
    * 
    * This parameter is required.
    * 
@@ -13,6 +13,14 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
    * am-bp19aaaaaa****
    */
   DBClusterId?: string;
+  /**
+   * @remarks
+   * The file path prefix. Only files that match the specified path prefix are recalled.
+   * 
+   * @example
+   * oss://bucketName/path/prefix/
+   */
+  path?: string;
   /**
    * @remarks
    * The question for knowledge base recall.
@@ -25,7 +33,15 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   question?: string;
   /**
    * @remarks
-   * The top K number of related files to recall.
+   * The list of tags in JSON format.
+   * 
+   * @example
+   * {   "tag_key1": ["tag_key1_value1", "tag_key1_value2"],   "tag_key2": ["tag_key2_value"] }
+   */
+  tags?: string;
+  /**
+   * @remarks
+   * The top K associated files to recall.
    * 
    * @example
    * 5
@@ -33,7 +49,7 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   topk?: number;
   /**
    * @remarks
-   * The username. Only files that this user has permission to access are recalled.
+   * The username. Only files that the specified user has permission to access are recalled.
    * 
    * @example
    * user_name1
@@ -42,7 +58,9 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
+      path: 'Path',
       question: 'Question',
+      tags: 'Tags',
       topk: 'Topk',
       user: 'User',
     };
@@ -51,7 +69,9 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       DBClusterId: 'string',
+      path: 'string',
       question: 'string',
+      tags: 'string',
       topk: 'number',
       user: 'string',
     };

package/src/models/GetKnowledgeRecallResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetKnowledgeRecallResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 5

package/src/models/ListKnowledgeFilesRequest.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListKnowledgeFilesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp19aaaaaa****
+   */
+  DBClusterId?: string;
+  /**
+   * @example
+   * [1001,1002,1003]
+   */
+  fileIds?: string;
+  /**
+   * @example
+   * 1
+   */
+  page?: string;
+  /**
+   * @example
+   * 20
+   */
+  pageSize?: string;
+  /**
+   * @example
+   * FAILED
+   */
+  status?: string;
+  /**
+   * @example
+   * u123
+   */
+  user?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      fileIds: 'FileIds',
+      page: 'Page',
+      pageSize: 'PageSize',
+      status: 'Status',
+      user: 'User',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      fileIds: 'string',
+      page: 'string',
+      pageSize: 'string',
+      status: 'string',
+      user: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListKnowledgeFilesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListKnowledgeFilesResponseBody } from "./ListKnowledgeFilesResponseBody";
+
+
+export class ListKnowledgeFilesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ListKnowledgeFilesResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: ListKnowledgeFilesResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListKnowledgeFilesResponseBody.ts

@@ -0,0 +1,195 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListKnowledgeFilesResponseBodyDataFiles extends $dara.Model {
+  /**
+   * @example
+   * 2026-06-09 10:27:35
+   */
+  createdAt?: string;
+  /**
+   * @example
+   * 137
+   */
+  fileId?: number;
+  /**
+   * @example
+   * 1024
+   */
+  fileSizeBytes?: number;
+  /**
+   * @example
+   * oss://bucketName/path/to/file
+   */
+  fileUrl?: string;
+  /**
+   * @example
+   * mp4
+   */
+  format?: string;
+  /**
+   * @example
+   * false
+   */
+  isDirectory?: boolean;
+  /**
+   * @example
+   * 122
+   */
+  ownerFileId?: number;
+  /**
+   * @example
+   * 2
+   */
+  pageCount?: number;
+  /**
+   * @example
+   * successful
+   */
+  processMessage?: string;
+  /**
+   * @example
+   * Finished
+   */
+  processStatus?: string;
+  /**
+   * @example
+   * 2026-06-10 10:23:46
+   */
+  updatedAt?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createdAt: 'CreatedAt',
+      fileId: 'FileId',
+      fileSizeBytes: 'FileSizeBytes',
+      fileUrl: 'FileUrl',
+      format: 'Format',
+      isDirectory: 'IsDirectory',
+      ownerFileId: 'OwnerFileId',
+      pageCount: 'PageCount',
+      processMessage: 'ProcessMessage',
+      processStatus: 'ProcessStatus',
+      updatedAt: 'UpdatedAt',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createdAt: 'string',
+      fileId: 'number',
+      fileSizeBytes: 'number',
+      fileUrl: 'string',
+      format: 'string',
+      isDirectory: 'boolean',
+      ownerFileId: 'number',
+      pageCount: 'number',
+      processMessage: 'string',
+      processStatus: 'string',
+      updatedAt: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListKnowledgeFilesResponseBodyData extends $dara.Model {
+  files?: ListKnowledgeFilesResponseBodyDataFiles[];
+  /**
+   * @example
+   * Successful
+   */
+  message?: string;
+  /**
+   * @example
+   * 1
+   */
+  page?: number;
+  /**
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @example
+   * true
+   */
+  success?: boolean;
+  /**
+   * @example
+   * 100
+   */
+  total?: number;
+  static names(): { [key: string]: string } {
+    return {
+      files: 'Files',
+      message: 'Message',
+      page: 'Page',
+      pageSize: 'PageSize',
+      success: 'Success',
+      total: 'Total',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      files: { 'type': 'array', 'itemType': ListKnowledgeFilesResponseBodyDataFiles },
+      message: 'string',
+      page: 'number',
+      pageSize: 'number',
+      success: 'boolean',
+      total: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.files)) {
+      $dara.Model.validateArray(this.files);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListKnowledgeFilesResponseBody extends $dara.Model {
+  data?: ListKnowledgeFilesResponseBodyData;
+  /**
+   * @example
+   * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: ListKnowledgeFilesResponseBodyData,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+