@alicloud/gpdb20160503 3.11.0 → 3.11.1

package/src/models/ListApiKeysRequest.ts

@@ -4,27 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListApiKeysRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the API key.
+   * 
    * @example
    * my api
    */
   keyName?: string;
   /**
+   * @remarks
+   * The maximum number of records to return in this query.
+   * 
    * @example
    * 50
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next query.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
    * @remarks
+   * The workspace ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListApiKeysResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListApiKeysResponseBodyItemsAuthServices extends $dara.Model {
   /**
+   * @remarks
+   * The service IDs.
+   * 
    * @example
    * agdb-xxxxxx
    */
   serviceId?: string;
   /**
+   * @remarks
+   * The service type.
+   * 
+   * Valid values:
+   * - memory
+   * - drama
+   * 
    * @example
    * memory
    */
@@ -37,28 +47,47 @@ export class ListApiKeysResponseBodyItemsAuthServices extends $dara.Model {
 }
 
 export class ListApiKeysResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The service IDs.
+   */
   authServices?: ListApiKeysResponseBodyItemsAuthServices[];
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2021-10-09T04:54:08Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The description of the API key.
+   * 
    * @example
    * my first api key
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the API key.
+   * 
    * @example
    * api-xxxxxxxx
    */
   keyId?: string;
   /**
+   * @remarks
+   * The name of the API key.
+   * 
    * @example
    * my first api key
    */
   keyName?: string;
   /**
+   * @remarks
+   * The prefix of the API key.
+   * 
    * @example
    * sk-12345****
    */
@@ -98,23 +127,39 @@ export class ListApiKeysResponseBodyItems extends $dara.Model {
 }
 
 export class ListApiKeysResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API keys.
+   */
   items?: ListApiKeysResponseBodyItems[];
   /**
+   * @remarks
+   * The maximum number of records to return in this query.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next page in a paged query.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 1
    */

package/src/models/ListSaasServiceRequest.ts

@@ -13,7 +13,7 @@ export class ListSaasServiceRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token for the next query when paging. Use this token to start the next query.
+   * The token for the next page when performing a paging query. This specifies the starting token for the next page.
    * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883

package/src/models/ListSaasServiceResponseBody.ts

