@alicloud/dms20250414 1.25.0 → 2.0.0

package/src/models/SendChatMessageRequest.ts

@@ -5,13 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Model {
   /**
    * @remarks
-   * The list of columns that are allowed to be queried in the current table. If this field is left empty, all columns can be queried. If this field is specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure the effectiveness of DataAgent analysis, avoid specifying columns that exceed the allowed scope in the prompts, knowledge, or instructions modules of DataAgent. Otherwise, SQL statements without the required permissions are generated and blocked, which reduces the analysis speed and effectiveness of DataAgent.
+   * The list of columns that are allowed for querying in the current table. If this field is left empty, all columns can be queried. If specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure DataAgent analysis effectiveness, avoid specifying columns beyond the allowed scope in the DataAgent prompts, knowledge, or instructions modules. Otherwise, unauthorized SQL statements may be generated and blocked, which reduces DataAgent analysis speed and effectiveness.
    */
   allowedColumns?: string[];
+  /**
+   * @remarks
+   * The list of columns that are not allowed for querying in the current table. If this field is left empty, all columns **can be queried**. If specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked.  
+   * 
+   * If both the disallowed list and the allowed list are configured, the disallowed list takes higher priority. For example, if Table 1 has columns A, B, C, and D, and columns A and B are configured as not queryable while columns B and C are configured as queryable, the final result is that only column C is queryable.
+   * 
+   * To ensure DataAgent analysis effectiveness, avoid specifying columns beyond the allowed scope in the DataAgent prompts, knowledge, or instructions modules. Otherwise, unauthorized SQL statements may be generated and blocked, which reduces DataAgent analysis speed and effectiveness.
+   */
   disallowedColumns?: string[];
   /**
    * @remarks
-   * The required row filter condition for the current table. If this field is left empty, it is ignored. If this field is specified, all SQL statements involving this table are validated to check whether they carry the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints are rejected. Ensure the format of the validation conditions is correct.
+   * The required row filter condition for the current table. If this field is left empty, it is ignored. If specified, all SQL statements involving this table are validated to check whether they carry the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints are rejected. Ensure the validation condition format is correct.
    * 
    * @example
    * region = \\"east\\"
@@ -19,7 +27,7 @@ export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Mode
   requiredRowFilter?: string;
   /**
    * @remarks
-   * The name of the table to which the permission constraint rule applies.
+   * The table name to which the permission constraint rule applies.
    * 
    * @example
    * sample_table
@@ -99,7 +107,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
   dataSourceId?: string;
   /**
    * @remarks
-   * The data source type. Valid values: `[remote_data_center, database]`, which indicate that the analysis is performed on a file or a database.
+   * The data source type. Valid values: `[remote_data_center, database]`, indicating that the analysis is performed on a file or a database.
    * 
    * @example
    * remote_data_center
@@ -231,13 +239,21 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
 export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
   /**
    * @remarks
-   * The list of columns that are allowed to be queried in the current table. If this field is left empty, all columns can be queried. If this field is specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure the effectiveness of DataAgent analysis, avoid specifying columns that exceed the allowed scope in the prompts, knowledge, or instructions modules of DataAgent. Otherwise, SQL statements without the required permissions are generated and blocked, which reduces the analysis speed and effectiveness of DataAgent.
+   * The list of columns that are allowed for querying in the current table. If this field is left empty, all columns can be queried. If specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure DataAgent analysis effectiveness, avoid specifying columns beyond the allowed scope in the DataAgent prompts, knowledge, or instructions modules. Otherwise, unauthorized SQL statements may be generated and blocked, which reduces DataAgent analysis speed and effectiveness.
    */
   allowedColumns?: string[];
+  /**
+   * @remarks
+   * The list of columns that are not allowed for querying in the current table. If this field is left empty, all columns **can be queried**. If specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked.  
+   * 
+   * If both the disallowed list and the allowed list are configured, the disallowed list takes higher priority. For example, if Table 1 has columns A, B, C, and D, and columns A and B are configured as not queryable while columns B and C are configured as queryable, the final result is that only column C is queryable.
+   * 
+   * To ensure DataAgent analysis effectiveness, avoid specifying columns beyond the allowed scope in the DataAgent prompts, knowledge, or instructions modules. Otherwise, unauthorized SQL statements may be generated and blocked, which reduces DataAgent analysis speed and effectiveness.
+   */
   disallowedColumns?: string[];
   /**
    * @remarks
-   * The required row filter condition for the current table. If this field is left empty, it is ignored. If this field is specified, all SQL statements involving this table are validated to check whether they carry the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints are rejected. Ensure the format of the validation conditions is correct.
+   * The required row filter condition for the current table. If this field is left empty, it is ignored. If specified, all SQL statements involving this table are validated to check whether they carry the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints are rejected. Ensure the validation condition format is correct.
    * 
    * @example
    * region = \\"east\\"
@@ -245,7 +261,7 @@ export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Mod
   requiredRowFilter?: string;
   /**
    * @remarks
-   * The name of the table to which the permission constraint rule applies.
+   * The table name to which the permission constraint rule applies.
    * 
    * @example
    * sample_table
@@ -325,7 +341,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
   dataSourceId?: string;
   /**
    * @remarks
-   * The data source type. Valid values: remote_data_center and database, which indicate that the analysis is performed on a file or a database.
+   * The data source type. Valid values: remote_data_center, database. These values indicate that the analysis is performed on a file or a database.
    * 
    * @example
    * remote_data_center
@@ -457,9 +473,14 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
 export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.Model {
   /**
    * @remarks
-   * The default behavior for unconfigured tables. Valid values:
-   * - allow: Allow. This is the default value.
-   * - deny: Deny.
+   * The default action for table-level permissions. This parameter controls whether tables that are not configured in DataSources.[item].Permission can be queried. Valid values: allow, deny.
+   * 
+   * - allow (default): works in blacklist mode. By default, all tables can be queried, and the actual permissions are subject to the permissions configured on the Data Management side. Row-level and column-level permissions are enforced only when you configure **row-level and column-level** permissions in DataSources.[item].Permission.
+   * 
+   * - deny (must be manually specified): works in whitelist mode. By default, no tables can be queried. A table can be queried only when you configure permissions for it in DataSources.[item].Permission. You can grant full access to a table by not configuring any row-level or column-level restrictions.
+   * 
+   * @example
+   * allow
    */
   defaultAction?: string;
   static names(): { [key: string]: string } {
@@ -486,7 +507,7 @@ export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.M
 export class SendChatMessageRequestSessionConfig extends $dara.Model {
   /**
    * @remarks
-   * The custom Agent ID. A custom Agent is an entity used to customize the analysis process. You can create one in the DataAgent console or by calling the CreateCustomAgent operation. The custom Agent ID is a string that starts with `ca-`.
+   * The custom agent ID. A custom agent is an entity used to customize the analysis process. You can create one in the DataAgent console or by calling the CreateCustomAgent operation. The custom agent ID is a string that starts with `ca-`.
    * 
    * @example
    * ca-asfkjhqwe***aesrfqa
@@ -494,7 +515,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
   customAgentId?: string;
   /**
    * @remarks
-   * The stage of the custom Agent.
+   * The stage of the custom agent.
    * 
    * @example
    * null
@@ -507,7 +528,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
    * @example
    * false
    */
-  enableSearch?: string;
+  enableSearch?: boolean;
   /**
    * @remarks
    * The list of knowledge base IDs.
@@ -515,7 +536,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
    * @example
    * dasd***cc211
    */
-  kbUuidList?: string;
+  kbUuidList?: string[];
   /**
    * @remarks
    * Currently only Chinese and English are supported. The default value is Chinese. Only uppercase values are supported.
@@ -531,7 +552,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
    * @example
    * 2q1tu90**********6uttu2nw
    */
-  mcpServerIds?: string;
+  mcpServerIds?: string[];
   /**
    * @remarks
    * The mode. Valid values:
@@ -545,12 +566,12 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * The session-level permission configuration. This parameter specifies only the default behavior for unconfigured tables.
+   * The session level data permission settings. If this parameter is set multiple times across multiple turns within the same session, the last setting takes effect.
    */
   permissionConfig?: SendChatMessageRequestSessionConfigPermissionConfig;
   /**
    * @remarks
-   * Specifies whether to enable the plan. Valid values: disable, enable, and force. Default value: enable.
+   * Specifies whether to enable the plan. Valid values: disable, enable, force. Default value: enable.
    * 
    * @example
    * disable
@@ -596,6 +617,10 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
    * True
    */
   skipWebReportConfirm?: boolean;
+  /**
+   * @remarks
+   * The list of user-specified skills.
+   */
   userSpecifiedSkillList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -621,10 +646,10 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
     return {
       customAgentId: 'string',
       customAgentStage: 'string',
-      enableSearch: 'string',
-      kbUuidList: 'string',
+      enableSearch: 'boolean',
+      kbUuidList: { 'type': 'array', 'itemType': 'string' },
       language: 'string',
-      mcpServerIds: 'string',
+      mcpServerIds: { 'type': 'array', 'itemType': 'string' },
       mode: 'string',
       permissionConfig: SendChatMessageRequestSessionConfigPermissionConfig,
       planMode: 'string',
@@ -638,6 +663,12 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
   }
 
   validate() {
+    if(Array.isArray(this.kbUuidList)) {
+      $dara.Model.validateArray(this.kbUuidList);
+    }
+    if(Array.isArray(this.mcpServerIds)) {
+      $dara.Model.validateArray(this.mcpServerIds);
+    }
     if(this.permissionConfig && typeof (this.permissionConfig as any).validate === 'function') {
       (this.permissionConfig as any).validate();
     }
@@ -671,7 +702,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
   reportTheme?: string;
   /**
    * @remarks
-   * The service type. Valid values: TextReport and WebReport, which indicate that the task generates a text report or a web report. Currently only WebReport is supported.
+   * The service type. Valid values: TextReport and WebReport, which indicate that the task generates a text report or a web report. Currently, only WebReport is supported.
    * 
    * @example
    * WebReport
@@ -705,7 +736,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
 export class SendChatMessageRequestTaskConfig extends $dara.Model {
   /**
    * @remarks
-   * The report rule configuration. Only when MessageType is REPORT, a report task is executed based on this configuration.
+   * The configuration of the report rule. Only when MesageType is set to REPORT, a report task is executed based on this configuration.
    */
   reportConfig?: SendChatMessageRequestTaskConfigReportConfig;
   static names(): { [key: string]: string } {
@@ -735,7 +766,7 @@ export class SendChatMessageRequestTaskConfig extends $dara.Model {
 export class SendChatMessageRequest extends $dara.Model {
   /**
    * @remarks
-   * **[Deprecated]** This field is now automatically obtained by the backend. You do not need to specify this field.
+   * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field.
    * 
    * @example
    * agent_***
@@ -743,7 +774,7 @@ export class SendChatMessageRequest extends $dara.Model {
   agentId?: string;
   /**
    * @remarks
-   * **[Deprecated]** This field is now automatically obtained by the backend. You do not need to specify this field when calling the API.
+   * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field when calling the API.
    * 
    * @example
    * cn-hangzhou
@@ -764,7 +795,7 @@ export class SendChatMessageRequest extends $dara.Model {
   dataSources?: SendChatMessageRequestDataSources[];
   /**
    * @remarks
-   * The content of the message to send to the Agent.
+   * The message content to send to the Agent.
    * 
    * This parameter is required.
    * 
@@ -778,11 +809,11 @@ export class SendChatMessageRequest extends $dara.Model {
    * 
    * - For regular interactions with the Agent, set the message type to `[primary]`.
    * 
-   * - When the message is a response to the Agent\\"s human-in-the-loop question, set the type to `[additional]`.
+   * - When the message is a response to the Agent\\"s Human-in-Loop question, set the type to `[additional]`.
    * 
-   * - When the message triggers a report generation, set the type to `[report]`.
+   * - When the message is intended to trigger report generation, set the type to `[report]`.
    * 
-   * - When the message cancels the current session, set the type to `[cancel]`.
+   * - When the message is intended to cancel the current session, set the type to `[cancel]`.
    * 
    * @example
    * primary
@@ -798,7 +829,7 @@ export class SendChatMessageRequest extends $dara.Model {
   parentSessionId?: string;
   /**
    * @remarks
-   * This field is required when the message type is `additional`. Specify the specific question that the Agent asks the user through the human-in-the-loop mechanism.
+   * This field is required when the message type is `additional`. Specify the specific question that the Agent asks the user through Human-in-Loop.
    * 
    * @example
    * Provide the criteria for calculating GMV
@@ -816,9 +847,9 @@ export class SendChatMessageRequest extends $dara.Model {
    * @remarks
    * **Important**
    * 
-   * When this message is a reply to an Agent message (for example, the Agent asks a clarifying question through ASK_HUMAN), set reply_to to the exact Checkpoint sequence number carried in that Agent message. If this message is not a targeted reply, such as requesting the Agent to perform further in-depth analysis after the analysis is complete, leave reply_to empty or set it to "0".  
+   * When this message is a reply to an Agent message (for example, the Agent asks a clarifying question through ASK_HUMAN), set reply_to to the exact Checkpoint sequence number carried in that Agent message. If this message is not a targeted reply, such as requesting the Agent to perform further in-depth analysis after analysis is complete, you can leave reply_to empty or set it to "0".  
    * 
-   * This field affects how the Agent decides to process the message. Passing an incorrect value may cause the analysis results to be less effective than expected.
+   * This field affects how the Agent decides to process the message. Incorrect values may lead to analysis results that do not meet expectations.
    * 
    * @example
    * 0
@@ -834,10 +865,10 @@ export class SendChatMessageRequest extends $dara.Model {
   sessionConfig?: SendChatMessageRequestSessionConfig;
   /**
    * @remarks
-   * The session ID. This is an optional field used for multi-turn conversations.
-   * - You can start a session without specifying this field. The response includes the SessionID for the current session.
+   * The session ID. This is an optional field used for multi-turn sessions.
+   * - You can start a session without specifying this field. The response includes the SessionID of the current session.
    * - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating a session.
-   * - If you need multi-turn conversations (such as follow-up questions or confirming execution plans), include the SessionID returned by the previous SendChatMessage call.
+   * - For multi-turn conversations (such as follow-up questions or confirming execution plans), specify the SessionID returned by the previous SendChatMessage call.
    * 
    * @example
    * sess_***
@@ -850,7 +881,7 @@ export class SendChatMessageRequest extends $dara.Model {
   taskConfig?: SendChatMessageRequestTaskConfig;
   /**
    * @remarks
-   * The OSS bucket of the user. If this field is left empty, the analysis data is securely stored in the built-in storage.
+   * The OSS bucket of the user. If this parameter is not specified, the analysis data is securely stored in built-in storage.
    * 
    * @example
    * my-bucket

package/src/models/SendChatMessageShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SendChatMessageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * **[Deprecated]** This field is now automatically obtained by the backend. You do not need to specify this field.
+   * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field.
    * 
    * @example
    * agent_***
@@ -13,7 +13,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
   agentId?: string;
   /**
    * @remarks
-   * **[Deprecated]** This field is now automatically obtained by the backend. You do not need to specify this field when calling the API.
+   * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field when calling the API.
    * 
    * @example
    * cn-hangzhou
@@ -34,7 +34,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
   dataSourcesShrink?: string;
   /**
    * @remarks
-   * The content of the message to send to the Agent.
+   * The message content to send to the Agent.
    * 
    * This parameter is required.
    * 
@@ -48,11 +48,11 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
    * 
    * - For regular interactions with the Agent, set the message type to `[primary]`.
    * 
-   * - When the message is a response to the Agent\\"s human-in-the-loop question, set the type to `[additional]`.
+   * - When the message is a response to the Agent\\"s Human-in-Loop question, set the type to `[additional]`.
    * 
-   * - When the message triggers a report generation, set the type to `[report]`.
+   * - When the message is intended to trigger report generation, set the type to `[report]`.
    * 
-   * - When the message cancels the current session, set the type to `[cancel]`.
+   * - When the message is intended to cancel the current session, set the type to `[cancel]`.
    * 
    * @example
    * primary
@@ -68,7 +68,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
   parentSessionId?: string;
   /**
    * @remarks
-   * This field is required when the message type is `additional`. Specify the specific question that the Agent asks the user through the human-in-the-loop mechanism.
+   * This field is required when the message type is `additional`. Specify the specific question that the Agent asks the user through Human-in-Loop.
    * 
    * @example
    * Provide the criteria for calculating GMV
@@ -86,9 +86,9 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
    * @remarks
    * **Important**
    * 
-   * When this message is a reply to an Agent message (for example, the Agent asks a clarifying question through ASK_HUMAN), set reply_to to the exact Checkpoint sequence number carried in that Agent message. If this message is not a targeted reply, such as requesting the Agent to perform further in-depth analysis after the analysis is complete, leave reply_to empty or set it to "0".  
+   * When this message is a reply to an Agent message (for example, the Agent asks a clarifying question through ASK_HUMAN), set reply_to to the exact Checkpoint sequence number carried in that Agent message. If this message is not a targeted reply, such as requesting the Agent to perform further in-depth analysis after analysis is complete, you can leave reply_to empty or set it to "0".  
    * 
-   * This field affects how the Agent decides to process the message. Passing an incorrect value may cause the analysis results to be less effective than expected.
+   * This field affects how the Agent decides to process the message. Incorrect values may lead to analysis results that do not meet expectations.
    * 
    * @example
    * 0
@@ -104,10 +104,10 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
   sessionConfigShrink?: string;
   /**
    * @remarks
-   * The session ID. This is an optional field used for multi-turn conversations.
-   * - You can start a session without specifying this field. The response includes the SessionID for the current session.
+   * The session ID. This is an optional field used for multi-turn sessions.
+   * - You can start a session without specifying this field. The response includes the SessionID of the current session.
    * - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating a session.
-   * - If you need multi-turn conversations (such as follow-up questions or confirming execution plans), include the SessionID returned by the previous SendChatMessage call.
+   * - For multi-turn conversations (such as follow-up questions or confirming execution plans), specify the SessionID returned by the previous SendChatMessage call.
    * 
    * @example
    * sess_***
@@ -120,7 +120,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
   taskConfigShrink?: string;
   /**
    * @remarks
-   * The OSS bucket of the user. If this field is left empty, the analysis data is securely stored in the built-in storage.
+   * The OSS bucket of the user. If this parameter is not specified, the analysis data is securely stored in built-in storage.
    * 
    * @example
    * my-bucket