@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/DescribeDocumentResponseBody.ts

@@ -4,66 +4,115 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDocumentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The description of the document.
+   * 
    * @example
    * abc
    */
   description?: string;
   /**
+   * @remarks
+   * The number of chunks.
+   * 
    * @example
    * 123
    */
   docsCount?: number;
   /**
+   * @remarks
+   * The name of the document loader.
+   * 
    * @example
    * ADBPGLoader
    */
   documentLoaderName?: string;
   /**
+   * @remarks
+   * The file extension of the document.
+   * 
    * @example
    * md
    */
   fileExt?: string;
   /**
+   * @remarks
+   * The size of the document in bytes.
+   * 
    * @example
    * 20307
    */
   fileSize?: number;
   /**
+   * @remarks
+   * The creation time of the document, in UTC.
+   * 
    * @example
    * 2026-04-22 22:59:35
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * The last modification time of the document, in UTC.
+   * 
    * @example
    * 2026-04-24 21:22:53
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * The ID of the knowledge base.
+   * 
    * @example
    * kb-***
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * The keywords of the document.
+   * 
    * @example
    * ["test","abc"]
    */
   keywords?: string;
   /**
+   * @remarks
+   * The name of the document.
+   * 
    * @example
    * test.md
    */
   name?: string;
   /**
+   * @remarks
+   * The document state. Possible values are:
+   * 
+   * - **0**: Parsing complete.
+   * 
+   * - **-1**: Not parsed.
+   * 
+   * - **-2**: Parsing in progress.
+   * 
+   * - **-3**: Parsing failed.
+   * 
+   * - **-4**: Parsing canceled.
+   * 
    * @example
    * 0
    */
   state?: number;
   /**
+   * @remarks
+   * The summary of the document.
+   * 
    * @example
    * This is a test document.
    */
   summary?: string;
   /**
+   * @remarks
+   * The name of the text splitter.
+   * 
    * @example
    * ChineseRecursiveTextSplitter
    */
@@ -114,23 +163,43 @@ export class DescribeDocumentResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDocumentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the document.
+   */
   data?: DescribeDocumentResponseBodyData;
   /**
+   * @remarks
+   * The error code returned when the request fails.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned when the request fails.
+   * 
    * @example
    * Resource not found kb-***
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The unique request ID. Provide this ID for troubleshooting if an error occurs.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DescribeFileUploadSignatureRequest.ts

@@ -3,8 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeFileUploadSignatureRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Used by the frontend only
+   * 
+   * @example
+   * 仅前端使用
+   */
   callFrom?: string;
   /**
+   * @remarks
+   * Current DMS unit
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeFileUploadSignatureResponseBody.ts

@@ -3,34 +3,60 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Parameter set that specifies the derived key
+   */
   ossCredential?: string;
   /**
+   * @remarks
+   * Time of the request, formatted according to the ISO 8601 date and time standard
+   * 
    * @example
    * 20260101T135341Z
    */
   ossDate?: string;
   /**
+   * @remarks
+   * STS token used for uploading to OSS, valid for 1 hour
+   * 
    * @example
    * CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********
    */
   ossSecurityToken?: string;
   /**
+   * @remarks
+   * Description information used for signature authentication
+   * 
    * @example
    * 9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********
    */
   ossSignature?: string;
   /**
+   * @remarks
+   * Specifies the version and algorithm of the signature
+   * 
    * @example
    * OSS4-HMAC-SHA256
    */
   ossSignatureVersion?: string;
   /**
+   * @remarks
+   * Permission constraints and conditions for file upload
+   * 
    * @example
    * eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********
    */
   policy?: string;
+  /**
+   * @remarks
+   * Path for file upload
+   */
   uploadDir?: string;
   /**
+   * @remarks
+   * Target address for file upload
+   * 
    * @example
    * https://**********.oss-cn-hangzhou.aliyuncs.com
    */
@@ -71,13 +97,23 @@ export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
 }
 
 export class DescribeFileUploadSignatureResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Return struct
