@alicloud/dms20250414 1.20.1 → 1.20.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 (62) hide show
  1. package/dist/client.d.ts +6 -6
  2. package/dist/client.js +12 -6
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ConfigDataAgentMemoryRequest.d.ts +17 -0
  5. package/dist/models/ConfigDataAgentMemoryRequest.js.map +1 -1
  6. package/dist/models/ConfigDataAgentMemoryResponseBody.d.ts +33 -0
  7. package/dist/models/ConfigDataAgentMemoryResponseBody.js.map +1 -1
  8. package/dist/models/CreateCustomAgentRequest.d.ts +28 -27
  9. package/dist/models/CreateCustomAgentRequest.js +2 -0
  10. package/dist/models/CreateCustomAgentRequest.js.map +1 -1
  11. package/dist/models/CreateCustomAgentResponseBody.d.ts +13 -12
  12. package/dist/models/CreateCustomAgentResponseBody.js +2 -0
  13. package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
  14. package/dist/models/CreateCustomAgentShrinkRequest.d.ts +27 -27
  15. package/dist/models/DescribeCustomAgentResponseBody.d.ts +10 -9
  16. package/dist/models/DescribeCustomAgentResponseBody.js +2 -0
  17. package/dist/models/DescribeCustomAgentResponseBody.js.map +1 -1
  18. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.d.ts +1 -0
  19. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.js +2 -0
  20. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.js.map +1 -1
  21. package/dist/models/GetDataAgentTaskModelUsageMetricsResponseBody.d.ts +1 -1
  22. package/dist/models/GetDataAgentTaskModelUsageRequest.d.ts +3 -2
  23. package/dist/models/GetDataAgentTaskModelUsageRequest.js +2 -0
  24. package/dist/models/GetDataAgentTaskModelUsageRequest.js.map +1 -1
  25. package/dist/models/GetDataAgentTaskModelUsageResponseBody.d.ts +9 -5
  26. package/dist/models/GetDataAgentTaskModelUsageResponseBody.js +8 -0
  27. package/dist/models/GetDataAgentTaskModelUsageResponseBody.js.map +1 -1
  28. package/dist/models/GetSqlConsoleOperationLogRequest.d.ts +1 -1
  29. package/dist/models/ListCustomAgentResponseBody.d.ts +1 -0
  30. package/dist/models/ListCustomAgentResponseBody.js +2 -0
  31. package/dist/models/ListCustomAgentResponseBody.js.map +1 -1
  32. package/dist/models/ModifyCustomAgentRequest.d.ts +12 -14
  33. package/dist/models/ModifyCustomAgentRequest.js +2 -0
  34. package/dist/models/ModifyCustomAgentRequest.js.map +1 -1
  35. package/dist/models/ModifyCustomAgentResponseBody.d.ts +7 -6
  36. package/dist/models/ModifyCustomAgentResponseBody.js +2 -0
  37. package/dist/models/ModifyCustomAgentResponseBody.js.map +1 -1
  38. package/dist/models/ModifyCustomAgentShrinkRequest.d.ts +10 -13
  39. package/dist/models/ModifyCustomAgentShrinkRequest.js.map +1 -1
  40. package/dist/models/SendChatMessageRequest.d.ts +44 -29
  41. package/dist/models/SendChatMessageRequest.js.map +1 -1
  42. package/dist/models/SendChatMessageShrinkRequest.d.ts +21 -9
  43. package/dist/models/SendChatMessageShrinkRequest.js.map +1 -1
  44. package/package.json +1 -1
  45. package/src/client.ts +14 -6
  46. package/src/models/ConfigDataAgentMemoryRequest.ts +17 -0
  47. package/src/models/ConfigDataAgentMemoryResponseBody.ts +33 -0
  48. package/src/models/CreateCustomAgentRequest.ts +30 -27
  49. package/src/models/CreateCustomAgentResponseBody.ts +15 -12
  50. package/src/models/CreateCustomAgentShrinkRequest.ts +27 -27
  51. package/src/models/DescribeCustomAgentResponseBody.ts +12 -9
  52. package/src/models/GetDataAgentTaskModelUsageMetricsRequest.ts +3 -0
  53. package/src/models/GetDataAgentTaskModelUsageMetricsResponseBody.ts +1 -1
  54. package/src/models/GetDataAgentTaskModelUsageRequest.ts +5 -2
  55. package/src/models/GetDataAgentTaskModelUsageResponseBody.ts +17 -5
  56. package/src/models/GetSqlConsoleOperationLogRequest.ts +1 -1
  57. package/src/models/ListCustomAgentResponseBody.ts +3 -0
  58. package/src/models/ModifyCustomAgentRequest.ts +14 -14
  59. package/src/models/ModifyCustomAgentResponseBody.ts +9 -6
  60. package/src/models/ModifyCustomAgentShrinkRequest.ts +10 -13
  61. package/src/models/SendChatMessageRequest.ts +44 -29
  62. package/src/models/SendChatMessageShrinkRequest.ts +21 -9
