@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/CreateCustomAgentRequest.ts

@@ -39,21 +39,33 @@ export class CreateCustomAgentRequestCallbackConfig extends $dara.Model {
 
 export class CreateCustomAgentRequestExecutionConfig extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to skip asking the user for 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 web report confirmation step.
+   * 
    * @example
    * true
    */
@@ -87,12 +99,20 @@ export class CreateCustomAgentRequestExecutionConfig extends $dara.Model {
 
 export class CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
   /**
+   * @remarks
+   * The access type.
+   * 
+   * - `mcp`: Access via an MCP server.
+   * 
    * @example
    * mcp
    */
   accessType?: string;
   kbUuid?: string;
   /**
+   * @remarks
+   * The ID of the MCP server.
+   * 
    * @example
    * nhdpt9adf6ac**********ca
    */
@@ -124,12 +144,25 @@ export class CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
 
 export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
   /**
+   * @remarks
+   * The cron expression for the scheduled task.
+   * 
    * @example
    * 0 0 0 ? * 1-7
    */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The query for the scheduled task.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
   /**
+   * @remarks
+   * The ID of a previous session to use for reference.
+   * 
    * @example
    * 4m24*****mg7j2v
    */
@@ -162,22 +195,198 @@ export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
 export class CreateCustomAgentRequest extends $dara.Model {
   callbackConfig?: CreateCustomAgentRequestCallbackConfig;
   /**
+   * @remarks
+   * The ID of the DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
+  /**
+   * @remarks
+   * The data range, specified as a **JSON string**.
+   * 
+   * - General parameters
+   * 
+   *   - `tableFlag`: Set to `true` to specify a data range.
+   * 
+   *   - `scope`: The value must be `personal`.
+   * 
+   *   - `personal`: Contains the parameters for a file or database.
+   * 
+   * **File type**: Use the following parameters.
+   * 
+   * - `DataSourceType`: The value must be `remote_data_center`.
+   * 
+   * - `FileId`: The ID of the file.
+   * 
+   * - `Database`: The name of the database returned by the `ListDataCenterTable` operation. This is typically the file name.
+   * 
+   * - `Tables`: The names of the tables 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"
+   *   }
+   * }
+   * ```
+   * 
+   * **Database type**: Use the following parameters.
+   * 
+   * - `DataSourceType`: The value must be `database`.
+   * 
+   * - `DmsInstanceId`: The ID of the DMS instance returned by the data center API.
+   * 
+   * - `DmsDatabaseId`: The ID of the DMS database returned by the data center API.
+   * 
+   * - `FileId`: The instance name. This parameter is deprecated.
+   * 
+   * - `DbName`: The name of the database returned by the data center API.
+   * 
+   * - `Database`: The name of the database returned by the data center API.
+   * 
+   * - `Tables`: The names of the tables returned by the data center API.
+   * 
+   * - `TableIds`: The table IDs returned by the data center API.
+   * 
+   * - `Engine`: The database engine. 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?: CreateCustomAgentRequestExecutionConfig;
+  /**
+   * @remarks
+   * The instruction for the custom agent.
+   * 
+   * - Maximum length: 10,000 characters.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   instruction?: string;
+  /**
+   * @remarks
+   * The knowledge for the custom agent.
+   * 
+   * - Maximum length: 10,000 characters.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
+  /**
+   * @remarks
+   * A list of external knowledge bases.
+   */
   knowledgeConfigList?: CreateCustomAgentRequestKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
   relatedSessionId?: string;
+  /**
+   * @remarks
+   * The configuration for the scheduled task.
+   */
   scheduleTaskConfig?: CreateCustomAgentRequestScheduleTaskConfig;
+  /**
+   * @remarks
+   * The formatting requirements for the text report.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The formatting requirements for the web report.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */

package/src/models/CreateCustomAgentResponseBody.ts

@@ -39,21 +39,33 @@ export class CreateCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
 
 export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether to prevent the agent from asking the user for clarification during execution.
+   * 
    * @example
    * true
    */
   skipAskHuman?: boolean;
   /**
+   * @remarks
+   * Indicates whether to skip the plan confirmation step.
+   * 
    * @example
    * true
    */
   skipPlan?: boolean;
   /**
+   * @remarks
+   * Indicates whether to skip all SQL confirmations.
+   * 
    * @example
    * true
    */
   skipSqlConfirm?: boolean;
   /**
+   * @remarks
+   * Indicates whether to skip the web report generation confirmation.
+   * 
    * @example
    * true
    */
@@ -87,12 +99,20 @@ export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
 
 export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
   /**
+   * @remarks
+   * The access method.
+   * 
+   * - `mcp`: Connects using MCP.
+   * 
    * @example
    * mcp
    */
   accessType?: string;
   kbUuid?: string;
   /**
+   * @remarks
+   * The ID of the MCP server.
+   * 
    * @example
    * nhdpt9adf6ac**********ca
    */
@@ -124,12 +144,25 @@ export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.
 
 export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
   /**
+   * @remarks
+   * The cron expression for the scheduled task.
+   * 
    * @example
    * 0 0 0 ? * 1-7
    */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The query for the scheduled task.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
   /**
+   * @remarks
+   * The ID of a previous session to be used as a template for the scheduled task.
+   * 
    * @example
    * 4m24*****mg7j2v
    */
@@ -161,98 +194,230 @@ export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
 
 export class CreateCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The primary Alibaba Cloud account ID.
+   * 
    * @example
    * 16738266********
    */
   aliyunParentUid?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID.
+   * 
    * @example
    * 20372822********
    */
   aliyunUid?: string;
   callbackConfig?: CreateCustomAgentResponseBodyDataCallbackConfig;
   /**
+   * @remarks
+   * The username of the creator.
+   * 
    * @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 specified data scope, in a JSON string 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 description of the custom agent.
+   * 
+   * @example
+   * Agent测试描述
+   */
   description?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
+  /**
+   * @remarks
+   * The execution configuration.
+   */
   executionConfig?: CreateCustomAgentResponseBodyDataExecutionConfig;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The 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 for the agent.
+   * 
    * @example
    * false
    */
   isScheduleTask?: boolean;
+  /**
+   * @remarks
+   * The knowledge for the agent.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
+  /**
+   * @remarks
+   * A list of external knowledge bases.
+   */
   knowledgeConfigList?: CreateCustomAgentResponseBodyDataKnowledgeConfigList[];
   /**
+   * @remarks
+   * The ID of the user who last modified the agent.
+   * 
    * @example
    * 20372822********
    */
   modifier?: string;
   /**
+   * @remarks
+   * The username of the user who last modified the agent.
+   * 
    * @example
    * HaoY*****
    */
   modifierUserName?: string;
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
   /**
+   * @remarks
+   * The next run time of the scheduled task, formatted as a UNIX timestamp.
+   * 
+   * - Timestamp format
+   * 
    * @example
    * 1767715200
    */
   nextRuntime?: number;
   /**
+   * @remarks
+   * The offline time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
   /**
+   * @remarks
+   * The region.
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
   relatedSessionId?: string;
   /**
+   * @remarks
+   * The release time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   releaseTime?: string;
+  /**
+   * @remarks
+   * The configuration of the scheduled task.
+   */
   scheduleTaskConfig?: CreateCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
+   * @remarks
+   * The status of the custom agent.
+   * 
    * @example
    * NEW
    */
   status?: string;
+  /**
+   * @remarks
+   * The format of the text report.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The format of the web report.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 20923*****7291
    */
@@ -347,26 +512,43 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class CreateCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response data.
+   */
   data?: CreateCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @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
    */