@alicloud/dms20250414 1.14.2 → 1.14.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/dist/client.d.ts +22 -22
  2. package/dist/client.js +39 -23
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateDataAgentWorkspaceRequest.d.ts +3 -3
  5. package/dist/models/CreateDataAgentWorkspaceResponseBody.d.ts +6 -9
  6. package/dist/models/CreateDataAgentWorkspaceResponseBody.js +2 -0
  7. package/dist/models/CreateDataAgentWorkspaceResponseBody.js.map +1 -1
  8. package/dist/models/DescribeDataAgentSessionRequest.d.ts +3 -3
  9. package/dist/models/DescribeDataAgentSessionResponseBody.d.ts +83 -40
  10. package/dist/models/DescribeDataAgentSessionResponseBody.js +93 -1
  11. package/dist/models/DescribeDataAgentSessionResponseBody.js.map +1 -1
  12. package/dist/models/DmsGatewayOrder.d.ts +23 -0
  13. package/dist/models/DmsGatewayOrder.js +76 -0
  14. package/dist/models/DmsGatewayOrder.js.map +1 -0
  15. package/dist/models/GetDataAgentWorkspaceInfoRequest.d.ts +2 -2
  16. package/dist/models/GetDataAgentWorkspaceInfoResponseBody.d.ts +9 -12
  17. package/dist/models/GetDataAgentWorkspaceInfoResponseBody.js +2 -0
  18. package/dist/models/GetDataAgentWorkspaceInfoResponseBody.js.map +1 -1
  19. package/dist/models/ListDataAgentWorkspaceRequest.d.ts +6 -6
  20. package/dist/models/ListDataAgentWorkspaceResponseBody.d.ts +13 -12
  21. package/dist/models/ListDataAgentWorkspaceResponseBody.js +2 -0
  22. package/dist/models/ListDataAgentWorkspaceResponseBody.js.map +1 -1
  23. package/dist/models/SendChatMessageRequest.d.ts +62 -29
  24. package/dist/models/SendChatMessageRequest.js +59 -1
  25. package/dist/models/SendChatMessageRequest.js.map +1 -1
  26. package/dist/models/SendChatMessageResponseBody.d.ts +7 -6
  27. package/dist/models/SendChatMessageResponseBody.js +2 -0
  28. package/dist/models/SendChatMessageResponseBody.js.map +1 -1
  29. package/dist/models/SendChatMessageShrinkRequest.d.ts +12 -11
  30. package/dist/models/SendChatMessageShrinkRequest.js +2 -0
  31. package/dist/models/SendChatMessageShrinkRequest.js.map +1 -1
  32. package/dist/models/model.d.ts +6 -0
  33. package/dist/models/model.js +28 -16
  34. package/dist/models/model.js.map +1 -1
  35. package/package.json +1 -1
  36. package/src/client.ts +41 -23
  37. package/src/models/CreateDataAgentWorkspaceRequest.ts +3 -3
  38. package/src/models/CreateDataAgentWorkspaceResponseBody.ts +8 -9
  39. package/src/models/DescribeDataAgentSessionRequest.ts +3 -3
  40. package/src/models/DescribeDataAgentSessionResponseBody.ts +148 -40
  41. package/src/models/DmsGatewayOrder.ts +54 -0
  42. package/src/models/GetDataAgentWorkspaceInfoRequest.ts +2 -2
  43. package/src/models/GetDataAgentWorkspaceInfoResponseBody.ts +11 -12
  44. package/src/models/ListDataAgentWorkspaceRequest.ts +6 -6
  45. package/src/models/ListDataAgentWorkspaceResponseBody.ts +15 -12
  46. package/src/models/SendChatMessageRequest.ts +102 -29
  47. package/src/models/SendChatMessageResponseBody.ts +9 -6
  48. package/src/models/SendChatMessageShrinkRequest.ts +14 -11
  49. package/src/models/model.ts +6 -0
