@alicloud/adb20211201 5.5.0 → 5.6.0

package/src/models/ExecuteSparkReplStatementResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account that owns the cluster.
+   * The Alibaba Cloud account to which the cluster belongs.
    * 
    * @example
    * 17108278707****
@@ -13,7 +13,7 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   aliyunUid?: number;
   /**
    * @remarks
-   * The code that is executed.
+   * The executed code.
    * 
    * @example
    * print(1+1)
@@ -21,12 +21,11 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The code execution status. Valid values:
-   * 
-   * *   CANCELLED
-   * *   RUNNING
-   * *   SUCCEEDED
-   * *   ERROR
+   * The execution status of the code. Valid values:
+   * - CANCELLED: The execution is canceled.
+   * - RUNNING: The execution is in progress.
+   * - SUCCEEDED: The execution is successful.
+   * - ERROR: The execution failed.
    * 
    * @example
    * RUNNING
@@ -34,10 +33,9 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   codeState?: string;
   /**
    * @remarks
-   * The code type. Valid values:
-   * 
-   * *   SCALA
-   * *   PYTHON
+   * The type of the code. Valid values:
+   * - SCALA
+   * - PYTHON
    * 
    * @example
    * PYTHON
@@ -45,12 +43,12 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   codeType?: string;
   /**
    * @remarks
-   * The column names.
+   * The array of column names.
    */
   columns?: string[];
   /**
    * @remarks
-   * The end time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * The end time. The time is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1730968125000
@@ -66,7 +64,7 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   error?: string;
   /**
    * @remarks
-   * The code execution result, which is a JSON string that conforms to Apache Livy.
+   * The code execution result. It is a JSON-formatted string that follows the Apache Livy output standard.
    * 
    * @example
    * {"text/plain": 2}
@@ -74,10 +72,9 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   output?: string;
   /**
    * @remarks
-   * The execution result type, which is in the JSON format. Valid values:
-   * 
-   * *   TEXT: the text content that conforms to Apache Livy.
-   * *   TABLE: the table content that conforms to Apache Livy.
+   * The serialization format of the execution result. The structure is a JSON object. Valid values:
+   * - TEXT: The output is text content that follows the Apache Livy standard.
+   * - TABLE: The output is table content that follows the Apache Livy standard.
    * 
    * @example
    * TEXT
@@ -85,7 +82,7 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
   outputType?: string;
   /**
    * @remarks
-   * The start time of the execution. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * The start time. The time is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1730968125000
@@ -146,7 +143,7 @@ export class ExecuteSparkReplStatementResponseBodyData extends $dara.Model {
 export class ExecuteSparkReplStatementResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned data.
+   * The response data.
    */
   data?: ExecuteSparkReplStatementResponseBodyData;
   /**

package/src/models/ExecuteSparkWarehouseBatchSqlrequest.ts

@@ -8,7 +8,7 @@ export class ExecuteSparkWarehouseBatchSQLRequest extends $dara.Model {
    * The name of the client.
    * 
    * @example
-   * Dataworks。
+   * DataWorks
    */
   agency?: string;
   /**

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/GetAdbsparkNecessaryRampermissionsRequest.ts

@@ -6,7 +6,7 @@ export class GetADBSparkNecessaryRAMPermissionsRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all clusters in a specific region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all clusters in the specified region.
    * 
    * This parameter is required.
    * 

package/src/models/GetAdbsparkNecessaryRampermissionsResponseBody.ts

@@ -13,9 +13,9 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   action?: string;
   /**
    * @remarks
-   * The type of access policy denial. Valid values:
-   * - ImplicitDeny: The resource owner has not configured a relevant access policy for the current user. Unauthorized operations are denied by default.
-   * - ExplicitDeny: The RAM policy configured by the resource owner explicitly denies the current user authorization to access the corresponding resource.
+   * The type of denial by the access policy. Valid values:
+   * - ImplicitDeny: The resource owner has not configured a relevant access policy for the current user, and operations without authorization are denied by default.
+   * - ExplicitDeny: The RAM policy configured by the resource owner explicitly denies the current user access to the corresponding resource.
    * 
    * @example
    * ImplicitDeny
@@ -23,12 +23,12 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   noPermissionType?: string;
   /**
    * @remarks
-   * The type of the policy that caused the permission denial. Valid values:
-   * - ControlPolicy: control policy.
-   * - SessionPolicy: an additional permission policy attached to a temporary token.
-   * - AssumeRolePolicy: the trust policy of a RAM role.
-   * - AccountLevelIdentityBasedPolicy: an identity-access policy at the account authorization scope, including custom policies and system policies.
-   * - ResourceGroupLevelIdentityBasedPolicy: an identity-access policy at the resource group authorization scope, including custom policies and system policies.
+   * The type of the policy that causes the permission denial. Valid values:
+   * - ControlPolicy: The control policy.
+   * - SessionPolicy: An additional permission policy attached to the temporary token.
+   * - AssumeRolePolicy: The trust policy of the RAM role.
+   * - AccountLevelIdentityBasedPolicy: The identity-access policy at the account level, including custom policies and system policies.
+   * - ResourceGroupLevelIdentityBasedPolicy: The identity-access policy at the resource group level, including custom policies and system policies.
    * 
    * @example
    * ControlPolicy
@@ -46,7 +46,7 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   principalType?: string;
   /**
    * @remarks
-   * The information about the authentication target, which can be the Resource Access Management (RAM) users ID of the current user or the role information of the current accessor.
+   * The information about the authentication object, which can be the ID of the Resource Access Management (RAM) users of the current user or the role information of the current accessor.
    * 
    * @example
    * 223345695632****
@@ -94,15 +94,14 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
 export class GetADBSparkNecessaryRAMPermissionsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The diagnostic information returned when the permission check fails.
+   * The diagnostic information about the permission check failure. This parameter is returned when the permission check fails.
    */
   deniedDetail?: GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail;
   /**
    * @remarks
-   * Indicates whether the current user has the basic permissions to use ADB Spark. Valid values:
-   * 
-   * - true: The check is passed. The user has the basic permissions.
-   * - false: The check failed. The user is missing some permissions.
+   * Indicates whether the user has the basic permissions required to use ADB Spark. Valid values:
+   * - true: The check passed, and the user has the basic permissions.
+   * - false: The check failed, and the user lacks some permissions.
    * 
    * @example
    * true
@@ -110,7 +109,7 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyData extends $dara.Mo
   passed?: boolean;
   /**
    * @remarks
-   * The recommended RAM configuration based on the diagnostic information.
+   * The recommended configurations in the RAM system based on the diagnostic information.
    * 
    * @example
    * Grant the system RAM policy \\"AliyunADBDeveloperAccess\\" to current RAM user can quickly solve this issue.

package/src/models/GetDatabaseObjectsRequest.ts

@@ -13,7 +13,7 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The owner of the database.
+   * The owner.
    * 
    * @example
    * admin
@@ -21,7 +21,7 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
   filterOwner?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * test_db
@@ -29,12 +29,15 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
   filterSchemaName?: string;
   /**
    * @remarks
-   * The order in which you want to sort the query results. Valid values:
+   * The sort field.
+   * Valid values for Type:
+   * - Asc
+   * - Desc
    * 
-   * *   Asc
-   * *   Desc
-   * 
-   * Valid values for Field: DatabaseName, CreateTime, and UpdateTime. -CreateTime; -UpdateTime;
+   * Valid values for Field:
+   * - DatabseName
+   * - CreateTime
+   * - UpdateTime
    * 
    * Default value: {"Type": "Desc","Field": "DatabaseName"}.
    * 
@@ -47,7 +50,7 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value must be greater than 0 and no greater than the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -57,9 +60,9 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
    * @remarks
    * The number of entries per page. Valid values:
    * 
-   * *   30
-   * *   50
-   * *   100
+   * - 30
+   * - 50
+   * - 100
    * 
    * Default value: 30.
    * 
@@ -69,7 +72,7 @@ export class GetDatabaseObjectsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the database.
+   * The region ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetDatabaseObjectsResponseBody.ts

@@ -6,12 +6,12 @@ import { DatabaseSummaryModel } from "./DatabaseSummaryModel";
 export class GetDatabaseObjectsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The queried databases.
+   * The result array.
    */
   databaseSummaryModels?: DatabaseSummaryModel[];
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value must be greater than 0 and no greater than the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -21,9 +21,9 @@ export class GetDatabaseObjectsResponseBodyData extends $dara.Model {
    * @remarks
    * The number of entries per page. Valid values:
    * 
-   * *   30
-   * *   50
-   * *   100
+   * - 30
+   * - 50
+   * - 100
    * 
    * Default value: 30.
    * 
@@ -33,7 +33,7 @@ export class GetDatabaseObjectsResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 1
@@ -77,7 +77,7 @@ export class GetDatabaseObjectsResponseBody extends $dara.Model {
   data?: GetDatabaseObjectsResponseBodyData;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value is a positive integer. Default value: **1**.
    * 
    * @example
    * 1
@@ -86,10 +86,9 @@ export class GetDatabaseObjectsResponseBody extends $dara.Model {
   /**
    * @remarks
    * The number of entries per page. Valid values:
-   * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **30** (default)
+   * - **50**
+   * - **100**
    * 
    * @example
    * 30
@@ -105,7 +104,7 @@ export class GetDatabaseObjectsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 1

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 ADB MySQL cluster.
+   * The ID of the AnalyticDB for MySQL cluster.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,15 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The file path prefix. Only files that match the specified path prefix are recalled.
+   * The array of images to search for image retrieval. Currently, only one image is supported. The image must be Base64-encoded and passed in JSON format. Set the base64 key to the encoded image and the mime_type key to the image format. For more information, see the examples.
+   * 
+   * @example
+   * [{"base64": "/9j/4AAQSkZJRgABAQ...", "mime_type": "image/jpeg"}]
+   */
+  images?: string;
+  /**
+   * @remarks
+   * The file path prefix. Only files that match the path prefix are retrieved.
    * 
    * @example
    * oss://bucketName/path/prefix/
@@ -23,7 +31,7 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   path?: string;
   /**
    * @remarks
-   * The question for knowledge base recall.
+   * The question for knowledge base retrieval.
    * 
    * This parameter is required.
    * 
@@ -31,6 +39,14 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
    * What are the reports for the clothing category this month?
    */
   question?: string;
+  /**
+   * @remarks
+   * The semantic rules. Currently, only "all" and "" are supported.
+   * 
+   * @example
+   * all
+   */
+  semanticRules?: string;
   /**
    * @remarks
    * The list of tags in JSON format.
@@ -41,7 +57,7 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   tags?: string;
   /**
    * @remarks
-   * The top K associated files to recall.
+   * The top K value for retrieving associated files.
    * 
    * @example
    * 5
@@ -49,7 +65,7 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   topk?: number;
   /**
    * @remarks
-   * The username. Only files that the specified user has permission to access are recalled.
+   * The username. Only files that the user has permissions to access are retrieved.
    * 
    * @example
    * user_name1
@@ -58,8 +74,10 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
+      images: 'Images',
       path: 'Path',
       question: 'Question',
+      semanticRules: 'SemanticRules',
       tags: 'Tags',
       topk: 'Topk',
       user: 'User',
@@ -69,8 +87,10 @@ export class GetKnowledgeRecallRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       DBClusterId: 'string',
+      images: 'string',
       path: 'string',
       question: 'string',
+      semanticRules: 'string',
       tags: 'string',
       topk: 'number',
       user: 'string',

package/src/models/GetKnowledgeRecallResponseBody.ts

@@ -13,7 +13,7 @@ export class GetKnowledgeRecallResponseBodyData extends $dara.Model {
   count?: number;
   /**
    * @remarks
-   * The prompt message.
+   * The message.
    * 
    * @example
    * recall 5 files
@@ -21,7 +21,7 @@ export class GetKnowledgeRecallResponseBodyData extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The recall results.
+   * The retrieval results.
    */
   results?: { [key: string]: any }[];
   /**