@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/DescribeCustomAgentResponseBody.ts

@@ -3,10 +3,30 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The callback arguments.
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The callback prompt.
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The callback time.
+   */
   callbackTime?: number;
+  /**
+   * @remarks
+   * The tool ID.
+   */
   toolId?: string;
+  /**
+   * @remarks
+   * The callback type.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -38,13 +58,37 @@ export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Mod
 }
 
 export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to disable prompts that require human intervention.
+   * 
+   * @example
+   * false
+   */
   skipAskHuman?: boolean;
   /**
+   * @remarks
+   * Specifies whether to skip the plan confirmation step.
+   * 
    * @example
    * true
    */
   skipPlan?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to skip all SQL confirmations.
+   * 
+   * @example
+   * true
+   */
   skipSqlConfirm?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to skip confirmation before a web report is generated.
+   * 
+   * @example
+   * false
+   */
   skipWebReportConfirm?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -74,8 +118,20 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
 }
 
 export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The access type.
+   */
   accessType?: string;
+  /**
+   * @remarks
+   * The UUID of the knowledge base.
+   */
   kbUuid?: string;
+  /**
+   * @remarks
+   * The ID of the MCP server.
+   */
   mcpServerId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -103,8 +159,29 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dar
 }
 
 export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The cron expression for the scheduled task.
+   * 
+   * @example
+   * 0 0 0 ? * 1-7
+   */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The task query.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
+  /**
+   * @remarks
+   * The ID of the related historical session.
+   * 
+   * @example
+   * 4m24*****mg7j2v
+   */
   relatedSessionId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -133,95 +210,244 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
 
 export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the parent Alibaba Cloud account.
+   * 
    * @example
    * 16738266********
    */
   aliyunParentUid?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID.
+   * 
    * @example
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback configuration.
+   */
   callbackConfig?: DescribeCustomAgentResponseBodyDataCallbackConfig;
   /**
+   * @remarks
+   * The username of the creator.
+   * 
    * @example
    * HaoY*****
    */
   creatorUserName?: string;
   /**
+   * @remarks
+   * The ID of the custom agent.
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
+  /**
+   * @remarks
+   * The data scope, formatted as a JSON string.
+   * 
+   * @example
+   * {
+   *   "tableFlag" : true,
+   *   "scope" : "personal",
+   *   "personal" : {
+   *     "DataSourceType" : "remote_data_center",
+   *     "FileId" : "f-5qlrwaw10********s3gpw1z",
+   *     "Database" : "测试表格******.xlsx",
+   *     "Tables" : [ "Sheet1" ],
+   *     "TableIds" : [ "******" ],
+   *     "RegionId" : "cn-hangzhou"
+   *   }
+   * }
+   */
   dataJson?: string;
+  /**
+   * @remarks
+   * Indicates whether this is the default agent.
+   */
   defaultAgent?: number;
+  /**
+   * @remarks
+   * The description of the custom agent.
+   * 
+   * @example
+   * Agent测试描述
+   */
   description?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
+  /**
+   * @remarks
+   * The execution configuration.
+   */
   executionConfig?: DescribeCustomAgentResponseBodyDataExecutionConfig;
   /**
+   * @remarks
+   * The time when the agent was created.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The time when the agent was last modified.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtModified?: string;
+  /**
+   * @remarks
+   * The instruction for the agent\\"s analysis.
+   * 
+   * @example
+   * 分析框架：
+   * 1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；
+   * 2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；
+   * 3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；
+   */
   instruction?: string;
+  /**
+   * @remarks
+   * Indicates whether a scheduled task is configured.
+   * 
+   * @example
+   * true
+   */
   isScheduleTask?: boolean;
+  /**
+   * @remarks
+   * The domain knowledge for the agent.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
+  /**
+   * @remarks
+   * The knowledge configurations.
+   */
   knowledgeConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeConfigList[];
   /**
+   * @remarks
+   * The ID of the user who last modified the agent.
+   * 
    * @example
    * 20372822********
    */
   modifier?: string;
   /**
+   * @remarks
+   * The username of the modifier.
+   * 
    * @example
    * HaoY*****
    */
   modifierUserName?: string;
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
+  /**
+   * @remarks
+   * The next scheduled execution time.
+   * 
+   * @example
+   * 1767715200
+   */
   nextRuntime?: number;
   /**
+   * @remarks
+   * The time when the agent was taken offline.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
   /**
+   * @remarks
+   * The region.
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
   /**
+   * @remarks
+   * The ID of the related historical session.
+   * 
    * @example
    * 5xyz...
    */
   relatedSessionId?: string;
   /**
+   * @remarks
+   * The release time.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   releaseTime?: string;
+  /**
+   * @remarks
+   * The configuration of the scheduled task.
+   */
   scheduleTaskConfig?: DescribeCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
