@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/UpdateDocumentRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDocumentRequest extends $dara.Model {
   /**
    * @remarks
+   * The document name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDocumentRequest extends $dara.Model {
   documentName?: string;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class UpdateDocumentRequest extends $dara.Model {
   kbUuid?: string;
   /**
    * @remarks
+   * The new document description.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateDocumentResponseBody.ts

@@ -4,23 +4,43 @@ import { OneMetaKnowledgeBaseDocument } from "./OneMetaKnowledgeBaseDocument";
 
 
 export class UpdateDocumentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response object.
+   */
   data?: OneMetaKnowledgeBaseDocument;
   /**
+   * @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 ID of the request. Use this ID for troubleshooting.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/UpdateKnowledgeBaseRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateKnowledgeBaseRequest extends $dara.Model {
   /**
+   * @remarks
+   * The new knowledge base description.
+   * 
    * @example
    * updated kb desc
    */
   description?: string;
   /**
    * @remarks
+   * The knowledge base ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,6 +22,9 @@ export class UpdateKnowledgeBaseRequest extends $dara.Model {
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * The new knowledge base name.
+   * 
    * @example
    * updated kb name
    */

package/src/models/UpdateKnowledgeBaseResponseBody.ts

@@ -4,23 +4,43 @@ import { OneMetaKnowledgeBase } from "./OneMetaKnowledgeBase";
 
 
 export class UpdateKnowledgeBaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: OneMetaKnowledgeBase;
   /**
+   * @remarks
+   * The error code returned on failure.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned on failure.
+   * 
    * @example
    * Resource not found kb-***
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D21075-CD3E-4D98-8264-FD8AD04A63B6
    */
   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/UploadDocumentRequest.ts

@@ -4,27 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class UploadDocumentRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of overlapping characters between adjacent chunks. This value cannot exceed `ChunkSize`. The default is 50.
+   * 
    * @example
    * 50
    */
   chunkOverlap?: number;
   /**
+   * @remarks
+   * The size of each document chunk. The default is 250, and the maximum is 2,048.
+   * 
    * @example
    * 250
    */
   chunkSize?: number;
   /**
+   * @remarks
+   * The description of the document.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The name of the document loader. The default is `ADBPGLoader`.
+   * 
    * @example
    * ADBPGLoader
    */
   documentLoaderName?: string;
   /**
    * @remarks
+   * The name of the document.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +47,8 @@ export class UploadDocumentRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -41,26 +57,48 @@ export class UploadDocumentRequest extends $dara.Model {
   kbUuid?: string;
   /**
    * @remarks
+   * The OSS location of the input file. Construct this path by appending the file name to the `UploadDir` value returned by the `DescribeKnowledgeBaseUploadSignature` operation.
+   * 
    * This parameter is required.
    */
   location?: string;
+  /**
+   * @remarks
+   * An array of strings used to split text.
+   * 
+   * > - This critical parameter affects data chunking results and is related to the splitter specified by `TextSplitterName`.
+   * >
+   * > - In most cases, you can omit this parameter. The service automatically assigns default separators based on `TextSplitterName`.
+   */
   separators?: string[];
   /**
+   * @remarks
+   * The splitter model to use. The default is `qwen3-8b`.
+   * 
    * @example
    * qwen3-8b
    */
   splitterModel?: string;
   /**
+   * @remarks
+   * The name of the text splitter.
+   * 
    * @example
    * ChineseRecursiveTextSplitter
    */
   textSplitterName?: string;
   /**
+   * @remarks
+   * Specifies whether to enable visual-linguistic (VL) enhanced content recognition for complex documents. The default is false.
+   * 
    * @example
    * false
    */
   vlEnhance?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable title enhancement.
+   * 
    * @example
    * false
    */

package/src/models/UploadDocumentResponseBody.ts

@@ -4,22 +4,43 @@ import { OneMetaKnowledgeBaseDocument } from "./OneMetaKnowledgeBaseDocument";
 
 
 export class UploadDocumentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data object.
+   */
   data?: OneMetaKnowledgeBaseDocument;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Resource not found kb-***
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The unique ID of the request. Use this ID to troubleshoot issues.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request succeeded. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/UploadDocumentShrinkRequest.ts

@@ -4,27 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class UploadDocumentShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of overlapping characters between adjacent chunks. This value cannot exceed `ChunkSize`. The default is 50.
+   * 
    * @example
    * 50
    */
   chunkOverlap?: number;
   /**
+   * @remarks
+   * The size of each document chunk. The default is 250, and the maximum is 2,048.
+   * 
    * @example
    * 250
    */
   chunkSize?: number;
   /**
+   * @remarks
+   * The description of the document.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The name of the document loader. The default is `ADBPGLoader`.
+   * 
    * @example
    * ADBPGLoader
    */
   documentLoaderName?: string;
   /**
    * @remarks
+   * The name of the document.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +47,8 @@ export class UploadDocumentShrinkRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -41,26 +57,48 @@ export class UploadDocumentShrinkRequest extends $dara.Model {
   kbUuid?: string;
   /**
    * @remarks
+   * The OSS location of the input file. Construct this path by appending the file name to the `UploadDir` value returned by the `DescribeKnowledgeBaseUploadSignature` operation.
+   * 
    * This parameter is required.
    */
   location?: string;
+  /**
+   * @remarks
+   * An array of strings used to split text.
+   * 
+   * > - This critical parameter affects data chunking results and is related to the splitter specified by `TextSplitterName`.
+   * >
+   * > - In most cases, you can omit this parameter. The service automatically assigns default separators based on `TextSplitterName`.
+   */
   separatorsShrink?: string;
   /**
+   * @remarks
+   * The splitter model to use. The default is `qwen3-8b`.
+   * 
    * @example
    * qwen3-8b
    */
   splitterModel?: string;
   /**
+   * @remarks
+   * The name of the text splitter.
+   * 
    * @example
    * ChineseRecursiveTextSplitter
    */
   textSplitterName?: string;
   /**
+   * @remarks
+   * Specifies whether to enable visual-linguistic (VL) enhanced content recognition for complex documents. The default is false.
+   * 
    * @example
    * false
    */
   vlEnhance?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable title enhancement.
+   * 
    * @example
    * false
    */

package/src/models/UpsertDocumentChunksRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpsertDocumentChunksRequest extends $dara.Model {
   /**
    * @remarks
+   * A list of document chunks to upsert.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +24,8 @@ export class UpsertDocumentChunksRequest extends $dara.Model {
   chunks?: string;
   /**
    * @remarks
+   * The name of the document.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,6 +34,8 @@ export class UpsertDocumentChunksRequest extends $dara.Model {
   documentName?: string;
   /**
    * @remarks
+   * The unique identifier for the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpsertDocumentChunksResponseBody.ts

@@ -4,26 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpsertDocumentChunksResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the update was successful. Valid values:
+   * 
+   * - **true**: The update succeeded.
+   * 
+   * - **false**: The update failed.
+   * 
    * @example
    * true
    */
   data?: boolean;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @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 succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/WorkspaceActionLogRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class WorkspaceActionLogRequest extends $dara.Model {
   /**
    * @remarks
+   * The key for the session playback history.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class WorkspaceActionLogRequest extends $dara.Model {
   key?: string;
   /**
    * @remarks
+   * The workspace ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/WorkspaceActionLogResponseBody.ts

@@ -4,31 +4,53 @@ import * as $dara from '@darabonba/typescript';
 
 export class WorkspaceActionLogResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The log.
+   * 
    * @example
    * log info
    */
   data?: string;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The response message. This can be an error message or an informational notice.
+   * 
    * @example
    * This record is being collected, please wait for a moment.
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D21075-CD3E-4D98-8264-FD8AD04A63B6
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates if the request succeeded. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/WorkspaceActionStatusRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class WorkspaceActionStatusRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique key that identifies the asynchronous task. You can obtain this key from the response of an operation, such as a deployment.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class WorkspaceActionStatusRequest extends $dara.Model {
   key?: string;
   /**
    * @remarks
+   * The ID of the workspace.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/WorkspaceActionStatusResponseBody.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class WorkspaceActionStatusResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The error message if the task fails.
+   * 
    * @example
    * action failed
    */
   data?: string;
   /**
+   * @remarks
+   * The time when the task ended.
+   * 
    * @example
    * 2026-01-13T14:30:20.582182728+08:00
    */
   endTime?: string;
   /**
+   * @remarks
+   * The time when the task started.
+   * 
    * @example
    * 2026-01-13T14:30:20.582182728+08:00
    */
   startTime?: string;
   /**
    * @remarks
+   * The status of the asynchronous task. Valid values: SUCCESS, ERROR, TIMEOUT, and CANCEL.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -54,28 +65,51 @@ export class WorkspaceActionStatusResponseBodyData extends $dara.Model {
 }
 
 export class WorkspaceActionStatusResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: WorkspaceActionStatusResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * InvalidTid
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message that is returned if the request fails.
+   * 
    * @example
    * This record is being collected, please wait for a moment.
    */
   message?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @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/WorkspaceCodePublishRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class WorkspaceCodePublishRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration for the code deployment, specified as a JSON string. The `repos` array identifies the Git repositories in the workspace and specifies the branch to deploy. The `exclude` array lists directories to skip during the deployment.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class WorkspaceCodePublishRequest extends $dara.Model {
   config?: string;
   /**
    * @remarks
+   * The workspace ID (numeric ID) for the code deployment.
+   * 
    * This parameter is required.
    * 
    * @example