@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/CreateCustomAgentResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCustomAgentResponseBodyDataCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The callback tool invocation parameters.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating callback tool invocation parameters.
+   * 
+   * @example
+   * send web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The callback tool invocation timing.
+   * 
+   * @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,10 +73,17 @@ export class CreateCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
 }
 
 export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to prohibit appending data sources in a session.
+   * 
+   * @example
+   * true
+   */
   forbiddenAppendDataSource?: boolean;
   /**
    * @remarks
-   * Specifies whether to disable user inquiries during the process.
+   * Specifies whether to prohibit user inquiries during the process.
    * 
    * @example
    * true
@@ -65,7 +107,7 @@ export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
   skipSqlConfirm?: boolean;
   /**
    * @remarks
-   * Specifies whether to skip the web report generation confirmation.
+   * Specifies whether to skip the confirmation for generating a web report.
    * 
    * @example
    * true
@@ -103,18 +145,25 @@ export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
 export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
   /**
    * @remarks
-   * The access type.
-   * 
-   * - mcp: access through MCP.
+   * 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 ID of the MCP Server.
+   * The MCP server ID.
    * 
    * @example
    * nhdpt9adf6ac**********ca
@@ -146,9 +195,39 @@ export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.
 }
 
 export class CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The DMS database ID.
+   * 
+   * @example
+   * 69305251
+   */
   dbId?: string;
+  /**
+   * @remarks
+   * The DMS instance ID.
+   * 
+   * @example
+   * 2943299
+   */
   instanceId?: string;
+  /**
+   * @remarks
+   * The knowledge UUID.
+   * 
+   * @example
+   * 7ca8f50d782*******02e87
+   */
   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 {
@@ -230,7 +309,17 @@ export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
 export class CreateCustomAgentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud account ID of the parent account.
+   * The custom agent type. Valid values:
+   * - Default: The system-built-in custom agent.
+   * - Common: The common custom agent.
+   * 
+   * @example
+   * Common
+   */
+  agentType?: string;
+  /**
+   * @remarks
+   * The Alibaba Cloud main account ID.
    * 
    * @example
    * 16738266********
@@ -244,6 +333,10 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback feature configuration.
+   */
   callbackConfig?: CreateCustomAgentResponseBodyDataCallbackConfig;
   /**
    * @remarks
@@ -280,7 +373,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
    *   "personal" : {
    *     "DataSourceType" : "remote_data_center",
    *     "FileId" : "f-5qlrwaw10********s3gpw1z",
-   *     "Database" : "测试表格******.xlsx",
+   *     "Database" : "Test table******.xlsx",
    *     "Tables" : [ "Sheet1" ],
    *     "TableIds" : [ "******" ],
    *     "RegionId" : "cn-hangzhou"
@@ -293,7 +386,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
    * The description of the custom agent.
    * 
    * @example
-   * AgentTestDescription
+   * Agent test description
    */
   description?: string;
   /**
@@ -327,18 +420,18 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The instruction.
+   * The instructions.
    * 
    * @example
    * Analysis framework:
-   * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) on a daily, weekly, and monthly basis, and analyze trends and year-over-year/month-over-month fluctuations.
-   * 2. Segment by new/existing customers, channels, and regions to identify growth drivers and weaknesses.
-   * 3. Conduct funnel analysis based on user behavior paths (browse → add to cart → payment) to identify drop-off points
+   * 1. Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis to analyze trend changes and year-over-year or month-over-month fluctuations.
+   * 2. Segment data by new and existing customers, channels, and regions to identify growth drivers and shortcomings.
+   * 3. Conduct funnel analysis based on user behavior paths (browse > add to cart > checkout) to identify churn stages
    */
   instruction?: string;
   /**
    * @remarks
-   * Indicates whether a periodic task is configured.
+   * Indicates whether a scheduled task is configured.
    * 
    * @example
    * false
@@ -350,17 +443,21 @@ export class CreateCustomAgentResponseBodyData 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
+   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
+   * 2. Order volume refers to the number of valid daily orders.
+   * 3. UV (Unique Visitors) refers to the number of deduplicated users visiting the website or app.
+   * 4. Conversion rate = Paid orders / UV, reflecting the traffic conversion efficiency
    */
   knowledge?: string;
   /**
    * @remarks
-   * The external knowledge base.
+   * The external knowledge bases.
    */
   knowledgeConfigList?: CreateCustomAgentResponseBodyDataKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
   /**
    * @remarks
@@ -383,12 +480,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
    * The name of the custom agent.
    * 
    * @example
-   * AgentTestName
+   * Agent test name
    */
   name?: string;
   /**
    * @remarks
-   * The next run time of the periodic task.
+   * The next run time of the scheduled task.
    * - Timestamp format.
    * 
    * @example
@@ -403,6 +500,12 @@ export class CreateCustomAgentResponseBodyData 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.
@@ -414,11 +517,14 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The ID of the referenced historical session.
+   * 
+   * @example
+   * 99crainsjnv*******vynid
    */
   relatedSessionId?: string;
   /**
    * @remarks
-   * The publish time.
+   * The release time.
    * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
@@ -426,12 +532,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   releaseTime?: string;
   /**
    * @remarks
-   * The periodic task configuration.
+   * The scheduled task configuration.
    */
   scheduleTaskConfig?: CreateCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
    * @remarks
-   * The status of the custom agent.
+   * The custom agent status.
    * 
    * @example
    * NEW
@@ -442,18 +548,34 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
    * The text report format.
    * 
    * @example
-   * The text report requires all numbers to be expressed in Chinese characters instead of Arabic numerals
+   * The text report requires that all numbers be written as Chinese numerals instead of 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 expressed in Chinese characters instead of Arabic numerals
+   * The web report requires that all numbers be written as Chinese numerals instead of Arabic numerals
    */
   webReportConfig?: string;
+  /**
+   * @remarks
+   * The web report theme. Valid values:
+   * - default: Default.
+   * - journal: Journal.
+   * - legacy: Classic.
+   * - neobrutalism: Neobrutalism.
+   * - infographic: Infographic.
+   * 
+   * @example
+   * default
+   */
   webReportTheme?: string;
   /**
    * @remarks
@@ -465,6 +587,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       aliyunParentUid: 'AliyunParentUid',
       aliyunUid: 'AliyunUid',
       callbackConfig: 'CallbackConfig',
@@ -487,6 +610,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
       name: 'Name',
       nextRuntime: 'NextRuntime',
       offlineTime: 'OfflineTime',
+      recommendQuestionList: 'RecommendQuestionList',
       region: 'Region',
       relatedSessionId: 'RelatedSessionId',
       releaseTime: 'ReleaseTime',
@@ -502,6 +626,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       aliyunParentUid: 'string',
       aliyunUid: 'string',
       callbackConfig: CreateCustomAgentResponseBodyDataCallbackConfig,
@@ -524,6 +649,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
       name: 'string',
       nextRuntime: 'number',
       offlineTime: 'string',
+      recommendQuestionList: { 'type': 'array', 'itemType': 'string' },
       region: 'string',
       relatedSessionId: 'string',
       releaseTime: 'string',
@@ -550,6 +676,9 @@ export class CreateCustomAgentResponseBodyData 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();
     }
@@ -580,7 +709,7 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the request failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.
@@ -596,10 +725,9 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - True: The request was successful.                                 
-   * - False: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - True: The request is successful.
+   * - False: The request fails.
    * 
    * @example
    * true

package/src/models/CreateCustomAgentShrinkRequest.ts

@@ -3,6 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCustomAgentShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the custom agent. Valid values:
+   * - Default: the system-built-in custom agent. Each workspace can have at most one Default agent, and it cannot be deleted.
+   * - Common: a regular custom agent.
+   * 
+   * @example
+   * Common
+   */
+  agentType?: string;
+  /**
+   * @remarks
+   * The callback feature configuration.
+   */
   callbackConfigShrink?: string;
   /**
    * @remarks
@@ -14,18 +28,18 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The specified data scope in **JSON character string format**.
-   * - Common metric description
-   *   - tableFlag: true indicates that a data scope is specified.
+   * The specified data scope, in **JSON character string format**.
+   * - General parameter descriptions
+   *   - tableFlag: true specifies the data scope.
    *   - scope: personal is a fixed value.
-   *   - personal: pass parameters for file or database types.
+   *   - personal: the parameters for file and database types.
    * 
-   * **File type**. Pass parameters in the following format:
+   * **File type**: pass parameters in the following format:
    * - DataSourceType: remote_data_center is a fixed value.
    * - FileId: the file ID.
-   * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name.
-   * - Tables: the table name returned by the ListDataCenterTable operation.
-   * - TableIds: the TableId returned by the ListDataCenterTable operation.
+   * - Database: the database name returned by the ListDataCenterTable operation, which is usually 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.
    * ```
    * {
@@ -46,16 +60,16 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * }
    * ```
    * 
-   * **Database type**. Pass parameters as follows:
+   * **Database type**: pass parameters in the following format:
    * - DataSourceType: database is a fixed value.
-   * - DmsInstanceId: the DMS instance ID returned by the data center operation.
-   * - DmsDatabaseId: the DMS database ID returned by the data center operation.
-   * - FileId: the instance name (deprecated).
-   * - DbName: the database name returned by the data center operation.
-   * - Database: the database name returned by the data center operation.
-   * - Tables: the table name returned by the data center operation.
-   * - TableIds: the TableId returned by the data center operation.
-   * - Engine: the DPI engine type (mysql or postgresql).
+   * - DmsInstanceId: the DMS instance ID returned by the data center API.
+   * - DmsDatabaseId: the DMS database ID returned by the data center API.
+   * - FileId: the instance name (**[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, such as mysql or postgresql.
    * - RegionId: the current region.
    * ```
    * {
@@ -87,7 +101,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    *   "personal" : {
    *     "DataSourceType" : "remote_data_center",
    *     "FileId" : "f-5qlrwaw10********s3gpw1z",
-   *     "Database" : "测试表格******.xlsx",
+   *     "Database" : "Test table******.xlsx",
    *     "Tables" : [ "Sheet1" ],
    *     "TableIds" : [ "******" ],
    *     "RegionId" : "cn-hangzhou"
@@ -100,7 +114,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * The description of the custom agent.
    * 
    * @example
-   * AgentTestDescription
+   * Agent test description
    */
   description?: string;
   /**
@@ -110,47 +124,60 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
   executionConfigShrink?: string;
   /**
    * @remarks
-   * The instruction.
-   * - Input limit: a maximum of 10000 characters.
+   * The instructions.
+   * - Input limit: up to 10,000 characters.
    * 
    * @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
+   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
+   * 2. Order volume refers to the number of valid daily orders.
+   * 3. UV (Unique Visitors) refers to the number of deduplicated users visiting the website or app.
+   * 4. Conversion rate = Paid orders / UV, reflecting the traffic conversion efficiency
    */
   instruction?: string;
   /**
    * @remarks
    * The knowledge.
-   * - Input limit: a maximum of 10000 characters.
+   * - Input limit: up to 10,000 characters.
    * 
    * @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
+   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
+   * 2. Order volume refers to the number of valid daily orders.
+   * 3. UV (Unique Visitors) refers to the number of deduplicated users visiting the website or app.
+   * 4. Conversion rate = Paid orders / UV, reflecting the traffic conversion efficiency
    */
   knowledge?: string;
   /**
    * @remarks
-   * The external knowledge base.
+   * The external knowledge bases.
    */
   knowledgeConfigListShrink?: string;
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigListShrink?: string;
   /**
    * @remarks
    * The name of the custom agent.
    * 
    * @example
-   * AgentTestName
+   * Agent test name
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of recommended questions.
+   * - You can configure up to 10 recommended questions.
+   */
+  recommendQuestionListShrink?: string;
   /**
    * @remarks
    * The ID of the referenced historical session.
+   * 
+   * @example
+   * 99crainsjnveo*******vynid
    */
   relatedSessionId?: string;
   /**
@@ -163,18 +190,29 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * The text report format.
    * 
    * @example
-   * The text report requires all numbers to be expressed in Chinese characters instead of Arabic numerals
+   * The text report requires that all numbers be written as Chinese numerals instead of Arabic numerals
    */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The list of user-specified skills.
+   */
   userSpecifiedSkillListShrink?: string;
   /**
    * @remarks
    * The web report format.
    * 
    * @example
-   * The web report requires all numbers to be expressed in Chinese characters instead of Arabic numerals
+   * The web report requires that all numbers be written as Chinese numerals instead of Arabic numerals
    */
   webReportConfig?: string;
+  /**
+   * @remarks
+   * The web report theme.
+   * 
+   * @example
+   * Default
+   */
   webReportTheme?: string;
   /**
    * @remarks
@@ -186,6 +224,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       callbackConfigShrink: 'CallbackConfig',
       DMSUnit: 'DMSUnit',
       dataJson: 'DataJson',
@@ -196,6 +235,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
       knowledgeConfigListShrink: 'KnowledgeConfigList',
       knowledgeSemanticConfigListShrink: 'KnowledgeSemanticConfigList',
       name: 'Name',
+      recommendQuestionListShrink: 'RecommendQuestionList',
       relatedSessionId: 'RelatedSessionId',
       scheduleTaskConfigShrink: 'ScheduleTaskConfig',
       textReportConfig: 'TextReportConfig',
@@ -208,6 +248,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       callbackConfigShrink: 'string',
       DMSUnit: 'string',
       dataJson: 'string',
@@ -218,6 +259,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
       knowledgeConfigListShrink: 'string',
       knowledgeSemanticConfigListShrink: 'string',
       name: 'string',
+      recommendQuestionListShrink: 'string',
       relatedSessionId: 'string',
       scheduleTaskConfigShrink: 'string',
       textReportConfig: 'string',

package/src/models/CreateDataAgentSkillMetaRequest.ts

@@ -6,7 +6,7 @@ export class CreateDataAgentSkillMetaRequest extends $dara.Model {
   /**
    * @remarks
    * The skill description.
-   * - By default, this parameter is optional. The backend parses the ZIP package specified by UploadLocation to obtain the skill description.
+   * - Optional. If not specified, the system parses the ZIP package specified by UploadLocation to obtain the skill description.
    * 
    * @example
    * This is a demo skill description.
@@ -15,7 +15,7 @@ export class CreateDataAgentSkillMetaRequest extends $dara.Model {
   /**
    * @remarks
    * The skill name.
-   * - By default, this parameter is optional. The backend parses the ZIP package specified by UploadLocation to obtain the skill name.
+   * - Optional. If not specified, the system parses the ZIP package specified by UploadLocation to obtain the skill name.
    * 
    * @example
    * data-query-skill
@@ -23,8 +23,8 @@ export class CreateDataAgentSkillMetaRequest extends $dara.Model {
   skillName?: string;
   /**
    * @remarks
-   * The full path for uploading the skill ZIP file.
-   * - Format: The UploadDir field returned by the DescribeSkillFileUploadSignature operation concatenated with the file name.
+   * The full path to the uploaded skill ZIP file.
+   * - Format: Concatenate the file name to the UploadDir value returned by the DescribeSkillFileUploadSignature operation.
    * - Example: ${UploadDir}/${Filename}
    */
   uploadLocation?: string;