@alicloud/adb20211201 5.5.1 → 5.6.0

package/src/client.ts

@@ -11114,6 +11114,64 @@ export default class Client extends OpenApi {
     return await this.existRunningSQLEngineWithOptions(request, runtime);
   }
 
+  /**
+   * Creates a reference record for a knowledge base file.
+   * 
+   * @param request - ForkKnowledgeFileRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns ForkKnowledgeFileResponse
+   */
+  async forkKnowledgeFileWithOptions(request: $_model.ForkKnowledgeFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ForkKnowledgeFileResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.DBClusterId)) {
+      query["DBClusterId"] = request.DBClusterId;
+    }
+
+    if (!$dara.isNull(request.fileId)) {
+      query["FileId"] = request.fileId;
+    }
+
+    if (!$dara.isNull(request.fileLocation)) {
+      query["FileLocation"] = request.fileLocation;
+    }
+
+    if (!$dara.isNull(request.tags)) {
+      query["Tags"] = request.tags;
+    }
+
+    if (!$dara.isNull(request.uploadUser)) {
+      query["UploadUser"] = request.uploadUser;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "ForkKnowledgeFile",
+      version: "2021-12-01",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.ForkKnowledgeFileResponse>(await this.callApi(params, req, runtime), new $_model.ForkKnowledgeFileResponse({}));
+  }
+
+  /**
+   * Creates a reference record for a knowledge base file.
+   * 
+   * @param request - ForkKnowledgeFileRequest
+   * @returns ForkKnowledgeFileResponse
+   */
+  async forkKnowledgeFile(request: $_model.ForkKnowledgeFileRequest): Promise<$_model.ForkKnowledgeFileResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.forkKnowledgeFileWithOptions(request, runtime);
+  }
+
   /**
    * Generates an executable SQL statement from a semantic SQL statement.
    * 
@@ -13278,6 +13336,10 @@ export default class Client extends OpenApi {
       query["FileIds"] = request.fileIds;
     }
 
+    if (!$dara.isNull(request.fileLocation)) {
+      query["FileLocation"] = request.fileLocation;
+    }
+
     if (!$dara.isNull(request.page)) {
       query["Page"] = request.page;
     }
@@ -17391,6 +17453,56 @@ export default class Client extends OpenApi {
     return await this.suspendApsJobWithOptions(request, runtime);
   }
 
+  /**
+   * Submits a reparse task for a knowledge base file.
+   * 
+   * @param request - TriggerKnowledgeFileParseRequest
+   * @param runtime - runtime options for this request RuntimeOptions
+   * @returns TriggerKnowledgeFileParseResponse
+   */
+  async triggerKnowledgeFileParseWithOptions(request: $_model.TriggerKnowledgeFileParseRequest, runtime: $dara.RuntimeOptions): Promise<$_model.TriggerKnowledgeFileParseResponse> {
+    request.validate();
+    let query = { };
+    if (!$dara.isNull(request.DBClusterId)) {
+      query["DBClusterId"] = request.DBClusterId;
+    }
+
+    if (!$dara.isNull(request.fileId)) {
+      query["FileId"] = request.fileId;
+    }
+
+    if (!$dara.isNull(request.fileLocation)) {
+      query["FileLocation"] = request.fileLocation;
+    }
+
+    let req = new $OpenApiUtil.OpenApiRequest({
+      query: OpenApiUtil.query(query),
+    });
+    let params = new $OpenApiUtil.Params({
+      action: "TriggerKnowledgeFileParse",
+      version: "2021-12-01",
+      protocol: "HTTPS",
+      pathname: "/",
+      method: "POST",
+      authType: "AK",
+      style: "RPC",
+      reqBodyType: "formData",
+      bodyType: "json",
+    });
+    return $dara.cast<$_model.TriggerKnowledgeFileParseResponse>(await this.callApi(params, req, runtime), new $_model.TriggerKnowledgeFileParseResponse({}));
+  }
+
+  /**
+   * Submits a reparse task for a knowledge base file.
+   * 
+   * @param request - TriggerKnowledgeFileParseRequest
+   * @returns TriggerKnowledgeFileParseResponse
+   */
+  async triggerKnowledgeFileParse(request: $_model.TriggerKnowledgeFileParseRequest): Promise<$_model.TriggerKnowledgeFileParseResponse> {
+    let runtime = new $dara.RuntimeOptions({ });
+    return await this.triggerKnowledgeFileParseWithOptions(request, runtime);
+  }
+
   /**
    * Disassociates a standard account of an AnalyticDB for MySQL cluster from a Resource Access Management (RAM) user.
    * 

package/src/models/AddKnowledgeTagsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AddKnowledgeTagsRequest extends $dara.Model {
   /**
    * @remarks
-   * The database cluster ID.
+   * The ID of the database cluster.
    * 
    * This parameter is required.
    * 
@@ -14,6 +14,9 @@ export class AddKnowledgeTagsRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The ID of the file.
+   * 
    * @example
    * 21321
    */

