@alicloud/polardb20170801 8.2.0 → 8.2.2

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

@@ -15,7 +15,7 @@ export class ModifyPolarFsMappingAuthRequest extends $dara.Model {
   bucket?: string;
   /**
    * @remarks
-   * The AccessKey ID for the storage bucket.
+   * The AccessKey ID of the storage bucket.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class ModifyPolarFsMappingAuthRequest extends $dara.Model {
   bucketAccessKeyId?: string;
   /**
    * @remarks
-   * The AccessKey secret for the storage bucket.
+   * The AccessKey secret of the storage bucket.
    * 
    * This parameter is required.
    * 

package/src/models/RetrievalKnowledgeBaseRequest.ts

@@ -5,6 +5,8 @@ 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
@@ -13,14 +15,18 @@ export class RetrievalKnowledgeBaseRequest extends $dara.Model {
   knowledgeBaseId?: string;
   /**
    * @remarks
+   * The query text.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 财报
+   * Financial report
    */
   queryText?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,16 +34,25 @@ export class RetrievalKnowledgeBaseRequest extends $dara.Model {
    */
   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
    */

package/src/models/RetrievalKnowledgeBaseResponseBody.ts

@@ -4,33 +4,59 @@ 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
-   * 2024财报.pdf
+   * 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
    */
@@ -78,20 +104,33 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
 
 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 {

package/src/models/RetryKnowledgeBaseFilesRequest.ts

@@ -5,6 +5,8 @@ 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
@@ -13,6 +15,8 @@ export class RetryKnowledgeBaseFilesRequest extends $dara.Model {
   fileIds?: string;
   /**
    * @remarks
+   * The unique ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class RetryKnowledgeBaseFilesRequest extends $dara.Model {
   knowledgeBaseId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RetryKnowledgeBaseFilesResponseBody.ts

@@ -4,21 +4,36 @@ import * as $dara from '@darabonba/typescript';
 
 export class RetryKnowledgeBaseFilesResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * AclProjectionNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The failure reason.
+   * 
    * @example
    * No active ACL projection exists for the IM document
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The file ID.
+   * 
    * @example
    * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
    */
   fileId?: string;
   /**
+   * @remarks
+   * The request result. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
+   * 
    * @example
    * false
    */
@@ -52,22 +67,38 @@ export class RetryKnowledgeBaseFilesResponseBodyItems extends $dara.Model {
 
 export class RetryKnowledgeBaseFilesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The number of failed retries.
+   * 
    * @example
    * 0
    */
   failedCount?: number;
+  /**
+   * @remarks
+   * The list of retry results.
+   */
   items?: RetryKnowledgeBaseFilesResponseBodyItems[];
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * CED079B7-A408-41A1-BFF1-EC608E******
    */
   requestId?: string;
   /**
+   * @remarks
+   * The number of successful retries.
+   * 
    * @example
    * 1
    */
   succeededCount?: number;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 1
    */

package/src/models/TempModifyDbnodeRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class TempModifyDBNodeRequestDBNode extends $dara.Model {
   /**
    * @remarks
-   * The specifications of the node to upgrade or add.
+   * The specifications of the node to be upgraded or added.
    * 
-   * > - When you add a node, the node specifications must be the same as the specifications of the existing nodes.
-   * >
-   * > - For more information about the specifications of existing cluster nodes, see [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html).
+   * > - When you add a node, the node specifications must be the same as those of the existing nodes.
+   * > - For the specifications of existing cluster nodes, see [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html).
    * 
    * @example
    * polar.mysql.x4.medium
@@ -17,7 +16,7 @@ export class TempModifyDBNodeRequestDBNode extends $dara.Model {
   targetClass?: string;
   /**
    * @remarks
-   * The zone for the new node. The zone must be the same as the zone of the existing nodes.
+   * The zone of the node to be added. The zone must be the same as that of the existing nodes.
    * 
    * @example
    * cn-hangzhou-i
@@ -47,10 +46,16 @@ export class TempModifyDBNodeRequestDBNode extends $dara.Model {
 }
 
 export class TempModifyDBNodeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): Uses coupons.
+   * * false: Does not use coupons.
+   */
   autoUseCoupon?: boolean;
   /**
    * @remarks
-   * A client token to ensure the idempotence of the request. Generate a unique token for each request. The token is case-sensitive and can be up to 64 ASCII characters in length.
+   * The client token that is used to ensure the idempotency 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
    * 6000170000591aed949d0f5********************
@@ -68,14 +73,14 @@ export class TempModifyDBNodeRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The information about the nodes to upgrade or add.
+   * The information about the node to be upgraded or added.
    * 
    * This parameter is required.
    */
   DBNode?: TempModifyDBNodeRequestDBNode[];
   /**
    * @remarks
-   * The modification type. The value is fixed to **TempUpgrade**.
+   * The change type. The value is fixed as **TempUpgrade**.
    * 
    * This parameter is required.
    * 
@@ -87,9 +92,8 @@ export class TempModifyDBNodeRequest extends $dara.Model {
    * @remarks
    * The operation type. Valid values:
    * 
-   * - **Modify**: temporary upgrade
-   * 
-   * - **Add**: temporarily add a node
+   * - **Modify**: temporarily upgrades specifications.
+   * - **Add**: temporarily adds nodes.
    * 
    * This parameter is required.
    * 
@@ -100,6 +104,9 @@ export class TempModifyDBNodeRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The coupon code. If this parameter is not specified, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
@@ -108,9 +115,9 @@ export class TempModifyDBNodeRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The time to revert the temporary upgrade. The format is YYYY-MM-DD hh:mm:ss.
+   * The restore time for the temporary upgrade. Specify the time in the YYYY-MM-DD hh:mm:ss format.
    * 
-   * > The revert time must be at least 1 hour later than the current time. It must also be at least 1 day before the cluster expires.
+   * > The restore time cannot be earlier than 1 hour after the current time or later than 1 day before the cluster expiration time.
    * 
    * This parameter is required.
    * 

package/src/models/TransformDbclusterPayTypeRequest.ts

@@ -3,10 +3,16 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class TransformDBClusterPayTypeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): Use coupons.
+   * * false: Do not use coupons.
+   */
   autoUseCoupon?: boolean;
   /**
    * @remarks
-   * A client token to ensure the idempotence of the request. The client generates the token, but you must make sure that the token is unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.
+   * The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 6000170000591aed949d0f5********************
@@ -14,7 +20,7 @@ export class TransformDBClusterPayTypeRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the PolarDB cluster.
+   * The PolarDB cluster ID.
    * 
    * This parameter is required.
    * 
@@ -40,19 +46,22 @@ export class TransformDBClusterPayTypeRequest extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * The unit of the subscription duration. Valid values:
+   * The subscription type of the subscription instance. Valid values:
    * 
-   * - **Year**
+   * - **Year**: yearly subscription
    * 
-   * - **Month**
+   * - **Month**: monthly subscription
    * 
-   * > This parameter is required when you set **PayType** to **Prepaid**.
+   * > This parameter is required when **PayType** is set to **Prepaid**.
    * 
    * @example
    * Month
    */
   period?: string;
   /**
+   * @remarks
+   * The coupon code. If you do not specify this parameter, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
@@ -69,7 +78,7 @@ export class TransformDBClusterPayTypeRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The resource group ID.
    * 
    * @example
    * rg-acfm3f4un32****
@@ -81,11 +90,11 @@ export class TransformDBClusterPayTypeRequest extends $dara.Model {
    * @remarks
    * The subscription duration. Valid values:
    * 
-   * - If you set **Period** to **Year**, the value of **UsedTime** can be 1, 2, or 3.
+   * - If **Period** is set to **Year**, set **UsedTime** to a value from 1 to 3.
    * 
-   * - If you set **Period** to **Month**, the value of **UsedTime** can be an integer from 1 to 9.
+   * - If **Period** is set to **Month**, set **UsedTime** to a value from 1 to 9.
    * 
-   * > This parameter is required when you set **PayType** to **Prepaid**.
+   * > This parameter is required when **PayType** is set to **Prepaid**.
    * 
    * @example
    * 1

package/src/models/TransformDbclusterPayTypeResponseBody.ts

@@ -17,7 +17,7 @@ export class TransformDBClusterPayTypeResponseBody extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * The ID of the PolarDB cluster.
+   * The PolarDB cluster ID.
    * 
    * @example
    * pc-bp10gr51qasnl****
@@ -26,8 +26,7 @@ export class TransformDBClusterPayTypeResponseBody extends $dara.Model {
   /**
    * @remarks
    * The expiration time of the instance.
-   * 
-   * > This parameter is returned only when **PayType** is set to **Prepaid**.
+   * > This response parameter is returned only when **PayType** is set to **Prepaid**.
    * 
    * @example
    * 2020-04-20T10:00:00Z

package/src/models/TriggerKnowledgeBaseSyncRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class TriggerKnowledgeBaseSyncRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique identifier of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class TriggerKnowledgeBaseSyncRequest extends $dara.Model {
    */
   knowledgeBaseId?: string;
   /**
+   * @remarks
+   * The synchronization link ID.
+   * 
    * @example
    * pkbl-xxxxx
    */
   linkId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/TriggerKnowledgeBaseSyncResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class TriggerKnowledgeBaseSyncResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * A7E6A8FD-C50B-46B2-BA85-D8B8D3******
    */