@alicloud/dms20250414 4.1.0 → 4.2.0

package/src/models/ListCustomAgentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.Model {
   /**
    * @remarks
-   * The parameters to invoke the callback during tool calling.
+   * The callback tool invocation parameters.
    * 
    * @example
    * {"ID":"test"}
@@ -13,7 +13,7 @@ export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.
   callbackArgs?: string;
   /**
    * @remarks
-   * The prompt for generating parameters to invoke the callback during tool calling.
+   * The prompt for generating callback tool invocation parameters.
    * 
    * @example
    * Invoke the send_email tool to send the web report to 123456@163.com
@@ -21,10 +21,10 @@ export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.
   callbackPrompt?: string;
   /**
    * @remarks
-   * The time to invoke the callback during tool calling.
+   * The timing for callback tool invocation.
    * 
    * @example
-   * End of web report generation
+   * The web report rendering is completed
    */
   callbackTime?: number;
   /**
@@ -75,7 +75,7 @@ export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.
 export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to prohibit appending data sources during the session.
+   * Specifies whether to prohibit appending data sources in the session.
    * 
    * @example
    * true
@@ -107,7 +107,7 @@ export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara
   skipSqlConfirm?: boolean;
   /**
    * @remarks
-   * Specifies whether to skip the web report generation confirmation.
+   * Specifies whether to skip the web report rendering confirmation.
    * 
    * @example
    * false
@@ -163,7 +163,7 @@ export class ListCustomAgentResponseBodyDataContentKnowledgeConfigList extends $
   kbUuid?: string;
   /**
    * @remarks
-   * The ID of the MCP server.
+   * The MCP server ID.
    * 
    * @example
    * nhdpt9adf6ac**********ca
@@ -195,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 {
@@ -237,7 +267,7 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
   cronExpression?: string;
   /**
    * @remarks
-   * The query for the scheduled task.
+   * The question for the scheduled task.
    * 
    * @example
    * Analyze this data and provide a brief report
@@ -245,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
@@ -279,7 +309,17 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
 export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud parent 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********
@@ -287,7 +327,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   aliyunParentId?: string;
   /**
    * @remarks
-   * The Alibaba Cloud account ID.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 20372822********
@@ -295,7 +335,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   aliyunUid?: string;
   /**
    * @remarks
-   * The callback configuration.
+   * The callback feature configuration.
    */
   callbackConfig?: ListCustomAgentResponseBodyDataContentCallbackConfig;
   /**
@@ -308,7 +348,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   creatorUserName?: string;
   /**
    * @remarks
-   * The ID of the custom agent.
+   * The custom agent ID.
    * 
    * @example
    * ca-4y3ca4khkcu**********ysf
@@ -351,10 +391,10 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   defaultAgent?: number;
   /**
    * @remarks
-   * The description of the custom agent.
+   * The custom agent description.
    * 
    * @example
-   * Sample agent description
+   * Agent test description
    */
   description?: string;
   /**
@@ -392,8 +432,8 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * 
    * @example
    * Analysis framework:
-   * 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/month-over-month fluctuations.
-   * 2. Break down data by new and returning customers, channels, and regions to identify growth sources and weaknesses.
+   * 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;
@@ -411,8 +451,8 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * 
    * @example
    * Core metric definitions:
-   * 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 orders placed per day.
+   * 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
    */
@@ -422,6 +462,10 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * The external knowledge bases.
    */
   knowledgeConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeSemanticConfigList[];
   /**
    * @remarks
@@ -441,10 +485,10 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   modifierUserName?: string;
   /**
    * @remarks
-   * The name of the custom agent.
+   * The custom agent name.
    * 
    * @example
-   * Sample agent name
+   * Agent test name
    */
   name?: string;
   /**
@@ -463,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.
@@ -473,7 +523,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The ID of the referenced historical session.
+   * The reference historical session ID.
    * 
    * @example
    * 99crainsjnve******vynid
@@ -494,7 +544,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   scheduleTaskConfig?: ListCustomAgentResponseBodyDataContentScheduleTaskConfig;
   /**
    * @remarks
-   * The status of the custom agent.
+   * The custom agent status.
    * 
    * @example
    * RELEASED
@@ -505,12 +555,12 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * The text report format.
    * 
    * @example
-   * The text report requires all numbers to be written as Chinese characters instead of Arabic numerals
+   * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
    */
   textReportConfig?: string;
   /**
    * @remarks
-   * The list of user-specified skills.
+   * The user-specified skill list.
    */
   userSpecifiedSkillList?: string[];
   /**
@@ -518,7 +568,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * The web report format.
    * 
    * @example
-   * The web report requires all numbers to be written as Chinese characters instead of Arabic numerals
+   * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
    */
   webReportConfig?: string;
   /**
@@ -544,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',
@@ -567,6 +618,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
       name: 'Name',
       nextRuntime: 'NextRuntime',
       offlineTime: 'OfflineTime',
+      recommendQuestionList: 'RecommendQuestionList',
       region: 'Region',
       relatedSessionId: 'RelatedSessionId',
       releaseTime: 'ReleaseTime',
@@ -582,6 +634,7 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       aliyunParentId: 'string',
       aliyunUid: 'string',
       callbackConfig: ListCustomAgentResponseBodyDataContentCallbackConfig,
@@ -605,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',
@@ -631,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();
     }
@@ -731,7 +788,7 @@ export class ListCustomAgentResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.

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

package/src/models/ListDataAgentAccuracyTestResultsResponseBody.ts

@@ -13,12 +13,19 @@ export class ListDataAgentAccuracyTestResultsResponseBodyDataContent extends $da
   accuracyTestTaskId?: string;
   /**
    * @remarks
-   * The actual answer from the agent.
+   * The actual answer provided by the agent.
    * 
    * @example
-   * 在公司历史职位记录中，共有97,750名员工曾拥有Senior Engineer头衔。
+   * In the company\\"s historical job records, a total of 97,750 employees have previously held the title of Senior Engineer.
    */
   agentResult?: string;
+  /**
+   * @remarks
+   * The SQL statement generated by DataAgent.
+   * 
+   * @example
+   * SELECT COUNT(*) FROM titles WHERE title = \\"Senior Engineer\\";
+   */
   agentSql?: string;
   /**
    * @remarks
@@ -30,7 +37,7 @@ export class ListDataAgentAccuracyTestResultsResponseBodyDataContent extends $da
   answerResult?: string;
   /**
    * @remarks
-   * The expected SQL.
+   * The expected SQL statement.
    * 
    * @example
    * SELECT COUNT(*) FROM titles WHERE title = \\"Senior Engineer\\";
@@ -49,37 +56,44 @@ export class ListDataAgentAccuracyTestResultsResponseBodyDataContent extends $da
    * The test question.
    * 
    * @example
-   * 拥有Senior Engineer头衔的员工有多少人？
+   * How many employees hold the title of Senior Engineer?
    */
   question?: string;
   /**
    * @remarks
-   * The error reason.
+   * The cause of the error.
    * 
    * @example
-   * SQL 中不应该使用COUNT(DISTINCT)
+   * COUNT(DISTINCT) should not be used in SQL.
    */
   reason?: string;
   /**
    * @remarks
-   * The improvement suggestion.
+   * The improvement suggestions.
    * 
    * @example
-   * 在问题中描述清楚是否需去重
+   * Clearly specify in the problem description whether deduplication is required.
    */
   recommendation?: string;
   /**
    * @remarks
-   * The result ID.
+   * The ID of the result.
    * 
    * @example
    * at-emhnbwewfngrxxxxxxxxxx
    */
   resultId?: string;
+  /**
+   * @remarks
+   * The ID of the session corresponding to the evaluation subtask.
+   * 
+   * @example
+   * bnd7***2e5
+   */
   sessionId?: string;
   /**
    * @remarks
-   * The subtask ID.
+   * The ID of the subtask.
    * 
    * @example
    * f1eb8728-xxxx-xxxx-xxxx-xxxxxxxxxxxx
@@ -152,12 +166,19 @@ export class ListDataAgentAccuracyTestResultsResponseBodyData extends $dara.Mode
   content?: ListDataAgentAccuracyTestResultsResponseBodyDataContent[];
   /**
    * @remarks
-   * The number of test cases that passed evaluation.
+   * The number of test cases that passed the evaluation.
    * 
    * @example
    * 9
    */
   correctCount?: number;
+  /**
+   * @remarks
+   * The number of failed subtasks.
+   * 
+   * @example
+   * 5
+   */
   failedCount?: string;
   /**
    * @remarks
@@ -175,6 +196,13 @@ export class ListDataAgentAccuracyTestResultsResponseBodyData extends $dara.Mode
    * 50
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The number of pending subtasks.
+   * 
+   * @example
+   * 10
+   */
   pendingCount?: string;
   /**
    * @remarks
@@ -250,7 +278,7 @@ export class ListDataAgentAccuracyTestResultsResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * UnknownError
@@ -258,7 +286,7 @@ export class ListDataAgentAccuracyTestResultsResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of results per page.
    * 
    * @example
    * no use
@@ -282,10 +310,10 @@ export class ListDataAgentAccuracyTestResultsResponseBody 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/ListDataAgentWorkspaceRequest.ts

@@ -45,7 +45,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The sort field name.
+   * The name of the field to sort by.
    * 
    * @example
    * CreateTime
@@ -53,7 +53,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The page number.
+   * The starting page number.
    * 
    * This parameter is required.
    * 
@@ -81,7 +81,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   workspaceName?: string;
   /**
    * @remarks
-   * The workspace type.
+   * The workspace type to query.
    * 
    * This parameter is required.
    *