+   * @remarks
+   * The status of the custom agent. Valid values:
+   * 
    * @example
    * RELEASED
    */
   status?: string;
+  /**
+   * @remarks
+   * The formatting requirements for the text report.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The formatting requirements for the web report.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */
@@ -318,26 +544,43 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the custom agent.
+   */
   data?: DescribeCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DescribeDataAgentSessionRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDataAgentSessionRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * The ID of the agent session.
+   * 
    * @example
-   * c61n7gmopfvuascr70xmavzrj
+   * c61n7gm******rj
    */
   sessionId?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 12****
    */

package/src/models/DescribeDataAgentSessionResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extends $dara.Model {
+  /**
+   * @remarks
+   * The key of the session replay history item.
+   * 
+   * @example
+   * testKey1
+   */
   key?: string;
+  /**
+   * @remarks
+   * The OSS download URL for the session replay history item.
+   * 
+   * @example
+   * ****
+   */
   url?: string;
   static names(): { [key: string]: string } {
     return {
@@ -30,16 +44,29 @@ export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extend
 
 export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the custom agent.
+   * 
    * @example
    * ca-e*******ckd
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The stage of the custom agent. Valid values:
+   * 
+   * - **debug**: The test stage.
+   * 
+   * - **prod**: The production stage.
+   * 
    * @example
    * debug
    */
   customAgentStage?: string;
   /**
+   * @remarks
+   * Indicates whether web search is enabled.
+   * 
    * @example
    * True
    */
@@ -48,18 +75,47 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   encryptType?: string;
   kbUuidList?: string[];
   /**
+   * @remarks
+   * The language. Valid values:
+   * 
+   * - **CHINESE**: Chinese
+   * 
+   * - **ENGLISH**: English
+   * 
    * @example
    * CHINESE
    */
   language?: string;
+  /**
+   * @remarks
+   * A list of MCP server IDs.
+   */
   mcpServerIds?: string[];
   /**
+   * @remarks
+   * The mode. Valid values:
+   * 
+   * - **ASK_DATA**: quick inquiry mode
+   * 
+   * - **ANALYSIS**: analysis mode
+   * 
+   * - **INSIGHT**: insight mode
+   * 
    * @example
    * ANALYSIS
    */
   mode?: string;
   reportPageWidth?: number;
   reportWaterMark?: string;
+  /**
+   * @remarks
+   * The name of the user\\"s OSS bucket.
+   * 
+   * - The service can upload analysis files and reports to this bucket.
+   * 
+   * @example
+   * user-oss-bucket
+   */
   userOssBucket?: string;
   static names(): { [key: string]: string } {
     return {
@@ -112,40 +168,94 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
 
 export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the agent.
+   * 
    * @example
    * cu0cs*******mf
    */
   agentId?: string;
+  /**
+   * @remarks
+   * The status of the agent.
+   * 
+   * @example
+   * RUNNING
+   */
   agentStatus?: string;
+  /**
+   * @remarks
+   * The session replay history.
+   */
   chatHistoryLocations?: DescribeDataAgentSessionResponseBodyDataChatHistoryLocations[];
   /**
+   * @remarks
+   * The timestamp indicating when the session was created.
+   * 
    * @example
    * 1731645908000
    */
   createTime?: number;
   /**
+   * @remarks
+   * Indicates whether the current user has favorited the session in the workspace.
+   * 
    * @example
    * true
    */
   favoriteInWorkspace?: string;
   /**
+   * @remarks
+   * The ID of the file.
+   * 
    * @example
    * f-8*******01m
    */
   file?: string;
   /**
+   * @remarks
+   * Indicates whether the current user has favorited the session.
+   * 
    * @example
    * true
    */
   saved?: boolean;
+  /**
+   * @remarks
+   * The configuration of the session.
+   */
   sessionConfig?: DescribeDataAgentSessionResponseBodyDataSessionConfig;
   /**
+   * @remarks
+   * The ID of the agent session.
+   * 
    * @example
    * 976*********p
    */
   sessionId?: string;
+  /**
+   * @remarks
+   * The status of the session.
+   * 
+   * @example
+   * RUNNING
+   */
   sessionStatus?: string;
+  /**
+   * @remarks
+   * The title of the session.
+   * 
+   * @example
+   * 分析一下这份文件，给出报告。
+   */
   title?: string;
+  /**
+   * @remarks
+   * The ID of the session owner.
+   * 
+   * @example
+   * 2096******
+   */
   userId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -197,26 +307,43 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDataAgentSessionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response data.
+   */
   data?: DescribeDataAgentSessionResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned when the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 18****-*****-*******7A3122F
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DescribeDocumentRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDocumentRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the document.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeDocumentRequest extends $dara.Model {
   documentName?: string;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example