@alicloud/gpdb20160503 3.5.0 → 3.7.0

package/src/models/CreateCollectionShrinkRequest.ts

@@ -3,12 +3,27 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCollectionShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The vector index algorithm.
+   * 
+   * Valid values:
+   * 
+   * - `hnswflat`: (Default) An HNSW index without quantization compression.
+   * 
+   * - `novam`: A graph index without quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.
+   * 
+   * - `novad`: A partitioned index with `rabitq` quantization. This algorithm is suitable for large-scale, low-cost retrieval scenarios.
+   * 
+   * @example
+   * hnswflat
+   */
   algorithm?: string;
   /**
    * @remarks
-   * The name of the collection that you want to create.
+   * The name of the collection to create.
    * 
-   * >  The name must comply with the naming conventions of PostgreSQL objects.
+   * > The name must comply with PostgreSQL object naming conventions.
    * 
    * This parameter is required.
    * 
@@ -20,17 +35,17 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
    * 
    * @example
-   * gp-xxxxxxxxx
+   * gp-bp152460513z****
    */
   DBInstanceId?: string;
   /**
    * @remarks
-   * The number of vector dimensions.
+   * The vector dimension.
    * 
-   * >  If you specify this parameter, an index is created. When you call the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) operation, make sure that the length of the Rows.Vector parameter is the same as the value of this parameter. If you do not specify this parameter, you can call the [CreateVectorIndex](https://help.aliyun.com/document_detail/2401499.html) operation to create an index.
+   * > If you specify this parameter, a vector index is created. In subsequent calls to the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) operation, the length of `Rows.Vector` must match this dimension. If you do not specify this parameter, you must call the [CreateVectorIndex](https://help.aliyun.com/document_detail/2401499.html) operation to create an index later.
    * 
    * @example
    * 1024
@@ -38,13 +53,17 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   dimension?: number;
   /**
    * @remarks
-   * Specifies whether to use the memory mapping technology to create HNSW indexes. Valid values: 0 and 1. Default value: 0. We recommend that you set the value to 1 in scenarios that require upload speed but not data deletion.
+   * Specifies whether to use `mmap` to build the HNSW index. The default value is 0. We recommend setting this to 1 if your data does not require deletion and you need high-performance data ingestion.
+   * 
+   * Valid values:
    * 
-   * > 
+   * - `0`: (Default) Builds the index by using segmented page storage. This mode can use the `shared_buffer` in PostgreSQL for caching and supports `DELETE` and `UPDATE` operations.
    * 
-   * *   0: uses segmented paging storage to create indexes. This method uses the shared buffer of PostgreSQL for caching and supports the delete and update operations.
+   * - `1`: Builds the index by using `mmap`. This mode does not support `DELETE` or `UPDATE` operations.
    * 
-   * *   1: uses the memory mapping technology to create indexes. This method does not support the delete or update operation.
+   * >Notice: 
+   * 
+   * The `ExternalStorage` parameter is available only for AnalyticDB for PostgreSQL v6.0 instances and is not supported in v7.0.
    * 
    * @example
    * 0
@@ -52,26 +71,45 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   externalStorage?: number;
   /**
    * @remarks
-   * The fields used for full-text search. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.
+   * The fields to use for full-text search. Use commas (`,`) to separate multiple field names. These fields must be keys defined in the `Metadata` parameter.
    * 
    * @example
    * title,content
    */
   fullTextRetrievalFields?: string;