package/dist/client.d.ts CHANGED
@@ -171,7 +171,7 @@ export default class Client extends OpenApi {
171
171
  */
172
172
  createDataAgentSession(request: $_model.CreateDataAgentSessionRequest): Promise<$_model.CreateDataAgentSessionResponse>;
173
173
  /**
174
- * Creates a DataAgent workspace.
174
+ * Creates a DataAgent collaborative workspace.
175
175
  *
176
176
  * @param request - CreateDataAgentWorkspaceRequest
177
177
  * @param runtime - runtime options for this request RuntimeOptions
@@ -179,7 +179,7 @@ export default class Client extends OpenApi {
179
179
  */
180
180
  createDataAgentWorkspaceWithOptions(request: $_model.CreateDataAgentWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataAgentWorkspaceResponse>;
181
181
  /**
182
- * Creates a DataAgent workspace.
182
+ * Creates a DataAgent collaborative workspace.
183
183
  *
184
184
  * @param request - CreateDataAgentWorkspaceRequest
185
185
  * @returns CreateDataAgentWorkspaceResponse
@@ -447,7 +447,7 @@ export default class Client extends OpenApi {
447
447
  */
448
448
  describeCustomAgent(request: $_model.DescribeCustomAgentRequest): Promise<$_model.DescribeCustomAgentResponse>;
449
449
  /**
450
- * Gets the details of a DataAgent session.
450
+ * Retrieves the description of a DataAgent session.
451
451
  *
452
452
  * @param request - DescribeDataAgentSessionRequest
453
453
  * @param runtime - runtime options for this request RuntimeOptions
@@ -455,7 +455,7 @@ export default class Client extends OpenApi {
455
455
  */
456
456
  describeDataAgentSessionWithOptions(request: $_model.DescribeDataAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDataAgentSessionResponse>;
457
457
  /**
458
- * Gets the details of a DataAgent session.
458
+ * Retrieves the description of a DataAgent session.
459
459
  *
460
460
  * @param request - DescribeDataAgentSessionRequest
461
461
  * @returns DescribeDataAgentSessionResponse
@@ -605,7 +605,7 @@ export default class Client extends OpenApi {
605
605
  */
606
606
  getDataAgentSubAccountInfo(request: $_model.GetDataAgentSubAccountInfoRequest): Promise<$_model.GetDataAgentSubAccountInfoResponse>;
607
607
  /**
608
- * Retrieves workspace details.
608
+ * Retrieves the details of a collaborative workspace.
609
609
  *
610
610
  * @param request - GetDataAgentWorkspaceInfoRequest
611
611
  * @param runtime - runtime options for this request RuntimeOptions
@@ -613,7 +613,7 @@ export default class Client extends OpenApi {
613
613
  */
614
614
  getDataAgentWorkspaceInfoWithOptions(request: $_model.GetDataAgentWorkspaceInfoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataAgentWorkspaceInfoResponse>;
615
615
  /**
616
- * Retrieves workspace details.
616
+ * Retrieves the details of a collaborative workspace.
617
617
  *
618
618
  * @param request - GetDataAgentWorkspaceInfoRequest
619
619
  * @returns GetDataAgentWorkspaceInfoResponse
@@ -854,7 +854,7 @@ export default class Client extends OpenApi {
854
854
  */
855
855
  listDataAgentSession(request: $_model.ListDataAgentSessionRequest): Promise<$_model.ListDataAgentSessionResponse>;
856
856
  /**
857
- * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
857
+ * Retrieves the collaborative workspaces under the primary account with pagination.
858
858
  *
859
859
  * @param request - ListDataAgentWorkspaceRequest
860
860
  * @param runtime - runtime options for this request RuntimeOptions
@@ -862,7 +862,7 @@ export default class Client extends OpenApi {
862
862
  */
863
863
  listDataAgentWorkspaceWithOptions(request: $_model.ListDataAgentWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataAgentWorkspaceResponse>;
864
864
  /**
865
- * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
865
+ * Retrieves the collaborative workspaces under the primary account with pagination.
866
866
  *
867
867
  * @param request - ListDataAgentWorkspaceRequest
868
868
  * @returns ListDataAgentWorkspaceResponse
@@ -1247,16 +1247,16 @@ export default class Client extends OpenApi {
1247
1247
  */
1248
1248
  saveWorkspaceCode(request: $_model.SaveWorkspaceCodeRequest): Promise<$_model.SaveWorkspaceCodeResponse>;
1249
1249
  /**
1250
- * Sends a user message to a specified session or ends the session.
1250
+ * Sends a user message to a specified session or cancels a session.
1251
1251
  *
1252
1252
  * @remarks
1253
- * ## Request
1254
- * - The `agent_id` and `session_id` fields are required.
1255
- * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
1256
- * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
1253
+ * ## Request description
1254
+ * - `agent_id` and `session_id` are required fields.
1255
+ * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
1256
+ * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
1257
1257
  * - When `message_type` is `additional`, the `question` field is required.
1258
- * - Use the `quoted_message` field to reference a previous user message.
1259
- * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
1258
+ * - `quoted_message` can be used to quote the content of a previous user message.
1259
+ * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
1260
1260
  *
1261
1261
  * @param tmpReq - SendChatMessageRequest
1262
1262
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1264,16 +1264,16 @@ export default class Client extends OpenApi {
1264
1264
  */
1265
1265
  sendChatMessageWithOptions(tmpReq: $_model.SendChatMessageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SendChatMessageResponse>;
1266
1266
  /**
1267
- * Sends a user message to a specified session or ends the session.
1267
+ * Sends a user message to a specified session or cancels a session.
1268
1268
  *
1269
1269
  * @remarks
1270
- * ## Request
1271
- * - The `agent_id` and `session_id` fields are required.
1272
- * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
1273
- * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
1270
+ * ## Request description
1271
+ * - `agent_id` and `session_id` are required fields.
1272
+ * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
1273
+ * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
1274
1274
  * - When `message_type` is `additional`, the `question` field is required.
1275
- * - Use the `quoted_message` field to reference a previous user message.
1276
- * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
1275
+ * - `quoted_message` can be used to quote the content of a previous user message.
1276
+ * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
1277
1277
  *
1278
1278
  * @param request - SendChatMessageRequest
1279
1279
  * @returns SendChatMessageResponse
package/dist/client.js CHANGED
@@ -68,7 +68,17 @@ __exportStar(require("./models/model"), exports);
68
68
  class Client extends openapi_core_1.default {
69
69
  constructor(config) {
70
70
  super(config);
71
- this._endpointRule = "";
71
+ this._endpointRule = "regional";
72
+ this._endpointMap = {
73
+ 'us-west-1': "dms.us-west-1.aliyuncs.com",
74
+ 'us-east-1': "dms.us-east-1.aliyuncs.com",
75
+ 'cn-shenzhen': "dms.cn-shenzhen.aliyuncs.com",
76
+ 'cn-shanghai': "dms.cn-shanghai.aliyuncs.com",
77
+ 'cn-hongkong': "dms.cn-hongkong.aliyuncs.com",
78
+ 'cn-hangzhou': "dms.cn-hangzhou.aliyuncs.com",
79
+ 'cn-beijing': "dms.cn-beijing.aliyuncs.com",
80
+ 'ap-southeast-1': "dms.ap-southeast-1.aliyuncs.com",
81
+ };
72
82
  this.checkConfig(config);
73
83
  this._endpoint = this.getEndpoint("dms", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
74
84
  }
@@ -716,7 +726,7 @@ class Client extends openapi_core_1.default {
716
726
  return await this.createDataAgentSessionWithOptions(request, runtime);
717
727
  }
718
728
  /**
719
- * Creates a DataAgent workspace.
729
+ * Creates a DataAgent collaborative workspace.
720
730
  *
721
731
  * @param request - CreateDataAgentWorkspaceRequest
722
732
  * @param runtime - runtime options for this request RuntimeOptions
@@ -754,7 +764,7 @@ class Client extends openapi_core_1.default {
754
764
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateDataAgentWorkspaceResponse({}));
755
765
  }
756
766
  /**
757
- * Creates a DataAgent workspace.
767
+ * Creates a DataAgent collaborative workspace.
758
768
  *
759
769
  * @param request - CreateDataAgentWorkspaceRequest
760
770
  * @returns CreateDataAgentWorkspaceResponse
@@ -1628,7 +1638,7 @@ class Client extends openapi_core_1.default {
1628
1638
  return await this.describeCustomAgentWithOptions(request, runtime);
1629
1639
  }
1630
1640
  /**
1631
- * Gets the details of a DataAgent session.
1641
+ * Retrieves the description of a DataAgent session.
1632
1642
  *
1633
1643
  * @param request - DescribeDataAgentSessionRequest
1634
1644
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1663,7 +1673,7 @@ class Client extends openapi_core_1.default {
1663
1673
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDataAgentSessionResponse({}));
1664
1674
  }
1665
1675
  /**
1666
- * Gets the details of a DataAgent session.
1676
+ * Retrieves the description of a DataAgent session.
1667
1677
  *
1668
1678
  * @param request - DescribeDataAgentSessionRequest
1669
1679
  * @returns DescribeDataAgentSessionResponse
@@ -2101,7 +2111,7 @@ class Client extends openapi_core_1.default {
2101
2111
  return await this.getDataAgentSubAccountInfoWithOptions(request, runtime);
2102
2112
  }
2103
2113
  /**
2104
- * Retrieves workspace details.
2114
+ * Retrieves the details of a collaborative workspace.
2105
2115
  *
2106
2116
  * @param request - GetDataAgentWorkspaceInfoRequest
2107
2117
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2133,7 +2143,7 @@ class Client extends openapi_core_1.default {
2133
2143
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetDataAgentWorkspaceInfoResponse({}));
2134
2144
  }
2135
2145
  /**
2136
- * Retrieves workspace details.
2146
+ * Retrieves the details of a collaborative workspace.
2137
2147
  *
2138
2148
  * @param request - GetDataAgentWorkspaceInfoRequest
2139
2149
  * @returns GetDataAgentWorkspaceInfoResponse
@@ -2852,7 +2862,7 @@ class Client extends openapi_core_1.default {
2852
2862
  return await this.listDataAgentSessionWithOptions(request, runtime);
2853
2863
  }
2854
2864
  /**
2855
- * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
2865
+ * Retrieves the collaborative workspaces under the primary account with pagination.
2856
2866
  *
2857
2867
  * @param request - ListDataAgentWorkspaceRequest
2858
2868
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2905,7 +2915,7 @@ class Client extends openapi_core_1.default {
2905
2915
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListDataAgentWorkspaceResponse({}));
2906
2916
  }
2907
2917
  /**
2908
- * Retrieves paginated collaboration workspaces for an Alibaba Cloud account.
2918
+ * Retrieves the collaborative workspaces under the primary account with pagination.
2909
2919
  *
2910
2920
  * @param request - ListDataAgentWorkspaceRequest
2911
2921
  * @returns ListDataAgentWorkspaceResponse
@@ -4326,16 +4336,16 @@ class Client extends openapi_core_1.default {
4326
4336
  return await this.saveWorkspaceCodeWithOptions(request, runtime);
4327
4337
  }
4328
4338
  /**
4329
- * Sends a user message to a specified session or ends the session.
4339
+ * Sends a user message to a specified session or cancels a session.
4330
4340
  *
4331
4341
  * @remarks
4332
- * ## Request
4333
- * - The `agent_id` and `session_id` fields are required.
4334
- * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
4335
- * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
4342
+ * ## Request description
4343
+ * - `agent_id` and `session_id` are required fields.
4344
+ * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
4345
+ * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
4336
4346
  * - When `message_type` is `additional`, the `question` field is required.
4337
- * - Use the `quoted_message` field to reference a previous user message.
4338
- * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
4347
+ * - `quoted_message` can be used to quote the content of a previous user message.
4348
+ * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
4339
4349
  *
4340
4350
  * @param tmpReq - SendChatMessageRequest
4341
4351
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4354,6 +4364,9 @@ class Client extends openapi_core_1.default {
4354
4364
  if (!$dara.isNull(tmpReq.sessionConfig)) {
4355
4365
  request.sessionConfigShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.sessionConfig, "SessionConfig", "json");
4356
4366
  }
4367
+ if (!$dara.isNull(tmpReq.taskConfig)) {
4368
+ request.taskConfigShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.taskConfig, "TaskConfig", "json");
4369
+ }
4357
4370
  let query = {};
4358
4371
  if (!$dara.isNull(request.agentId)) {
4359
4372
  query["AgentId"] = request.agentId;
@@ -4391,6 +4404,9 @@ class Client extends openapi_core_1.default {
4391
4404
  if (!$dara.isNull(request.sessionId)) {
4392
4405
  query["SessionId"] = request.sessionId;
4393
4406
  }
4407
+ if (!$dara.isNull(request.taskConfigShrink)) {
4408
+ query["TaskConfig"] = request.taskConfigShrink;
4409
+ }
4394
4410
  let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
4395
4411
  query: openapi_core_2.OpenApiUtil.query(query),
4396
4412
  });
@@ -4408,16 +4424,16 @@ class Client extends openapi_core_1.default {
4408
4424
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.SendChatMessageResponse({}));
4409
4425
  }
4410
4426
  /**
4411
- * Sends a user message to a specified session or ends the session.
4427
+ * Sends a user message to a specified session or cancels a session.
4412
4428
  *
4413
4429
  * @remarks
4414
- * ## Request
4415
- * - The `agent_id` and `session_id` fields are required.
4416
- * - The `message_type` field defaults to `primary`. Set it to `additional` to append information or to `cancel` to end the session.
4417
- * - The `reply_to` field specifies which agent message the current message is a response to. It defaults to `0`.
4430
+ * ## Request description
4431
+ * - `agent_id` and `session_id` are required fields.
4432
+ * - `message_type` defaults to `primary`. Set it to `additional` when appending information or `cancel` when canceling a session.
4433
+ * - `reply_to` indicates which Agent message this message responds to. The default value is `0`.
4418
4434
  * - When `message_type` is `additional`, the `question` field is required.
4419
- * - Use the `quoted_message` field to reference a previous user message.
4420
- * - The optional fields `data_source`, `dms_user`, `db_metadata`, and `session_config` provide more detailed context.
4435
+ * - `quoted_message` can be used to quote the content of a previous user message.
4436
+ * - `data_source`, `dms_user`, `db_metadata`, `session_config`, and other fields are optional but provide more detailed context information.
4421
4437
  *
4422
4438
  * @param request - SendChatMessageRequest
4423
4439
  * @returns SendChatMessageResponse