@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/DescribeCustomAgentResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The parameters to invoke callback tool calling.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating parameters to invoke callback tool calling.
+   * 
+   * @example
+   * send web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The timing to invoke callback tool calling.
+   * 
+   * @example
+   * 0
+   */
   callbackTime?: number;
+  /**
+   * @remarks
+   * The callback tool identifier.
+   * 
+   * @example
+   * Mcp serverId (6te...g7a)
+   */
   toolId?: string;
+  /**
+   * @remarks
+   * The callback tool type.
+   * 
+   * @example
+   * Mcp
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -38,6 +73,13 @@ export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Mod
 }
 
 export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to prohibit appending data sources in a session.
+   * 
+   * @example
+   * true
+   */
   forbiddenAppendDataSource?: boolean;
   /**
    * @remarks
@@ -65,7 +107,7 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
   skipSqlConfirm?: boolean;
   /**
    * @remarks
-   * Specifies whether to skip the web report rendering confirmation.
+   * Specifies whether to skip the confirmation for drawing a web report.
    * 
    * @example
    * false
@@ -101,8 +143,31 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
 }
 
 export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The access type. Valid values:
+   * - mcp: MCP access
+   * - dms_kb: DMS knowledge base access
+   * 
+   * @example
+   * mcp
+   */
   accessType?: string;
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * @example
+   * kb-HZ-6anhdzx7hddf9*******obx
+   */
   kbUuid?: string;
+  /**
+   * @remarks
+   * The MCP server ID.
+   * 
+   * @example
+   * nhdpt9adf6ac**********ca
+   */
   mcpServerId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -130,9 +195,39 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dar
 }
 
 export class DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The DMS database ID.
+   * 
+   * @example
+   * 71991648
+   */
   dbId?: string;
+  /**
+   * @remarks
+   * The DMS instance ID.
+   * 
+   * @example
+   * 2190779
+   */
   instanceId?: string;
+  /**
+   * @remarks
+   * The knowledge UUID.
+   * 
+   * @example
+   * 7ca8f50d78234******e87
+   */
   knowledgeUuid?: string;
+  /**
+   * @remarks
+   * The knowledge semantic type. Valid values:
+   * - sql_template: SQL template
+   * - ossie_model: Ossie semantic view
+   * 
+   * @example
+   * sql_template
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -164,7 +259,7 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList exte
 export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
   /**
    * @remarks
-   * The cron expression for timed scheduling.
+   * The cron expression for time-based periodic scheduling.
    * 
    * @example
    * 0 0 0 ? * 1-7
@@ -172,10 +267,10 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
   cronExpression?: string;
   /**
    * @remarks
-   * The query for the scheduled task.
+   * The question for the periodic task.
    * 
    * @example
-   * Analyze this data and provide a brief report
+   * Analyze the data and provide the report
    */
   query?: string;
   /**
@@ -214,7 +309,17 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
 export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud primary account ID.
+   * The custom agent type. Valid values:
+   * - Default: system-built-in custom agent
+   * - Common: common custom agent
+   * 
+   * @example
+   * Common
+   */
+  agentType?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud main account.
    * 
    * @example
    * 16738266********
@@ -228,6 +333,10 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback feature configuration.
+   */
   callbackConfig?: DescribeCustomAgentResponseBodyDataCallbackConfig;
   /**
    * @remarks
@@ -264,7 +373,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    *   "personal" : {
    *     "DataSourceType" : "remote_data_center",
    *     "FileId" : "f-5qlrwaw10********s3gpw1z",
-   *     "Database" : "TestTable******.xlsx",
+   *     "Database" : "test-table******.xlsx",
    *     "Tables" : [ "Sheet1" ],
    *     "TableIds" : [ "******" ],
    *     "RegionId" : "cn-hangzhou"
@@ -272,13 +381,20 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * }
    */
   dataJson?: string;
+  /**
+   * @remarks
+   * Specifies whether the agent is displayed by default.
+   * 
+   * @example
+   * 1
+   */
   defaultAgent?: number;
   /**
    * @remarks
-   * The description of the custom agent.
+   * The custom agent description.
    * 
    * @example
-   * Agent test description
+   * Description for the test agent
    */
   description?: string;
   /**
@@ -312,18 +428,19 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The instruction.
+   * The instructions.
    * 
    * @example
-   * Analysis framework:
-   * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) by day, week, and month dimensions, and analyze trends and year-over-year/month-over-month fluctuations;
-   * 2. Segment by new/existing customers, channels, and regions to identify growth sources and weaknesses;
-   * 3. Conduct funnel analysis based on user behavior paths (browse → add to cart → payment) to locate drop-off points;
+   * Analytical framework:
+   * 
+   * Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis to analyze trends and identify year-over-year and month-over-month fluctuations.
+   * Segment by new vs. returning customers, channels, and regions to identify growth drivers and areas of weakness.
+   * Conduct funnel analysis based on user behavior paths (browse → add to cart → purchase) to pinpoint stages where user drop-off occurs.
    */
   instruction?: string;
   /**
    * @remarks
-   * Specifies whether a scheduled task is configured.
+   * Specifies whether a periodic task is configured.
    * 
    * @example
    * true
@@ -335,13 +452,22 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * 
    * @example
    * Core metric definitions:
-   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders;
-   * 2. Order volume is the number of valid orders placed per day;
-   * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app;
-   * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency;
+   * 
+   * GMV (Gross Merchandise Volume) refers to the total sum of order amounts, including both paid and unpaid orders.
+   * Order volume refers to the number of valid orders placed per day.
+   * UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
+   * Conversion rate = paid orders / UV, reflecting the efficiency of traffic conversion.
    */
   knowledge?: string;
