@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/PartitionError.ts

@@ -4,10 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class PartitionError extends $dara.Model {
   /**
+   * @remarks
+   * The details of the error.
+   * 
    * @example
    * auth failed
    */
   errorDetail?: string;
+  /**
+   * @remarks
+   * The partition values.
+   */
   values?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/RedeployAirflowRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class RedeployAirflowRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class RedeployAirflowRequest extends $dara.Model {
   airflowId?: string;
   /**
    * @remarks
+   * The ID of the DMS workspace.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RedeployAirflowResponseBody.ts

@@ -4,36 +4,61 @@ import * as $dara from '@darabonba/typescript';
 
 export class RedeployAirflowResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Details about the access denial.
+   * 
    * @example
    * NOT_FOUND
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Successful
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The redeployment result.
+   * 
    * @example
    * {\\"Responses\\": {\\"responses\\": [{\\"Uuid\\": \\"af-63ly5o1yuf076ifrpbxpka396\\", \\"Success\\": True}]}}
    */
   root?: boolean;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/RemoveUserToDataAgentWorkspaceRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemoveUserToDataAgentWorkspaceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * The UID of the member account to remove.
+   * 
    * @example
    * 21482*****7584
    */
   memberId?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 20923*****7291
    */

package/src/models/RemoveUserToDataAgentWorkspaceResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemoveUserToDataAgentWorkspaceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * DMS-DA-40114
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
    * @example
    * Specified parameter is not valid.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D2-*****-A63B6
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/RetrieveKnowledgeBaseRequest.ts

@@ -4,32 +4,105 @@ import * as $dara from '@darabonba/typescript';
 
 export class RetrieveKnowledgeBaseRequest extends $dara.Model {
   /**
+   * @remarks
+   * A filter for the data, specified as a SQL `WHERE` clause.
+   * 
    * @example
    * title = \\"test\\" AND name like \\"test%\\"
    */
   filter?: string;
   /**
+   * @remarks
+   * The hybrid search algorithm. If this parameter is not set, the system directly compares and ranks the scores from the dense vector and full-text searches.
+   * 
+   * Valid values:
+   * 
+   * - `RRF`: Reciprocal Rank Fusion. This method uses a parameter `k` to control the fusion effect. For more information, see the `HybridSearchArgs` configuration.
+   * 
+   * - `Weight`: Weighted ranking. This method applies weights to the vector and full-text search scores before ranking. For more information, see the `HybridSearchArgs` configuration.
+   * 
+   * - `Cascaded`: Performs a full-text search first, followed by a vector search on the results of the full-text search.
+   * 
    * @example
    * RRF
    */
   hybridSearch?: string;
   /**
+   * @remarks
+   * Parameters for the specified `HybridSearch` algorithm. Both `RRF` and `Weight` are supported. You can use the `HybridPathsSetting` object to specify the retrieval paths: dense vector (`dense`), sparse vector (`sparse`), and full-text search (`fulltext`). If this object is not provided, the default retrieval paths are `dense` and `fulltext`.
+   * 
+   * - `RRF`: Specifies the constant `k` in the scoring formula `1/(k+rank_i)`. The value of `k` must be an integer greater than 1. The format is as follows:
+   * 
+   * ```
+   * {
+   *   "HybridPathsSetting": {
+   *     "paths": "dense,fulltext"
+   *   },
+   *   "RRF": {
+   *     "k": 60
+   *   }
+   * }
+   * ```
+   * 
+   * - `Weight`:
+   * 
+   *   - Two-path recall (do not specify `HybridPathsSetting`; specify only `alpha`):
+   * 
+   *     - The score is calculated using the formula: `alpha * dense_score + (1-alpha) * fulltext_score`. The `alpha` parameter balances the scores from the dense vector and full-text searches. Its value must be in the range [0, 1], where 0 relies solely on full-text search, and 1 relies solely on dense vector search.
+   * 
+   * ```
+   * { 
+   *    "Weight": {
+   *     "alpha": 0.5
+   *    }
+   * }
+   * ```
+   * 
+   * - Three-path recall:
+   * 
+   *   - The score is calculated using the formula: `normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score`. The `dense`, `sparse`, and `fulltext` parameters are the weights for the dense vector, sparse vector, and full-text searches, respectively. Their values must be 0 or greater. The system automatically normalizes the weights to sum to 1 (for example, `normalized_x = x / (dense + sparse + fulltext)`).
+   * 
+   * ```
+   * {
+   *   "HybridPathsSetting": {
+   *      "paths": "dense,sparse,fulltext"
+   *    },
+   *   "Weight": {
+   *     "dense": 0.5,
+   *     "sparse": 0.3,
+   *     "fulltext": 0.2
+   *   }
+   * }
+   * ```
+   * 
    * @example
    * { \\"Weight\\": { \\"alpha\\": 0.5 } }
    */
   hybridSearchArgs?: string;
   /**
+   * @remarks
+   * The metadata fields to return, separated by commas. By default, no metadata fields are returned.
+   * 
    * @example
    * title,page
    */
   includeMetadataFields?: string;
   /**
+   * @remarks
+   * Specifies whether to include the vector in the results. The default value is `false`.
+   * 
+   * > - **false**: The vector is not returned.
+   * >
+   * > - **true**: The vector is returned.
+   * 
    * @example
    * false
    */
   includeVector?: boolean;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,22 +110,45 @@ export class RetrieveKnowledgeBaseRequest extends $dara.Model {
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * The distance metric for retrieval. If unspecified, this defaults to the metric configured for the knowledge base. Only set this parameter if you have specific requirements.
+   * 
+   * Valid values:
+   * 
+   * - `l2`: Euclidean distance.
+   * 
+   * - `ip`: Inner product.
+   * 
+   * - `cosine`: Cosine similarity.
+   * 
    * @example
    * cosine
    */
   metrics?: string;
   /**
+   * @remarks
+   * The offset for pagination.
+   * 
    * @example
    * 0
    */
   offset?: number;
   /**
+   * @remarks
+   * The field to use for sorting the results. By default, this parameter is empty.
+   * 
+   * The field must be a metadata field or a default table field, such as `id`. Supported formats include:
+   * 
+   * You can specify a single field (for example, `chunk_id`), multiple comma-separated fields (for example, `block_id, chunk_id`), or fields with descending order (for example, `block_id DESC, chunk_id DESC`).
+   * 
    * @example
    * created_at
    */
   orderBy?: string;
   /**
    * @remarks
+   * The query text.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,16 +156,33 @@ export class RetrieveKnowledgeBaseRequest extends $dara.Model {
    */
   query?: string;
   /**
+   * @remarks
+   * The recall window. If specified, this parameter expands the context of the retrieved results. The format is a two-element array `[A, B]`, where `-10 <= A <= 0` and `0 <= B <= 10`.
+   * 
+   * > - Recommended when document chunks are highly fragmented, which might cause context loss during retrieval.
+   * >
+   * > - Reranking occurs before windowing is applied.
+   * 
    * @example
    * [-5,5]
    */
   recallWindow?: string;
   /**
+   * @remarks
+   * The factor used to rerank vector search results. The value must be in the range (1, 5].
+   * 
+   * > - Reranking may be slow if document chunks are sparse.
+   * >
+   * > - The number of items to rerank, calculated as `ceil(TopK * RerankFactor)`, should not exceed 50.
+   * 
    * @example
    * 2
    */
   rerankFactor?: number;
   /**
+   * @remarks
+   * The number of top-ranked results to return.
+   * 
    * @example
    * 10
    */

package/src/models/RetrieveKnowledgeBaseResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class RetrieveKnowledgeBaseResponseBodyDataMatches extends $dara.Model {
   /**
+   * @remarks
+   * The text content.
+   * 
    * @example
    * GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.
    */
   content?: string;
   /**
+   * @remarks
+   * The name of the source document.
+   * 
    * @example
    * 1.txt
    */
   fileName?: string;
   /**
+   * @remarks
+   * The unique ID of the vector.
+   * 
    * @example
    * 3b35c95-57f3-442f-9220-xxxxx
    */
   id?: string;
   /**
+   * @remarks
+   * The metadata generated by the document loader.
+   * 
    * @example
    * {"page_pos": 1}
    */
   loaderMetadata?: string;
   /**
+   * @remarks
+   * A key-value map of the metadata.
+   * 
    * @example
    * {"title":"test"}
    */
@@ -62,45 +77,73 @@ export class RetrieveKnowledgeBaseResponseBodyDataMatches extends $dara.Model {
 
 export class RetrieveKnowledgeBaseResponseBodyDataResults extends $dara.Model {
   /**
+   * @remarks
+   * The content of the retrieved text chunk.
+   * 
    * @example
    * GraphRAG (Graph Retrieval-Augmented Generation) is an advanced AI framework that combines Knowledge Graphs with Large Language Models (LLMs) to improve the accuracy, context, and reasoning capabilities of information retrieval and generation.
    */
   content?: string;
   /**
+   * @remarks
+   * The name of the source document.
+   * 
    * @example
    * 1.txt
    */
   fileName?: string;
   /**
+   * @remarks
+   * The unique ID of the vector.
+   * 
    * @example
    * 3b35c95-57f3-442f-9220-xxxxx
    */
   id?: string;
   /**
+   * @remarks
+   * The metadata generated by the document loader.
+   * 
    * @example
    * {"page_pos": 1}
    */
   loaderMetadata?: string;
   /**
+   * @remarks
+   * A key-value map of the metadata.
+   * 
    * @example
    * {"title":"test"}
    */
   metadata?: { [key: string]: any };
   /**
+   * @remarks
+   * The rerank score.
+   * 
    * @example
    * 6.2345
    */
   rerankScore?: number;
   /**
+   * @remarks
+   * The method used for retrieval. Valid values: `1` (vector retrieval), `2` (full-text search), and `3` (hybrid search).
+   * 
    * @example
    * 1
    */
   retrievalSource?: number;
   /**
+   * @remarks
+   * The similarity score of the result. This score depends on the distance metric (`l2`, `ip`, or `cosine`) specified when the index was created.
+   * 
    * @example
    * 0.81
    */
   score?: number;
+  /**
+   * @remarks
+   * The vector data as an array of floating-point numbers.
+   */
   vector?: number[];
   static names(): { [key: string]: string } {
     return {
@@ -146,7 +189,15 @@ export class RetrieveKnowledgeBaseResponseBodyDataResults extends $dara.Model {
 }
 
 export class RetrieveKnowledgeBaseResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Matched items from the windowing process.
+   */
   matches?: RetrieveKnowledgeBaseResponseBodyDataMatches[];
+  /**
+   * @remarks
+   * The retrieved results.
+   */
   results?: RetrieveKnowledgeBaseResponseBodyDataResults[];
   static names(): { [key: string]: string } {
     return {
@@ -178,23 +229,43 @@ export class RetrieveKnowledgeBaseResponseBodyData extends $dara.Model {
 }
 
 export class RetrieveKnowledgeBaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response payload.
+   */
   data?: RetrieveKnowledgeBaseResponseBodyData;
   /**
+   * @remarks
+   * The error code for a failed request.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message for a failed request.
+   * 
    * @example
    * Resource not found kb-***
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The unique request ID. Use this ID to troubleshoot errors.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/SaveWorkspaceCodeRequest.ts

@@ -5,42 +5,60 @@ import * as $dara from '@darabonba/typescript';
 export class SaveWorkspaceCodeRequest extends $dara.Model {
   /**
    * @remarks
+   * The code content.
+   * 
    * This parameter is required.
    * 
    * @example
-   * Description: \\"Example template, describe instances in some status\\"nFormatVersion: OOS-2019-06-01nTasks:n  - Name: SleepTaskn    Action: ACS::Sleepn    Properties:n      Duration: PT1Mn
+   * print(123)
    */
   content?: string;
   /**
+   * @remarks
+   * Specifies whether to forcibly overwrite the file. If set to true, the file is overwritten regardless of whether it has been modified by others.
+   * 
    * @example
    * True
    */
   force?: boolean;
   /**
+   * @remarks
+   * Specifies whether the file is an infrastructure as code template file. Set this parameter to true for YAML configuration files that are edited in the visual editor.
+   * 
    * @example
    * false
    */
   iac?: boolean;
   /**
+   * @remarks
+   * The file modification time. The GetWorkspaceCode operation returns this mtime value. When you call SaveWorkspaceCode, include this mtime value to check whether the file has been changed on the server. If the mtime values do not match, the save operation fails, which indicates that the server-side version has been modified.
+   * 
    * @example
    * 2026-01-01T10:11:12Z
    */
   mtime?: string;
   /**
    * @remarks
+   * The file path to save.
+   * 
    * This parameter is required.
    * 
    * @example
-   * {"repos":[{"repo":"git@xxxx.git", "branch":"master"}], "exclude":["/.dms", "/username"]}
+   * /Workspace/code/test.py
    */
   path?: string;
   /**
+   * @remarks
+   * The repository information. Specify this parameter when creating a git repository directory during the save operation.
+   * 
    * @example
-   * computing/ecs
+   * git@codeup.aliyun.com:test/abc.git
    */
   repo?: string;
   /**
    * @remarks
+   * The workspace ID (numeric ID).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/SaveWorkspaceCodeResponseBody.ts

@@ -4,31 +4,51 @@ import * as $dara from '@darabonba/typescript';
 
 export class SaveWorkspaceCodeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * 返回数据
+   * 
    * @example
    * 1
    */
   data?: string;
   /**
+   * @remarks
+   * 错误码
+   * 
    * @example
    * InvalidTid
    */
   errorCode?: string;
   /**
+   * @remarks
+   * http状态码
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * 错误信息，在接口失败时，返回具体错误信息，成功时则为空
+   * 
    * @example
    * Failed to publish，repo branch empty
    */
   message?: string;
   /**
+   * @remarks
+   * 请求ID
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * 是否调用成功。
+   * - **true**：调用成功。
+   * - **false**：调用失败。
+   * 
    * @example
    * true
    */