+   */
   data?: DescribeFileUploadSignatureResponseBodyData;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message returned when the invocation fails
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
@@ -91,6 +127,12 @@ export class DescribeFileUploadSignatureResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. The return value is as follows:
+   * 
+   * - **true**: The request succeeded.
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DescribeKnowledgeBaseStatsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeKnowledgeBaseStatsRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeKnowledgeBaseStatsResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeKnowledgeBaseStatsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The number of documents in the knowledge base.
+   * 
    * @example
    * 100
    */
   documentCount?: number;
   /**
+   * @remarks
+   * The number of hits for the knowledge base.
+   * 
    * @example
    * 18
    */
   kbHits?: number;
   /**
+   * @remarks
+   * The ID of the knowledge base.
+   * 
    * @example
    * kb-***
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * The total number of knowledge chunks in the knowledge base.
+   * 
    * @example
    * 10
    */
   totalChunkCount?: number;
   /**
+   * @remarks
+   * The total size of all files in the knowledge base, in bytes.
+   * 
    * @example
    * 4194588751
    */
@@ -58,23 +73,39 @@ export class DescribeKnowledgeBaseStatsResponseBodyData extends $dara.Model {
 }
 
 export class DescribeKnowledgeBaseStatsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The object that contains the knowledge base statistics.
+   */
   data?: DescribeKnowledgeBaseStatsResponseBodyData;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * Permission denied.
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Knowledge base limit exceeded. Current: xxx
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The unique ID of the request. Use this ID to troubleshoot errors.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. A value of `true` indicates success, and a value of `false` indicates failure.
+   * 
    * @example
    * true
    */

package/src/models/DescribeKnowledgeBaseUploadSignatureRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeKnowledgeBaseUploadSignatureRequest extends $dara.Model {
   /**
    * @remarks
+   * The knowledge base ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeKnowledgeBaseUploadSignatureResponseBody.ts

@@ -3,34 +3,60 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeKnowledgeBaseUploadSignatureResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The credential scope string for the signature.
+   */
   ossCredential?: string;
   /**
+   * @remarks
+   * The request time in ISO 8601 format.
+   * 
    * @example
    * 20260101T135341Z
    */
   ossDate?: string;
   /**
+   * @remarks
+   * The STS token used for uploading to OSS. It is valid for one hour.
+   * 
    * @example
    * CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********
    */
   ossSecurityToken?: string;
   /**
+   * @remarks
+   * The authentication signature.
+   * 
    * @example
    * 9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********
    */
   ossSignature?: string;
   /**
+   * @remarks
+   * The signature version and algorithm.
+   * 
    * @example
    * OSS4-HMAC-SHA256
    */
   ossSignatureVersion?: string;
   /**
+   * @remarks
+   * The Base64-encoded POST policy that specifies the conditions for the file upload.
+   * 
    * @example
    * eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5aRmR2RDJRWlFSeWlwZmpkS295NEYxb2ovMjAyNjA1MTQvY24taGFuZ3pob3Uvb3NzL2FsaXl1bl92NF9yZXF1ZXN0In0seyJ4LW9zcy1kYXRlIjoiMjAyNjA1MTRUMDMzMjI3WiJ9LHsieC1vc3Mtc2VjdXJpdHktdG9rZW4iOiJDQUlTMmdKMXE2RnQ1QjJ5ZlNqSXI1bnpMOHp3MzQ1NzVwQ1NhMWJYam1RZVkvWVlxZlRFaUR6MklIaE1**
    */
   policy?: string;
+  /**
+   * @remarks
+   * The path prefix for the file upload.
+   */
   uploadDir?: string;
   /**
+   * @remarks
+   * The destination URL for the file upload.
+   * 
    * @example
    * https://onemeta-kb-staging.oss-cn-hangzhou.aliyuncs.com
    */
@@ -71,23 +97,43 @@ export class DescribeKnowledgeBaseUploadSignatureResponseBodyData extends $dara.
 }
 
 export class DescribeKnowledgeBaseUploadSignatureResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The upload signature details.
