@alicloud/dms20250414 1.14.2 → 1.14.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alicloud/dms20250414",
-  "version": "1.14.2",
+  "version": "1.14.3",
   "description": "",
   "main": "dist/client.js",
   "scripts": {

package/src/client.ts

@@ -11,7 +11,17 @@ export default class Client extends OpenApi {
 
   constructor(config: $OpenApiUtil.Config) {
     super(config);
-    this._endpointRule = "";
+    this._endpointRule = "regional";
+    this._endpointMap = {
+      'us-west-1': "dms.us-west-1.aliyuncs.com",
+      'us-east-1': "dms.us-east-1.aliyuncs.com",
+      'cn-shenzhen': "dms.cn-shenzhen.aliyuncs.com",
+      'cn-shanghai': "dms.cn-shanghai.aliyuncs.com",
+      'cn-hongkong': "dms.cn-hongkong.aliyuncs.com",
+      'cn-hangzhou': "dms.cn-hangzhou.aliyuncs.com",
+      'cn-beijing': "dms.cn-beijing.aliyuncs.com",
+      'ap-southeast-1': "dms.ap-southeast-1.aliyuncs.com",
+    };
     this.checkConfig(config);
     this._endpoint = this.getEndpoint("dms", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
   }
@@ -766,7 +776,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a DataAgent workspace.
+   * Creates a DataAgent collaborative workspace.
    * 
    * @param request - CreateDataAgentWorkspaceRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -809,7 +819,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a DataAgent workspace.
+   * Creates a DataAgent collaborative workspace.
    * 
    * @param request - CreateDataAgentWorkspaceRequest
    * @returns CreateDataAgentWorkspaceResponse
@@ -1794,7 +1804,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Gets the details of a DataAgent session.
+   * Retrieves the description of a DataAgent session.
    * 
    * @param request - DescribeDataAgentSessionRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -1833,7 +1843,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Gets the details of a DataAgent session.
+   * Retrieves the description of a DataAgent session.
    * 
    * @param request - DescribeDataAgentSessionRequest
    * @returns DescribeDataAgentSessionResponse
@@ -2300,7 +2310,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves workspace details.
+   * Retrieves the details of a collaborative workspace.
    * 
    * @param request - GetDataAgentWorkspaceInfoRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -2335,7 +2345,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves workspace details.
+   * Retrieves the details of a collaborative workspace.
    * 
    * @param request - GetDataAgentWorkspaceInfoRequest
    * @returns GetDataAgentWorkspaceInfoResponse
@@ -3142,7 +3152,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
+   * Retrieves the collaborative workspaces under the primary account with pagination.
    * 
    * @param request - ListDataAgentWorkspaceRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -3205,7 +3215,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
+   * Retrieves the collaborative workspaces under the primary account with pagination.
    * 
    * @param request - ListDataAgentWorkspaceRequest
    * @returns ListDataAgentWorkspaceResponse
@@ -4848,16 +4858,16 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Sends a user message to a specified session or ends the session.
+   * Sends a user message to a specified session or cancels a session.
    * 
    * @remarks
-   * ## Request
-   * - The `agent_id` and `session_id` fields are required.
-   * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
-   * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
+   * ## Request description
+   * - `agent_id` and `session_id` are required fields.
+   * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
+   * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
    * - When `message_type` is `additional`, the `question` field is required.
-   * - Use the `quoted_message` field to reference a previous user message.
-   * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
+   * - `quoted_message` can be used to quote the content of a previous user message.
+   * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
    * 
    * @param tmpReq - SendChatMessageRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -4879,6 +4889,10 @@ export default class Client extends OpenApi {
       request.sessionConfigShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.sessionConfig, "SessionConfig", "json");
     }
 
+    if (!$dara.isNull(tmpReq.taskConfig)) {
+      request.taskConfigShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.taskConfig, "TaskConfig", "json");
+    }
+
     let query = { };
     if (!$dara.isNull(request.agentId)) {
       query["AgentId"] = request.agentId;
@@ -4928,6 +4942,10 @@ export default class Client extends OpenApi {
       query["SessionId"] = request.sessionId;
     }
 
+    if (!$dara.isNull(request.taskConfigShrink)) {
+      query["TaskConfig"] = request.taskConfigShrink;
+    }
+
     let req = new $OpenApiUtil.OpenApiRequest({
       query: OpenApiUtil.query(query),
     });
@@ -4946,16 +4964,16 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Sends a user message to a specified session or ends the session.
+   * Sends a user message to a specified session or cancels a session.
    * 
    * @remarks
-   * ## Request
-   * - The `agent_id` and `session_id` fields are required.
-   * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
-   * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
+   * ## Request description
+   * - `agent_id` and `session_id` are required fields.
+   * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
+   * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
    * - When `message_type` is `additional`, the `question` field is required.
-   * - Use the `quoted_message` field to reference a previous user message.
-   * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
+   * - `quoted_message` can be used to quote the content of a previous user message.
+   * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
    * 
    * @param request - SendChatMessageRequest
    * @returns SendChatMessageResponse

package/src/models/CreateDataAgentWorkspaceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataAgentWorkspaceRequest extends $dara.Model {
   /**
    * @remarks
-   * The DMS unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou
@@ -14,7 +14,7 @@ export class CreateDataAgentWorkspaceRequest extends $dara.Model {
   isSessionShareEnabled?: boolean;
   /**
    * @remarks
-   * The description of the workspace.
+   * The description of the collaborative workspace.
    * 
    * @example
    * Space for test
@@ -22,7 +22,7 @@ export class CreateDataAgentWorkspaceRequest extends $dara.Model {
   workspaceDesc?: string;
   /**
    * @remarks
-   * The name of the workspace.
+   * The name of the collaborative workspace.
    * 
    * @example
    * workspaceTest

package/src/models/CreateDataAgentWorkspaceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The time the workspace was created, as a UNIX timestamp in seconds.
+   * The time when the workspace was created. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1765960516
@@ -13,20 +13,16 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The user ID of the workspace creator.
+   * The UID of the workspace creator.
    * 
    * @example
    * 20282*****7591
    */
   creator?: string;
-  /**
-   * @remarks
-   * Indicates whether session sharing is enabled for the workspace.
-   */
   isSessionShareEnabled?: boolean;
   /**
    * @remarks
-   * The time the workspace was last modified, as a UNIX timestamp in seconds.
+   * The time when the workspace was last modified. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1765961516
@@ -34,7 +30,7 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
   modifyTime?: number;
   /**
    * @remarks
-   * The name of the user\\"s role in the workspace.
+   * The role name of the user in the workspace.
    * 
    * @example
    * owner
@@ -48,6 +44,7 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
    * 11
    */
   totalMember?: number;
+  type?: string;
   /**
    * @remarks
    * The description of the workspace.
@@ -88,6 +85,7 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
       modifyTime: 'ModifyTime',
       roleName: 'RoleName',
       totalMember: 'TotalMember',
+      type: 'Type',
       workspaceDesc: 'WorkspaceDesc',
       workspaceId: 'WorkspaceId',
       workspaceName: 'WorkspaceName',
@@ -103,6 +101,7 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
       modifyTime: 'number',
       roleName: 'string',
       totalMember: 'number',
+      type: 'string',
       workspaceDesc: 'string',
       workspaceId: 'string',
       workspaceName: 'string',
@@ -122,7 +121,7 @@ export class CreateDataAgentWorkspaceResponseBodyData extends $dara.Model {
 export class CreateDataAgentWorkspaceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned data structure.
+   * The response struct.
    */
   data?: CreateDataAgentWorkspaceResponseBodyData;
   /**

package/src/models/DescribeDataAgentSessionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataAgentSessionRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the DMS unit.
+   * The current Data Management unit.
    * 
    * @example
    * cn-hangzhou
@@ -13,7 +13,7 @@ export class DescribeDataAgentSessionRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The ID of the agent session.
+   * The agent session ID.
    * 
    * @example
    * c61n7gm******rj
@@ -21,7 +21,7 @@ export class DescribeDataAgentSessionRequest extends $dara.Model {
   sessionId?: string;
   /**
    * @remarks
-   * The ID of the workspace.
+   * The workspace ID.
    * 
    * @example
    * 12****

package/src/models/DescribeDataAgentSessionResponseBody.ts

@@ -2,10 +2,54 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Model {
+  description?: string;
+  finishTime?: string;
+  id?: string;
+  name?: string;
+  receiveTime?: string;
+  startTime?: string;
+  status?: string;
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      description: 'Description',
+      finishTime: 'FinishTime',
+      id: 'Id',
+      name: 'Name',
+      receiveTime: 'ReceiveTime',
+      startTime: 'StartTime',
+      status: 'Status',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      description: 'string',
+      finishTime: 'string',
+      id: 'string',
+      name: 'string',
+      receiveTime: 'string',
+      startTime: 'string',
+      status: 'string',
+      type: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extends $dara.Model {
   /**
    * @remarks
-   * The key of the session replay history item.
+   * The key of the chat replay history.
    * 
    * @example
    * testKey1
@@ -13,7 +57,7 @@ export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extend
   key?: string;
   /**
    * @remarks
-   * The OSS download URL for the session replay history item.
+   * The OSS download URL of the chat replay history.
    * 
    * @example
    * ****
@@ -42,10 +86,65 @@ export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extend
   }
 }
 
+export class DescribeDataAgentSessionResponseBodyDataDataSources extends $dara.Model {
+  category?: string;
+  detail?: string;
+  static names(): { [key: string]: string } {
+    return {
+      category: 'Category',
+      detail: 'Detail',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      category: 'string',
+      detail: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDataAgentSessionResponseBodyDataRecallResults extends $dara.Model {
+  content?: string;
+  score?: number;
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      content: 'Content',
+      score: 'Score',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      content: 'string',
+      score: 'number',
+      type: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara.Model {
   /**
    * @remarks
-   * The ID of the custom agent.
+   * The custom agent ID.
    * 
    * @example
    * ca-e*******ckd
@@ -54,10 +153,8 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   /**
    * @remarks
    * The stage of the custom agent. Valid values:
-   * 
-   * - **debug**: The test stage.
-   * 
-   * - **prod**: The production stage.
+   * - **debug**: Debug stage.
+   * - **prod**: Production stage.
    * 
    * @example
    * debug
@@ -65,7 +162,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   customAgentStage?: string;
   /**
    * @remarks
-   * Indicates whether web search is enabled.
+   * Specifies whether to enable web search.
    * 
    * @example
    * True
@@ -77,10 +174,8 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   /**
    * @remarks
    * The language. Valid values:
-   * 
-   * - **CHINESE**: Chinese
-   * 
-   * - **ENGLISH**: English
+   * - **CHINESE**: Chinese.
+   * - **ENGLISH**: English.
    * 
    * @example
    * CHINESE
@@ -88,18 +183,15 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   language?: string;
   /**
    * @remarks
-   * A list of MCP server IDs.
+   * The list of MCP server IDs in the session configuration.
    */
   mcpServerIds?: string[];
   /**
    * @remarks
    * The mode. Valid values:
-   * 
-   * - **ASK_DATA**: quick inquiry mode
-   * 
-   * - **ANALYSIS**: analysis mode
-   * 
-   * - **INSIGHT**: insight mode
+   * - **ASK_DATA**: Ask data mode.
+   * - **ANALYSIS**: Analysis mode.
+   * - **INSIGHT**: Insight mode.
    * 
    * @example
    * ANALYSIS
@@ -109,9 +201,8 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   reportWaterMark?: string;
   /**
    * @remarks
-   * The name of the user\\"s OSS bucket.
-   * 
-   * - The service can upload analysis files and reports to this bucket.
+   * The name of the user OSS bucket.
+   * - Analysis process files and report artifacts can be uploaded to the user-specified OSS bucket.
    * 
    * @example
    * user-oss-bucket
@@ -169,7 +260,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
 export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The ID of the agent.
+   * The current agent ID.
    * 
    * @example
    * cu0cs*******mf
@@ -177,28 +268,30 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   agentId?: string;
   /**
    * @remarks
-   * The status of the agent.
+   * The current agent status.
    * 
    * @example
    * RUNNING
    */
   agentStatus?: string;
+  artifacts?: DescribeDataAgentSessionResponseBodyDataArtifacts[];
   /**
    * @remarks
-   * The session replay history.
+   * The chat replay history.
    */
   chatHistoryLocations?: DescribeDataAgentSessionResponseBodyDataChatHistoryLocations[];
   /**
    * @remarks
-   * The timestamp indicating when the session was created.
+   * The session creation time.
    * 
    * @example
    * 1731645908000
    */
   createTime?: number;
+  dataSources?: DescribeDataAgentSessionResponseBodyDataDataSources[];
   /**
    * @remarks
-   * Indicates whether the current user has favorited the session in the workspace.
+   * Indicates whether the session is saved as a favorite in the workspace by the current logged-in user.
    * 
    * @example
    * true
@@ -206,15 +299,16 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   favoriteInWorkspace?: string;
   /**
    * @remarks
-   * The ID of the file.
+   * The file ID.
    * 
    * @example
    * f-8*******01m
    */
   file?: string;
+  recallResults?: DescribeDataAgentSessionResponseBodyDataRecallResults[];
   /**
    * @remarks
-   * Indicates whether the current user has favorited the session.
+   * Indicates whether the session is saved as a favorite by the current logged-in user.
    * 
    * @example
    * true
@@ -222,12 +316,12 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   saved?: boolean;
   /**
    * @remarks
-   * The configuration of the session.
+   * The session configuration item.
    */
   sessionConfig?: DescribeDataAgentSessionResponseBodyDataSessionConfig;
   /**
    * @remarks
-   * The ID of the agent session.
+   * The agent session ID.
    * 
    * @example
    * 976*********p
@@ -235,7 +329,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   sessionId?: string;
   /**
    * @remarks
-   * The status of the session.
+   * The session status.
    * 
    * @example
    * RUNNING
@@ -243,7 +337,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   sessionStatus?: string;
   /**
    * @remarks
-   * The title of the session.
+   * The title.
    * 
    * @example
    * 分析一下这份文件，给出报告。
@@ -261,10 +355,13 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
     return {
       agentId: 'AgentId',
       agentStatus: 'AgentStatus',
+      artifacts: 'Artifacts',
       chatHistoryLocations: 'ChatHistoryLocations',
       createTime: 'CreateTime',
+      dataSources: 'DataSources',
       favoriteInWorkspace: 'FavoriteInWorkspace',
       file: 'File',
+      recallResults: 'RecallResults',
       saved: 'Saved',
       sessionConfig: 'SessionConfig',
       sessionId: 'SessionId',
@@ -278,10 +375,13 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
     return {
       agentId: 'string',
       agentStatus: 'string',
+      artifacts: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataArtifacts },
       chatHistoryLocations: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataChatHistoryLocations },
       createTime: 'number',
+      dataSources: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataDataSources },
       favoriteInWorkspace: 'string',
       file: 'string',
+      recallResults: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataRecallResults },
       saved: 'boolean',
       sessionConfig: DescribeDataAgentSessionResponseBodyDataSessionConfig,
       sessionId: 'string',
@@ -292,9 +392,18 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   }
 
   validate() {
+    if(Array.isArray(this.artifacts)) {
+      $dara.Model.validateArray(this.artifacts);
+    }
     if(Array.isArray(this.chatHistoryLocations)) {
       $dara.Model.validateArray(this.chatHistoryLocations);
     }
+    if(Array.isArray(this.dataSources)) {
+      $dara.Model.validateArray(this.dataSources);
+    }
+    if(Array.isArray(this.recallResults)) {
+      $dara.Model.validateArray(this.recallResults);
+    }
     if(this.sessionConfig && typeof (this.sessionConfig as any).validate === 'function') {
       (this.sessionConfig as any).validate();
     }
@@ -309,7 +418,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
 export class DescribeDataAgentSessionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response data.
+   * The response struct.
    */
   data?: DescribeDataAgentSessionResponseBodyData;
   /**
@@ -322,7 +431,7 @@ export class DescribeDataAgentSessionResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the request fails.
+   * The error message returned if the call failed.
    * 
    * @example
    * UnknownError
@@ -330,7 +439,7 @@ export class DescribeDataAgentSessionResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 18****-*****-*******7A3122F
@@ -338,11 +447,10 @@ export class DescribeDataAgentSessionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
-   * 
-   * - **true**: The request was successful.
+   * The return value. Valid values:
    * 
-   * - **false**: The request failed.
+   * - **true**: Succeeded.
+   * - **false**: Failed.
    * 
    * @example
    * true