@alicloud/polardb20170801 8.2.0 → 8.2.1

package/src/models/CreateStoragePlanRequest.ts

@@ -3,10 +3,16 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateStoragePlanRequest 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 this token on your client. The token must be unique across different requests. It is case-sensitive and can contain up to 64 ASCII characters.
+   * 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********************
@@ -16,11 +22,11 @@ export class CreateStoragePlanRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The unit of the subscription duration for the storage plan. Valid values:
+   * The unit of the storage plan duration. Valid values:
    * 
-   * - **Month**
+   * - **Month**: month.
    * 
-   * - **Year**
+   * - **Year**: year.
    * 
    * This parameter is required.
    * 
@@ -29,6 +35,9 @@ export class CreateStoragePlanRequest extends $dara.Model {
    */
   period?: string;
   /**
+   * @remarks
+   * The coupon code. If this parameter is not specified, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
@@ -37,7 +46,7 @@ export class CreateStoragePlanRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The capacity of the storage plan, in GB. Valid values: 50, 100, 200, 300, 500, 1,000, 2,000, 3,000, 5,000, 10,000, 15,000, 20,000, 25,000, 30,000, 50,000, 100,000, and 200,000.
+   * The capacity of the storage plan. Unit: GB. Valid values: 50, 100, 200, 300, 500, 1000, 2000, 3000, 5000, 10000, 15000, 20000, 25000, 30000, 50000, 100000, and 200000.
    * 
    * This parameter is required.
    * 
@@ -49,9 +58,9 @@ export class CreateStoragePlanRequest extends $dara.Model {
    * @remarks
    * The type of the storage plan. Valid values:
    * 
-   * - **Mainland**: For use in the Chinese mainland.
+   * - **Mainland**: general-purpose, applicable in the Chinese mainland.
    * 
-   * - **Overseas**: For use in China (Hong Kong) and regions outside China.
+   * - **Overseas**: general-purpose, applicable in Hong Kong (China) and outside China.
    * 
    * This parameter is required.
    * 
@@ -61,11 +70,11 @@ export class CreateStoragePlanRequest extends $dara.Model {
   storageType?: string;
   /**
    * @remarks
-   * The subscription duration of the storage plan.
+   * The duration of the storage plan.
    * 
    * - If **Period** is set to **Month**, the value ranges from 1 to 9.
    * 
-   * - If **Period** is set to **Year**, the valid values are 1, 2, 3, and 5.
+   * - If **Period** is set to **Year**, valid values are 1, 2, 3, and 5.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteDbclusterEndpointRequest.ts

@@ -15,7 +15,7 @@ export class DeleteDBClusterEndpointRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The ID of the custom cluster endpoint.
+   * The custom cluster endpoint ID.
    * 
    * This parameter is required.
    * 
@@ -26,6 +26,9 @@ export class DeleteDBClusterEndpointRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The PolarFs instance ID.
+   * 
    * @example
    * pfs-test*****
    */

package/src/models/DeleteKnowledgeBaseFileRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteKnowledgeBaseFileRequest extends $dara.Model {
   /**
    * @remarks
+   * The file ID. To delete multiple files at a time, separate the file IDs with commas (,). A maximum of 500 file IDs are supported.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteKnowledgeBaseFileRequest extends $dara.Model {
   fileId?: string;
   /**
    * @remarks
+   * The unique ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DeleteKnowledgeBaseFileRequest extends $dara.Model {
   knowledgeBaseId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteKnowledgeBaseFileResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteKnowledgeBaseFileResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * 6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
    */

package/src/models/DescribeDbclusterAccessWhitelistRequest.ts

@@ -16,6 +16,9 @@ export class DescribeDBClusterAccessWhitelistRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The PFS instance ID.
+   * 
    * @example
    * pfs-xxx
    */

package/src/models/DescribeDbclusterSslrequest.ts

@@ -6,7 +6,7 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * >You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters under your account, including the cluster ID.
+   * >You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters under your account, including cluster IDs.
    * 
    * This parameter is required.
    * 
@@ -17,6 +17,9 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The PFS instance ID.
+   * 
    * @example
    * pfs-xxx
    */

package/src/models/DescribeDbclusterSslresponseBody.ts

@@ -19,7 +19,7 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
    * 
    * - **Disable**: Disabled.
    * 
-   * > This parameter is supported only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible.
+   * > This parameter is supported only when the database engine is PostgreSQL-compatible or Oracle syntax-compatible.
    * 
    * @example
    * Enable

package/src/models/DescribeDbclusterVersionRequest.ts

@@ -6,8 +6,7 @@ export class DescribeDBClusterVersionRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to view details of all clusters in your account, such as cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters within your account, such as the cluster ID.
    * 
    * This parameter is required.
    * 
@@ -17,11 +16,10 @@ export class DescribeDBClusterVersionRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to return information about the latest version or a list of upgradable versions. Valid values:
-   * 
-   * - LATEST_VERSION: Queries information about the latest version.
+   * Specifies whether to return the latest version information or the list of available upgrade versions. Valid values:
    * 
-   * - AVAILABLE_VERSION: Queries a list of upgradable versions.
+   * - LATEST_VERSION: queries the latest version information.
+   * - AVAILABLE_VERSION: queries the list of available upgrade versions.
    * 
    * @example
    * LATEST_VERSION

package/src/models/DescribeDbclusterVersionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClusterVersionResponseBodyDBRevisionVersionList extends $dara.Model {
   /**
    * @remarks
-   * The release notes of the version.
+   * The release notes for the version.
    * 
    * @example
    * ReleaseNote
@@ -14,14 +14,10 @@ export class DescribeDBClusterVersionResponseBodyDBRevisionVersionList extends $
   /**
    * @remarks
    * The release status of the database version. Valid values:
-   * 
-   * - **Stable**: The current version is stable.
-   * 
-   * - **Old**: The current version is outdated. Do not upgrade to this version.
-   * 
-   * - **HighRisk**: The current version has critical bugs. Do not upgrade to this version.
-   * 
-   * - **Beta**: The current version is a beta version.
+   * * **Stable**: The current version is stable.
+   * * **Old**: The current version is outdated. Upgrading to this version is not recommended.
+   * * **HighRisk**: The current version has critical bugs. Upgrading to this version is not recommended.
+   * * **Beta**: The current version is a beta version.
    * 
    * @example
    * Stable
@@ -29,7 +25,7 @@ export class DescribeDBClusterVersionResponseBodyDBRevisionVersionList extends $
   releaseType?: string;
   /**
    * @remarks
-   * The revision version code of the database engine. You can use this code to specify the target version for an upgrade.
+   * The revision version code of the database engine, which is used to specify the target version for the upgrade.
    * 
    * @example
    * 20230707
@@ -37,7 +33,7 @@ export class DescribeDBClusterVersionResponseBodyDBRevisionVersionList extends $
   revisionVersionCode?: string;
   /**
    * @remarks
-   * The revision version of the database engine.
+   * The revision version number of the database engine.
    * 
    * @example
    * 8.0.1.1.35.1
@@ -73,7 +69,7 @@ export class DescribeDBClusterVersionResponseBodyDBRevisionVersionList extends $
 export class DescribeDBClusterVersionResponseBodyProxyRevisionVersionList extends $dara.Model {
   /**
    * @remarks
-   * The release notes of the version.
+   * The release notes for the version.
    * 
    * @example
    * ReleaseNote
@@ -82,10 +78,8 @@ export class DescribeDBClusterVersionResponseBodyProxyRevisionVersionList extend
   /**
    * @remarks
    * The release type. Valid values:
-   * 
-   * - **LTS**: long-term support version.
-   * 
-   * - **BETA**: preview version.
+   * * **LTS**: Long-term support version.
+   * * **BETA**: Preview version.
    * 
    * @example
    * LTS
@@ -93,7 +87,7 @@ export class DescribeDBClusterVersionResponseBodyProxyRevisionVersionList extend
   releaseType?: string;
   /**
    * @remarks
-   * The revision version code of the database proxy engine. You can use this code to specify the target version for an upgrade.
+   * The revision version code of the PolarProxy engine, which is used to specify the target version for the upgrade.
    * 
    * @example
    * 20230707
@@ -101,7 +95,7 @@ export class DescribeDBClusterVersionResponseBodyProxyRevisionVersionList extend
   revisionVersionCode?: string;
   /**
    * @remarks
-   * The revision version of the database proxy engine.
+   * The revision version number of the PolarProxy engine.
    * 
    * @example
    * 2.8.24
@@ -144,13 +138,16 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The latest stable version of PolarDB for PostgreSQL.
+   * 
    * @example
    * 2.0.16.13.14.0
    */
   DBLatestStableVersion?: string;
   /**
    * @remarks
-   * The latest version of the database kernel.
+   * The latest version of the database kernel engine.
    * 
    * @example
    * 8.0.1.1.16
@@ -158,17 +155,13 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   DBLatestVersion?: string;
   /**
    * @remarks
-   * The minor version of the database engine.
-   * 
-   * - If `DBVersion` is **8.0**, valid values are:
+   * The minor version number of the database engine.
+   * * If `DBVersion` is **8.0**, valid values:
+   *     * **8.0.2**
+   *     * **8.0.1**
+   * * If `DBVersion` is **5.7**, the value is **5.7.28**.
    * 
-   *   - **8.0.2**
-   * 
-   *   - **8.0.1**
-   * 
-   * - If `DBVersion` is **5.7**, the value is **5.7.28**.
-   * 
-   * - If `DBVersion` is **5.6**, the value is **5.6.16**.
+   * * If `DBVersion` is **5.6**, the value is **5.6.16**.
    * 
    * @example
    * 8.0.1
@@ -176,9 +169,8 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   DBMinorVersion?: string;
   /**
    * @remarks
-   * The revision version of the database engine.
-   * 
-   * > For a PolarDB for MySQL 5.6 cluster, this parameter is returned only when the release date of the revision version is later than 20200831. Otherwise, this parameter is empty. For more information about the kernel version of a PolarDB for MySQL cluster, see [Kernel release notes](https://help.aliyun.com/document_detail/423884.html).
+   * The Milvus version number of the database engine.
+   * > For PolarDB for MySQL 5.6 clusters, only the `Milvus version` information with a release date later than August 31, 2020 is returned. Otherwise, this parameter is empty. For more information about the minor engine versions of PolarDB for MySQL clusters, see [Release notes](https://help.aliyun.com/document_detail/423884.html).
    * 
    * @example
    * 8.0.1.1.7
@@ -186,18 +178,15 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   DBRevisionVersion?: string;
   /**
    * @remarks
-   * A list of upgradable versions.
+   * The list of available upgrade version information.
    */
   DBRevisionVersionList?: DescribeDBClusterVersionResponseBodyDBRevisionVersionList[];
   /**
    * @remarks
-   * The major version of the database engine. Valid values:
-   * 
-   * - **8.0**
-   * 
-   * - **5.7**
-   * 
-   * - **5.6**
+   * The major version number of the database engine. Valid values:
+   * * **8.0**
+   * * **5.7**
+   * * **5.6**
    * 
    * @example
    * 8.0
@@ -205,34 +194,31 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   DBVersion?: string;
   /**
    * @remarks
-   * The status of the current minor version of the database. Valid values:
-   * 
-   * - **Stable**: The current version is stable.
-   * 
-   * - **Old**: The current version is outdated. Upgrade to the latest version.
-   * 
-   * - **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.
-   * 
-   * - **Beta**: The current version is a beta version.
-   * 
-   * > For more information about how to upgrade the minor version of a database, see [Upgrade versions](https://help.aliyun.com/document_detail/158572.html).
+   * The status of the current database minor version. Valid values:
+   * * **Stable**: The current version is stable.
+   * * **Old**: The current version is outdated. Upgrade to the latest version.
+   * * **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.
+   * * **Beta**: The current version is a beta version.
+   * >For more information about how to upgrade the database minor version, see [Version upgrade](https://help.aliyun.com/document_detail/158572.html).
    * 
    * @example
    * Stable
    */
   DBVersionStatus?: string;
   /**
+   * @remarks
+   * Indicates whether the current version is the latest stable version of PolarDB for PostgreSQL.
+   * 
    * @example
    * true
    */
   isLatestStableVersion?: string;
   /**
    * @remarks
-   * Indicates whether the current database kernel version is the latest version. Valid values:
-   * 
-   * - **true**
+   * Indicates whether the current database kernel DPI engine version is the latest database engine version. Valid values:
    * 
-   * - **false**
+   * -  **true**
+   * -  **false**
    * 
    * @example
    * true
@@ -240,11 +226,9 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   isLatestVersion?: string;
   /**
    * @remarks
-   * Indicates whether the current database proxy version is the latest version. Valid values:
-   * 
-   * - **true**
-   * 
-   * - **false**
+   * Indicates whether the current PolarProxy version is the latest version. Valid values:
+   * * **true**
+   * * **false**
    * 
    * @example
    * true
@@ -252,7 +236,7 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   isProxyLatestVersion?: string;
   /**
    * @remarks
-   * The latest version of the database proxy.
+   * The latest version of PolarProxy.
    * 
    * @example
    * 2.4.17
@@ -260,7 +244,7 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   proxyLatestVersion?: string;
   /**
    * @remarks
-   * The version of the database proxy.
+   * The version of PolarProxy.
    * 
    * @example
    * 2.4.15
@@ -268,30 +252,22 @@ export class DescribeDBClusterVersionResponseBody extends $dara.Model {
   proxyRevisionVersion?: string;
   /**
    * @remarks
-   * A list of upgradable proxy versions.
+   * The release status of the PolarProxy version. Valid values:
    * 
    * - **Stable**: The current version is stable.
-   * 
-   * - **Old**: This version is outdated and not recommended for upgrades.
-   * 
-   * - **HighRisk**: This version has critical bugs and is not recommended for upgrades.
-   * 
-   * - **Beta**: This is a beta version.
+   * - **Old**: The current version is outdated. Upgrading to this version is not recommended.
+   * - **HighRisk**: The current version has critical bugs. Upgrading to this version is not recommended.
+   * - **Beta**: The current version is a beta version.
    */
   proxyRevisionVersionList?: DescribeDBClusterVersionResponseBodyProxyRevisionVersionList[];
   /**
    * @remarks
-   * The status of the database proxy version. Valid values:
-   * 
-   * - **Stable**: The current version is stable.
-   * 
-   * - **Old**: The current version is outdated. Upgrade to the latest version.
-   * 
-   * - **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.
-   * 
-   * - **Beta**: The current version is a beta version.
-   * 
-   * > For more information about how to upgrade the database proxy version, see [Upgrade versions](https://help.aliyun.com/document_detail/158572.html).
+   * The version status of PolarProxy. Valid values:
+   * * **Stable**: The current version is stable.
+   * * **Old**: The current version is outdated. Upgrade to the latest version.
+   * * **HighRisk**: The current version has critical bugs. Upgrade to the latest version immediately.
+   * * **Beta**: The current version is a beta version.
+   * >For more information about how to upgrade the PolarProxy version, see [Version upgrade](https://help.aliyun.com/document_detail/158572.html).
    * 
    * @example
    * Stable

package/src/models/DescribeKnowledgeBaseAnswerRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeKnowledgeBaseAnswerRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeKnowledgeBaseAnswerRequest extends $dara.Model {
   knowledgeBaseId?: string;
   /**
    * @remarks
+   * The unique ID of the Q&A task.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DescribeKnowledgeBaseAnswerRequest extends $dara.Model {
   queryId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeKnowledgeBaseAnswerResponseBody.ts

@@ -4,47 +4,78 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model {
   /**
+   * @remarks
+   * The chunk metadata.
+   * 
    * @example
    * {}
    */
   chunkMetadata?: { [key: string]: any };
   /**
+   * @remarks
+   * The file ID.
+   * 
    * @example
    * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
    */
   fileId?: string;
   /**
+   * @remarks
+   * The file name.
+   * 
    * @example
-   * 财报.pdf
+   * financial_report.pdf
    */
   fileName?: string;
   /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
    * @example
    * pkb-xxxxx
    */
   knowledgeBaseId?: string;
   /**
+   * @remarks
+   * The document metadata.
+   * 
    * @example
    * {}
    */
   metadata?: { [key: string]: any };
+  /**
+   * @remarks
+   * The list of page numbers to which the shard belongs.
+   */
   pageNumbers?: number[];
   /**
+   * @remarks
+   * The shard content.
+   * 
    * @example
-   * 财报
+   * financial_report
    */
   shardContent?: string;
   /**
+   * @remarks
+   * The shard ID.
+   * 
    * @example
    * 8
    */
   shardIndex?: number;
   /**
+   * @remarks
+   * The similarity score.
+   * 
    * @example
    * 0.75
    */
   similarityScore?: number;
   /**
+   * @remarks
+   * The source ID.
+   * 
    * @example
    * 1
    */
@@ -99,52 +130,88 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
 
 export class DescribeKnowledgeBaseAnswerResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Agent ID
+   * 
    * @example
    * ******
    */
   agentId?: string;
   /**
+   * @remarks
+   * The answer content.
+   * 
    * @example
-   * 财报的内容总结如下：******
+   * The financial report is summarized as follows: ******
    */
   answer?: string;
   /**
+   * @remarks
+   * The cumulative number of tokens generated by the completion.
+   * 
    * @example
    * 3935
    */
   completionTokens?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Space not found: pks-xxxx
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The error type.
+   * 
    * @example
    * not_found
    */
   errorType?: string;
   /**
+   * @remarks
+   * The large language model ID.
+   * 
    * @example
    * OO1A6p8B******_xPUC
    */
   LLMModelId?: string;
   /**
+   * @remarks
+   * The cumulative number of tokens consumed by the prompt.
+   * 
    * @example
    * 2459
    */
   promptTokens?: number;
   /**
+   * @remarks
+   * The unique ID of the Q&A task.
+   * 
    * @example
    * R3BGbnBqcXN******.2a5a23c9-******-179970533d30
    */
   queryId?: string;
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * CDB3258F-B5DE-43C4-8935-CBA0CA******
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of reference sources for the answer.
+   */
   sources?: DescribeKnowledgeBaseAnswerResponseBodySources[];
   /**
+   * @remarks
+   * The status of the Q&A task. Valid values:
+   * - RUNNING: In progress.
+   * - COMPLETED: Completed.
+   * 
    * @example
    * COMPLETED
    */