@alicloud/polardb20170801 8.1.1 → 8.2.1

package/src/models/ModifyDbclusterParametersRequest.ts

@@ -3,12 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyDBClusterParametersRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to clear binlogs. This parameter takes effect only when binlog is disabled.
+   */
   clearBinlog?: boolean;
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to view information about all clusters in the destination region, including cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query information about all clusters in the specified region, including cluster IDs.
    * 
    * This parameter is required.
    * 
@@ -18,11 +21,11 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to immediately modify the parameters and restart the cluster. Valid values:
+   * Specifies whether to immediately or schedule the parameter modification and cluster restart. Valid values:  
    * 
-   * - false (default): The modification is scheduled.
-   * 
-   * - true: The modification is performed immediately.
+   * - false (default): Scheduled execution.
+   *  
+   * - true: Immediate execution.
    * 
    * @example
    * false
@@ -32,13 +35,12 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The ID of the parameter template.
+   * The parameter template ID.
+   * 
    * 
-   * > - Call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to view the ID of the parameter template.
-   * >
-   * > - You must specify this parameter or the `Parameters` parameter.
-   * >
-   * > - This parameter is supported only by PolarDB for MySQL.
+   * > * You can call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to query the parameter template ID.
+   * > * You must specify either this parameter or the `Parameters` parameter.
+   * > * Only PolarDB for MySQL supports this parameter.
    * 
    * @example
    * pcpg-**************
@@ -46,13 +48,11 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
   parameterGroupId?: string;
   /**
    * @remarks
-   * A JSON string that consists of parameters and their values. The parameter values must be strings. For example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.
+   * A JSON string that consists of parameters and their values. Parameter values are of the STRING type. Example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.
    * 
-   * > - Call the [DescribeDBClusterParameters](https://help.aliyun.com/document_detail/98122.html) operation to view the parameters of a PolarDB cluster.
-   * >
-   * > - This parameter is required if the destination cluster is a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Oracle compatible) cluster.
-   * >
-   * > - If the destination cluster is a PolarDB for MySQL cluster, you must specify this parameter or the `ParameterGroupId` parameter.
+   * > * You can call the [DescribeDBClusterParameters](https://help.aliyun.com/document_detail/98122.html) operation to query the parameters of a PolarDB cluster.
+   * > * If the cluster runs PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle), this parameter is required.
+   * > * If the cluster runs PolarDB for MySQL, you must specify either this parameter or the `ParameterGroupId` parameter.
    * 
    * @example
    * {"wait_timeout":"86","innodb_old_blocks_time":"10"}
@@ -60,11 +60,9 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
   parameters?: string;
   /**
    * @remarks
-   * The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
-   * 
-   * > - The latest start time must be at least 30 minutes later than the earliest start time.
-   * >
-   * > - If you specify `PlannedStartTime` but not this parameter, the latest time to start the task is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.
+   * The latest time to start running the scheduled task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
+   * > * The latest time must be at least 30 minutes later than the start time.
+   * > * If you specify `PlannedStartTime` but do not specify this parameter, the latest time defaults to `start time + 30 minutes`. For example, if `PlannedStartTime` is set to `2021-01-14T09:00:00Z` and this parameter is left empty, the task starts no later than `2021-01-14T09:30:00Z`.
    * 
    * @example
    * 2022-04-28T14:30:00Z
@@ -72,11 +70,9 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
   plannedEndTime?: string;
   /**
    * @remarks
-   * The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
-   * 
-   * > - The start time can be any point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value in the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
-   * >
-   * > - If you leave this parameter empty, the task is executed immediately.
+   * The earliest time to start running the scheduled task within the specified time range. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
+   * > * The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
+   * > * If this parameter is left empty, the task is immediately executed.
    * 
    * @example
    * 2022-04-28T14:00:00Z

package/src/models/ModifyDbclusterSslrequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBClusterSSLRequest extends $dara.Model {
   /**
+   * @remarks
+   * The validity period of the SSL certificate. Unit: days. Valid values: 365 and 1095.
+   * 
    * @example
    * 1095
    */
   certValidDays?: string;
   /**
+   * @remarks
+   * The connection string.
+   * 
    * @example
    * xxx
    */
@@ -28,7 +34,7 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
    * The endpoint ID.
    * 
    * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