@@ -38,6 +38,7 @@ export class ModifyCustomAgentRequestCallbackConfig extends $dara.Model {
38
38
  }
39
39
 
40
40
  export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
41
+ forbiddenAppendDataSource?: boolean;
41
42
  /**
42
43
  * @remarks
43
44
  * Specifies whether to disable user inquiries during the process.
@@ -72,6 +73,7 @@ export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
72
73
  skipWebReportConfirm?: boolean;
73
74
  static names(): { [key: string]: string } {
74
75
  return {
76
+ forbiddenAppendDataSource: 'ForbiddenAppendDataSource',
75
77
  skipAskHuman: 'SkipAskHuman',
76
78
  skipPlan: 'SkipPlan',
77
79
  skipSqlConfirm: 'SkipSqlConfirm',
@@ -81,6 +83,7 @@ export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
81
83
 
82
84
  static types(): { [key: string]: any } {
83
85
  return {
86
+ forbiddenAppendDataSource: 'boolean',
84
87
  skipAskHuman: 'boolean',
85
88
  skipPlan: 'boolean',
86
89
  skipSqlConfirm: 'boolean',
@@ -186,7 +189,7 @@ export class ModifyCustomAgentRequestScheduleTaskConfig extends $dara.Model {
186
189
  * The query for the scheduled task.
187
190
  *
188
191
  * @example
189
- * Analyze this data and provide a brief report
192
+ * Analyze this data and provide a briefing
190
193
  */
191
194
  query?: string;
192
195
  /**
@@ -236,7 +239,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
236
239
  customAgentId?: string;
237
240
  /**
238
241
  * @remarks
239
- * The current Data Management unit.
242
+ * The current DMS unit.
240
243
  *
241
244
  * @example
242
245
  * cn-hangzhou
@@ -253,7 +256,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
253
256
  * **File type**. Pass parameters in the following format:
254
257
  * - DataSourceType: remote_data_center is a fixed value
255
258
  * - FileId: the file ID
256
- * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name
259
+ * - Database: the database name returned by the ListDataCenterTable operation, which is usually the file name
257
260
  * - Tables: the table name returned by the ListDataCenterTable operation
258
261
  * - TableIds: the TableId returned by the ListDataCenterTable operation
259
262
  * - RegionId: the current region
@@ -271,7 +274,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
271
274
  * "TableIds": [
272
275
  * "35hfn94pxl********50pi"
273
276
  * ],
274
- * "RegionId": "ap-southeast-1"
277
+ * "RegionId": "cn-hangzhou"
275
278
  * }
276
279
  * }
277
280
  * ```
@@ -305,7 +308,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
305
308
  * "5263****31"
306
309
  * ],
307
310
  * "Engine": "postgresql",
308
- * "RegionId": "ap-southeast-1"
311
+ * "RegionId": "cn-hangzhou"
309
312
  * }
310
313
  * }
311
314
  * ```
@@ -344,9 +347,6 @@ export class ModifyCustomAgentRequest extends $dara.Model {
344
347
  *
345
348
  * @example
346
349
  * Analysis framework:
347
- * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) on a daily, weekly, and monthly basis. Analyze trends and year-over-year/month-over-month fluctuations.
348
- * 2. Segment by new vs. returning customers, channels, and regions to identify growth drivers and weaknesses.
349
- * 3. Conduct funnel analysis based on user behavior paths (browsing → add to cart → payment) to pinpoint drop-off stages.
350
350
  */