package/src/models/AddKnowledgeTagsResponseBody.ts

@@ -71,7 +71,7 @@ export class AddKnowledgeTagsResponseBodyData extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The number of tags that were successfully updated.
+   * The number of tags that were successfully modified.
    * 
    * @example
    * 1
@@ -84,7 +84,7 @@ export class AddKnowledgeTagsResponseBodyData extends $dara.Model {
   skipped?: AddKnowledgeTagsResponseBodyDataSkipped[];
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Specifies whether the request was successful. Valid values:
    * - **true**: The request was successful.
    * - **false**: The request failed.
    * 

package/src/models/ForkKnowledgeFileRequest.ts

@@ -0,0 +1,76 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ForkKnowledgeFileRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ADB instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp19aaaaaa****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The ID of the knowledge base file. You must specify either this parameter or FileLocation, but not both. Use a decimal positive integer string without leading zeros. Valid values: 1 to 9223372036854775807.
+   * 
+   * @example
+   * 123
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The address of a single file in the knowledge base. You must specify either this parameter or FileId, but not both. You cannot specify a directory. The address must uniquely locate an active file.
+   * 
+   * @example
+   * oss://bucket/doc.pdf
+   */
+  fileLocation?: string;
+  /**
+   * @remarks
+   * The initial business tags for the new record. Use a JSON string of a JSON object or an array of tag_key/tag_value objects. If omitted, the source tags are not inherited.
+   * 
+   * @example
+   * {"biz.game":"yys"}
+   */
+  tags?: string;
+  /**
+   * @remarks
+   * The initial authorized user for the new record. You can pass a JSON string of a single user identifier or a user array. If omitted, no initial user authorization is applied, and the source authorization is not inherited.
+   * 
+   * @example
+   * ["alice","bob"]
+   */
+  uploadUser?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      fileId: 'FileId',
+      fileLocation: 'FileLocation',
+      tags: 'Tags',
+      uploadUser: 'UploadUser',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      fileId: 'string',
+      fileLocation: 'string',
+      tags: 'string',
+      uploadUser: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ForkKnowledgeFileResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ForkKnowledgeFileResponseBody } from "./ForkKnowledgeFileResponseBody";
+
+
+export class ForkKnowledgeFileResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ForkKnowledgeFileResponseBody;
+  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: ForkKnowledgeFileResponseBody,
+    };
+  }
+
+  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/ForkKnowledgeFileResponseBody.ts

