@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/ModifyCustomAgentShrinkRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyCustomAgentShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The callback configuration.
+   */
   callbackConfigShrink?: string;
   /**
    * @remarks
+   * The ID of the custom agent.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,22 +19,201 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
+  /**
+   * @remarks
+   * The data scope for the agent, specified in a **JSON-formatted string**.
+   * 
+   * - General parameters:
+   * 
+   *   - `tableFlag`: Set this to `true` to specify the data scope.
+   * 
+   *   - `scope`: The value must be `personal`.
+   * 
+   *   - `personal`: The parameters for files or databases.
+   * 
+   * **For files**, use the following parameters:
+   * 
+   * - `DataSourceType`: The value must be `remote_data_center`.
+   * 
+   * - `FileId`: The file ID.
+   * 
+   * - `Database`: The database name returned by the `ListDataCenterTable` operation. This is typically the file name.
+   * 
+   * - `Tables`: The table names returned by the `ListDataCenterTable` operation.
+   * 
+   * - `TableIds`: The table IDs returned by the `ListDataCenterTable` operation.
+   * 
+   * - `RegionId`: The current region.
+   * 
+   * ```
+   * {
+   *   "tableFlag": true,
+   *   "scope": "personal",
+   *   "personal": {
+   *     "DataSourceType": "remote_data_center",
+   *     "FileId": "f-f0jksn001ibmkoo********6v2zn6",
+   *     "Database": "diamonds.csv",
+   *     "Tables": [
+   *       "diamonds"
+   *     ],
+   *     "TableIds": [
+   *       "35hfn94pxl********50pi"
+   *     ],
+   *     "RegionId": "cn-hangzhou"
+   *   }
+   * }
+   * ```
+   * 
+   * **For databases**, use the following parameters:
+   * 
+   * - `DataSourceType`: The value must be `database`.
+   * 
+   * - `DmsInstanceId`: The ID of the DMS instance, which is returned by the data center API.
+   * 
+   * - `DmsDatabaseId`: The ID of the DMS database, which is returned by the data center API.
+   * 
+   * - `FileId`: The instance name. This parameter is deprecated.
+   * 
+   * - `DbName`: The database name returned by the data center API.
+   * 
+   * - `Database`: The database name returned by the data center API.
+   * 
+   * - `Tables`: The table names returned by the data center API.
+   * 
+   * - `TableIds`: The table IDs returned by the data center API.
+   * 
+   * - `Engine`: The database engine type. Valid values: `mysql` and `postgresql`.
+   * 
+   * - `RegionId`: The current region.
+   * 
+   * ```
+   * {
+   *   "tableFlag": true,
+   *   "scope": "personal",
+   *   "personal": {
+   *     "DataSourceType": "database",
+   *     "DmsInstanceId": "284***8",
+   *     "DmsDatabaseId": "769***45",
+   *     "FileId": "pgm-bp15095e*******6t",
+   *     "DbName": "pg_catalog",
+   *     "Database": "pg_catalog",
+   *     "Tables": [
+   *       "pg_aggregate"
+   *     ],
+   *     "TableIds": [
+   *       "5263****31"
+   *     ],
+   *     "Engine": "postgresql",
+   *     "RegionId": "cn-hangzhou"
+   *   }
+   * }
+   * ```
+   * 
+   * @example
+   * {
+   *   "tableFlag" : true,
+   *   "scope" : "personal",
+   *   "personal" : {
+   *     "DataSourceType" : "remote_data_center",
+   *     "FileId" : "f-5qlrwaw10********s3gpw1z",
+   *     "Database" : "测试表格******.xlsx",
+   *     "Tables" : [ "Sheet1" ],
+   *     "TableIds" : [ "******" ],
+   *     "RegionId" : "cn-hangzhou"
+   *   }
+   * }
+   */
   dataJson?: string;
+  /**
+   * @remarks
+   * The description of the custom agent.
+   * 
+   * @example
+   * Agent测试描述
+   */
   description?: string;
+  /**
+   * @remarks
+   * The execution configuration.
+   */
   executionConfigShrink?: string;
+  /**
+   * @remarks
+   * The system instruction for the custom agent.
+   * 
+   * - The maximum length is 10,000 characters.
+   * 
+   * @example
+   * 分析框架：
+   * 1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；
+   * 2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；
+   * 3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；
+   */
   instruction?: string;