@@ -2,7 +2,46 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class ListSaasServiceResponseBodyItemsComponents extends $dara.Model {
+  componentId?: string;
+  componentType?: string;
+  createTime?: string;
+  cu?: string;
+  deletionProtection?: boolean;
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      componentId: 'ComponentId',
+      componentType: 'ComponentType',
+      createTime: 'CreateTime',
+      cu: 'Cu',
+      deletionProtection: 'DeletionProtection',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      componentId: 'string',
+      componentType: 'string',
+      createTime: 'string',
+      cu: 'string',
+      deletionProtection: 'boolean',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ListSaasServiceResponseBodyItems extends $dara.Model {
+  components?: ListSaasServiceResponseBodyItemsComponents[];
   /**
    * @remarks
    * The creation time.
@@ -19,6 +58,7 @@ export class ListSaasServiceResponseBodyItems extends $dara.Model {
    * 1
    */
   cu?: number;
+  deletionProtection?: boolean;
   /**
    * @remarks
    * The expiration time.
@@ -40,7 +80,7 @@ export class ListSaasServiceResponseBodyItems extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * [Deprecated]
+   * **[Deprecated]**
    * 
    * @example
    * deprecated
@@ -86,8 +126,10 @@ export class ListSaasServiceResponseBodyItems extends $dara.Model {
   status?: string;
   static names(): { [key: string]: string } {
     return {
+      components: 'Components',
       createTime: 'CreateTime',
       cu: 'Cu',
+      deletionProtection: 'DeletionProtection',
       expireTime: 'ExpireTime',
       payType: 'PayType',
       plan: 'Plan',
@@ -100,8 +142,10 @@ export class ListSaasServiceResponseBodyItems extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      components: { 'type': 'array', 'itemType': ListSaasServiceResponseBodyItemsComponents },
       createTime: 'string',
       cu: 'number',
+      deletionProtection: 'boolean',
       expireTime: 'string',
       payType: 'string',
       plan: 'string',
@@ -113,6 +157,9 @@ export class ListSaasServiceResponseBodyItems extends $dara.Model {
   }
 
   validate() {
+    if(Array.isArray(this.components)) {
+      $dara.Model.validateArray(this.components);
+    }
     super.validate();
   }
 

package/src/models/ListWorkspacesResponseBody.ts

@@ -125,7 +125,46 @@ export class ListWorkspacesResponseBodyItemsApikeys extends $dara.Model {
   }
 }
 
+export class ListWorkspacesResponseBodyItemsServicesComponents extends $dara.Model {
+  createTime?: string;
+  cu?: string;
+  deletionProtection?: boolean;
+  status?: string;
+  componentId?: string;
+  componentType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      cu: 'Cu',
+      deletionProtection: 'DeletionProtection',
+      status: 'Status',
+      componentId: 'componentId',
+      componentType: 'componentType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      cu: 'string',
+      deletionProtection: 'boolean',
+      status: 'string',
+      componentId: 'string',
+      componentType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
+  components?: ListWorkspacesResponseBodyItemsServicesComponents[];
   /**
    * @remarks
    * The creation time.
@@ -142,6 +181,7 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
    * 1
    */
   cu?: string;
+  deletionProtection?: boolean;
   /**
    * @remarks
    * The expiration time.
@@ -166,7 +206,7 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * [Deprecated]
+   * **[Deprecated]**
    * 
    * @example
    * deprecated
@@ -212,8 +252,10 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
   status?: string;
   static names(): { [key: string]: string } {
     return {
+      components: 'Components',
       createTime: 'CreateTime',
       cu: 'Cu',
+      deletionProtection: 'DeletionProtection',
       expireTime: 'ExpireTime',
       payType: 'PayType',
       plan: 'Plan',
@@ -226,8 +268,10 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      components: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItemsServicesComponents },
       createTime: 'string',
       cu: 'string',
+      deletionProtection: 'boolean',
       expireTime: 'string',
       payType: 'string',
       plan: 'string',
@@ -239,6 +283,9 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
   }
 
   validate() {
+    if(Array.isArray(this.components)) {
+      $dara.Model.validateArray(this.components);
+    }
     super.validate();
   }
 

package/src/models/PauseSaasServiceRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class PauseSaasServiceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The region ID of the service.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
    * @remarks
+   * The service ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/PauseSaasServiceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class PauseSaasServiceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
   /**
+   * @remarks
+   * The service ID.
+   * 
    * @example
    * drama-123456
    */

package/src/models/QueryContentAdvanceRequest.ts

@@ -36,8 +36,7 @@ export class QueryContentAdvanceRequestGraphSearchArgs extends $dara.Model {
 export class QueryContentAdvanceRequestRerankModel extends $dara.Model {
   /**
    * @remarks
-   * This parameter can be set when RerankModel.Name is qwen3-rerank.
-   * Adds a custom sorting task type description. This parameter guides the model to adopt different sorting strategies.
+   * This parameter can be set when RerankModel.Name is qwen3-rerank. Specifies a custom sorting task type description that guides the model to adopt different sorting strategies.
    * 
    * @example
    * Given a web search query, retrieve relevant passages that answer the query
@@ -45,7 +44,7 @@ export class QueryContentAdvanceRequestRerankModel extends $dara.Model {
   instruct?: string;
   /**
    * @remarks
-   * The name of the rerank model. Valid values: qwen3-rerank, gte-rerank-v2.
+   * The rerank model name. Valid values: qwen3-rerank, gte-rerank-v2.
    * 
    * @example
    * qwen3-rerank
@@ -114,7 +113,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * @remarks
    * The name of the source image file to search in image-to-image search scenarios.
    * 
-   * > The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.
+   * > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
    * 
    * @example
    * test.jpg
@@ -124,7 +123,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * @remarks
    * The publicly accessible URL of the image file in image-to-image search scenarios.
    * 
-   * > The image file must have a file extension. Supported image extensions: bmp, jpg, jpeg, png, and tiff.
+   * > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
    * 
    * @example
    * https://xx/myImage.jpg
@@ -132,10 +131,10 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   fileUrlObject?: Readable;
   /**
    * @remarks
-   * The filter condition for the data to query, in SQL WHERE clause format. The filter is an expression that returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using the IN, BETWEEN, and LIKE keywords.
+   * The filter condition for the data to query, in SQL WHERE clause format. The expression returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using IN, BETWEEN, and LIKE keywords.
    * 
    * > 
-   * > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.
+   * > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/
    * 
    * @example
    * title = \\"test\\" AND name like \\"test%\\"
@@ -156,13 +155,13 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   graphSearchArgs?: QueryContentAdvanceRequestGraphSearchArgs;
   /**
    * @remarks
-   * The multi-channel recall algorithm. Default value: empty, which indicates that the dense vector and full-text index scores are directly compared and sorted.
+   * The multi-channel recall algorithm. Default value: empty (scores from dense vectors and full-text retrieve are directly compared and sorting is performed).
    * 
    * Valid values:
    * 
-   * - RRF: Reciprocal Rank Fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
-   * - Weight: Weighted sorting. Parameters control the score weights of AISearch retrieve and full-text index results before sorting. For more information, see the HybridSearchArgs configuration.
-   * - Cascaded: Full-text index retrieve is performed first, followed by AISearch retrieve based on the full-text index results.
+   * - RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
+   * - Weight: Weighted sorting. Parameters control the score weights of vector retrieve and full-text retrieve results before sorting. For more information, see the HybridSearchArgs configuration.
+   * - Cascaded: Full-text retrieve is performed first, followed by vector retrieve on the full-text retrieve results.
    * 
    * @example
    * RRF
@@ -170,9 +169,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   hybridSearch?: string;
   /**
    * @remarks
-   * The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text index (fulltext). If this value is empty, dense vectors (dense) and full-text index (fulltext) are used by default.
+   * The algorithm parameters for multi-channel recall. Currently, RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text retrieve (fulltext). If the value is empty, dense vectors (dense) and full-text retrieve (fulltext) are recalled by default.
    * 
-   * - RRF: Specifies the constant k in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
+   * - RRF: Specifies the k constant in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
    * ```
    * {
    *   "HybridPathsSetting": {
@@ -186,7 +185,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * 
    * - Weight: 
    *    - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
-   *       - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text index retrieve. Valid values: 0 to 1, where 0 indicates full-text index only and 1 indicates dense vector only:
+   *       - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text retrieve. Valid values: 0 to 1, where 0 indicates full-text retrieve only and 1 indicates dense vectors only:
    * ```
    * { 
    *    "Weight": {
@@ -195,7 +194,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * }
    * ```
    *   - Three-path recall pattern:
-   *      - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext values represent the weights for dense vectors, sparse vectors, and full-text index retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization of the weights to 0 to 1 (normalized_x = x / (dense + sparse + fulltext)).
+   *      - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext parameters represent the weights of dense vectors, sparse vectors, and full-text retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization on the weights to 0–1 (normalized_x = x / (dense + sparse + fulltext)).
    * ```
    * {
    *   "HybridPathsSetting": {
@@ -220,7 +219,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   includeFileUrl?: boolean;
   /**
    * @remarks
-   * The metadata fields to return. Default value: empty. Separate multiple fields with commas.
+   * The metadata fields to return, separated by commas. Default value: empty.
    * 
    * @example
    * title,page
@@ -238,7 +237,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   includeVector?: boolean;
   /**
    * @remarks
-   * The similarity algorithm used for retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.
+   * The similarity algorithm used during retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.
    * 
    * > Valid values:
    * > - **l2**: Euclidean distance.
@@ -253,7 +252,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * @remarks
    * The namespace. Default value: public.
    * 
-   * > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
+   * > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query the list of namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
    * 
    * @example
    * mynamespace
@@ -273,7 +272,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   namespacePassword?: string;
   /**
    * @remarks
-   * The offset for paged query. Used for paging through results.
+   * The offset for paging query.
    * 
    * @example
    * 0
@@ -283,9 +282,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
    * @remarks
    * The field used for sorting. Default value: empty.
    * 
-   * The field must belong to metadata or a default field in the table, such as id. Supported formats:
+   * The field must belong to metadata or a default field in the table such as id. Supported formats:
    * 
-   * A single field, such as chunk_id.
+   * Single field, such as chunk_id.
    * Multiple fields separated by commas, such as block_id, chunk_id.
    * Descending order, such as block_id DESC, chunk_id DESC.
    * 
@@ -296,9 +295,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The recall window. When this value is not empty, additional context around the retrieval results is returned. The format is a two-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.
+   * The recall window. When this value is not empty, the context of the retrieval results is also returned. The format is a 2-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.
    * > - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.
-   * > - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.
+   * > - Reranking takes priority over windowing, meaning reranking is performed first, followed by windowing.
    */
   recallWindow?: number[];
   /**
@@ -313,9 +312,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The reranking factor. When this value is not empty, the AISearch retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
-   * > - Reranking is slow when documents are sparsely chunked.
-   * > - The total number of reranked results (TopK × Factor, rounded up) should not exceed 50.
+   * The reranking factor. When this value is not empty, the vector retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
+   * > - Reranking is slower when documents are sparsely chunked.
+   * > - The total number of items to rerank (TopK × Factor, rounded up) should not exceed 50.
    * 
    * @example
    * 2
@@ -349,7 +348,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
   urlExpiration?: string;
   /**
    * @remarks
-   * (Deprecated) Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which indicates that only vector retrieval is used.
+   * **[Deprecated]** Specifies whether to use full-text retrieve (dual-path recall). Default value: false, which indicates that only vector retrieve is used.
    * 
    * @example
    * true