@alicloud/gpdb20160503 3.10.0 → 3.11.0

package/src/models/TagSupabaseProjectRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class TagSupabaseProjectRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key. The key cannot be empty and can be up to 64 characters long. It cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.
+   * The tag key. This parameter cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
    * 
    * @example
    * test-key
@@ -13,7 +13,7 @@ export class TagSupabaseProjectRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value. The value can be empty or up to 128 characters long. It cannot contain `http://` or `https://`.
+   * The tag value. This parameter can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.
    * 
    * @example
    * test-value
@@ -53,12 +53,12 @@ export class TagSupabaseProjectRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The IDs of the instances. You can specify up to 50 instance IDs.
+   * The Nth instance. Valid values of N: 1 to 50.
    */
   resourceId?: string[];
   /**
    * @remarks
-   * The resource type. Set this parameter to `instance`.
+   * The resource type. Set the value to `instance`.
    * 
    * @example
    * instance
@@ -66,7 +66,7 @@ export class TagSupabaseProjectRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
-   * The tags to add. You can specify up to 20 tags.
+   * The Nth tag. Valid values of N: 1 to 20.
    */
   tag?: TagSupabaseProjectRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/TagSupabaseProjectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class TagSupabaseProjectResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

package/src/models/TextEmbeddingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class TextEmbeddingRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,10 @@ export class TextEmbeddingRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The number of embedding dimensions. The default value is the number of dimensions supported by the embedding algorithm.
+   * The vector dimensions. Default value: the dimensions supported by the embedding model.
    * 
    * > 
-   * 
-   * *   The text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.
+   * > - text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.
    * 
    * @example
    * 1024