+  /**
+   * @remarks
+   * A text-based knowledge base for the custom agent.
+   * 
+   * - The maximum length is 10,000 characters.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
+  /**
+   * @remarks
+   * The configurations for the external knowledge base.
+   */
   knowledgeConfigListShrink?: string;
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
   relatedSessionId?: string;
+  /**
+   * @remarks
+   * The configuration for the scheduled task.
+   */
   scheduleTaskConfigShrink?: string;
+  /**
+   * @remarks
+   * The formatting instructions for the text report.
+   * 
+   * - The maximum length is 10,000 characters.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The formatting instructions for the web report.
+   * 
+   * - The maximum length is 50,000 characters.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */

package/src/models/OneMetaDatabase.ts

@@ -4,20 +4,76 @@ import { OneMetaDatabaseEngineMeta } from "./OneMetaDatabaseEngineMeta";
 
 
 export class OneMetaDatabase extends $dara.Model {
+  /**
+   * @remarks
+   * The catalog name.
+   */
   catalogName?: string;
+  /**
+   * @remarks
+   * The catalog type.
+   */
   catalogType?: string;
+  /**
+   * @remarks
+   * The catalog UUID.
+   */
   catalogUuid?: string;
+  /**
+   * @remarks
+   * The data source type.
+   */
   dataSourceType?: string;
+  /**
+   * @remarks
+   * The business attributes of the database.
+   */
   databaseBizAttrs?: { [key: string]: any };
+  /**
+   * @remarks
+   * The database UUID.
+   */
   databaseUuid?: string;
+  /**
+   * @remarks
+   * The database description.
+   */
   description?: string;
   engineMeta?: OneMetaDatabaseEngineMeta;
+  /**
+   * @remarks
+   * The database name.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The extended properties of the database.
+   */
   properties?: { [key: string]: any };
+  /**
+   * @remarks
+   * The qualified name of the database.
+   */
   qualifiedName?: string;
+  /**
+   * @remarks
+   * The region ID.
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * The name used to search the database.
+   */
   searchName?: string;
+  /**
+   * @remarks
+   * The database state.
+   */
   state?: number;
+  /**
+   * @remarks
+   * The database storage location.
+   */
   storageLocation?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/OneMetaDatabaseEngineMeta.ts

@@ -3,9 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class OneMetaDatabaseEngineMeta extends $dara.Model {
+  /**
+   * @remarks
+   * The catalog name.
+   */
   catalogName?: string;
+  /**
+   * @remarks
+   * The character encoding for the database.
+   */
   encoding?: string;
+  /**
+   * @remarks
+   * The schema name.
+   */
   schemaName?: string;
+  /**
+   * @remarks
+   * The database storage capacity, in GB.
+   */
   storageCapacity?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/OneMetaKnowledgeBase.ts

@@ -4,51 +4,81 @@ import * as $dara from '@darabonba/typescript';
 
 export class OneMetaKnowledgeBase extends $dara.Model {
   /**
+   * @remarks
+   * The creator of the knowledge base.
+   * 
    * @example
    * 20464374909***
    */
   creator?: string;
   /**
+   * @remarks
+   * The description of the knowledge base.
+   * 
    * @example
    * order knowledgebase
    */
   description?: string;
   /**
+   * @remarks
+   * The domain of the knowledge base.
+   * 
    * @example
    * vehicle
    */
   domain?: string;
   /**
+   * @remarks
+   * Additional information about the knowledge base.
+   * 
    * @example
    * {"keywords":"sales,vehicle brand"}
    */
   extraInfo?: string;
   /**
+   * @remarks
+   * The time when the knowledge base was created.
+   * 
    * @example
    * 2026-05-14 11:30:00
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * The time when the knowledge base was last modified.
+   * 
    * @example
    * 2026-05-14 11:30:39
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * The UUID of the knowledge base.
+   * 
    * @example
    * kb-***
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * The name of the knowledge base.
+   * 
    * @example
    * order_kb
    */
   name?: string;
   /**
+   * @remarks
+   * The state of the knowledge base. Valid values include 0 (No data) and 1 (Available).
+   * 
    * @example
    * 1
    */
   state?: number;
   /**
+   * @remarks
+   * The tag of the knowledge base.
+   * 
    * @example
    * 4phsj52f81ymlm***
    */

package/src/models/OneMetaKnowledgeBaseChunk.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class OneMetaKnowledgeBaseChunk extends $dara.Model {
   /**
+   * @remarks
+   * The time when the chunk was last modified.
+   * 
    * @example
    * 2026-04-20 15:51:27
    */
   chunkMtime?: string;
   /**
+   * @remarks
+   * The title of the chunk.
+   * 
    * @example
    * titile1
    */
   chunkTitle?: string;
   /**
+   * @remarks
+   * The content of the chunk.
+   * 
    * @example
    * abc
    */
   content?: string;
   /**
+   * @remarks
+   * The name of the document.
+   * 
    * @example
    * test.md
    */
   docName?: string;
   /**
+   * @remarks
+   * The unique identifier for the chunk.
+   * 
    * @example
    * 2e12aeb5-52cd-4834-bcd8-****
    */

package/src/models/OneMetaKnowledgeBaseDocument.ts

@@ -4,66 +4,115 @@ import * as $dara from '@darabonba/typescript';
 
 export class OneMetaKnowledgeBaseDocument extends $dara.Model {
   /**
+   * @remarks
+   * The document description.
+   * 
    * @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.
+   * 
    * @example
    * md
    */
   fileExt?: string;
   /**
+   * @remarks
+   * The file size, in bytes.
+   * 
    * @example
    * 20307
    */
   fileSize?: number;
   /**
+   * @remarks
+   * When the document was created.
+   * 
    * @example
    * 2026-04-22 22:59:35
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * When the document was last modified.
+   * 
    * @example
    * 2026-04-24 21:22:53
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * The knowledge base ID.
+   * 
    * @example
    * kb-***
    */
   kbUuid?: string;
   /**
+   * @remarks
+   * Keywords extracted from the document.
+   * 
    * @example
    * ["test","abc"]
    */
   keywords?: string;
   /**
+   * @remarks
+   * The document name.
+   * 
    * @example
    * test.md
    */
   name?: string;
   /**
+   * @remarks
+   * The document status. Valid values are:
+   * 
+   * - **0**: Complete.
+   * 
+   * - **-1**: Unprocessed.
+   * 
+   * - **-2**: Parsing.
+   * 
+   * - **-3**: Failed.
+   * 
+   * - **-4**: 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
    */

package/src/models/OpenClawInstanceQuotaVo.ts

@@ -3,17 +3,65 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class OpenClawInstanceQuotaVO extends $dara.Model {
+  /**
+   * @remarks
+   * The Alibaba Cloud account UID.
+   */
   aliyunAccountUid?: string;
+  /**
+   * @remarks
+   * The total quota for deep research calls.
+   */
   deepResearchCallQuota?: string;
+  /**
+   * @remarks
+   * The number of deep research calls used.
+   */
   deepResearchCallUsed?: string;
+  /**
+   * @remarks
+   * The instance creation time.
+   */
   instanceGmtCreate?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   */
   instanceId?: string;
+  /**
+   * @remarks
+   * The instance name.
+   */
   instanceName?: string;
+  /**
+   * @remarks
+   * The timestamp of the last metering event.
+   */
   lastMeteringTime?: string;
+  /**
+   * @remarks
+   * The total quota for model calls.
+   */
   modelCallQuota?: string;
+  /**
+   * @remarks
+   * The number of model calls used.
+   */
   modelCallUsed?: string;
+  /**
+   * @remarks
+   * The day of the month on which the quota refreshes.
+   */
   refreshDay?: string;
+  /**
+   * @remarks
+   * The total quota for skill plan calls.
+   */
   skillPlanCallQuota?: string;
+  /**
+   * @remarks
+   * The number of skill plan calls used.
+   */
   skillPlanCallUsed?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/OperateCustomAgentRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class OperateCustomAgentRequest extends $dara.Model {
   /**
    * @remarks
+   * Custom Agent ID
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class OperateCustomAgentRequest extends $dara.Model {
   customAgentId?: string;
   /**
    * @remarks
+   * Operation type
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,6 +24,9 @@ export class OperateCustomAgentRequest extends $dara.Model {
    */
   operateType?: string;
   /**
+   * @remarks
+   * Workspace ID
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */

package/src/models/OperateCustomAgentResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class OperateCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Custom Agent ID
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * Operation message
+   * 
    * @example
    * Custom agent successfully released
    */
   message?: string;
   /**
+   * @remarks
+   * Is the operation successful?
+   * 
    * @example
    * true
    */
@@ -44,13 +53,23 @@ export class OperateCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class OperateCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Return struct
+   */
   data?: OperateCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message returned when the call fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
@@ -64,6 +83,13 @@ export class OperateCustomAgentResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Is the request successful? Return values are as follows:
+   * 
+   * - True: The request is successful.
+   * 
+   * - False: The request failed.
+   * 
    * @example
    * true
    */