@alicloud/gpdb20160503 3.4.1 → 3.6.0

package/src/models/QueryCollectionDataRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryCollectionDataRequestRelationalTableFilter extends $dara.Model {
   /**
    * @remarks
-   * The Metadata field of the vector collection, used to associate with the fields in the vector table.
+   * The metadata field of the vector collection, which is used to associate with the fields of the vector table.
    * 
    * @example
    * doc_id
@@ -13,7 +13,7 @@ export class QueryCollectionDataRequestRelationalTableFilter extends $dara.Model
   collectionMetadataField?: string;
   /**
    * @remarks
-   * The filtering condition for the relational table.
+   * The filter conditions for the relational table.
    * 
    * @example
    * tags @> ARRAY[\\"art\\"]
@@ -21,7 +21,7 @@ export class QueryCollectionDataRequestRelationalTableFilter extends $dara.Model
   condition?: string;
   /**
    * @remarks
-   * The field in the relational table, used to associate with the Metadata field of the vector collection.
+   * The field of the relational table, which is used to associate with the metadata field of the vector collection.
    * 
    * @example
    * id
@@ -63,7 +63,17 @@ export class QueryCollectionDataRequestRelationalTableFilter extends $dara.Model
 }
 
 export class QueryCollectionDataRequestSparseVector extends $dara.Model {
+  /**
+   * @remarks
+   * The array of indexes.
+   * 
+   * > The number of elements in the array cannot exceed 4,000.
+   */
   indices?: number[];
+  /**
+   * @remarks
+   * The array of sparse vectors.
+   */
   values?: number[];
   static names(): { [key: string]: string } {
     return {
@@ -97,9 +107,9 @@ export class QueryCollectionDataRequestSparseVector extends $dara.Model {
 export class QueryCollectionDataRequest extends $dara.Model {
   /**
    * @remarks
-   * Collection name.
+   * The name of the collection.
    * 
-   * > You can use the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) API to view the list.
+   * > You can call the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) operation to list available collections.
    * 
    * This parameter is required.
    * 
@@ -109,9 +119,9 @@ export class QueryCollectionDataRequest extends $dara.Model {
   collection?: string;
   /**
    * @remarks
-   * Content for full-text search. When this value is empty, only vector search is used; when it is not empty, both vector and full-text search are used.
+   * The content for full-text search. If this parameter is omitted, only vector search is performed. If this parameter is specified, the system performs a hybrid search of vector search and full-text search.
    * 
-   * > The Vector parameter cannot be empty at the same time.
+   * > You must specify one of the Content and Vector parameters.
    * 
    * @example
    * hello_world
@@ -119,9 +129,9 @@ export class QueryCollectionDataRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The ID of the instance.
    * 
-   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query details for all AnalyticDB for PostgreSQL instances in a region, including their instance IDs.
    * 
    * @example
    * gp-xxxxxxxxx
@@ -129,24 +139,25 @@ export class QueryCollectionDataRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Filter conditions for the data to be queried, in SQL WHERE format. It is an expression that returns a boolean value (true or false). Conditions can be simple comparison operators such as equal (=), not equal (<> or !=), greater than (>), less than (<), greater than or equal to (>=), less than or equal to (<=), or more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using keywords like IN, BETWEEN, and LIKE.
+   * The filter conditions for data retrieval. It is in the format of a WHERE clause in SQL. This expression returns a boolean value, which can be a simple comparison operator, such as `=`, `<>`, `!=`, `>`, `<`, `>=`, and `<=`, or a more complex expression combined with logical operators, such as `AND`, `OR`, and `NOT`, and keywords such as `IN`, `BETWEEN`, and `LIKE`.
    * 
-   * > 
-   * > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/
+   * > - For more information about the syntax, see [PostgreSQL WHERE](https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/).
    * 
    * @example
-   * response > 200
+   * pipeline_id=\\"1yhpmo0rbn\\" AND (spu=\\"10025667796135\\" AND dept_id=\\"226\\")
    */
   filter?: string;
   /**
    * @remarks
-   * Dual-path recall algorithm, default is empty (i.e., directly compare and sort the scores of vectors and full-text).
+   * The hybrid search algorithm. If this parameter is empty, the system ranks results by directly comparing the scores from the vector search and the full-text search.
+   * 
+   * Valid values:
    * 
-   * Available values:
+   * - `RRF`: Reciprocal Rank Fusion. This algorithm has a parameter k to control the fusion effect. For more information, see the description of the `HybridSearchArgs` parameter.
    * 
-   * - RRF: Reciprocal rank fusion, with a parameter k controlling the fusion effect. See HybridSearchArgs configuration for details;
-   * - Weight: Weighted sorting, using a parameter alpha to control the score ratio of vectors and full-text, then sorting. See HybridSearchArgs configuration for details;
-   * - Cascaded: Perform full-text search first, then vector search based on the full-text results;
+   * - `Weight`: weighted sort. This algorithm uses a parameter alpha to control the score ratio of vector search and full-text search, and then sorts the results. For more information about the parameter, see the `HybridSearchArgs` parameter.
+   * 
+   * - `Cascaded`: performs a full-text search, and then performs a vector search on the search results.
    * 
    * @example
    * RRF
@@ -154,43 +165,56 @@ export class QueryCollectionDataRequest extends $dara.Model {
   hybridSearch?: string;
   /**
    * @remarks
-   * The parameters of the two-way retrieval algorithm. The following parameters are supported:
-   * 
-   * *   When HybridSearch is set to RRF, the scores are calculated by using the `1/(k+rank_i)` formula. The constant k is a positive integer that is greater than 1.
-   * 
-   * <!---->
-   * 
-   *     { 
-   *        "RRF": {
-   *         "k": 60
-   *        }
-   *     }
-   * 
-   * *   When HybridSearch is set to Weight, the scores are calculated by using the `alpha * vector_score + (1-alpha) * text_score` formula. The alpha parameter specifies the proportion of the vector search score and the full-text search score and ranges from 0 to 1. A value of 0 specifies full-text search and a value of 1 specifies vector search.
-   * 
-   * <!---->
-   * 
-   *     { 
-   *        "Weight": {
-   *         "alpha": 0.5
-   *        }
-   *     }
+   * The parameters for the hybrid search algorithm. The following algorithms are supported: RRF and Weight.
+   * 
+   * - For RRF, specify the constant k in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1. The format is as follows:
+   * 
+   * ```
+   * { 
+   *    "RRF": {
+   *     "k": 60
+   *    }
+   * }
+   * ```
+   * 
+   * - For Weight, in the formula `alpha * vector_score + (1-alpha) * text_score`, the alpha parameter indicates the score ratio of the vector search to the full-text search. The value ranges from 0 to 1. 0 indicates that only the full-text search is used, and 1 indicates that only the vector search is used.
+   * 
+   * ```
+   * { 
+   *    "Weight": {
+   *     "alpha": 0.5
+   *    }
+   * }
+   * ```
    */
   hybridSearchArgs?: { [key: string]: {[key: string]: any} };
   /**
    * @remarks
-   * Defaults to empty, indicating the metadata fields to return. Multiple fields should be separated by commas.
+   * This parameter is left empty by default. It specifies the metadata fields to be returned. You can specify multiple fields and separate them with commas (,).
    * 
    * @example
    * title,content
    */
   includeMetadataFields?: string;
+  /**
+   * @remarks
+   * Specifies whether to return sparse vector data. Valid values:
+   * 
+   * - **true**: returns sparse vector data.
+   * 
+   * - **false**: does not return sparse vector data.
+   * 
+   * @example
+   * false
+   */
   includeSparseValues?: boolean;
   /**
    * @remarks
-   * Whether to return vector data. Value descriptions:
-   * - **true**: Return vector data.
-   * - **false**: Do not return vector data, used for full-text search scenarios.
+   * Specifies whether to return dense vector data. Valid values:
+   * 
+   * - **true**: returns dense vector data.
+   * 
+   * - **false**: does not return dense vector data.
    * 
    * @example
    * true
@@ -198,12 +222,15 @@ export class QueryCollectionDataRequest extends $dara.Model {
   includeValues?: boolean;
   /**
    * @remarks
-   * Similarity algorithm used during retrieval. Value descriptions:
-   * - **l2**: Euclidean distance.
-   * - **ip**: Inner product (dot product) distance.
-   * - **cosine**: Cosine similarity.
+   * The similarity algorithm for search. Valid values:
    * 
-   * > If this value is empty, the algorithm specified during index creation is used.
+   * - **l2**: the Euclidean distance.
+   * 
+   * - **ip**: the dot product distance.
+   * 
+   * - **cosine**: the cosine similarity.
+   * 
+   * > If this parameter is not specified, the algorithm specified when the index is created is used.
    * 
    * @example
    * cosine
@@ -211,9 +238,9 @@ export class QueryCollectionDataRequest extends $dara.Model {
   metrics?: string;
   /**
    * @remarks
-   * Namespace.
+   * The name of the namespace.
    * 
-   * > You can use the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) API to view the list.
+   * > You can call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to list available namespaces.
    * 
    * @example
    * mynamespace
@@ -221,7 +248,7 @@ export class QueryCollectionDataRequest extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * Password for the namespace.
+   * The password for the namespace.
    * 
    * This parameter is required.
    * 
@@ -231,12 +258,15 @@ export class QueryCollectionDataRequest extends $dara.Model {
   namespacePassword?: string;
   /**
    * @remarks
-   * Defaults to empty, indicating the starting point for pagination queries. Does not support hybrid search scenarios.
+   * This parameter is left empty by default. It specifies the start position of a paged query. This parameter is not supported in hybrid search.
+   * 
+   * The value must be greater than or equal to 0. When this parameter is not empty, Total in the response indicates the total number of hits. This parameter is used with TopK. For example, if you want to retrieve chunks 0 to 44 with a page size of 20, you must send three requests:
    * 
-   * The value must be >= 0. When this value is not empty, it will return `Total`, which indicates the total number of hits. This parameter works with `TopK`. For example, to paginate 20 and retrieve chunks with `chunk_id` from 0 to 44, you need to make three requests:
-   * - `Offset=0, TopK=20` returns `chunk_id` 0~19
-   * - `Offset=20, TopK=20` returns `chunk_id` 20~39
-   * - `Offset=30, TopK=20` returns `chunk_id` 40~44
+   * - `Offset=0, TopK=20` returns chunks 0 to 19.
+   * 
+   * - `Offset=20, TopK=20` returns chunks 20 to 39.
+   * 
+   * - `Offset=40, TopK=20` returns chunks 40 to 44.
    * 
    * @example
    * 0
@@ -244,12 +274,15 @@ export class QueryCollectionDataRequest extends $dara.Model {
   offset?: number;
   /**
    * @remarks
-   * Defaults to empty, indicating the field for sorting. Does not support hybrid search scenarios.
+   * This parameter is left empty by default. It specifies the field based on which to sort the results. This parameter is not supported in hybrid search.
+   * 
+   * The field must be a metadata field or a default field in the table, such as `id`. The following formats are supported:
+   * 
+   * - A single field, such as `chunk_id`.
+   * 
+   * - Multiple fields separated by commas (,), such as `block_id, chunk_id`.
    * 
-   * The field must belong to metadata or be a default field in the table, such as `id`. The supported formats are:
-   * - A single field, e.g., `chunk_id`;
-   * - Multiple fields, separated by commas, e.g., `block_id, chunk_id`;
-   * - Supports reverse order, e.g., `block_id DESC, chunk_id DESC`;
+   * - Descending order, such as `block_id DESC, chunk_id DESC`.
    * 
    * @example
    * chunk_id
@@ -258,7 +291,7 @@ export class QueryCollectionDataRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * Region ID where the instance is located.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 
@@ -268,15 +301,19 @@ export class QueryCollectionDataRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Uses another relational table to filter vector data (similar to a Join function).
+   * Uses another relational table to filter vector data, which is similar to the JOIN operation.
    * 
-   * > Data from the relational table can be returned by setting the `IncludeMetadataFields` parameter. For example, `rds_table_name.id` indicates returning the `id` field from the relational table.
+   * > The data of the relational table can be returned by setting the IncludeMetadataFields parameter. For example, `rds_table_name.id` indicates that the id field of the relational table is returned.
    */
   relationalTableFilter?: QueryCollectionDataRequestRelationalTableFilter;
+  /**
+   * @remarks
+   * The sparse vector data.
+   */
   sparseVector?: QueryCollectionDataRequestSparseVector;
   /**
    * @remarks
-   * Set the number of top results to return.
+   * Specifies the number of top results to return.
    * 
    * This parameter is required.
    * 
@@ -286,13 +323,16 @@ export class QueryCollectionDataRequest extends $dara.Model {
   topK?: number;
   /**
    * @remarks
-   * Vector data, with the same dimension as specified in the [CreateCollection](https://help.aliyun.com/document_detail/2401497.html) API.
-   * > When the vector is empty, only full-text search results are returned.
+   * The vector data. The length of the vector data must be the same as that specified in the [CreateCollection](https://help.aliyun.com/document_detail/2401497.html) operation.
+   * 
+   * > - If `SparseVector` is empty, only the dense vector search results are returned.
+   * >
+   * > - If both `Vector` and `SparseVector` are empty, only the full-text search results are returned.
    */
   vector?: number[];
   /**
    * @remarks
-   * The ID of the Workspace composed of multiple database instances. This parameter and `DBInstanceId` cannot both be empty. If both are specified, this parameter takes precedence.
+   * The ID of the workspace that consists of multiple database instances. You must specify this parameter or the DBInstanceId parameter. If both this parameter and DBInstanceId are specified, this parameter is used.
    * 
    * @example
    * gp-ws-*****

package/src/models/QueryCollectionDataResponseBody.ts

@@ -189,10 +189,14 @@ export class QueryCollectionDataResponseBodyMatches extends $dara.Model {
 }
 
 export class QueryCollectionDataResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The matched results.
+   */
   matches?: QueryCollectionDataResponseBodyMatches;
   /**
    * @remarks
-   * Detailed information when the request fails.
+   * Details about the error, returned if the request fails.
    * 
    * @example
    * 0.1234
@@ -200,7 +204,7 @@ export class QueryCollectionDataResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -208,9 +212,11 @@ export class QueryCollectionDataResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Status, with the following values:
-   * - **success**: Success.
-   * - **fail**: Failure.
+   * The status of the request. Valid values:
+   * 
+   * - **success**: The request was successful.
+   * 
+   * - **fail**: The request failed.
    * 
    * @example
    * success
@@ -218,7 +224,7 @@ export class QueryCollectionDataResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Only returned when the Offset is not 0, this value represents the total number of hits for the search criteria.
+   * The total number of hits for the search. This parameter is returned only when the Offset parameter in the request is not 0.
    * 
    * @example
    * 100