@@ -27,7 +26,7 @@ export class TextEmbeddingRequest extends $dara.Model {
   dimension?: number;
   /**
    * @remarks
-   * A list of text content to be embedded. The list length must not exceed 100.
+   * The list of text content to vectorize. The list can contain up to 100 entries.
    * 
    * @example
    * What is ADBPG?
@@ -35,14 +34,13 @@ export class TextEmbeddingRequest extends $dara.Model {
   input?: string[];
   /**
    * @remarks
-   * The text embedding model. Valid values:
-   * 
-   * *   text-embedding-v1:1536 dimensions
-   * *   text-embedding-v2:1536 dimensions
-   * *   text-embedding-v3 (default):1024, 768, and 512 dimensions
-   * *   text2vec: 1024 dimensions
-   * *   m3e-base: 768 dimensions
-   * *   m3e-small: 512 dimensions
+   * The embedding model. Valid values:
+   * - text-embedding-v1: 1536 dimensions
+   * - text-embedding-v2: 1536 dimensions
+   * - text-embedding-v3 (default): 1024, 768, or 512 dimensions
+   * - text2vec (not recommended): 1024 dimensions
+   * - m3e-base (not recommended): 768 dimensions
+   * - m3e-small (not recommended): 512 dimensions
    * 
    * @example
    * text-embedding-v3
@@ -51,7 +49,7 @@ export class TextEmbeddingRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 

package/src/models/TextEmbeddingResponseBody.ts

@@ -86,7 +86,7 @@ export class TextEmbeddingResponseBodyResults extends $dara.Model {
 export class TextEmbeddingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned message.
+   * The message details.
    * 
    * @example
    * Successful
@@ -94,7 +94,7 @@ export class TextEmbeddingResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -103,10 +103,9 @@ export class TextEmbeddingResponseBody extends $dara.Model {
   results?: TextEmbeddingResponseBodyResults;
   /**
    * @remarks
-   * The status of the operation. Valid values:
-   * 
-   * *   **success**
-   * *   **fail**
+   * The API execution status. Valid values:
+   * - **success**: The execution is successful.
+   * - **fail**: The execution failed.
    * 
    * @example
    * success

package/src/models/TextEmbeddingShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class TextEmbeddingShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,10 @@ export class TextEmbeddingShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The number of embedding dimensions. The default value is the number of dimensions supported by the embedding algorithm.
+   * The vector dimensions. Default value: the dimensions supported by the embedding model.
    * 
    * > 
-   * 
-   * *   The text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.
+   * > - text-embedding-v3 supports 1024, 768, and 512 dimensions. Default value: 1024.
    * 
    * @example
    * 1024
@@ -27,7 +26,7 @@ export class TextEmbeddingShrinkRequest extends $dara.Model {
   dimension?: number;
   /**
    * @remarks
-   * A list of text content to be embedded. The list length must not exceed 100.
+   * The list of text content to vectorize. The list can contain up to 100 entries.
    * 
    * @example
    * What is ADBPG?
@@ -35,14 +34,13 @@ export class TextEmbeddingShrinkRequest extends $dara.Model {
   inputShrink?: string;
   /**
    * @remarks
-   * The text embedding model. Valid values:
-   * 
-   * *   text-embedding-v1:1536 dimensions
-   * *   text-embedding-v2:1536 dimensions
-   * *   text-embedding-v3 (default):1024, 768, and 512 dimensions
-   * *   text2vec: 1024 dimensions
-   * *   m3e-base: 768 dimensions
-   * *   m3e-small: 512 dimensions
+   * The embedding model. Valid values:
+   * - text-embedding-v1: 1536 dimensions
+   * - text-embedding-v2: 1536 dimensions
+   * - text-embedding-v3 (default): 1024, 768, or 512 dimensions
+   * - text2vec (not recommended): 1024 dimensions
+   * - m3e-base (not recommended): 768 dimensions
+   * - m3e-small (not recommended): 512 dimensions
    * 
    * @example
    * text-embedding-v3
@@ -51,7 +49,7 @@ export class TextEmbeddingShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 

package/src/models/UntagSupabaseProjectRequest.ts

@@ -5,13 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class UntagSupabaseProjectRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to remove all tags from the instance. This parameter takes effect only when `TagKey.N` is not specified. Valid values:
+   * Specifies whether to unbind all tags from the instance. This parameter takes effect only when TagKey.N is not specified in the request. Valid values:
    * 
    * - true
-   * 
    * - false
    * 
-   * Default value: false
+   * Default value: false.
    * 
    * @example
    * false
@@ -27,16 +26,14 @@ export class UntagSupabaseProjectRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The instance IDs. You can specify up to 50 instance IDs.
+   * The instance ID. Valid values of N: 1 to 50.
    */
   resourceId?: string[];
   /**
    * @remarks
    * The resource type. Valid values:
-   * 
-   * - `instance`: a reserved mode instance.
-   * 
-   * - `ALIYUN::GPDB::INSTANCE`: an elastic mode instance.
+   * - `instance`: reserved mode instance.
+   * - `ALIYUN::GPDB::INSTANCE`: elastic mode instance.
    * 
    * @example
    * instance
@@ -44,7 +41,7 @@ export class UntagSupabaseProjectRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
-   * The keys of the tags that you want to remove. You can specify up to 20 tag keys.
+   * The tag key of the resource. Valid values of N: 1 to 20.
    */
   tagKey?: string[];
   static names(): { [key: string]: string } {

package/src/models/UntagSupabaseProjectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UntagSupabaseProjectResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad

package/src/models/UpgradeDbinstanceRequest.ts

@@ -5,8 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpgradeDBInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies the cache storage for Serverless Pro instances. Unit: GB.
-   * 
+   * The Serverless cache storage capacity. Unit: GB.
    * > This parameter is required only for Serverless Pro instances.
    * 
    * @example
@@ -15,7 +14,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   cacheStorageSize?: string;
   /**
    * @remarks
-   * This parameter is deprecated.
+   * This parameter is deprecated. You do not need to specify this parameter.
    * 
    * @example
    * null
@@ -23,7 +22,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   DBInstanceClass?: string;
   /**
    * @remarks
-   * This parameter is deprecated.
+   * This parameter is deprecated. You do not need to specify this parameter.
    * 
    * @example
    * null
@@ -43,9 +42,9 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The specifications of segment nodes. For supported node specifications, see [Instance types](https://help.aliyun.com/document_detail/35406.html).
+   * The specifications of segment nodes. For information about supported node specifications, see [Instance specifications](https://help.aliyun.com/document_detail/35406.html).
    * 
-   * > This parameter is available only for instances in storage-elastic mode.
+   * > This parameter is supported only for elastic storage mode instances.
    * 
    * @example
    * 4C16G
@@ -53,7 +52,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   instanceSpec?: string;
   /**
    * @remarks
-   * The number of master nodes.
+   * This parameter is deprecated. You do not need to specify this parameter.
    * 
    * @example
    * null
@@ -62,7 +61,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * This parameter is deprecated.
+   * This parameter is deprecated. You do not need to specify this parameter.
    * 
    * @example
    * null
@@ -80,7 +79,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group to which the instance belongs. To obtain the resource group ID, see [View basic information of a resource group](https://help.aliyun.com/document_detail/151181.html).
+   * The ID of the resource group to which the instance belongs. For information about how to obtain the resource group ID, see [View basic information of a resource group](https://help.aliyun.com/document_detail/151181.html).
    * 
    * @example
    * rg-bp67acfmxazb4p****
@@ -88,12 +87,10 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The performance level (PL) of the disk. Valid values:
+   * The performance level (PL) of the cloud disk. Valid values:
    * 
    * - **pl0**: PL0.
-   * 
    * - **pl1**: PL1.
-   * 
    * - **pl2**: PL2.
    * 
    * @example
@@ -102,13 +99,11 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   segDiskPerformanceLevel?: string;
   /**
    * @remarks
-   * The number of segment nodes. The supported number of nodes varies based on the instance resource type and edition:
-   * 
-   * - Instances in storage-elastic mode (High-availability Edition): 4 to 512, in increments of 4.
-   * 
-   * - Instances in storage-elastic mode (High-performance Edition): 2 to 512, in increments of 2.
+   * The number of segment nodes. The supported number of nodes varies based on the instance resource type and instance edition:
    * 
-   * - Instances in Serverless manual-scheduling mode: 2 to 512, in increments of 2.
+   * - Elastic storage mode, High-availability Edition: Valid values: 4 to 512. The value must be a multiple of 4.
+   * - Elastic storage mode, <props="china">Basic Edition (formerly High-performance Edition)<props="intl">High-performance Edition: Valid values: 2 to 512. The value must be a multiple of 2.
+   * - Serverless manual scheduling mode: Valid values: 2 to 512. The value must be a multiple of 2.
    * 
    * @example
    * 2
@@ -116,7 +111,7 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   segNodeNum?: string;
   /**
    * @remarks
-   * The new disk storage type. You can only upgrade to an ESSD cloud disk. To do so, set this parameter to **cloud_essd**.
+   * The cloud disk storage type after the change. Currently, only ESSD cloud disks are supported. Set the value to **cloud_essd**.
    * 
    * @example
    * cloud_essd
@@ -124,21 +119,16 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   segStorageType?: string;
   /**
    * @remarks
-   * - For an instance in Serverless automatic-scheduling mode, this parameter specifies the computing resource threshold. The value must be a multiple of 8 in the range of 8 to 32. Unit: ACU. Default value: 32.
-   * 
-   * - For a Serverless Pro instance, this parameter specifies the reserved computing resources. Valid values range from 16 to 1,024. Unit: ACU. Default value: 16. Increment rules:
-   * 
-   *   - 16 to 32: in increments of 4.
-   * 
-   *   - 32 to 64: in increments of 8.
-   * 
-   *   - 64 to 128: in increments of 16.
+   * - Serverless instances:
+   * The compute resource threshold. Valid values: 8 to 32. The value must be a multiple of 8. Unit: ACU. Default value: 32.
    * 
-   *   - 128 to 256: in increments of 32.
-   * 
-   *   - Greater than 256: in increments of 64.
-   * 
-   * > This parameter is required only for instances in Serverless automatic-scheduling mode and Serverless Pro instances.
+   * - Serverless Pro instances: The reserved compute resources. Valid values: 16 to 1024. Unit: ACU. Default value: 16. The step size varies based on the value range:
+   *   - 16 to 32: step size of 4.
+   *   - 32 to 64: step size of 8.
+   *   - 64 to 128: step size of 16.
+   *   - 128 to 256: step size of 32.
+   *   - Greater than 256: step size of 64.
+   * > This parameter is required only for Serverless automatic scheduling mode and Serverless Pro instances.
    * 
    * @example
    * 16
@@ -146,9 +136,9 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   serverlessResource?: string;
   /**
    * @remarks
-   * The storage capacity of each segment node. Unit: GB. The value must be a multiple of 50 in the range of 50 to <props="china">8,000<props="intl">6,000.
+   * The storage capacity of segment nodes. Unit: GB. Valid values: 50 to <props="china">8000<props="intl">6000. The value must be a multiple of 50.
    * 
-   * > This parameter is available only for instances in storage-elastic mode.
+   * > This parameter is supported only for elastic storage mode instances.
    * 
    * @example
    * 100
@@ -156,23 +146,17 @@ export class UpgradeDBInstanceRequest extends $dara.Model {
   storageSize?: string;
   /**
    * @remarks
-   * The type of specification change. Valid values:
-   * 
-   * - **0** (default): Changes the number of segment nodes. The SegNodeNum parameter is required, and other parameters are ignored.
-   * 
-   * - **1**: Changes the specifications and storage capacity of segment nodes. The InstanceSpec parameter is required. The StorageSize parameter is optional. If specified, its value must be greater than or equal to the current storage capacity of the instance.
-   * 
-   * - **2**: Changes the number of master nodes. The MasterNodeNum parameter is required, and other parameters are ignored.
-   * 
-   * - **3**: Changes the disk storage type and performance level. The SegDiskPerformanceLevel and SegStorageType parameters are required, and other parameters are ignored.
-   * 
-   * > * Support for scaling computing resources varies by instance resource type. For more information, see [Usage notes](https://help.aliyun.com/document_detail/50956.html).
-   * 
-   * - If you select a change type, only the parameters associated with that type take effect; other parameters are ignored. For example, if you set **UpgradeType** to 0 and specify parameters to change both the number of segment nodes and the number of master nodes, only the parameters for changing the number of segment nodes take effect.
+   * The type of the specification change. Valid values:
    * 
-   * - You can change the number of master nodes only on the Alibaba Cloud China site.
+   * - **0** (default): Changes the number of segment nodes. SegNodeNum is required. Other parameters do not take effect.
+   * - **1**: Changes the segment node specifications and instance storage capacity. InstanceSpec is required. StorageSize is optional and must be greater than or equal to the current instance storage capacity.
+   * - **2**: Changes the number of master nodes. MasterNodeNum is required. Other parameters do not take effect.
+   * - **3**: Changes the cloud disk storage type and performance level (PL). SegDiskPerformanceLevel and SegStorageType are required. Other parameters do not take effect.
    * 
-   * - You can change the disk storage type only from ultra disk to ESSD cloud disk.
+   * > - Different instance resource types support different Upgrade/Downgrade operations for compute nodes. For more information, see [Precautions](https://help.aliyun.com/document_detail/50956.html).
+   * - After you select a specification change type, only the corresponding parameters take effect. Other parameters do not take effect. For example, if **UpgradeType** is set to 0 and you specify both the number of segment nodes and the number of master nodes, only the number of segment nodes is changed.
+   * - Changing the number of master nodes is supported only on the China site (aliyun.com).
+   * - You can change the cloud disk storage type only from standard SSD to ESSD cloud disk.
    * 
    * @example
    * 0