351
351
  instruction?: string;
352
352
  /**
@@ -355,10 +355,10 @@ export class ModifyCustomAgentRequest extends $dara.Model {
355
355
  *
356
356
  * @example
357
357
  * Core metric definitions:
358
- * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders;
359
- * 2. Order volume is the number of valid orders placed per day;
360
- * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app;
361
- * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency;
358
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
359
+ * 2. Order volume is the number of valid orders placed per day.
360
+ * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
361
+ * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency.
362
362
  */
363
363
  knowledge?: string;
364
364
  /**
@@ -390,7 +390,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
390
390
  * The text report format.
391
391
  *
392
392
  * @example
393
- * The text report requires that all numbers use Chinese numerals instead of Arabic numerals
393
+ * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
394
394
  */
395
395
  textReportConfig?: string;
396
396
  /**
@@ -398,7 +398,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
398
398
  * The web report format.
399
399
  *
400
400
  * @example
401
- * The web report requires that all numbers use Chinese numerals instead of Arabic numerals
401
+ * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
402
402
  */
403
403
  webReportConfig?: string;
404
404
  webReportTheme?: string;
@@ -38,6 +38,7 @@ export class ModifyCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
38
38
  }
39
39
 
40
40
  export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
41
+ forbiddenAppendDataSource?: boolean;
41
42
  /**
42
43
  * @remarks
43
44
  * Specifies whether to disable user inquiries during the process.
@@ -72,6 +73,7 @@ export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
72
73
  skipWebReportConfirm?: boolean;
73
74
  static names(): { [key: string]: string } {
74
75
  return {
76
+ forbiddenAppendDataSource: 'ForbiddenAppendDataSource',
75
77
  skipAskHuman: 'SkipAskHuman',
76
78
  skipPlan: 'SkipPlan',
77
79
  skipSqlConfirm: 'SkipSqlConfirm',
@@ -81,6 +83,7 @@ export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
81
83
 
82
84
  static types(): { [key: string]: any } {
83
85
  return {
86
+ forbiddenAppendDataSource: 'boolean',
84
87
  skipAskHuman: 'boolean',
85
88
  skipPlan: 'boolean',
86
89
  skipSqlConfirm: 'boolean',
@@ -186,7 +189,7 @@ export class ModifyCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
186
189
  * The query for the scheduled task.
187
190
  *
188
191
  * @example
189
- * Analyze this data and provide a brief report
192
+ * Analyze this data and provide a briefing
190
193
  */
191
194
  query?: string;
192
195
  /**
@@ -258,7 +261,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
258
261
  customAgentId?: string;
259
262
  /**
260
263
  * @remarks
261
- * The current Data Management unit.
264
+ * The current DMS unit.
262
265
  *
263
266
  * @example
264
267
  * cn-hangzhou
@@ -293,7 +296,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
293
296
  description?: string;
294
297
  /**
295
298
  * @remarks
296
- * The current Data Management unit.
299
+ * The current DMS unit.
297
300
  *
298
301
  * @example
299
302
  * cn-hangzhou
@@ -436,7 +439,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
436
439
  * The text report format.
437
440
  *
438
441
  * @example
439
- * The text report requires that all numbers use Chinese numerals instead of Arabic numerals
442
+ * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
440
443
  */
441
444
  textReportConfig?: string;
442
445
  /**
@@ -444,7 +447,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
444
447
  * The web report format.
445
448
  *
446
449
  * @example
447
- * The web report requires that all numbers use Chinese numerals instead of Arabic numerals
450
+ * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
448
451
  */
449
452
  webReportConfig?: string;
450
453
  webReportTheme?: string;
