@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/ListCustomAgentResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The callback tool invocation parameters.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating callback tool invocation parameters.
+   * 
+   * @example
+   * Invoke the send_email tool to send the web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The timing for callback tool invocation.
+   * 
+   * @example
+   * The web report rendering is completed
+   */
   callbackTime?: number;
+  /**
+   * @remarks
+   * The callback tool identifier.
+   * 
+   * @example
+   * For example, MCP server ID (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 ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.
 }
 
 export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to prohibit appending data sources in the 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
    * false
@@ -101,8 +143,31 @@ export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara
 }
 
 export class ListCustomAgentResponseBodyDataContentKnowledgeConfigList 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 ListCustomAgentResponseBodyDataContentKnowledgeConfigList extends $
 }
 
 export class ListCustomAgentResponseBodyDataContentKnowledgeSemanticConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The DMS database ID.
+   * 
+   * @example
+   * 69293629
+   */
   dbId?: string;
+  /**
+   * @remarks
+   * The DMS instance ID.
+   * 
+   * @example
+   * 2979631
+   */
   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 ListCustomAgentResponseBodyDataContentKnowledgeSemanticConfigList e
 export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $dara.Model {
   /**
    * @remarks
-   * The cron expression for the timed scheduling.
+   * The cron expression for time-based scheduling.
    * 
    * @example
    * 0 0 0 ? * 1-7
@@ -172,7 +267,7 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
   cronExpression?: string;
   /**
    * @remarks
-   * The query of the periodic task.
+   * The question for the scheduled task.
    * 
    * @example
    * Analyze this data and provide a brief report
@@ -180,7 +275,7 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
   query?: string;
   /**
    * @remarks
-   * The ID of the referenced historical session.
+   * The reference historical session ID.
    * 
    * @example
    * 4m24*****mg7j2v
@@ -214,7 +309,17 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
 export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud primary account ID.
+   * The custom agent type. Valid values:
+   * - Default: The system built-in custom agent.
+   * - Common: The common custom agent.
+   * 
+   * @example
+   * Common
+   */
+  agentType?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud main account.
    * 
    * @example
    * 16738266********
@@ -222,12 +327,16 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   aliyunParentId?: string;
   /**
    * @remarks
-   * The Alibaba Cloud account ID.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback feature configuration.
+   */
   callbackConfig?: ListCustomAgentResponseBodyDataContentCallbackConfig;
   /**
    * @remarks
@@ -239,13 +348,16 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   creatorUserName?: string;
   /**
    * @remarks
-   * The ID of the custom agent.
+   * The custom agent ID.
    * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
@@ -261,7 +373,7 @@ export class ListCustomAgentResponseBodyDataContent 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"
@@ -269,13 +381,20 @@ export class ListCustomAgentResponseBodyDataContent 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
-   * AgentTestDescription
+   * Agent test description
    */
   description?: string;
   /**
@@ -309,18 +428,18 @@ export class ListCustomAgentResponseBodyDataContent 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 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, conversion rate) on a daily, weekly, and monthly basis, and analyze trend changes and year-over-year or month-over-month fluctuations.
+   * 2. Segment by new and existing customers, channels, and regions to identify growth sources and shortcomings.
+   * 3. Conduct funnel analysis based on user behavior paths (browse -> add to cart -> pay) to locate churn points
    */
   instruction?: string;
   /**
    * @remarks
-   * Indicates whether a periodic task is configured.
+   * Specifies whether a scheduled task is configured.
    * 
    * @example
    * true
@@ -332,13 +451,21 @@ export class ListCustomAgentResponseBodyDataContent 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 successfully paid and unpaid orders.
+   * 2. Order volume is 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 = Number of paid orders / UV, reflecting the traffic conversion efficiency
    */
   knowledge?: string;
+  /**
+   * @remarks
+   * The external knowledge bases.
+   */
   knowledgeConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeSemanticConfigList[];
   /**
    * @remarks
@@ -358,15 +485,15 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   modifierUserName?: string;
   /**
    * @remarks
-   * The name of the custom agent.
+   * The custom agent name.
    * 
    * @example
-   * AgentTestName
+   * Agent test name
    */
   name?: string;
   /**
    * @remarks
-   * The next run time of the periodic task.
+   * The next run time of the scheduled task.
    * 
    * @example
    * 1767715200
@@ -380,6 +507,12 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
+  /**
+   * @remarks
+   * The recommended question list.
+   * - You can configure up to 10 recommended questions.
+   */
+  recommendQuestionList?: string[];
   /**
    * @remarks
    * The region.
@@ -388,19 +521,30 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * cn-hangzhou
    */
   region?: string;
+  /**
+   * @remarks
+   * The reference historical session ID.
+   * 
+   * @example
+   * 99crainsjnve******vynid
+   */
   relatedSessionId?: string;
   /**
    * @remarks
-   * The publish time.
+   * The release time.
    * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   releaseTime?: string;
+  /**
+   * @remarks
+   * The scheduled task configuration.
+   */
   scheduleTaskConfig?: ListCustomAgentResponseBodyDataContentScheduleTaskConfig;
   /**
    * @remarks
-   * The status of the custom agent.
+   * The custom agent status.
    * 
    * @example
    * RELEASED
@@ -411,18 +555,34 @@ export class ListCustomAgentResponseBodyDataContent 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 all numbers to be written in Chinese characters instead of Arabic numerals
    */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The user-specified skill list.
+   */
   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 all numbers to be written in Chinese characters instead of Arabic numerals
    */
   webReportConfig?: string;
+  /**
+   * @remarks
+   * The web report theme. Valid values:
+   * - default: Default.
+   * - journal: Journal.
+   * - legacy: Legacy.
+   * - neobrutalism: Neobrutalism.
+   * - infographic: Infographic.
+   * 
+   * @example
+   * default
+   */
   webReportTheme?: string;
   /**
    * @remarks
@@ -434,6 +594,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       aliyunParentId: 'AliyunParentId',
       aliyunUid: 'AliyunUid',
       callbackConfig: 'CallbackConfig',
@@ -457,6 +618,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
       name: 'Name',
       nextRuntime: 'NextRuntime',
       offlineTime: 'OfflineTime',
+      recommendQuestionList: 'RecommendQuestionList',
       region: 'Region',
       relatedSessionId: 'RelatedSessionId',
       releaseTime: 'ReleaseTime',
@@ -472,6 +634,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       aliyunParentId: 'string',
       aliyunUid: 'string',
       callbackConfig: ListCustomAgentResponseBodyDataContentCallbackConfig,
@@ -495,6 +658,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
       name: 'string',
       nextRuntime: 'number',
       offlineTime: 'string',
+      recommendQuestionList: { 'type': 'array', 'itemType': 'string' },
       region: 'string',
       relatedSessionId: 'string',
       releaseTime: 'string',
@@ -521,6 +685,9 @@ export class ListCustomAgentResponseBodyDataContent 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();
     }
@@ -551,7 +718,7 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of records per page.
+   * The number of entries per page.
    * 
    * @example
    * 20
@@ -559,7 +726,7 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 5
@@ -608,7 +775,7 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
 export class ListCustomAgentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response struct.
+   * The returned struct.
    */
   data?: ListCustomAgentResponseBodyData;
   /**
@@ -621,7 +788,7 @@ export class ListCustomAgentResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.
@@ -637,10 +804,10 @@ export class ListCustomAgentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates 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/ListDataAgentAccuracyTestInstancesRequest.ts

@@ -13,7 +13,7 @@ export class ListDataAgentAccuracyTestInstancesRequest extends $dara.Model {
   accuracyTestInsId?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of results to return.
    * 
    * @example
    * 20
@@ -21,7 +21,7 @@ export class ListDataAgentAccuracyTestInstancesRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The next token.
    * 
    * @example
    * Nes****
@@ -45,7 +45,7 @@ export class ListDataAgentAccuracyTestInstancesRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * The workspace ID.
+   * The ID of the workspace.
    * 
    * @example
    * 8wfig6l33n4f4xxxxxxxxxx

package/src/models/ListDataAgentAccuracyTestInstancesResponseBody.ts

@@ -27,6 +27,14 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
    * 20282*****7591
    */
   creator?: string;
+  /**
+   * @remarks
+   * The ID of the test dataset.
+   * 
+   * @example
+   * ds-sdg***jkh
+   */
+  datasetId?: string;
   /**
    * @remarks
    * The data source.
@@ -35,6 +43,14 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
    * null
    */
   datasource?: string;
+  /**
+   * @remarks
+   * The description.
+   * 
+   * @example
+   * null
+   */
+  description?: string;
   /**
    * @remarks
    * The ID of the test set file.
@@ -53,7 +69,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
   gmtCreate?: string;
   /**
    * @remarks
-   * The modification time.
+   * The update time.
    * 
    * @example
    * 2026-06-30T07:31:09.000+00:00
@@ -88,12 +104,12 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
    * The custom agent name.
    * 
    * @example
-   * AgentTestName
+   * Agent test name
    */
   name?: string;
   /**
    * @remarks
-   * Specifies whether sessions are displayed after analysis. This feature is not supported.
+   * Specifies whether the session is displayed after analysis. This feature is currently not supported.
    * 
    * @example
    * true
@@ -101,7 +117,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
   needDelete?: string;
   /**
    * @remarks
-   * The workspace ID.
+   * The ID of the workspace.
    * 
    * @example
    * 8wfig6l33n4f4xxxxxxxxxx
@@ -112,7 +128,9 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
       accuracyTestInsId: 'AccuracyTestInsId',
       agentId: 'AgentId',
       creator: 'Creator',
+      datasetId: 'DatasetId',
       datasource: 'Datasource',
+      description: 'Description',
       fileId: 'FileId',
       gmtCreate: 'GmtCreate',
       gmtModified: 'GmtModified',
@@ -130,7 +148,9 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
       accuracyTestInsId: 'string',
       agentId: 'string',
       creator: 'string',
+      datasetId: 'string',
       datasource: 'string',
+      description: 'string',
       fileId: 'string',
       gmtCreate: 'string',
       gmtModified: 'string',
@@ -155,7 +175,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
 export class ListDataAgentAccuracyTestInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response struct.
+   * The response data.
    */
   data?: ListDataAgentAccuracyTestInstancesResponseBodyData[];
   /**
@@ -176,7 +196,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBody extends $dara.Model
   errorMessage?: string;
   /**
    * @remarks
-   * The maximum number of entries returned per page. You can use this parameter together with NextToken to implement paging.
+   * The maximum number of results to return per request. You can use this parameter with NextToken to paginate results.
    * 
    * @example
    * 20
@@ -184,7 +204,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBody extends $dara.Model
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The next token.
    * 
    * @example
    * zCXS*****
@@ -216,7 +236,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true
@@ -224,7 +244,7 @@ export class ListDataAgentAccuracyTestInstancesResponseBody extends $dara.Model
   success?: string;
   /**
    * @remarks
-   * The operation timestamp.
+   * The timestamp of the operation.
    * 
    * @example
    * 1768270172

package/src/models/ListDataAgentAccuracyTestResultsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataAgentAccuracyTestResultsRequest extends $dara.Model {
   /**
    * @remarks
-   * The instance ID of the accuracy test.
+   * The instance ID of the accuracy test to which the task belongs.
    * 
    * @example
    * at-106n4rg17gv9fxxxxxxxxxx
@@ -13,7 +13,7 @@ export class ListDataAgentAccuracyTestResultsRequest extends $dara.Model {
   accuracyTestInsId?: string;
   /**
    * @remarks
-   * The result ID used to retrieve a single record.
+   * The ID of the result used to exactly match a single record.
    * 
    * @example
    * at-emhnbwewfngrxxxxxxxxxx
@@ -21,7 +21,7 @@ export class ListDataAgentAccuracyTestResultsRequest extends $dara.Model {
   accuracyTestResultId?: string;
   /**
    * @remarks
-   * The subtask ID used to filter results.
+   * The ID of the subtask used to filter results.
    * 
    * @example
    * f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx
@@ -37,7 +37,7 @@ export class ListDataAgentAccuracyTestResultsRequest extends $dara.Model {
   accuracyTestTaskId?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of results per page.
    * 
    * @example
    * nu use
@@ -77,7 +77,7 @@ export class ListDataAgentAccuracyTestResultsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The workspace ID.
+   * The ID of the workspace.
    * 
    * @example
    * 8wfig6l33n4f4xxxxxxxxxx