-  hnswEfConstruction?: string;
   /**
    * @remarks
-   * The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. Valid values: 1 to 1000. In most cases, this parameter is automatically configured based on the value of the Dimension parameter. You do not need to configure this parameter.
-   * 
-   * >  We recommend that you configure this parameter based on the value of the Dimension parameter.
-   * 
-   * *If you set Dimension to a value less than or equal to 384, set the value of HnswM to 16.
-   * 
-   * *If you set Dimension to a value greater than 384 and less than or equal to 768, set the value of HnswM to 32.
+   * The size of the candidate set for HNSW index construction. The value must be greater than or equal to `2 * HnswM`.
    * 
-   * *If you set Dimension to a value greater than 768 and less than or equal to 1024, set the value of HnswM to 64.
+   * > Value range:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 40 to 4000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 4 to 1000. The default value is 64.
    * 
-   * *If you set Dimension to a value greater than 1024, set the value of HnswM to 128.
+   * @example
+   * 128
+   */
+  hnswEfConstruction?: string;
+  /**
+   * @remarks
+   * The maximum number of neighbors for the HNSW algorithm. You do not typically need to set this parameter, as the system automatically determines a value based on the vector dimension.
+   * 
+   * > Value range:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.
+   * 
+   * > We recommend that you set this parameter based on the vector dimension:
+   * >
+   * > - 16 for dimensions less than or equal to 384.
+   * >
+   * > - 32 for dimensions greater than 384 and less than or equal to 768.
+   * >
+   * > - 64 for dimensions greater than 768 and less than or equal to 1024.
+   * >
+   * > - 128 for dimensions greater than 1024.
    * 
    * @example
    * 64
@@ -79,9 +117,9 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   hnswM?: number;
   /**
    * @remarks
-   * Name of the management account with rds_superuser permissions.
+   * The name of the management account that has the `rds_superuser` privilege.
    * 
-   * > You can create an account through the console -> Account Management, or by using the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) API.
+   * > You can call the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) operation to create an account.
    * 
    * This parameter is required.
    * 
@@ -91,7 +129,7 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   managerAccount?: string;
   /**
    * @remarks
-   * The password of the manager account.
+   * The password of the management account.
    * 
    * This parameter is required.
    * 
@@ -101,17 +139,17 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   managerAccountPassword?: string;
   /**
    * @remarks
-   * The metadata of the vector data, which is a JSON string in the MAP format. The key specifies the field name, and the value specifies the data type.
-   * 
-   * >  Supported data types:
-   * 
-   * *   For information about the supported data types, see [Data types](https://www.alibabacloud.com/help/zh/analyticdb/analyticdb-for-postgresql/developer-reference/data-types-1/).
+   * A JSON string that defines the metadata schema as a map. The keys are field names, and the values are their corresponding data types.
    * 
-   * *   The money data type is not supported.
+   * > Supported data types
+   * >
+   * > - For a list of supported data types, see [Data types](https://help.aliyun.com/document_detail/424383.html).
+   * >
+   * > - The `money` data type is not supported.
    * 
-   * **
+   * >Warning: 
    * 
-   * **Warning** Reserved fields such as id, vector, to_tsvector, and source cannot be used.
+   * The field names `id`, `vector`, `to_tsvector`, and `source` are reserved and cannot be used.
    * 
    * This parameter is required.
    * 
@@ -121,7 +159,7 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   metadata?: string;
   /**
    * @remarks
-   * The scalar index fields. Separate multiple fields with commas (,). These fields must be keys defined in Metadata.
+   * The scalar index fields. Separate multiple fields with commas (`,`). The fields must be keys that are defined in `Metadata`.
    * 
    * @example
    * title
@@ -129,11 +167,13 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   metadataIndices?: string;
   /**
    * @remarks
-   * The method that is used to create vector indexes. Valid values:
+   * The distance metric used to build the vector index. Valid values:
+   * 
+   * - `l2`: Euclidean distance.
+   * 
+   * - `ip`: dot product.
    * 
-   * *   l2: Euclidean distance.
-   * *   ip: inner product distance.
-   * *   cosine: cosine similarity.
+   * - `cosine`: cosine similarity.
    * 
    * @example
    * cosine
@@ -141,9 +181,9 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   metrics?: string;
   /**
    * @remarks
-   * The name of the namespace.
+   * The namespace.
    * 
-   * >  You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace and call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to query a list of namespaces.
+   * > You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace or the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to list existing namespaces.
    * 
    * @example
    * mynamespace
@@ -152,7 +192,7 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The analyzer that is used for full-text search.
+   * The parser for full-text search. The default is `zh_cn`.
    * 
    * @example
    * zh_cn
@@ -160,18 +200,19 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
   parser?: string;
   /**
    * @remarks
-   * Specifies whether to enable the product quantization (PQ) feature for index acceleration. We recommend that you enable this feature for more than 500,000 rows of data. Valid values:
+   * Specifies whether to enable Product Quantization (PQ) for index acceleration. This is recommended for datasets with more than 500,000 entries. Valid values:
    * 
-   * *   0: no.
-   * *   1 (default): yes.
+   * - `0`: Disabled.
+   * 
+   * - `1`: (Default) Enabled.
    * 
    * @example
-   * 0
+   * 1
    */
   pqEnable?: number;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The ID of the region where the instance is located.
    * 
    * This parameter is required.
    * 
@@ -179,12 +220,27 @@ export class CreateCollectionShrinkRequest extends $dara.Model {
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The configuration for the sparse vector index. If specified, a sparse vector index is created.
+   */
   sparseVectorIndexConfigShrink?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable support for sparse vectors. The default value is `false`.
+   * 
+   * @example
+   * true
+   */
   supportSparse?: boolean;
+  /**
+   * @remarks
+   * The configuration for the dense vector index.
+   */
   vectorIndexConfigShrink?: string;
   /**
    * @remarks
-   * The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes effect.
+   * The ID of the workspace, which contains multiple database instances. You must specify either `WorkspaceId` or `DBInstanceId`. If both are specified, `WorkspaceId` takes precedence.
    * 
    * @example
    * gp-ws-*****

package/src/models/CreateDbinstancePlanRequest.ts

@@ -45,7 +45,7 @@ export class CreateDBInstancePlanRequest extends $dara.Model {
    * *   If you do not specify this parameter, the plan stops until the plan is deleted.
    * 
    * @example
-   * 2023-04-17T23:00Z
+   * 2023-04-17T23:00:00Z
    */
   planEndDate?: string;
   /**
@@ -82,7 +82,7 @@ export class CreateDBInstancePlanRequest extends $dara.Model {
    * *   If you do not specify this parameter, the current time is used.
    * 
    * @example
-   * 2022-04-17T23:00Z
+   * 2022-04-17T23:00:00Z
    */
   planStartDate?: string;
   /**