@@ -555,7 +558,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
555
558
  export class ModifyCustomAgentResponseBody extends $dara.Model {
556
559
  /**
557
560
  * @remarks
558
- * The response struct.
561
+ * The returned struct.
559
562
  */
560
563
  data?: ModifyCustomAgentResponseBodyData;
561
564
  /**
@@ -16,7 +16,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
16
16
  customAgentId?: string;
17
17
  /**
18
18
  * @remarks
19
- * The current Data Management unit.
19
+ * The current DMS unit.
20
20
  *
21
21
  * @example
22
22
  * cn-hangzhou
@@ -33,7 +33,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
33
33
  * **File type**. Pass parameters in the following format:
34
34
  * - DataSourceType: remote_data_center is a fixed value
35
35
  * - FileId: the file ID
36
- * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name
36
+ * - Database: the database name returned by the ListDataCenterTable operation, which is usually the file name
37
37
  * - Tables: the table name returned by the ListDataCenterTable operation
38
38
  * - TableIds: the TableId returned by the ListDataCenterTable operation
39
39
  * - RegionId: the current region
@@ -51,7 +51,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
51
51
  * "TableIds": [
52
52
  * "35hfn94pxl********50pi"
53
53
  * ],
54
- * "RegionId": "ap-southeast-1"
54
+ * "RegionId": "cn-hangzhou"
55
55
  * }
56
56
  * }
57
57
  * ```
@@ -85,7 +85,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
85
85
  * "5263****31"
86
86
  * ],
87
87
  * "Engine": "postgresql",
88
- * "RegionId": "ap-southeast-1"
88
+ * "RegionId": "cn-hangzhou"
89
89
  * }
90
90
  * }
91
91
  * ```
@@ -124,9 +124,6 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
124
124
  *
125
125
  * @example
126
126
  * Analysis framework:
127
- * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) on a daily, weekly, and monthly basis. Analyze trends and year-over-year/month-over-month fluctuations.
128
- * 2. Segment by new vs. returning customers, channels, and regions to identify growth drivers and weaknesses.
129
- * 3. Conduct funnel analysis based on user behavior paths (browsing → add to cart → payment) to pinpoint drop-off stages.
130
127
  */
131
128
  instruction?: string;
132
129
  /**
@@ -135,10 +132,10 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
135
132
  *
136
133
  * @example
137
134
  * Core metric definitions:
138
- * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders;
139
- * 2. Order volume is the number of valid orders placed per day;
140
- * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app;
141
- * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency;
135
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
136
+ * 2. Order volume is the number of valid orders placed per day.
137
+ * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
138
+ * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency.
142
139
  */
143
140
  knowledge?: string;
144
141
  /**
@@ -170,7 +167,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
170
167
  * The text report format.
171
168
  *
172
169
  * @example
173
- * The text report requires that all numbers use Chinese numerals instead of Arabic numerals
170
+ * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
174
171
  */
175
172
  textReportConfig?: string;
176
173
  /**
@@ -178,7 +175,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
178
175
  * The web report format.
179
176
  *
180
177
  * @example
181
- * The web report requires that all numbers use Chinese numerals instead of Arabic numerals
178
+ * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
182
179
  */
183
180
  webReportConfig?: string;
184
181
  webReportTheme?: string;
@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The list of columns that are allowed to be queried in the current table. If this parameter is not specified, all columns can be queried. If this parameter is specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure the analysis effectiveness of DataAgent, 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.
8
+ * The list of columns that are allowed to be queried in the current table. If this parameter is not specified, 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, SQL statements without proper permissions are generated and blocked, which reduces DataAgent analysis speed and effectiveness.
9
9
  */
10
10
  allowedColumns?: string[];
11
11
  /**
12
12
  * @remarks
13
- * The required row filter condition for the current table. If this parameter is not specified, it is ignored. If this parameter is specified, the query condition is appended to all SQL statements that involve this table. Verify the validity of the condition before specifying it.
13
+ * The required row filter condition for the current table. If this parameter is not specified, it is ignored. If specified, all SQL statements involving this table are validated to check whether they include the filter field and whether the WHERE condition meets the constraint. SQL statements that do not meet the constraint are rejected. Ensure the validation condition format is correct.
14
14
  *
15
15
  * @example
16
16
  * region = \\"east\\"
@@ -18,7 +18,7 @@ export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Mode
18
18
  requiredRowFilter?: string;
19
19
  /**
20
20
  * @remarks
21
- * The name of the table to which the permission constraint rule applies.
21
+ * The table name to which the permission constraint rule applies.
22
22
  *
23
23
  * @example
24
24
  * sample_table
@@ -93,7 +93,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
93
93
  dataSourceId?: string;
94
94
  /**
95
95
  * @remarks
96
- * The data source type. Valid values: `[remote_data_center, database]`, indicating that the analysis is performed on a file or a database.
96
+ * The data source type. Valid values: `[remote_data_center, database]`, indicating whether the analysis is for a file or a database.
97
97
  *
98
98
  * @example
99
99
  * remote_data_center
@@ -117,7 +117,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
117
117
  dbName?: string;
118
118
  /**
119
119
  * @remarks
120
- * The ID of the database in Data Management.
120
+ * The database ID in Data Management.
121
121
  *
122
122
  * @example
123
123
  * 23******
@@ -125,7 +125,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
125
125
  dmsDatabaseId?: string;
126
126
  /**
127
127
  * @remarks
128
- * The ID of the instance in Data Management.
128
+ * The instance ID in Data Management.
129
129
  *
130
130
  * @example
131
131
  * 12******
@@ -157,7 +157,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
157
157
  location?: string;
158
158
  /**
159
159
  * @remarks
160
- * The permission constraints for querying the current data source. The permission constraint feature is available through a canary release. This parameter does not take effect for users who are not included in the canary release.
160
+ * The permission constraints for querying the current data source. The permission constraint feature is in canary release. This field does not take effect for users who are not included in the canary release.
161
161
  */
162
162
  permission?: SendChatMessageRequestDataSourcePermission;
163
163
  /**
@@ -225,12 +225,12 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
225
225
  export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
226
226
  /**
227
227
  * @remarks
228
- * The list of columns that are allowed to be queried in the current table. If this parameter is not specified, all columns can be queried. If this parameter is specified, SQL statements that exceed the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure the analysis effectiveness of DataAgent, 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.
228
+ * The list of columns that are allowed to be queried in the current table. If this parameter is not specified, 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, SQL statements without proper permissions are generated and blocked, which reduces DataAgent analysis speed and effectiveness.
229
229
  */
230
230
  allowedColumns?: string[];
231
231
  /**
232
232
  * @remarks
233
- * The required row filter condition for the current table. If this parameter is not specified, it is ignored. If this parameter is specified, the query condition is appended to all SQL statements that involve this table. Verify the validity of the condition before specifying it.
233
+ * The required row filter condition for the current table. If this parameter is not specified, it is ignored. If specified, all SQL statements involving this table are validated to check whether they include the filter field and whether the WHERE condition meets the constraint. SQL statements that do not meet the constraint are rejected. Ensure the validation condition format is correct.
234
234
  *
235
235
  * @example
236
236
  * region = \\"east\\"
@@ -238,7 +238,7 @@ export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Mod
238
238
  requiredRowFilter?: string;
239
239
  /**
240
240
  * @remarks
241
- * The name of the table to which the permission constraint rule applies.
241
+ * The table name to which the permission constraint rule applies.
242
242
  *
243
243
  * @example
244
244
  * sample_table
@@ -313,7 +313,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
313
313
  dataSourceId?: string;
314
314
  /**
315
315
  * @remarks
316
- * The data source type. Valid values: remote_data_center and database, indicating that the analysis is performed on a file or a database.
316
+ * The data source type. Valid values: remote_data_center, database, indicating whether the analysis is for a file or a database.
317
317
  *
318
318
  * @example
319
319
  * remote_data_center
@@ -337,7 +337,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
337
337
  dbName?: string;
338
338
  /**
339
339
  * @remarks
340
- * The ID of the database in Data Management.
340
+ * The database ID in Data Management.
341
341
  *
342
342
  * @example
343
343
  * 123****
@@ -345,7 +345,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
345
345
  dmsDatabaseId?: string;
346
346
  /**
347
347
  * @remarks
348
- * The ID of the instance in Data Management.
348
+ * The instance ID in Data Management.
349
349
  *
350
350
  * @example
351
351
  * 248*****
@@ -377,7 +377,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
377
377
  location?: string;
378
378
  /**
379
379
  * @remarks
380
- * The permission constraints for querying the current data source. The permission constraint feature is available through a canary release. This parameter does not take effect for users who are not included in the canary release.
380
+ * The permission constraints for querying the current data source. The permission constraint feature is in canary release. This field does not take effect for users who are not included in the canary release.
381
381
  */
382
382
  permission?: SendChatMessageRequestDataSourcesPermission;
383
383
  /**
@@ -477,7 +477,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
477
477
  kbUuidList?: string;
478
478
  /**
479
479
  * @remarks
480
- * Only Chinese and English are supported. Default value: Chinese. Only uppercase values are supported.
480
+ * Currently only Chinese and English are supported. The default value is Chinese. Only uppercase is supported.
481
481
  *
482
482
  * @example
483
483
  * ENGLISH
@@ -493,7 +493,10 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
493
493
  mcpServerIds?: string;
494
494
  /**
495
495
  * @remarks
496
- * The mode:
496
+ * The mode. Valid values:
497
+ * - **ASK_DATA**: data query mode.
498
+ * - **ANALYSIS**: analysis mode.
499
+ * - **INSIGHT**: insight mode.
497
500
  *
498
501
  * @example
499
502
  * ANALYSIS
@@ -501,7 +504,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
501
504
  mode?: string;
502
505
  /**
503
506
  * @remarks
504
- * Specifies whether to enable the plan. Valid values: disable, enable, and force. Default value: enable.
507
+ * Specifies whether to enable the plan. Valid values: disable, enable, force. Default value: enable.
505
508
  *
506
509
  * @example
507
510
  * disable
@@ -512,7 +515,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
512
515
  * The text of up to 64 characters that is used as a watermark in the generated PDF report.
513
516
  *
514
517
  * @example
515
- * SampleWatermark.
518
+ * SampleWatermark
516
519
  */
517
520
  reportWaterMark?: string;
518
521
  /**
@@ -603,7 +606,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
603
606
  reportPrompt?: string;
604
607
  /**
605
608
  * @remarks
606
- * The report theme. Valid values: default, journal, legacy, and neobrutalism.
609
+ * The report theme. Valid values: default, journal, legacy, neobrutalism.
607
610
  *
608
611
  * @example
609
612
  * default
@@ -611,7 +614,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
611
614
  reportTheme?: string;
612
615
  /**
613
616
  * @remarks
614
- * The service type. Valid values: TextReport and WebReport, indicating that the task generates a text report or a web report. Only WebReport is currently supported.
617
+ * The service type. Valid values: TextReport, WebReport, indicating whether the task generates a text report or a web report. Currently only WebReport is supported.
615
618
  *
616
619
  * @example
617
620
  * WebReport
@@ -675,7 +678,7 @@ export class SendChatMessageRequestTaskConfig extends $dara.Model {
675
678
  export class SendChatMessageRequest extends $dara.Model {
676
679
  /**
677
680
  * @remarks
678
- * The agent ID. This parameter is required. You can obtain the current AgentId from the response of the CreateAgentSession operation. Agent resources have a lifecycle, so the AgentId you need to specify may change with each request.
681
+ * The agent ID. This is a required field. You can obtain the current AgentId from the response of the CreateAgentSession operation. Agent resources have a lifecycle, so the AgentId you need to specify may change with each request.
679
682
  *
680
683
  * @example
681
684
  * agent_***
@@ -683,7 +686,7 @@ export class SendChatMessageRequest extends $dara.Model {
683
686
  agentId?: string;
684
687
  /**
685
688
  * @remarks
686
- * The Data Management unit you are currently in. If you select an analytics database, this information is used to correctly connect to your Data Management instance through Data Management. You can go to the DAS console to view your current Data Management unit. If you are a user of Alibaba Cloud China Website (www.aliyun.com), set this parameter to cn-hangzhou.
689
+ * The Data Management unit you are currently in. If you select an analytics database, this information is used to correctly connect to your Data Management instance. You can go to the DAS console to view your current Data Management unit. If you are a user on the Alibaba Cloud China Website (www.aliyun.com), you can directly enter cn-hangzhou.
687
690
  *
688
691
  * @example
689
692
  * cn-hangzhou
@@ -691,7 +694,7 @@ export class SendChatMessageRequest extends $dara.Model {
691
694
  DMSUnit?: string;
692
695
  /**
693
696
  * @remarks
694
- * The data source information. This parameter can be left empty. Only one data source can be specified for this parameter. Use the DataSources parameter instead.
697
+ * The data source information. This parameter can be left empty. This parameter supports only one data source. Use the DataSources parameter instead.
695
698
  *
696
699
  * @example
697
700
  * null
@@ -716,6 +719,14 @@ export class SendChatMessageRequest extends $dara.Model {
716
719
  * @remarks
717
720
  * The message type. Default value: `[primary]`.
718
721
  *
722
+ * - Under normal circumstances, when interacting with the Agent, the message type is `[primary]`.
723
+ *
724
+ * - When the message is a response to the Agent\\"s Human-in-Loop question, the type should be `[additional]`.
725
+ *
726
+ * - When the message is intended to trigger a report generation, the type should be `[report]`.
727
+ *
728
+ * - When the message is intended to cancel the current session, the type should be `[cancel]`.
729
+ *
719
730
  * @example
720
731
  * primary
721
732
  */
@@ -730,15 +741,15 @@ export class SendChatMessageRequest extends $dara.Model {
730
741
  parentSessionId?: string;
731
742
  /**
732
743
  * @remarks
733
- * The specific question that the agent asks the user through Human-in-Loop. This parameter is required when the message type is `additional`.
744
+ * This is a required field when the message type is `additional`. Specify the specific question that the agent asks the user through Human-in-Loop.
734
745
  *
735
746
  * @example
736
- * Please provide the criteria for calculating GMV.
747
+ * Please provide the criteria for calculating GMV
737
748
  */
738
749
  question?: string;
739
750
  /**
740
751
  * @remarks
741
- * The quoted content. This parameter is typically used when interacting with the agent.
752
+ * The quoted content. This is typically used when interacting with the agent.
742
753
  *
743
754
  * @example
744
755
  * {"version":"v0"}
@@ -748,13 +759,17 @@ export class SendChatMessageRequest extends $dara.Model {
748
759
  * @remarks
749
760
  * **Important**
750
761
  *
762
+ * 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 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".
763
+ *
764
+ * This field affects how the Agent decides to process the message. Passing an incorrect value may cause the analysis results to fall short of expectations.
765
+ *
751
766
  * @example
752
767
  * 0
753
768
  */
754
769
  replyTo?: string;
755
770
  /**
756
771
  * @remarks
757
- * The special configuration for the current session. For the same session, only the configuration specified in the first SendMessage call takes effect.
772
+ * The special configuration for the current session. For the same session, only the configuration passed with the first SendMessage call takes effect.
758
773
  *
759
774
  * **if can be null:**
760
775
  * true
@@ -762,7 +777,7 @@ export class SendChatMessageRequest extends $dara.Model {
762
777
  sessionConfig?: SendChatMessageRequestSessionConfig;
763
778
  /**
764
779
  * @remarks
765
- * The session ID. This parameter is required. You can obtain the SessionId by calling the CreateAgentSession operation.
780
+ * The session ID. This is a required field. You can obtain the SessionId by calling CreateAgentSession.
766
781
  *
767
782
  * @example
768
783
  * sess_***
@@ -775,7 +790,7 @@ export class SendChatMessageRequest extends $dara.Model {
775
790
  taskConfig?: SendChatMessageRequestTaskConfig;
776
791
  /**
777
792
  * @remarks
778
- * The OSS bucket of the user. If this parameter is not specified, the analysis data is securely stored in the built-in storage.
793
+ * The user OSS bucket. If this parameter is not specified, analysis data is securely stored in the built-in storage.
779
794
  *
780
795
  * @example
781
796
  * my-bucket
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class SendChatMessageShrinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The agent ID. This parameter is required. You can obtain the current AgentId from the response of the CreateAgentSession operation. Agent resources have a lifecycle, so the AgentId you need to specify may change with each request.
8
+ * The agent ID. This is a required field. You can obtain the current AgentId from the response of the CreateAgentSession operation. Agent resources have a lifecycle, so the AgentId you need to specify may change with each request.
9
9
  *
10
10
  * @example
11
11
  * agent_***
@@ -13,7 +13,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
13
13
  agentId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The Data Management unit you are currently in. If you select an analytics database, this information is used to correctly connect to your Data Management instance through Data Management. You can go to the DAS console to view your current Data Management unit. If you are a user of Alibaba Cloud China Website (www.aliyun.com), set this parameter to cn-hangzhou.
16
+ * The Data Management unit you are currently in. If you select an analytics database, this information is used to correctly connect to your Data Management instance. You can go to the DAS console to view your current Data Management unit. If you are a user on the Alibaba Cloud China Website (www.aliyun.com), you can directly enter cn-hangzhou.
17
17
  *
18
18
  * @example
19
19
  * cn-hangzhou
@@ -21,7 +21,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
21
21
  DMSUnit?: string;
22
22
  /**
23
23
  * @remarks
24
- * The data source information. This parameter can be left empty. Only one data source can be specified for this parameter. Use the DataSources parameter instead.
24
+ * The data source information. This parameter can be left empty. This parameter supports only one data source. Use the DataSources parameter instead.
25
25
  *
26
26
  * @example
27
27
  * null
@@ -46,6 +46,14 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
46
46
  * @remarks
47
47
  * The message type. Default value: `[primary]`.
48
48
  *
49
+ * - Under normal circumstances, when interacting with the Agent, the message type is `[primary]`.
50
+ *
51
+ * - When the message is a response to the Agent\\"s Human-in-Loop question, the type should be `[additional]`.
52
+ *
53
+ * - When the message is intended to trigger a report generation, the type should be `[report]`.
54
+ *
55
+ * - When the message is intended to cancel the current session, the type should be `[cancel]`.
56
+ *
49
57
  * @example
50
58
  * primary
51
59
  */
@@ -60,15 +68,15 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
60
68
  parentSessionId?: string;
61
69
  /**
62
70
  * @remarks
63
- * The specific question that the agent asks the user through Human-in-Loop. This parameter is required when the message type is `additional`.
71
+ * This is a required field when the message type is `additional`. Specify the specific question that the agent asks the user through Human-in-Loop.
64
72
  *
65
73
  * @example
66
- * Please provide the criteria for calculating GMV.
74
+ * Please provide the criteria for calculating GMV
67
75
  */
68
76
  question?: string;
69
77
  /**
70
78
  * @remarks
71
- * The quoted content. This parameter is typically used when interacting with the agent.
79
+ * The quoted content. This is typically used when interacting with the agent.
72
80
  *
73
81
  * @example
74
82
  * {"version":"v0"}
@@ -78,13 +86,17 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
78
86
  * @remarks
79
87
  * **Important**
80
88
  *
89
+ * 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 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".
90
+ *
91
+ * This field affects how the Agent decides to process the message. Passing an incorrect value may cause the analysis results to fall short of expectations.
92
+ *
81
93
  * @example
82
94
  * 0
83
95
  */
84
96
  replyTo?: string;
85
97
  /**
86
98
  * @remarks
87
- * The special configuration for the current session. For the same session, only the configuration specified in the first SendMessage call takes effect.
99
+ * The special configuration for the current session. For the same session, only the configuration passed with the first SendMessage call takes effect.
88
100
  *
89
101
  * **if can be null:**
90
102
  * true
@@ -92,7 +104,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
92
104
  sessionConfigShrink?: string;
93
105
  /**
94
106
  * @remarks
95
- * The session ID. This parameter is required. You can obtain the SessionId by calling the CreateAgentSession operation.
107
+ * The session ID. This is a required field. You can obtain the SessionId by calling CreateAgentSession.
96
108
  *
97
109
  * @example
98
110
  * sess_***
@@ -105,7 +117,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
105
117
  taskConfigShrink?: string;
106
118
  /**
107
119
  * @remarks
108
- * The OSS bucket of the user. If this parameter is not specified, the analysis data is securely stored in the built-in storage.
120
+ * The user OSS bucket. If this parameter is not specified, analysis data is securely stored in the built-in storage.
109
121
  *
110
122
  * @example
111
123
  * my-bucket