@alicloud/dms20250414 4.1.0 → 4.2.0

package/src/models/DescribeCustomAgentResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The parameters to invoke callback tool calling.
+   * 
+   * @example
+   * {"ID":"test"}
+   */
   callbackArgs?: string;
+  /**
+   * @remarks
+   * The prompt for generating parameters to invoke callback tool calling.
+   * 
+   * @example
+   * send web report to 123456@163.com
+   */
   callbackPrompt?: string;
+  /**
+   * @remarks
+   * The timing to invoke callback tool calling.
+   * 
+   * @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 {
@@ -40,7 +75,7 @@ export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Mod
 export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to prohibit appending data sources during a session.
+   * Specifies whether to prohibit appending data sources in a session.
    * 
    * @example
    * true
@@ -48,7 +83,7 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
   forbiddenAppendDataSource?: boolean;
   /**
    * @remarks
-   * Specifies whether to prohibit user inquiries during the process.
+   * Specifies whether to disable user inquiries during the process.
    * 
    * @example
    * false
@@ -72,7 +107,7 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
   skipSqlConfirm?: boolean;
   /**
    * @remarks
-   * Specifies whether to skip the confirmation for generating a web report.
+   * Specifies whether to skip the confirmation for drawing a web report.
    * 
    * @example
    * false
@@ -111,8 +146,8 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dar
   /**
    * @remarks
    * The access type. Valid values:
-   * - mcp: Accessed through MCP.
-   * - dms_kb: Accessed through DMS knowledge base.
+   * - mcp: MCP access
+   * - dms_kb: DMS knowledge base access
    * 
    * @example
    * mcp
@@ -160,9 +195,39 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dar
 }
 
 export class DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList extends $dara.Model {
+  /**
+   * @remarks
+   * The DMS database ID.
+   * 
+   * @example
+   * 71991648
+   */
   dbId?: string;