-   * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
+   * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
    * >* You can call the [DescribeDBClusterSSL](https://help.aliyun.com/document_detail/2319159.html) operation to query endpoint details.
    * 
    * @example
@@ -37,13 +43,13 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
   DBEndpointId?: string;
   /**
    * @remarks
-   * The network type of the endpoint. The value must be consistent with the network type of the endpoint specified by the **DBEndpointId** parameter. Valid values:
+   * The network type of the endpoint. The value must be the same as the network type of the endpoint specified by **DBEndpointId**. Valid values:
    * * **Public**: public network
    * * **Private**: private network
    * * **Inner**: private network (classic network)
    * 
    * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
-   * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
+   * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
    * 
    * @example
    * Public
@@ -52,6 +58,9 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The PFS instance ID.
+   * 
    * @example
    * pfs-xxx
    */
@@ -62,9 +71,9 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable automatic SSL certificate rotation. Valid values:
    * 
-   * - **Enable**: Enables automatic rotation.
+   * - **Enable**: Enabled.
    * 
-   * - **Disable**: Disables automatic rotation.
+   * - **Disable**: Disabled.
    * 
    * @example
    * Enable
@@ -72,12 +81,12 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
   SSLAutoRotate?: string;
   /**
    * @remarks
-   * The SSL status. Valid values:
-   * * **Disable**: Shutdown of Secure Sockets Layer (SSL) encryption.
-   * * **Enable**: Enables Secure Sockets Layer (SSL) encryption.
+   * The SSL status to set. Valid values:
+   * * **Disable**: Shutdown SSL encryption.
+   * * **Enable**: Enables SSL encryption.
    * * **Update**: Updates the CA certificate.
    * 
-   * > After you enable Secure Sockets Layer (SSL) encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
+   * > After you enable SSL encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
    * 
    * @example
    * Enable

package/src/models/ModifyDbclusterStoragePerformanceRequest.ts

@@ -3,16 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyDBClusterStoragePerformanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): uses coupons.
+   * * false: does not use coupons.
+   */
   autoUseCoupon?: boolean;
   /**
    * @remarks
-   * Specifies if the I/O performance burst feature is enabled for an ESSD AutoPL disk. Valid values:
+   * Specifies whether to enable I/O performance burst for the ESSD AutoPL cloud disk. Valid values:
    * 
-   * - **true**: Enabled
+   * - **true**: enabled.
+   * - **false**: disabled (default).
    * 
-   * - **false**: Disabled (Default)
-   * 
-   * > This parameter applies only when StorageType is set to ESSDAUTOPL.
+   * > This parameter is supported only when StorageType is set to ESSDAUTOPL.
    * 
    * @example
    * false
@@ -20,7 +25,7 @@ export class ModifyDBClusterStoragePerformanceRequest extends $dara.Model {
   burstingEnabled?: string;
   /**
    * @remarks
-   * A client-generated token that ensures request idempotence. The token must be unique for each request. It is case-sensitive and can be up to 64 ASCII characters long.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token is case-sensitive and can contain only ASCII characters. The token can be up to 64 characters in length.
    * 
    * @example
    * 6000170000591aed949d0f******************
@@ -38,38 +43,27 @@ export class ModifyDBClusterStoragePerformanceRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The modification type. Valid values:
-   * 
-   * - **Upgrade**: Upgrades the storage performance.
-   * 
-   * - **Downgrade**: Downgrades the storage performance.
+   * The type of the specification change. Valid values: 
+   * * **Upgrade**: upgrades the specifications.
+   * * **Downgrade**: downgrades the specifications.
    * 
    * @example
    * Upgrade
    */
   modifyType?: string;
   /**
+   * @remarks
+   * The coupon code. If this parameter is not specified, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
   promotionCode?: string;
   /**
    * @remarks
-   * <props="china">
-   * 
-   * Valid values: 0 to min{50,000, 1000 \\* capacity - baseline performance}.
-   * 
-   * 
-   * 
-   * <props="china">
-   * 
-   * Baseline performance = min{1,800 + 50 \\* capacity, 50,000}.
-   * 
-   * 
-   * 
-   * <props="china">
-   * 
-   * > This parameter applies only when StorageType is set to ESSDAUTOPL.
+   * <p id="p_wyg_t4a_glm" props="china" icmsditafragmentmagic=1>The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1000 × Capacity - Baseline performance}.</p>
+   * <p id="p_6de_jxy_k2g" props="china" icmsditafragmentmagic=1>Baseline performance = min{1,800 + 50 × Capacity, 50000}.</p>
+   * <note id="note_7kj_j0o_rgs" props="china" icmsditafragmentmagic=1>This parameter is supported only when StorageType is set to ESSDAUTOPL.</note>
    * 
    * @example
    * 2500
@@ -78,22 +72,15 @@ export class ModifyDBClusterStoragePerformanceRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The target storage type. Valid values for Enterprise Edition:
-   * 
+   * The target storage type. Valid values for PolarDB Enterprise Edition:
    * - **PSL5**
-   * 
    * - **PSL4**
    * 
-   * Valid values for Standard Edition:
-   * 
+   * Valid values for PolarDB for MySQL Standard Edition:
    * - **ESSDPL0**
-   * 
    * - **ESSDPL1**
-   * 
    * - **ESSDPL2**
-   * 
    * - **ESSDPL3**
-   * 
    * - **ESSDAUTOPL**
    * 
    * @example

package/src/models/ModifyDbclusterStoragePerformanceResponseBody.ts

@@ -13,7 +13,7 @@ export class ModifyDBClusterStoragePerformanceResponseBody extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The ID of the order.
+   * The order ID.
    * 
    * @example
    * 2035629******

package/src/models/RetrievalKnowledgeBaseRequest.ts

@@ -0,0 +1,90 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RetrievalKnowledgeBaseRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The query text.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Financial report
+   */
+  queryText?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable reranking. Default value: true.
+   * 
+   * @example
+   * true
+   */
+  rerankEnabled?: boolean;
+  /**
+   * @remarks
+   * The similarity score threshold.
+   * 
+   * @example
+   * 0.7
+   */
+  scoreThreshold?: number;
+  /**
+   * @remarks
+   * The number of results to return.
+   * 
+   * @example
+   * 5
+   */
+  topK?: number;
+  static names(): { [key: string]: string } {
+    return {
+      knowledgeBaseId: 'KnowledgeBaseId',
+      queryText: 'QueryText',
+      regionId: 'RegionId',
+      rerankEnabled: 'RerankEnabled',
+      scoreThreshold: 'ScoreThreshold',
+      topK: 'TopK',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      knowledgeBaseId: 'string',
+      queryText: 'string',
+      regionId: 'string',
+      rerankEnabled: 'boolean',
+      scoreThreshold: 'number',
+      topK: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RetrievalKnowledgeBaseResponse.ts

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

@@ -0,0 +1,164 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the file.
+   * 
+   * @example
+   * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * 2024FinancialReport.pdf
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The chain of section headings to which the shard belongs.
+   */
+  headings?: string[];
+  /**
+   * @remarks
+   * The metadata.
+   * 
+   * @example
+   * {}
+   */
+  metadata?: string;
+  /**
+   * @remarks
+   * The list of page numbers to which the shard belongs.
+   */
+  pageNumbers?: number[];
+  /**
+   * @remarks
+   * The text content of the shard.
+   * 
+   * @example
+   * Financial report
+   */
+  shardContent?: string;
+  /**
+   * @remarks
+   * The shard index.
+   * 
+   * @example
+   * 1
+   */
+  shardIndex?: number;
+  /**
+   * @remarks
+   * The similarity score.
+   * 
+   * @example
+   * 0.8
+   */
+  similarityScore?: number;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      fileName: 'FileName',
+      headings: 'Headings',
+      metadata: 'Metadata',
+      pageNumbers: 'PageNumbers',
+      shardContent: 'ShardContent',
+      shardIndex: 'ShardIndex',
+      similarityScore: 'SimilarityScore',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      fileName: 'string',
+      headings: { 'type': 'array', 'itemType': 'string' },
+      metadata: 'string',
+      pageNumbers: { 'type': 'array', 'itemType': 'number' },
+      shardContent: 'string',
+      shardIndex: 'number',
+      similarityScore: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.headings)) {
+      $dara.Model.validateArray(this.headings);
+    }
+    if(Array.isArray(this.pageNumbers)) {
+      $dara.Model.validateArray(this.pageNumbers);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class RetrievalKnowledgeBaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The query text.
+   * 
+   * @example
+   * Financial report
+   */
+  queryText?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * CD35F3-F3-44CA-AFFF-BAF869******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The number of results.
+   * 
+   * @example
+   * 5
+   */
+  resultCount?: number;
+  /**
+   * @remarks
+   * The search results.
+   */
+  results?: RetrievalKnowledgeBaseResponseBodyResults[];
+  static names(): { [key: string]: string } {
+    return {
+      queryText: 'QueryText',
+      requestId: 'RequestId',
+      resultCount: 'ResultCount',
+      results: 'Results',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      queryText: 'string',
+      requestId: 'string',
+      resultCount: 'number',
+      results: { 'type': 'array', 'itemType': RetrievalKnowledgeBaseResponseBodyResults },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.results)) {
+      $dara.Model.validateArray(this.results);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RetryKnowledgeBaseFilesRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RetryKnowledgeBaseFilesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The IDs of the files to retry. Separate multiple IDs with commas (,). A maximum of 30 IDs can be specified.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
+   */
+  fileIds?: string;
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileIds: 'FileIds',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileIds: 'string',
+      knowledgeBaseId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+