@alicloud/dms20250414 3.1.0 → 4.1.0

package/src/models/ListCustomAgentRequest.ts

@@ -13,7 +13,7 @@ export class ListCustomAgentRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of records per page. Default value: 20.
+   * The number of entries per page. Default value: 20.
    * 
    * @example
    * 20
@@ -21,7 +21,7 @@ export class ListCustomAgentRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Specifies whether to query all custom agents in the published state. Default value: false.
+   * Specifies whether to query all published custom agents. Default value: false.
    * 
    * @example
    * true
@@ -29,10 +29,10 @@ export class ListCustomAgentRequest extends $dara.Model {
   queryAllReleased?: boolean;
   /**
    * @remarks
-   * The search keyword. Supports fuzzy search by custom agent name and description.
+   * The search keyword. Fuzzy search is supported for custom agent names and descriptions.
    * 
    * @example
-   * TestAgent
+   * Test Agent
    */
   searchKey?: string;
   /**

package/src/models/ListCustomAgentResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The parameters to invoke the callback during tool calling.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating parameters to invoke the callback during tool calling.
+   * 
+   * @example
+   * Invoke the send_email tool to send the web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The time to invoke the callback during tool calling.
+   * 
+   * @example
+   * End of web report generation
+   */
   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 during 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
@@ -65,7 +107,7 @@ export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara
   skipSqlConfirm?: boolean;
   /**
    * @remarks
-   * Specifies whether to skip the web report rendering confirmation.
+   * Specifies whether to skip the web report generation confirmation.
    * 
    * @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 ID of the MCP server.
+   * 
+   * @example
+   * nhdpt9adf6ac**********ca
+   */
   mcpServerId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -164,7 +229,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 +237,7 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
   cronExpression?: string;
   /**
    * @remarks
-   * The query of the periodic task.
+   * The query for the scheduled task.
    * 
    * @example
    * Analyze this data and provide a brief report
@@ -214,7 +279,7 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
 export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud primary account ID.
+   * The Alibaba Cloud parent account ID.
    * 
    * @example
    * 16738266********
@@ -228,6 +293,10 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback configuration.
+   */
   callbackConfig?: ListCustomAgentResponseBodyDataContentCallbackConfig;
   /**
    * @remarks
@@ -246,6 +315,9 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
@@ -261,7 +333,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 +341,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.
    * 
    * @example
-   * AgentTestDescription
+   * Sample agent description
    */
   description?: string;
   /**
@@ -309,18 +388,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/month-over-month fluctuations.
+   * 2. Break down data by new and returning customers, channels, and regions to identify growth sources and weaknesses.
+   * 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,12 +411,16 @@ 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 paid and unpaid orders.
+   * 2. Order volume refers to the number of valid orders placed per day.
+   * 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[];
   knowledgeSemanticConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeSemanticConfigList[];
   /**
@@ -361,12 +444,12 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * The name of the custom agent.
    * 
    * @example
-   * AgentTestName
+   * Sample agent name
    */
   name?: string;
   /**
    * @remarks
-   * The next run time of the periodic task.
+   * The next run time of the scheduled task.
    * 
    * @example
    * 1767715200
@@ -388,15 +471,26 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
    * cn-hangzhou
    */
   region?: string;
+  /**
+   * @remarks
+   * The ID of the referenced historical session.
+   * 
+   * @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
@@ -411,18 +505,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 as Chinese characters 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 converted from Arabic numerals to Chinese numerals
+   * The web report requires all numbers to be written as 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
@@ -551,7 +661,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 +669,7 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 5
@@ -608,7 +718,7 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
 export class ListCustomAgentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response struct.
+   * The returned struct.
    */
   data?: ListCustomAgentResponseBodyData;
   /**
@@ -621,7 +731,7 @@ export class ListCustomAgentResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.
@@ -637,10 +747,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/ListDataAgentWorkspaceRequest.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListDataAgentWorkspaceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the creator used to search for workspaces.
+   * 
+   * @example
+   * 186xxx9947
+   */
   creator?: string;
   /**
    * @remarks
@@ -14,7 +21,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of results per page.
    * 
    * @example
    * no use
@@ -22,7 +29,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The next token.
    * 
    * @example
    * no use
@@ -38,7 +45,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The name of the field by which to sort.
+   * The sort field name.
    * 
    * @example
    * CreateTime
@@ -56,7 +63,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of records per page.
+   * The number of entries per page.
    * 
    * This parameter is required.
    * 
@@ -66,7 +73,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * The workspace name.
+   * The name of the workspace.
    * 
    * @example
    * workspaceTest
@@ -74,7 +81,7 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   workspaceName?: string;
   /**
    * @remarks
-   * The type of workspace to query.
+   * The workspace type.
    * 
    * This parameter is required.
    * 

package/src/models/ListDataAgentWorkspaceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataAgentWorkspaceResponseBodyDataContent extends $dara.Model {
   /**
    * @remarks
-   * The creation time of the workspace, in milliseconds (UNIX timestamp).
+   * The time when the workspace was created. The value is a timestamp in milliseconds.
    * 
    * @example
    * 1765960516000
@@ -19,6 +19,13 @@ export class ListDataAgentWorkspaceResponseBodyDataContent extends $dara.Model {
    * 20282*****7591
    */
   creator?: string;
+  /**
+   * @remarks
+   * The name of the workspace creator.
+   * 
+   * @example
+   * test
+   */
   creatorName?: string;
   /**
    * @remarks
@@ -38,7 +45,7 @@ export class ListDataAgentWorkspaceResponseBodyDataContent extends $dara.Model {
   isSessionShareEnabled?: boolean;
   /**
    * @remarks
-   * The most recent modification time of the workspace, in milliseconds (UNIX timestamp).
+   * The time when the workspace was last modified. The value is a timestamp in milliseconds.
    * 
    * @example
    * 1765961516000
@@ -46,21 +53,35 @@ export class ListDataAgentWorkspaceResponseBodyDataContent extends $dara.Model {
   modifyTime?: number;
   /**
    * @remarks
-   * The role name of the user in the workspace.
+   * The name of the user\\"s role in the workspace.
    * 
    * @example
    * admin
    */
   roleName?: string;
+  /**
+   * @remarks
+   * The number of running sessions in the workspace.
+   * 
+   * @example
+   * 15
+   */
   runningSessionCount?: number;
   /**
    * @remarks
-   * The number of members in the workspace.
+   * The total number of members in the workspace.
    * 
    * @example
    * 11
    */
   totalMember?: number;
+  /**
+   * @remarks
+   * The total number of sessions in the workspace.
+   * 
+   * @example
+   * 30
+   */
   totalSessionCount?: number;
   /**
    * @remarks
@@ -227,7 +248,7 @@ export class ListDataAgentWorkspaceResponseBody 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 is not valid.
@@ -235,7 +256,7 @@ export class ListDataAgentWorkspaceResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of results per page.
    * 
    * @example
    * nu use
@@ -243,7 +264,7 @@ export class ListDataAgentWorkspaceResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The next token.
    * 
    * @example
    * no use