+  /**
+   * @remarks
+   * The DMS instance ID.
+   * 
+   * @example
+   * 2190779
+   */
   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 {
@@ -194,7 +259,7 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList exte
 export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
   /**
    * @remarks
-   * The cron expression for time-based scheduling.
+   * The cron expression for time-based periodic scheduling.
    * 
    * @example
    * 0 0 0 ? * 1-7
@@ -202,7 +267,7 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
   cronExpression?: string;
   /**
    * @remarks
-   * The query for the scheduled task.
+   * The question for the periodic task.
    * 
    * @example
    * Analyze the data and provide the report
@@ -244,7 +309,17 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
 export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The primary Alibaba Cloud account ID.
+   * The custom agent type. Valid values:
+   * - Default: system-built-in custom agent
+   * - Common: common custom agent
+   * 
+   * @example
+   * Common
+   */
+  agentType?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud main account.
    * 
    * @example
    * 16738266********
@@ -258,6 +333,10 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * 20372822********
    */
   aliyunUid?: string;
+  /**
+   * @remarks
+   * The callback feature configuration.
+   */
   callbackConfig?: DescribeCustomAgentResponseBodyDataCallbackConfig;
   /**
    * @remarks
@@ -304,7 +383,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   dataJson?: string;
   /**
    * @remarks
-   * Indicates whether the agent is displayed by default.
+   * Specifies whether the agent is displayed by default.
    * 
    * @example
    * 1
@@ -312,7 +391,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   defaultAgent?: number;
   /**
    * @remarks
-   * The description of the custom agent.
+   * The custom agent description.
    * 
    * @example
    * Description for the test agent
@@ -361,7 +440,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   instruction?: string;
   /**
    * @remarks
-   * Indicates whether a scheduled task is configured.
+   * Specifies whether a periodic task is configured.
    * 
    * @example
    * true
@@ -385,6 +464,10 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * The external knowledge bases.
    */
   knowledgeConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeConfigList[];
+  /**
+   * @remarks
+   * The knowledge semantic configuration list.
+   */
   knowledgeSemanticConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
   /**
    * @remarks
@@ -404,7 +487,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   modifierUserName?: string;
   /**
    * @remarks
-   * The name of the custom agent.
+   * The custom agent name.
    * 
    * @example
    * Test agent name
@@ -412,7 +495,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The next run time of the scheduled task.
+   * The next run time of the periodic task.
    * 
    * @example
    * 1767715200
@@ -426,6 +509,11 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
+  /**
+   * @remarks
+   * The list of recommended questions. You can configure up to 10 recommended questions.
+   */
+  recommendQuestionList?: string[];
   /**
    * @remarks
    * The region.
@@ -452,12 +540,12 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   releaseTime?: string;
   /**
    * @remarks
-   * The scheduled task configuration.
+   * The periodic task configuration.
    */
   scheduleTaskConfig?: DescribeCustomAgentResponseBodyDataScheduleTaskConfig;
   /**
    * @remarks
-   * The status of the custom agent.
+   * The custom agent status.
    * 
    * @example
    * RELEASED
@@ -487,11 +575,11 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The web report theme. Valid values:
-   * - default: Default.
-   * - journal: Journal.
-   * - legacy: Classic.
-   * - neobrutalism: Stylized.
-   * - infographic: Infographic.
+   * - default: default
+   * - journal: journal
+   * - legacy: classic
+   * - neobrutalism: stylized
+   * - infographic: infographic
    * 
    * @example
    * default
@@ -507,6 +595,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
+      agentType: 'AgentType',
       aliyunParentUid: 'AliyunParentUid',
       aliyunUid: 'AliyunUid',
       callbackConfig: 'CallbackConfig',
@@ -530,6 +619,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
       name: 'Name',
       nextRuntime: 'NextRuntime',
       offlineTime: 'OfflineTime',
+      recommendQuestionList: 'RecommendQuestionList',
       region: 'Region',
       relatedSessionId: 'RelatedSessionId',
       releaseTime: 'ReleaseTime',
@@ -545,6 +635,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      agentType: 'string',
       aliyunParentUid: 'string',
       aliyunUid: 'string',
       callbackConfig: DescribeCustomAgentResponseBodyDataCallbackConfig,
@@ -568,6 +659,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
       name: 'string',
       nextRuntime: 'number',
       offlineTime: 'string',
+      recommendQuestionList: { 'type': 'array', 'itemType': 'string' },
       region: 'string',
       relatedSessionId: 'string',
       releaseTime: 'string',
@@ -594,6 +686,9 @@ export class DescribeCustomAgentResponseBodyData 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();
     }
@@ -640,7 +735,7 @@ export class DescribeCustomAgentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful. Valid values:
+   * Specifies whether the request is successful. Valid values:
    * 
    * - **true**: The request is successful.                                 
    * - **false**: The request fails.

package/src/models/DescribeFileUploadSignatureRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeFileUploadSignatureRequest extends $dara.Model {
   /**
    * @remarks
-   * The parameter used only by the frontend.
+   * For frontend use only.
    * 
    * @example
-   * 仅前端使用
+   * For frontend use only
    */
   callFrom?: string;
   /**
@@ -19,6 +19,13 @@ export class DescribeFileUploadSignatureRequest extends $dara.Model {
    * cn-hangzhou
    */
   dmsUnit?: string;
+  /**
+   * @remarks
+   * The workspace ID.
+   * 
+   * @example
+   * yrgug4e*******ypey63v
+   */
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeFileUploadSignatureResponseBody.ts

@@ -10,7 +10,7 @@ export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
   ossCredential?: string;
   /**
    * @remarks
-   * The time of the request. The format follows the ISO 8601 date and time standard.
+   * The time of the request, which follows the ISO 8601 date and time standard.
    * 
    * @example
    * 20260101T135341Z
@@ -18,7 +18,7 @@ export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
   ossDate?: string;
   /**
    * @remarks
-   * The STS token used to upload files to OSS. The token is valid for 1 hour.
+   * The STS token used to upload files to OSS, valid for one hour.
    * 
    * @example
    * CAIS4gJ1q6Ft5B2yfSjIr5vPHMj4p+lHx/utUUjg13ptZ+5u3oDzkzz2IHhMdXlrCOgYt/8xnG1V6f8flrJ/ToQAX0HfatZq5ZkS9AqnaoXM/te496IFg5D9y7dIs8GgjqHoeOzcYI73WJXEMiLp9EJaxb/9ak/RPTiMOoGIjphKd8keWhLCAxNNGNZRIHkJyqZYTwyzU8ygKRn3mGHdIVN1sw5n8wNF5L+439eX52i17jS46JdM/9ysesH5NpQxbMwkDYnk5oEsKPqdihw3wgNR6aJ7gJZD/Tr6pdyHCzFTmU7ea7uEqYw3clYiOPBnRvEd8eKPnPl5q/HVm4Hs0wxKNuxOSCXZS4yp3MLeH+ekJgOGwWFHz9qnOLmtQXqV22tMCRpzXIj6Zlmz+/reI6iNW+Ory74mxSFbrz3ZP4yv+o+Yv3QbMVumcySkKVbBbVvnv0R8GNsIC2lMUbp+rfShhfFuG2QagAECCyigwAlSAryrFmteD+EVuvxvi0NE7zDJLbUkhek6dcY+/u5V5jcmvL67CQ7bTNk+9lV8WDCvtoCD9ucqTaHweJEd8fS2DaFedAMDf8BfZa2C1CTLhVXdSgE2WORYbMqidelRm7dH3fTbZVvryWKDaveDRLt5J/Qfs**********
@@ -26,7 +26,7 @@ export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
   ossSecurityToken?: string;
   /**
    * @remarks
-   * The description information used for signature authentication.
+   * The description used for signature authentication.
    * 
    * @example
    * 9bebe0900716bdefaab899781c7bdfd614ec6ed711e0de5ddf6f5a**********
@@ -42,7 +42,7 @@ export class DescribeFileUploadSignatureResponseBodyData extends $dara.Model {
   ossSignatureVersion?: string;
   /**
    * @remarks
-   * The permission restrictions and constraints for file uploads.
+   * The permission limits and constraints for file uploads.
    * 
    * @example
    * eyJjb25kaXRpb25zIjpbeyJ4LW9zcy1jcmVkZW50aWFsIjoiU1RTLk5YeldyTEo2ZnA5RlNuUTN6OGthQjFFWH**********
@@ -112,7 +112,7 @@ export class DescribeFileUploadSignatureResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the call fails.
+   * The error message returned when the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.

package/src/models/DmsKnowledgeSearchOrderInfoDo.ts

@@ -3,40 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DmsKnowledgeSearchOrderInfoDO extends $dara.Model {
-  /**
-   * @remarks
-   * The UID of the Alibaba Cloud account.
-   */
   aliyunAccountUid?: string;
-  /**
-   * @remarks
-   * The API key used for authentication.
-   */
   apiKey?: string;
-  /**
-   * @remarks
-   * The time when the entry was created.
-   */
   gmtCreate?: string;
-  /**
-   * @remarks
-   * The time when the entry was last modified.
-   */
   gmtModified?: string;
-  /**
-   * @remarks
-   * The unique ID of the entry.
-   */
   id?: number;
-  /**
-   * @remarks
-   * The unique ID of the order.
-   */
   orderId?: string;
-  /**
-   * @remarks
-   * The endpoint URL for the web search API.
-   */
   webSearchApiUrl?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/FileUploadCallbackRequest.ts

@@ -13,7 +13,7 @@ export class FileUploadCallbackRequest extends $dara.Model {
   callFrom?: string;
   /**
    * @remarks
-   * The current Data Management unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou
@@ -21,7 +21,7 @@ export class FileUploadCallbackRequest extends $dara.Model {
   dmsUnit?: string;
   /**
    * @remarks
-   * The file size, in bytes.
+   * The size of the file, in bytes.
    * 
    * @example
    * 8110
@@ -29,7 +29,7 @@ export class FileUploadCallbackRequest extends $dara.Model {
   fileSize?: number;
   /**
    * @remarks
-   * The file name.
+   * The name of the file.
    * 
    * This parameter is required.
    * 
@@ -37,16 +37,31 @@ export class FileUploadCallbackRequest extends $dara.Model {
    * conversion_metrics.csv
    */
   filename?: string;
+  /**
+   * @remarks
+   * The name of the user\\"s OSS bucket.
+   * - Specify this parameter to use a file in the user\\"s OSS bucket and register the file as a data center file through the callback.
+   * 
+   * @example
+   * bgc-hangzhou-test-bucket
+   */
   ossBucket?: string;
   /**
    * @remarks
    * The full path of the uploaded file.
-   * - Format: The UploadDir field returned by the DescribeFileUploadSignature operation concatenated with the file name.
+   * - Format: Concatenate the UploadDir field returned by the DescribeFileUploadSignature operation with the file name.
    * - Example: ${UploadDir}/${Filename}
    * 
    * This parameter is required.
    */
   uploadLocation?: string;
+  /**
+   * @remarks
+   * The ID of the workspace.
+   * 
+   * @example
+   * ccihe433d3*******lxljv
+   */
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/FileUploadCallbackResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class FileUploadCallbackResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The file ID.
+   * The ID of the file.
    * 
    * @example
    * f-8*******01m
@@ -48,7 +48,7 @@ export class FileUploadCallbackResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * Specified parameter Tid is not valid.
@@ -64,9 +64,9 @@ export class FileUploadCallbackResponseBody 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.                                 
+   * - **true**: The request is successful.                                 
    * - **false**: The request failed.
    * 
    * @example

package/src/models/GetAgenticAgentByInstallTokenRequest.ts

@@ -5,7 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetAgenticAgentByInstallTokenRequest extends $dara.Model {
   /**
    * @remarks
+   * The one-time install token issued by IssueAgenticInstallToken. The token starts with dit_ followed by 40 URL-safe Base64 characters, making a total length of 44 characters.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * dit_0123456789abcdefghijklmnopqrstuvwxyzABCD
    */
   installToken?: string;
   static names(): { [key: string]: string } {

package/src/models/GetAgenticAgentByInstallTokenResponseBody.ts

@@ -3,14 +3,74 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetAgenticAgentByInstallTokenResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The prefix list of visible access tokens that are neither revoked nor expired under the agent. This parameter is empty if no access tokens are returned or no access tokens meet the conditional criteria. The prefix is used only to identify the credential and does not contain the complete secret.
+   */
   activeApiKeyPrefixes?: string[];
+  /**
+   * @remarks
+   * The unique identifier of the agent.
+   * 
+   * @example
+   * agent-7f3c9a2b
+   */
   agentId?: string;
+  /**
+   * @remarks
+   * The name of the agent.
+   * 
+   * @example
+   * my-data-agent
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission type of the agent. Valid values: HUMAN_BOUND (inherits user permissions), PERMISSION_NARROW (narrowed down from user permissions), and STANDALONE (independent permissions). The agent generated through the install token redemption process is of the HUMAN_BOUND type.
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The creation time of the agent, in the yyyy-MM-dd HH:mm:ss format.
+   * 
+   * @example
+   * 2026-07-13 10:30:00
+   */
   createdAt?: string;
+  /**
+   * @remarks
+   * The creation method of the agent. A value of auto indicates automatic creation by the system, and a value of manual indicates manual creation by a user. The agent generated through the install token redemption process is auto.
+   * 
+   * @example
+   * auto
+   */
   creationType?: string;
+  /**
+   * @remarks
+   * The description of the agent. This parameter is empty if it is not set.
+   * 
+   * @example
+   * Agent for data analytics
+   */
   description?: string;
+  /**
+   * @remarks
+   * The ID of the user to whom the agent belongs.
+   * 
+   * @example
+   * 27400000000000001
+   */
   ownerId?: string;
+  /**
+   * @remarks
+   * The status of the agent. A value of active indicates that the agent is enabled, and a value of disabled indicates that the agent is disabled.
+   * 
+   * @example
+   * active
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -53,10 +113,39 @@ export class GetAgenticAgentByInstallTokenResponseBodyData extends $dara.Model {
 }
 
 export class GetAgenticAgentByInstallTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The agent information associated with the install token after redemption. This parameter is empty if the token has not been redeemed, or if the associated credential or agent does not exist.
+   */
   data?: GetAgenticAgentByInstallTokenResponseBodyData;
+  /**
+   * @remarks
+   * The error code returned when the request fails. Programs use this code to determine the failure type. This parameter is empty when the request succeeds.
+   * 
+   * @example
+   * INSTALL_TOKEN_INVALID
+   */
   errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the request fails. This message helps with manual troubleshooting. This parameter is empty when the request succeeds.
+   * 
+   * @example
+   * install_token not found
+   */
   errorMessage?: string;
+  /**
+   * @remarks
+   * The unique identifier of the request, used for troubleshooting and log correlation.
+   * 
+   * @example
+   * 1AD222E9-E606-4A42-BF6C-2C4DD51BD5E7
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. A value of true indicates that the query succeeded. A value of false indicates that the query failed. In this case, you can use ErrorCode and ErrorMessage to identify the cause.
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetAgenticCatalogRequest.ts

@@ -0,0 +1,36 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetAgenticCatalogRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The catalog UUID. You can obtain it by calling ListAgenticCatalog or SearchAgenticCatalog.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * mc-HZ-OfjcNc2z***
+   */
+  catalogUuid?: string;
+  static names(): { [key: string]: string } {
+    return {
+      catalogUuid: 'CatalogUuid',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      catalogUuid: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+