+  /**
+   * @remarks
+   * The external knowledge bases.
+   */
   knowledgeConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
   /**
    * @remarks
@@ -361,15 +487,15 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   modifierUserName?: string;
   /**
    * @remarks
-   * The name of the custom agent.
+   * The custom agent name.
    * 
    * @example
-   * Agent test name
+   * Test agent name
    */
   name?: string;
   /**
    * @remarks
-   * The next run time of the scheduled task.
+   * The next run time of the periodic task.
    * 
    * @example
    * 1767715200
@@ -383,6 +509,11 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
+  /**
+   * @remarks
+   * The list of recommended questions. You can configure up to 10 recommended questions.
+   */
+  recommendQuestionList?: string[];
   /**
    * @remarks
    * The region.
@@ -401,7 +532,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   relatedSessionId?: string;
   /**
    * @remarks
-   * The publish time.
+   * The release time.
    * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
@@ -409,12 +540,12 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   releaseTime?: string;
   /**
    * @remarks
-   * The scheduled task configuration.
+   * The periodic task configuration.
    */
   scheduleTaskConfig?: DescribeCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
    * @remarks
-   * The status of the custom agent.
+   * The custom agent status.
    * 
    * @example
    * RELEASED
@@ -425,18 +556,34 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * The text report format.
    * 
    * @example
-   * The text report requires all numbers to be converted from Arabic numerals to Chinese numerals
+   * The text report requires that all numbers be written in Chinese numerals rather than Arabic numerals.
    */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The list of user-specified skills.
+   */
   userSpecifiedSkillList?: string[];
   /**
    * @remarks
    * The web report format.
    * 
    * @example
-   * The web report requires all numbers to be converted from Arabic numerals to Chinese numerals
+   * The web report requires that all numbers be written in Chinese numerals rather than Arabic numerals.
    */
   webReportConfig?: string;
+  /**
+   * @remarks
+   * The web report theme. Valid values:
+   * - default: default
+   * - journal: journal
+   * - legacy: classic
+   * - neobrutalism: stylized
+   * - infographic: infographic
+   * 
+   * @example
+   * default
+   */
   webReportTheme?: string;
   /**
    * @remarks
@@ -448,6 +595,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       aliyunParentUid: 'AliyunParentUid',
       aliyunUid: 'AliyunUid',
       callbackConfig: 'CallbackConfig',
@@ -471,6 +619,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
       name: 'Name',
       nextRuntime: 'NextRuntime',
       offlineTime: 'OfflineTime',
+      recommendQuestionList: 'RecommendQuestionList',
       region: 'Region',
       relatedSessionId: 'RelatedSessionId',
       releaseTime: 'ReleaseTime',
@@ -486,6 +635,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       aliyunParentUid: 'string',
       aliyunUid: 'string',
       callbackConfig: DescribeCustomAgentResponseBodyDataCallbackConfig,
@@ -509,6 +659,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
       name: 'string',
       nextRuntime: 'number',
       offlineTime: 'string',
+      recommendQuestionList: { 'type': 'array', 'itemType': 'string' },
       region: 'string',
       relatedSessionId: 'string',
       releaseTime: 'string',
@@ -535,6 +686,9 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
     if(Array.isArray(this.knowledgeSemanticConfigList)) {
       $dara.Model.validateArray(this.knowledgeSemanticConfigList);
     }
+    if(Array.isArray(this.recommendQuestionList)) {
+      $dara.Model.validateArray(this.recommendQuestionList);
+    }
     if(this.scheduleTaskConfig && typeof (this.scheduleTaskConfig as any).validate === 'function') {
       (this.scheduleTaskConfig as any).validate();
     }
@@ -565,7 +719,7 @@ export class DescribeCustomAgentResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.
@@ -581,10 +735,10 @@ export class DescribeCustomAgentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Specifies whether the request is successful. Valid values:
    * 
-   * - **true**: The request was successful.                                 
-   * - **false**: The request failed.
+   * - **true**: The request is successful.                                 
+   * - **false**: The request fails.
    * 
    * @example
    * true

package/src/models/DescribeDataAgentSessionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataAgentSessionRequest extends $dara.Model {
   /**
    * @remarks
-   * The current Data Management unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou