@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/CreateCustomAgentRequest.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateCustomAgentRequestCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The parameters to invoke the callback tool.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating the parameters to invoke the callback tool.
+   * 
+   * @example
+   * send web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The timing to invoke the callback tool.
+   * 
+   * @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 CreateCustomAgentRequestCallbackConfig extends $dara.Model {
 }
 
 export class CreateCustomAgentRequestExecutionConfig 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 CreateCustomAgentRequestExecutionConfig extends $dara.Model {
   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 CreateCustomAgentRequestExecutionConfig extends $dara.Model {
 export class CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
   /**
    * @remarks
-   * The access type.
-   * 
-   * - mcp: access through MCP.
+   * The access type. If you do not specify this parameter, the default value is mcp. Valid values:
+   * - mcp: access through MCP. You must pass the McpServerId parameter.
+   * - dms_kb: access through DMS knowledge base. You must pass the KbUuid parameter.
    * 
    * @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 CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
 }
 
 export class CreateCustomAgentRequestKnowledgeSemanticConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The DMS database ID.
+   * 
+   * @example
+   * 81512473
+   */
   dbId?: string;
+  /**
+   * @remarks
+   * The DMS instance ID.
+   * 
+   * @example
+   * 1532071
+   */
   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 {
@@ -228,6 +307,20 @@ export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
 }
 
 export class CreateCustomAgentRequest 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.
+   */
   callbackConfig?: CreateCustomAgentRequestCallbackConfig;
   /**
    * @remarks
@@ -239,18 +332,18 @@ export class CreateCustomAgentRequest 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.
    * ```
    * {
@@ -271,16 +364,16 @@ export class CreateCustomAgentRequest 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.
    * ```
    * {
@@ -312,7 +405,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
    *   "personal" : {
    *     "DataSourceType" : "remote_data_center",
    *     "FileId" : "f-5qlrwaw10********s3gpw1z",
-   *     "Database" : "测试表格******.xlsx",
+   *     "Database" : "Test table******.xlsx",
    *     "Tables" : [ "Sheet1" ],
    *     "TableIds" : [ "******" ],
    *     "RegionId" : "cn-hangzhou"
@@ -325,7 +418,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
    * The description of the custom agent.
    * 
    * @example
-   * AgentTestDescription
+   * Agent test description
    */
   description?: string;
   /**
@@ -335,47 +428,60 @@ export class CreateCustomAgentRequest extends $dara.Model {
   executionConfig?: CreateCustomAgentRequestExecutionConfig;
   /**
    * @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.
    */
   knowledgeConfigList?: CreateCustomAgentRequestKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: CreateCustomAgentRequestKnowledgeSemanticConfigList[];
   /**
    * @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.
+   */
+  recommendQuestionList?: string[];
   /**
    * @remarks
    * The ID of the referenced historical session.
+   * 
+   * @example
+   * 99crainsjnveo*******vynid
    */
   relatedSessionId?: string;
   /**
@@ -388,18 +494,29 @@ export class CreateCustomAgentRequest 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.
+   * 
+   * @example
+   * Default
+   */
   webReportTheme?: string;
   /**
    * @remarks
@@ -411,6 +528,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       callbackConfig: 'CallbackConfig',
       DMSUnit: 'DMSUnit',
       dataJson: 'DataJson',
@@ -421,6 +539,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
       knowledgeConfigList: 'KnowledgeConfigList',
       knowledgeSemanticConfigList: 'KnowledgeSemanticConfigList',
       name: 'Name',
+      recommendQuestionList: 'RecommendQuestionList',
       relatedSessionId: 'RelatedSessionId',
       scheduleTaskConfig: 'ScheduleTaskConfig',
       textReportConfig: 'TextReportConfig',
@@ -433,6 +552,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       callbackConfig: CreateCustomAgentRequestCallbackConfig,
       DMSUnit: 'string',
       dataJson: 'string',
@@ -443,6 +563,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
       knowledgeConfigList: { 'type': 'array', 'itemType': CreateCustomAgentRequestKnowledgeConfigList },
       knowledgeSemanticConfigList: { 'type': 'array', 'itemType': CreateCustomAgentRequestKnowledgeSemanticConfigList },
       name: 'string',
+      recommendQuestionList: { 'type': 'array', 'itemType': 'string' },
       relatedSessionId: 'string',
       scheduleTaskConfig: CreateCustomAgentRequestScheduleTaskConfig,
       textReportConfig: 'string',
@@ -466,6 +587,9 @@ export class CreateCustomAgentRequest 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();
     }