+   */
   data?: DescribeKnowledgeBaseUploadSignatureResponseBodyData;
   /**
+   * @remarks
+   * The error code if the request fails.
+   * 
    * @example
    * KnowledgeBaseNotFound
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message if the request fails.
+   * 
    * @example
    * Resource not found xxx
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The unique ID of the request. If an error occurs, use this ID to troubleshoot the issue.
+   * 
    * @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/Dlcatalog.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DLCatalog extends $dara.Model {
   /**
+   * @remarks
+   * The description of the data catalog.
+   * 
    * @example
    * init default catalog
    */
   description?: string;
   /**
+   * @remarks
+   * The storage path of the data catalog.
+   * 
    * @example
    * oss://xxxx
    */
   location?: string;
   /**
+   * @remarks
+   * The name of the data catalog.
+   * 
    * @example
    * hive
    */

package/src/models/Dlcolumn.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DLColumn extends $dara.Model {
   /**
+   * @remarks
+   * The comment of the column.
+   * 
    * @example
    * from deserializer
    */
   comment?: string;
   /**
+   * @remarks
+   * The name of the column.
+   * 
    * @example
    * col
    */
   name?: string;
   /**
+   * @remarks
+   * The data type of the column. Valid values include array, bigint, binary, boolean, char, date, decimal, double, float, int, interval, map, set, smallint, string, struct, timestamp, tinyint, union, and varchar.
+   * 
    * @example
    * string
    */

package/src/models/Dldatabase.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class DLDatabase extends $dara.Model {
   /**
+   * @remarks
+   * The name of the data catalog.
+   * 
    * @example
    * hive
    */
   catalogName?: string;
   /**
+   * @remarks
+   * The ID of the database.
+   * 
    * @example
    * 19
    */
   dbId?: number;
   /**
+   * @remarks
+   * The description of the database.
+   * 
    * @example
    * Default database for catalog hive
    */
   description?: string;
   /**
+   * @remarks
+   * The storage path of the database.
+   * 
    * @example
    * oss://xxx
    */
   location?: string;
   /**
+   * @remarks
+   * The name of the database.
+   * 
    * @example
    * default
    */
   name?: string;
   /**
+   * @remarks
+   * The parameters of the database.
+   * 
    * @example
    * key/value
    */

package/src/models/Dlfunction.ts

@@ -5,55 +5,95 @@ import { DLResourceUri } from "./DlresourceUri";
 
 export class DLFunction extends $dara.Model {
   /**
+   * @remarks
+   * The name of the data catalog.
+   * 
    * @example
    * hive
    */
   catalogName?: string;
   /**
+   * @remarks
+   * The Java class that contains the function code.
+   * 
    * @example
    * com.example.hive.MyCustomUDF
    */
   className?: string;
   /**
+   * @remarks
+   * The time when the function was created.
+   * 
    * @example
    * 1731586286
    */
   createTime?: number;
   /**
+   * @remarks
+   * The ID of the user who created the function.
+   * 
    * @example
    * 12****
    */
   creatorId?: number;
   /**
+   * @remarks
+   * The name of the database.
+   * 
    * @example
    * default
    */
   dbName?: string;
   /**
+   * @remarks
+   * The name of the function.
+   * 
    * @example
    * my_funciton
    */
   functionName?: string;
   /**
+   * @remarks
+   * The type of the function.
+   * 
    * @example
    * JAVA
    */
   functionType?: string;
   /**
+   * @remarks
+   * The ID of the user who modified the function.
+   * 
    * @example
    * 26****
    */
   modifierId?: number;
   /**
+   * @remarks
+   * The owner of the function.
+   * 
    * @example
    * zhangsan
    */
   ownerName?: string;
   /**
+   * @remarks
+   * The type of the owner. Valid values:
+   * 
+   * - ROLE
+   * 
+   * - GROUP
+   * 
+   * - USER
+   * 
    * @example
    * USER
    */
   ownerType?: string;
+  /**
+   * @remarks
+   * The resource URIs of the function. This parameter cannot be modified after the function is created.
+   */
   resourceUris?: DLResourceUri[];
   static names(): { [key: string]: string } {
     return {