@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/ModifyCustomAgentRequest.ts

@@ -3,10 +3,30 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyCustomAgentRequestCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The arguments for the callback.
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt to use for the callback.
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The timestamp of the callback.
+   */
   callbackTime?: number;
+  /**
+   * @remarks
+   * The ID of the tool to call.
+   */
   toolId?: string;
+  /**
+   * @remarks
+   * The callback type.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -39,21 +59,33 @@ export class ModifyCustomAgentRequestCallbackConfig extends $dara.Model {
 
 export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to prevent the agent from asking for user input during execution.
+   * 
    * @example
    * true
    */
   skipAskHuman?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip the plan confirmation step.
+   * 
    * @example
    * true
    */
   skipPlan?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip all SQL confirmation steps.
+   * 
    * @example
    * true
    */
   skipSqlConfirm?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip the confirmation for web report generation.
+   * 
    * @example
    * true
    */
@@ -87,12 +119,24 @@ export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
 
 export class ModifyCustomAgentRequestKnowledgeConfigList extends $dara.Model {
   /**
+   * @remarks
+   * The access type.
+   * 
+   * - `mcp`: Connects via the MCP service.
+   * 
    * @example
    * mcp
    */
   accessType?: string;
+  /**
+   * @remarks
+   * The UUID of the knowledge base.
+   */
   kbUuid?: string;
   /**
+   * @remarks
+   * The ID of the MCP server.
+   * 
    * @example
    * nhdpt9adf6ac**********ca
    */
@@ -124,12 +168,25 @@ export class ModifyCustomAgentRequestKnowledgeConfigList extends $dara.Model {
 
 export class ModifyCustomAgentRequestScheduleTaskConfig extends $dara.Model {
   /**
+   * @remarks
+   * The cron expression for the scheduled task.
+   * 
    * @example
    * 0 0 0,1 ? * 1-7
    */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The query for the scheduled task.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
   /**
+   * @remarks
+   * The ID of a previous session to use as a reference.
+   * 
    * @example
    * 4m24*****mg7j2v
    */
@@ -160,9 +217,15 @@ export class ModifyCustomAgentRequestScheduleTaskConfig extends $dara.Model {
 }
 
 export class ModifyCustomAgentRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The callback configuration.
+   */
   callbackConfig?: ModifyCustomAgentRequestCallbackConfig;
   /**
    * @remarks
+   * The ID of the custom agent.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -170,22 +233,201 @@ export class ModifyCustomAgentRequest 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.
+   */
   executionConfig?: ModifyCustomAgentRequestExecutionConfig;
+  /**
+   * @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.
+   */
   knowledgeConfigList?: ModifyCustomAgentRequestKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
   relatedSessionId?: string;
+  /**
+   * @remarks
+   * The configuration for the scheduled task.
+   */
   scheduleTaskConfig?: ModifyCustomAgentRequestScheduleTaskConfig;
+  /**
+   * @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/ModifyCustomAgentResponseBody.ts

@@ -3,10 +3,30 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyCustomAgentResponseBodyDataCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The callback arguments.
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The callback prompt.
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The callback timestamp.
+   */
   callbackTime?: number;
+  /**
+   * @remarks
+   * The ID of the tool to be called.
+   */
   toolId?: string;
+  /**
+   * @remarks
+   * The callback type.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -39,21 +59,33 @@ export class ModifyCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
 
 export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to skip asking for human input during execution.
+   * 
    * @example
    * true
    */
   skipAskHuman?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip plan confirmation.
+   * 
    * @example
    * true
    */
   skipPlan?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip all SQL confirmations.
+   * 
    * @example
    * true
    */
   skipSqlConfirm?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip web report confirmation.
+   * 
    * @example
    * true
    */
@@ -87,12 +119,24 @@ export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
 
 export class ModifyCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
   /**
+   * @remarks
+   * The access type.
+   * 
+   * - mcp: Connects via MCP.
+   * 
    * @example
    * mcp
    */
   accessType?: string;
+  /**
+   * @remarks
+   * The knowledge base UUID.
+   */
   kbUuid?: string;
   /**
+   * @remarks
+   * The MCP server ID.
+   * 
    * @example
    * nhdpt9adf6ac**********ca
    */
@@ -124,12 +168,25 @@ export class ModifyCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.
 
 export class ModifyCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
   /**
+   * @remarks
+   * The cron expression for the task.
+   * 
    * @example
    * 0 0 0 ? * 1-7
    */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The query for the task.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
   /**
+   * @remarks
+   * The ID of a reference session.
+   * 
    * @example
    * 4m24*****mg7j2v
    */
@@ -161,98 +218,238 @@ export class ModifyCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
 
 export class ModifyCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The main Alibaba Cloud account ID.
+   * 
    * @example
    * 16738266********
    */
   aliyunParentUid?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID.
+   * 
    * @example
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback configuration.
+   */
   callbackConfig?: ModifyCustomAgentResponseBodyDataCallbackConfig;
   /**
+   * @remarks
+   * Name of the user who created the agent.
+   * 
    * @example
    * HaoY*****
    */
   creatorUserName?: string;
   /**
+   * @remarks
+   * The custom agent ID.
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
+  /**
+   * @remarks
+   * The data scope in JSON format.
+   * 
+   * @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 custom agent description.
+   * 
+   * @example
+   * Agent测试描述
+   */
   description?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
+  /**
+   * @remarks
+   * The execution configuration.
+   */
   executionConfig?: ModifyCustomAgentResponseBodyDataExecutionConfig;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The last modification time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtModified?: string;
+  /**
+   * @remarks
+   * The instruction for the agent.
+   * 
+   * @example
+   * 分析框架：
+   * 1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；
+   * 2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；
+   * 3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；
+   */
   instruction?: string;
   /**
+   * @remarks
+   * Indicates whether a scheduled task is configured.
+   * 
    * @example
    * false
    */
   isScheduleTask?: boolean;
+  /**
+   * @remarks
+   * The text-based knowledge for the agent.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
+  /**
+   * @remarks
+   * Configurations for external knowledge bases.
+   */
   knowledgeConfigList?: ModifyCustomAgentResponseBodyDataKnowledgeConfigList[];
   /**
+   * @remarks
+   * ID of the last modifier.
+   * 
    * @example
    * 20372822********
    */
   modifier?: string;
   /**
+   * @remarks
+   * Name of the user who last modified the agent.
+   * 
    * @example
    * HaoY*****
    */
   modifierUserName?: string;
+  /**
+   * @remarks
+   * The custom agent name.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
   /**
+   * @remarks
+   * The next runtime for the scheduled task.
+   * 
+   * - This value is a UNIX timestamp.
+   * 
    * @example
    * 1767715200
    */
   nextRuntime?: number;
   /**
+   * @remarks
+   * The offline time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
+  /**
+   * @remarks
+   * The ID of a reference session.
+   */
   relatedSessionId?: string;
   /**
+   * @remarks
+   * The release time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   releaseTime?: string;
+  /**
+   * @remarks
+   * The scheduled task configuration.
+   */
   scheduleTaskConfig?: ModifyCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
+   * @remarks
+   * The agent status.
+   * 
    * @example
    * RELEASED
    */
   status?: string;
+  /**
+   * @remarks
+   * Formatting requirements for the text report.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * Formatting requirements for the web report.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */
@@ -347,26 +544,43 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class ModifyCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response data.
+   */
   data?: ModifyCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @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
    */