@@ -0,0 +1,134 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ForkKnowledgeFileResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the newly created reference record, represented as a decimal string. Use this ID for subsequent management of the record. This parameter is returned only when the operation is successful.
+   * 
+   * @example
+   * 456
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The address of the new reference record, in the format of fork://<source file ID>/<new file ID>. This parameter is returned only when the operation is successful.
+   * 
+   * @example
+   * fork://123/456
+   */
+  fileLocation?: string;
+  /**
+   * @remarks
+   * The description of the operation result. If the business operation fails, this parameter indicates the cause or the security error code.
+   * 
+   * @example
+   * Fork succeeded
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The ID of the content host file, represented as a decimal string. Currently, this value is the same as the source file ID. This parameter is returned only when the operation is successful.
+   * 
+   * @example
+   * 123
+   */
+  ownerFileId?: string;
+  /**
+   * @remarks
+   * The status of the new reference record. The value is fixed to DUPLICATED. This parameter is returned only when the operation is successful.
+   * 
+   * @example
+   * DUPLICATED
+   */
+  processStatus?: string;
+  /**
+   * @remarks
+   * The ID of the source file, represented as a decimal string. This parameter is returned only when the operation is successful.
+   * 
+   * @example
+   * 123
+   */
+  sourceFileId?: string;
+  /**
+   * @remarks
+   * Indicates whether the business operation is successful. If the operation fails, the Data parameter contains only Success and Message.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      fileLocation: 'FileLocation',
+      message: 'Message',
+      ownerFileId: 'OwnerFileId',
+      processStatus: 'ProcessStatus',
+      sourceFileId: 'SourceFileId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      fileLocation: 'string',
+      message: 'string',
+      ownerFileId: 'string',
+      processStatus: 'string',
+      sourceFileId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ForkKnowledgeFileResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
+  data?: ForkKnowledgeFileResponseBodyData;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @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: ForkKnowledgeFileResponseBodyData,
+      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);
+  }
+}
+

package/src/models/ListKnowledgeFilesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListKnowledgeFilesRequest extends $dara.Model {
   /**
    * @remarks
-   * The ADB instance ID.
+   * The ID of the ADB instance.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,15 @@ export class ListKnowledgeFilesRequest extends $dara.Model {
   fileIds?: string;
   /**
    * @remarks
-   * The page number, starting from 1. If this parameter is not specified, the default value is 1.
+   * The URL of the knowledge base file.
+   * 
+   * @example
+   * oss://bucket_name/path/to/file
+   */
+  fileLocation?: string;
+  /**
+   * @remarks
+   * The page number. Pages start from 1. If you do not specify this parameter, the default value is 1.
    * 
    * @example
    * 1
@@ -31,7 +39,7 @@ export class ListKnowledgeFilesRequest extends $dara.Model {
   page?: string;
   /**
    * @remarks
-   * The number of entries per page. Valid values: 1 to 100. If this parameter is not specified, the default value is 20.
+   * The number of entries per page. Valid values: 1 to 100. If you do not specify this parameter, the default value is 20.
    * 
    * @example
    * 20
@@ -47,7 +55,7 @@ export class ListKnowledgeFilesRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The stable ID of the authorized user. If this parameter is not specified, all files in the knowledge base can be queried.
+   * The stable ID of the authorized user. If you do not specify this parameter, all files in the knowledge base can be queried.
    * 
    * @example
    * u123
@@ -57,6 +65,7 @@ export class ListKnowledgeFilesRequest extends $dara.Model {
     return {
       DBClusterId: 'DBClusterId',
       fileIds: 'FileIds',
+      fileLocation: 'FileLocation',
       page: 'Page',
       pageSize: 'PageSize',
       status: 'Status',
@@ -68,6 +77,7 @@ export class ListKnowledgeFilesRequest extends $dara.Model {
     return {
       DBClusterId: 'string',
       fileIds: 'string',
+      fileLocation: 'string',
       page: 'string',
       pageSize: 'string',
       status: 'string',

package/src/models/ListKnowledgeFilesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListKnowledgeFilesResponseBodyDataFiles extends $dara.Model {
   /**
    * @remarks
-   * The time when the file was added to the knowledge base. The format is yyyy-MM-dd HH:mm:ss.
+   * The time when the file was added to the knowledge base. The time is in the yyyy-MM-dd HH:mm:ss format.
    * 
    * @example
    * 2026-06-09 10:27:35
@@ -53,7 +53,7 @@ export class ListKnowledgeFilesResponseBodyDataFiles extends $dara.Model {
   isDirectory?: boolean;
   /**
    * @remarks
-   * The file_id of the content host.
+   * The `file_id` of the content host.
    * 
    * @example
    * 122
@@ -69,7 +69,7 @@ export class ListKnowledgeFilesResponseBodyDataFiles extends $dara.Model {
   pageCount?: number;
   /**
    * @remarks
-   * The processing information of the knowledge base file.
+   * The processing message of the knowledge base file.
    * 
    * @example
    * successful
@@ -89,7 +89,7 @@ export class ListKnowledgeFilesResponseBodyDataFiles extends $dara.Model {
   processStatus?: string;
   /**
    * @remarks
-   * The update time. The format is yyyy-MM-dd HH:mm:ss.
+   * The time when the file was updated. The time is in the yyyy-MM-dd HH:mm:ss format.
    * 
    * @example
    * 2026-06-10 10:23:46
@@ -168,9 +168,9 @@ export class ListKnowledgeFilesResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
    * 
    * @example
    * true
@@ -178,7 +178,7 @@ export class ListKnowledgeFilesResponseBodyData extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 100

package/src/models/TriggerKnowledgeFileParseRequest.ts

@@ -0,0 +1,56 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class TriggerKnowledgeFileParseRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ADB instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp19aaaaaa****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The ID of the knowledge base file. You must specify either this parameter or FileLocation, but not both.
+   * 
+   * @example
+   * 123
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The URL of a single knowledge base file. You must specify either this parameter or FileId, but not both. You cannot specify a directory. The URL must uniquely point to an existing file.
+   * 
+   * @example
+   * oss://bucket/doc.pdf
+   */
+  fileLocation?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      fileId: 'FileId',
+      fileLocation: 'FileLocation',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      fileId: 'string',
+      fileLocation: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/TriggerKnowledgeFileParseResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { TriggerKnowledgeFileParseResponseBody } from "./TriggerKnowledgeFileParseResponseBody";
+
+
+export class TriggerKnowledgeFileParseResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: TriggerKnowledgeFileParseResponseBody;
+  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: TriggerKnowledgeFileParseResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+