@alicloud/polardb20170801 7.12.2 → 8.0.0

package/src/models/DescribeDbclusterTderesponseBody.ts

@@ -5,13 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether automatic key rotation is allowed. Valid values:
+   * Indicates whether automatic key rotation is enabled. Valid values:
    * 
-   * - **Enabled**: Automatic key rotation is allowed.
-   * 
-   * - **Disabled**: Automatic key rotation is not allowed.
-   * 
-   * > This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax.
+   * - **Enabled**: Enabled.
+   * - **Disabled**: Disabled.
+   * > This parameter is returned only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible.
    * 
    * @example
    * Enabled
@@ -19,7 +17,7 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   automaticRotation?: string;
   /**
    * @remarks
-   * The unique ID of the cluster.
+   * The cluster ID.
    * 
    * @example
    * pc-***************
@@ -27,13 +25,12 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Indicates whether automatic encryption is enabled for all newly created tables. Valid values:
+   * Indicates whether automatic encryption of all newly created tables is enabled. Valid values:
    * 
-   * - **ON**: Automatic encryption is enabled.
+   * - **ON**: Enabled.
    * 
-   * - **OFF**: Automatic encryption is disabled.
-   * 
-   * > This parameter is returned only when the database engine is compatible with MySQL.
+   * - **OFF**: Disabled.
+   * > This parameter is returned only when the database engine is MySQL-compatible.
    * 
    * @example
    * ON
@@ -41,7 +38,7 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   encryptNewTables?: string;
   /**
    * @remarks
-   * The ID of the custom key.
+   * The custom key ID.
    * 
    * @example
    * 2a4f4ac2-****-****-****-************
@@ -50,10 +47,8 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   /**
    * @remarks
    * The status of the key. Valid values:
-   * 
-   * - **Enabled**: The key is enabled.
-   * 
-   * - **Disabled**: The key is disabled.
+   * - **Enabled**: Enabled.
+   * - **Disabled**: Disabled.
    * 
    * @example
    * Enabled
@@ -61,7 +56,7 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   encryptionKeyStatus?: string;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * E37D1508-EC3B-4E06-A24A-C7AC31******
@@ -69,11 +64,11 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The automatic key rotation interval configured in KMS. If no automatic key rotation interval is set, 0 s is returned. Unit: s.
+   * The automatic key rotation interval configured in Key Management Service (KMS). If no automatic key rotation interval is configured, 0 s is returned. Unit: s.
    * 
    * For example, if the rotation interval is 7 days, 604800 s is returned.
    * 
-   * > This parameter is returned only when the database engine is compatible with PostgreSQL or Oracle syntax, and the value of `AutomaticRotation` is `Enabled`.
+   * > This parameter is returned only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible and the value of AutomaticRotation is Enabled.
    * 
    * @example
    * 604800s
@@ -81,7 +76,7 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   rotationInterval?: string;
   /**
    * @remarks
-   * The region where the TDE key is located.
+   * The region where the TDE key resides.
    * 
    * @example
    * cn-beijing
@@ -89,11 +84,9 @@ export class DescribeDBClusterTDEResponseBody extends $dara.Model {
   TDERegion?: string;
   /**
    * @remarks
-   * Indicates whether TDE encryption is enabled. Valid values:
-   * 
-   * - **Enabled**: TDE encryption is enabled.
-   * 
-   * - **Disabled**: TDE encryption is disabled.
+   * Indicates whether TDE is enabled. Valid values:
+   * * **Enabled**: Enabled.
+   * * **Disabled**: Disabled.
    * 
    * @example
    * Enabled

package/src/models/DescribeKnowledgeBaseAttributeRequest.ts

@@ -0,0 +1,48 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBaseAttributeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The unique identifier of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      knowledgeBaseId: 'KnowledgeBaseId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      knowledgeBaseId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBaseAttributeResponse.ts

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

@@ -0,0 +1,161 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBaseAttributeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The number of AI applications bound to the knowledge base.
+   * 
+   * @example
+   * 2
+   */
+  bindingAppCount?: number;
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2020-08-14T05:58:42Z
+   */
+  creationTime?: string;
+  /**
+   * @remarks
+   * The description of the knowledge base.
+   * 
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The unique identifier of the knowledge base.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The type of the knowledge base. Valid values:
+   * - PUBLIC
+   * - PERSONAL
+   * 
+   * @example
+   * PUBLIC
+   */
+  knowledgeBaseType?: string;
+  /**
+   * @remarks
+   * The ID of the knowledge space.
+   * 
+   * @example
+   * pks-xxxxxx
+   */
+  knowledgeSpaceId?: string;
+  /**
+   * @remarks
+   * The name of the knowledge base.
+   * 
+   * @example
+   * testName
+   */
+  name?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * E56531A4-E552-40BA-9C58-137B80******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The search mode. Valid values:
+   * * balanced (default)
+   * * precise
+   * * semantic
+   * * knn
+   * * rrf
+   * 
+   * @example
+   * balanced
+   */
+  searchMode?: string;
+  /**
+   * @remarks
+   * The number of shards.
+   * 
+   * @example
+   * 15
+   */
+  shardCount?: number;
+  /**
+   * @remarks
+   * The status of the knowledge base.
+   * 
+   * @example
+   * Activation
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The total number of documents.
+   * 
+   * @example
+   * 1
+   */
+  totalDocs?: number;
+  /**
+   * @remarks
+   * The total size in bytes.
+   * 
+   * @example
+   * 318881
+   */
+  totalSizeBytes?: number;
+  static names(): { [key: string]: string } {
+    return {
+      bindingAppCount: 'BindingAppCount',
+      creationTime: 'CreationTime',
+      description: 'Description',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      knowledgeBaseType: 'KnowledgeBaseType',
+      knowledgeSpaceId: 'KnowledgeSpaceId',
+      name: 'Name',
+      requestId: 'RequestId',
+      searchMode: 'SearchMode',
+      shardCount: 'ShardCount',
+      status: 'Status',
+      totalDocs: 'TotalDocs',
+      totalSizeBytes: 'TotalSizeBytes',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bindingAppCount: 'number',
+      creationTime: 'string',
+      description: 'string',
+      knowledgeBaseId: 'string',
+      knowledgeBaseType: 'string',
+      knowledgeSpaceId: 'string',
+      name: 'string',
+      requestId: 'string',
+      searchMode: 'string',
+      shardCount: 'number',
+      status: 'string',
+      totalDocs: 'number',
+      totalSizeBytes: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBasesRequest.ts

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBasesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The keyword for searching knowledge bases.
+   * 
+   * @example
+   * testkb
+   */
+  keyword?: string;
+  /**
+   * @remarks
+   * The unique identifier of the knowledge space.
+   * 
+   * @example
+   * pks-xxxxxx
+   */
+  knowledgeSpaceId?: string;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The status of the knowledge base.
+   * 
+   * @example
+   * Activation
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      keyword: 'Keyword',
+      knowledgeSpaceId: 'KnowledgeSpaceId',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      keyword: 'string',
+      knowledgeSpaceId: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBasesResponse.ts

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

@@ -0,0 +1,186 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBasesResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The number of AI applications bound to the knowledge base.
+   * 
+   * @example
+   * 2
+   */
+  bindingAppCount?: number;
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2025-03-25T09:37:10Z
+   */
+  creationTime?: string;
+  /**
+   * @remarks
+   * The description of the knowledge base.
+   * 
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The unique identifier of the knowledge base.
+   * 
+   * @example
+   * pkb-xxxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The ID of the knowledge space.
+   * 
+   * @example
+   * pks-xxxxxx
+   */
+  knowledgeSpaceId?: string;
+  /**
+   * @remarks
+   * The name of the knowledge base.
+   * 
+   * @example
+   * testName
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The status of the knowledge base.
+   * 
+   * @example
+   * Activation
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The total number of documents.
+   * 
+   * @example
+   * 1
+   */
+  totalDocs?: number;
+  /**
+   * @remarks
+   * The total size in bytes.
+   * 
+   * @example
+   * 231984
+   */
+  totalSizeBytes?: number;
+  static names(): { [key: string]: string } {
+    return {
+      bindingAppCount: 'BindingAppCount',
+      creationTime: 'CreationTime',
+      description: 'Description',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      knowledgeSpaceId: 'KnowledgeSpaceId',
+      name: 'Name',
+      status: 'Status',
+      totalDocs: 'TotalDocs',
+      totalSizeBytes: 'TotalSizeBytes',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bindingAppCount: 'number',
+      creationTime: 'string',
+      description: 'string',
+      knowledgeBaseId: 'string',
+      knowledgeSpaceId: 'string',
+      name: 'string',
+      status: 'string',
+      totalDocs: 'number',
+      totalSizeBytes: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeBasesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of knowledge bases.
+   */
+  items?: DescribeKnowledgeBasesResponseBodyItems[];
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: **30**, **50**, and **100**.
+   *                               
+   * Default value: **30**.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * CDB3258F-B5DE-43C4-8935-CBA0CA******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of records.
+   * 
+   * @example
+   * 1
+   */
+  totalRecordCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalRecordCount: 'TotalRecordCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': DescribeKnowledgeBasesResponseBodyItems },
+      pageNumber: 'number',
+      pageSize: 'number',
+      requestId: 'string',
+      totalRecordCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+