@alicloud/dms20250414 4.2.0 → 4.2.2

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.
@@ -5,21 +5,21 @@ 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 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.
8
+ * The list of columns that are allowed to be queried in the current table. If you leave this field empty, all columns can be queried. If you specify this field, SQL statements that query columns beyond the allowed scope, such as `SELECT *`, will be blocked. To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include columns beyond the allowed scope. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
9
9
  */
10
10
  allowedColumns?: string[];
11
11
  /**
12
12
  * @remarks
13
- * 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.
13
+ * The list of columns that are not allowed to be queried in the current table. If you leave this field empty, all columns **can be queried**. If you specify this field, SQL statements that query columns beyond the allowed scope, such as `SELECT *`, will be blocked.
14
14
  *
15
- * 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.
15
+ * If both the disallowed list and the allowed list are configured, the disallowed list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as not allowed, while configuring columns B and C as allowed, only column C is ultimately allowed to be queried.
16
16
  *
17
- * 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.
17
+ * To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include columns beyond the allowed scope. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
18
18
  */
19
19
  disallowedColumns?: string[];
20
20
  /**
21
21
  * @remarks
22
- * 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.
22
+ * The row filter condition that must be included for the current table. If you leave this field empty, it is ignored. If you specify this field, the system checks whether all SQL statements involving this table include the filter column and whether the WHERE clause meets the constraints. SQL statements that do not meet the constraints will be rejected. Pay attention to the format of the validation condition.
23
23
  *
24
24
  * @example
25
25
  * region = \\"east\\"
@@ -27,7 +27,7 @@ export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Mode
27
27
  requiredRowFilter?: string;
28
28
  /**
29
29
  * @remarks
30
- * The table name to which the permission constraint rule applies.
30
+ * The name of the table to which the permission constraint rules apply.
31
31
  *
32
32
  * @example
33
33
  * sample_table
@@ -69,7 +69,7 @@ export class SendChatMessageRequestDataSourcePermissionTables extends $dara.Mode
69
69
  export class SendChatMessageRequestDataSourcePermission extends $dara.Model {
70
70
  /**
71
71
  * @remarks
72
- * The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a table.
72
+ * The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a specific table.
73
73
  */
74
74
  tables?: SendChatMessageRequestDataSourcePermissionTables[];
75
75
  static names(): { [key: string]: string } {
@@ -99,7 +99,7 @@ export class SendChatMessageRequestDataSourcePermission extends $dara.Model {
99
99
  export class SendChatMessageRequestDataSource extends $dara.Model {
100
100
  /**
101
101
  * @remarks
102
- * Deprecated. You do not need to specify this field.
102
+ * **[Deprecated]** You do not need to specify this field.
103
103
  *
104
104
  * @example
105
105
  * 123
@@ -107,7 +107,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
107
107
  dataSourceId?: string;
108
108
  /**
109
109
  * @remarks
110
- * The data source type. Valid values: `[remote_data_center, database]`, indicating that the analysis is performed on a file or a database.
110
+ * The data source type. Valid values: `remote_data_center` and `database`. `remote_data_center` indicates a file, and `database` indicates a database.
111
111
  *
112
112
  * @example
113
113
  * remote_data_center
@@ -115,7 +115,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
115
115
  dataSourceType?: string;
116
116
  /**
117
117
  * @remarks
118
- * Deprecated. You do not need to specify this field.
118
+ * **[Deprecated]** You do not need to specify this field.
119
119
  *
120
120
  * @example
121
121
  * test_db
@@ -123,7 +123,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
123
123
  database?: string;
124
124
  /**
125
125
  * @remarks
126
- * The database name.
126
+ * The name of the database.
127
127
  *
128
128
  * @example
129
129
  * ******
@@ -131,7 +131,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
131
131
  dbName?: string;
132
132
  /**
133
133
  * @remarks
134
- * The ID of the database in Data Management.
134
+ * The ID of the database in Data Management (DMS).
135
135
  *
136
136
  * @example
137
137
  * 23******
@@ -139,7 +139,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
139
139
  dmsDatabaseId?: string;
140
140
  /**
141
141
  * @remarks
142
- * The ID of the instance in Data Management.
142
+ * The ID of the instance in DMS.
143
143
  *
144
144
  * @example
145
145
  * 12******
@@ -155,7 +155,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
155
155
  engine?: string;
156
156
  /**
157
157
  * @remarks
158
- * The file ID.
158
+ * The ID of the file.
159
159
  *
160
160
  * @example
161
161
  * 35****
@@ -163,7 +163,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
163
163
  fileId?: string;
164
164
  /**
165
165
  * @remarks
166
- * Deprecated. You do not need to specify this field.
166
+ * **[Deprecated]** You do not need to specify this field.
167
167
  *
168
168
  * @example
169
169
  * localhost
@@ -171,7 +171,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
171
171
  location?: string;
172
172
  /**
173
173
  * @remarks
174
- * The permission constraints for querying the current data source. The permission constraint feature is available through a canary release. This field does not take effect for users who are not included in the canary release.
174
+ * 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 outside the canary release scope.
175
175
  */
176
176
  permission?: SendChatMessageRequestDataSourcePermission;
177
177
  /**
@@ -184,9 +184,17 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
184
184
  regionId?: string;
185
185
  /**
186
186
  * @remarks
187
- * The list of table names to analyze.
187
+ * The list of names of the tables to be analyzed.
188
188
  */
189
189
  tables?: string[];
190
+ /**
191
+ * @remarks
192
+ * The data source resource identifier.
193
+ *
194
+ * @example
195
+ * datalake://abc/def
196
+ */
197
+ uri?: string;
190
198
  static names(): { [key: string]: string } {
191
199
  return {
192
200
  dataSourceId: 'DataSourceId',
@@ -201,6 +209,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
201
209
  permission: 'Permission',
202
210
  regionId: 'RegionId',
203
211
  tables: 'Tables',
212
+ uri: 'Uri',
204
213
  };
205
214
  }
206
215
 
@@ -218,6 +227,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
218
227
  permission: SendChatMessageRequestDataSourcePermission,
219
228
  regionId: 'string',
220
229
  tables: { 'type': 'array', 'itemType': 'string' },
230
+ uri: 'string',
221
231
  };
222
232
  }
223
233
 
@@ -239,21 +249,21 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
239
249
  export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
240
250
  /**
241
251
  * @remarks
242
- * 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.
252
+ * The list of columns that are allowed to be queried in the current table. If this parameter is left empty, all columns can be queried. If this parameter is specified, SQL statements that query columns beyond the allowed scope, such as SELECT *, are prohibited. To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions of DataAgent do not include columns beyond the allowed scope. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
243
253
  */
244
254
  allowedColumns?: string[];
245
255
  /**
246
256
  * @remarks
247
- * 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.
257
+ * The list of columns that are not allowed to be queried in the current table. If you leave this field empty, all columns **can be queried**. If you specify this field, SQL statements that query columns beyond the allowed scope, such as `SELECT *`, will be blocked.
248
258
  *
249
- * 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.
259
+ * If both the disallowed list and the allowed list are configured, the disallowed list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as not allowed, while configuring columns B and C as allowed, only column C is ultimately allowed to be queried.
250
260
  *
251
- * 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.
261
+ * To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include columns beyond the allowed scope. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
252
262
  */
253
263
  disallowedColumns?: string[];
254
264
  /**
255
265
  * @remarks
256
- * 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.
266
+ * The row filter condition that must be included for the current table. If you leave this field empty, it is ignored. If you specify this field, the system checks whether all SQL statements involving this table include the filter column and whether the WHERE clause meets the constraints. SQL statements that do not meet the constraints will be rejected. Pay attention to the format of the validation condition.
257
267
  *
258
268
  * @example
259
269
  * region = \\"east\\"
@@ -261,7 +271,7 @@ export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Mod
261
271
  requiredRowFilter?: string;
262
272
  /**
263
273
  * @remarks
264
- * The table name to which the permission constraint rule applies.
274
+ * The name of the table to which the permission constraint rules apply.
265
275
  *
266
276
  * @example
267
277
  * sample_table
@@ -303,7 +313,7 @@ export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Mod
303
313
  export class SendChatMessageRequestDataSourcesPermission extends $dara.Model {
304
314
  /**
305
315
  * @remarks
306
- * The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a table.
316
+ * The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a specific table.
307
317
  */
308
318
  tables?: SendChatMessageRequestDataSourcesPermissionTables[];
309
319
  static names(): { [key: string]: string } {
@@ -333,7 +343,7 @@ export class SendChatMessageRequestDataSourcesPermission extends $dara.Model {
333
343
  export class SendChatMessageRequestDataSources extends $dara.Model {
334
344
  /**
335
345
  * @remarks
336
- * Deprecated. You do not need to specify this field.
346
+ * **[Deprecated]** You do not need to specify this field.
337
347
  *
338
348
  * @example
339
349
  * 123
@@ -341,7 +351,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
341
351
  dataSourceId?: string;
342
352
  /**
343
353
  * @remarks
344
- * The data source type. Valid values: remote_data_center, database. These values indicate that the analysis is performed on a file or a database.
354
+ * The data source type. Valid values: remote_data_center and database, which indicate that the analysis is based on a file or a database, respectively.
345
355
  *
346
356
  * @example
347
357
  * remote_data_center
@@ -349,7 +359,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
349
359
  dataSourceType?: string;
350
360
  /**
351
361
  * @remarks
352
- * Deprecated. You do not need to specify this field.
362
+ * **[Deprecated]** You do not need to specify this field.
353
363
  *
354
364
  * @example
355
365
  * test_db
@@ -357,7 +367,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
357
367
  database?: string;
358
368
  /**
359
369
  * @remarks
360
- * The database name.
370
+ * The name of the database.
361
371
  *
362
372
  * @example
363
373
  * mydatabase
@@ -365,7 +375,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
365
375
  dbName?: string;
366
376
  /**
367
377
  * @remarks
368
- * The ID of the database in Data Management.
378
+ * The ID of the database in Data Management (DMS).
369
379
  *
370
380
  * @example
371
381
  * 123****
@@ -373,7 +383,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
373
383
  dmsDatabaseId?: string;
374
384
  /**
375
385
  * @remarks
376
- * The ID of the instance in Data Management.
386
+ * The ID of the instance in DMS.
377
387
  *
378
388
  * @example
379
389
  * 248*****
@@ -397,7 +407,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
397
407
  fileId?: string;
398
408
  /**
399
409
  * @remarks
400
- * Deprecated. You do not need to specify this field.
410
+ * **[Deprecated]** You do not need to specify this field.
401
411
  *
402
412
  * @example
403
413
  * localhost
@@ -405,7 +415,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
405
415
  location?: string;
406
416
  /**
407
417
  * @remarks
408
- * The permission constraints for querying the current data source. The permission constraint feature is available through a canary release. This field does not take effect for users who are not included in the canary release.
418
+ * 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 outside the canary release scope.
409
419
  */
410
420
  permission?: SendChatMessageRequestDataSourcesPermission;
411
421
  /**
@@ -418,9 +428,17 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
418
428
  regionId?: string;
419
429
  /**
420
430
  * @remarks
421
- * The list of table names to analyze.
431
+ * The list of names of the tables to be analyzed.
422
432
  */
423
433
  tables?: string[];
434
+ /**
435
+ * @remarks
436
+ * The data source resource identifier.
437
+ *
438
+ * @example
439
+ * datalake://abc/def
440
+ */
441
+ uri?: string;
424
442
  static names(): { [key: string]: string } {
425
443
  return {
426
444
  dataSourceId: 'DataSourceId',
@@ -435,6 +453,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
435
453
  permission: 'Permission',
436
454
  regionId: 'RegionId',
437
455
  tables: 'Tables',
456
+ uri: 'Uri',
438
457
  };
439
458
  }
440
459
 
@@ -452,6 +471,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
452
471
  permission: SendChatMessageRequestDataSourcesPermission,
453
472
  regionId: 'string',
454
473
  tables: { 'type': 'array', 'itemType': 'string' },
474
+ uri: 'string',
455
475
  };
456
476
  }
457
477
 
@@ -473,11 +493,11 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
473
493
  export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.Model {
474
494
  /**
475
495
  * @remarks
476
- * 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.
496
+ * The default behavior for table-level permissions. This parameter controls whether tables that are not configured in DataSources.[item].Permission can be queried. Valid values: `allow` and `deny`.
477
497
  *
478
- * - 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.
498
+ * - `allow`: the default value. This value indicates that the blacklist mode is used. By default, all tables can be queried, and the actual permissions are subject to the permissions configured in DMS. Only when you configure **row-level and column-level** permissions in DataSources.[item].Permission, the row-level and column-level permissions are used for access control.
479
499
  *
480
- * - 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.
500
+ * - `deny`: This value indicates that the whitelist mode is used. You must manually specify this value. By default, no tables can be queried. A table can be queried only when you configure permissions for the table in DataSources.[item].Permission. You can grant full access to a table by not configuring any row-level or column-level restrictions.
481
501
  *
482
502
  * @example
483
503
  * allow
@@ -507,7 +527,7 @@ export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.M
507
527
  export class SendChatMessageRequestSessionConfig extends $dara.Model {
508
528
  /**
509
529
  * @remarks
510
- * 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-`.
530
+ * The ID of the custom agent. A custom agent is an entity used to customize the analysis process. You can create a custom agent in the DataAgent console or by calling the CreateCustomAgent operation. The ID of a custom agent must start with `ca-`.
511
531
  *
512
532
  * @example
513
533
  * ca-asfkjhqwe***aesrfqa
@@ -539,7 +559,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
539
559
  kbUuidList?: string[];
540
560
  /**
541
561
  * @remarks
542
- * Currently only Chinese and English are supported. The default value is Chinese. Only uppercase values are supported.
562
+ * The language. Only Chinese and English are supported. The default value is Chinese. Only uppercase letters are supported.
543
563
  *
544
564
  * @example
545
565
  * ENGLISH
@@ -556,9 +576,9 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
556
576
  /**
557
577
  * @remarks
558
578
  * The mode. Valid values:
559
- * - **ASK_DATA**: data query mode.
560
- * - **ANALYSIS**: analysis mode.
561
- * - **INSIGHT**: insight mode.
579
+ * - **ASK_DATA**: the data query mode.
580
+ * - **ANALYSIS**: the analysis mode.
581
+ * - **INSIGHT**: the insight mode.
562
582
  *
563
583
  * @example
564
584
  * ANALYSIS
@@ -566,12 +586,12 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
566
586
  mode?: string;
567
587
  /**
568
588
  * @remarks
569
- * 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.
589
+ * The data permission settings at the session level. If you configure this parameter multiple times in multi-turn conversations within the same session, the last configuration prevails.
570
590
  */
571
591
  permissionConfig?: SendChatMessageRequestSessionConfigPermissionConfig;
572
592
  /**
573
593
  * @remarks
574
- * Specifies whether to enable the plan. Valid values: disable, enable, force. Default value: enable.
594
+ * Specifies whether to enable the plan feature. Valid values: `disable`, `enable`, and `force`. Default value: `enable`.
575
595
  *
576
596
  * @example
577
597
  * disable
@@ -579,7 +599,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
579
599
  planMode?: string;
580
600
  /**
581
601
  * @remarks
582
- * The text of up to 64 characters that is used as a watermark in the generated PDF report.
602
+ * The watermark text. You can enter up to 64 characters. The text is used to add a watermark to the generated PDF report.
583
603
  *
584
604
  * @example
585
605
  * sample-watermark
@@ -686,7 +706,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
686
706
  export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
687
707
  /**
688
708
  * @remarks
689
- * The prompt that the report must follow.
709
+ * The prompt that must be followed for the current report.
690
710
  *
691
711
  * @example
692
712
  * generate a report
@@ -702,7 +722,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
702
722
  reportTheme?: string;
703
723
  /**
704
724
  * @remarks
705
- * 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.
725
+ * The service type. Valid values: TextReport and WebReport, which indicate that the current task generates a text report or a web report, respectively. Only WebReport is supported.
706
726
  *
707
727
  * @example
708
728
  * WebReport
@@ -736,7 +756,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
736
756
  export class SendChatMessageRequestTaskConfig extends $dara.Model {
737
757
  /**
738
758
  * @remarks
739
- * The configuration of the report rule. Only when MesageType is set to REPORT, a report task is executed based on this configuration.
759
+ * The configuration of the report rules. A report task is executed based on this configuration only when MessageType is set to REPORT.
740
760
  */
741
761
  reportConfig?: SendChatMessageRequestTaskConfigReportConfig;
742
762
  static names(): { [key: string]: string } {
@@ -766,7 +786,7 @@ export class SendChatMessageRequestTaskConfig extends $dara.Model {
766
786
  export class SendChatMessageRequest extends $dara.Model {
767
787
  /**
768
788
  * @remarks
769
- * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field.
789
+ * **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it.
770
790
  *
771
791
  * @example
772
792
  * agent_***
@@ -774,7 +794,7 @@ export class SendChatMessageRequest extends $dara.Model {
774
794
  agentId?: string;
775
795
  /**
776
796
  * @remarks
777
- * **[Optimized]** This field is now automatically obtained by the backend. You do not need to specify this field when calling the API.
797
+ * **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it when calling the API.
778
798
  *
779
799
  * @example
780
800
  * cn-hangzhou
@@ -782,7 +802,7 @@ export class SendChatMessageRequest extends $dara.Model {
782
802
  DMSUnit?: string;
783
803
  /**
784
804
  * @remarks
785
- * The data source information. This parameter can be left empty. This parameter supports only one data source. Use the DataSources parameter instead.
805
+ * The data source information. This parameter can be left empty. You can specify only one data source for this parameter. Use the DataSources parameter instead.
786
806
  *
787
807
  * @example
788
808
  * null
@@ -795,7 +815,7 @@ export class SendChatMessageRequest extends $dara.Model {
795
815
  dataSources?: SendChatMessageRequestDataSources[];
796
816
  /**
797
817
  * @remarks
798
- * The message content to send to the Agent.
818
+ * The content of the message sent to the agent.
799
819
  *
800
820
  * This parameter is required.
801
821
  *
@@ -805,15 +825,15 @@ export class SendChatMessageRequest extends $dara.Model {
805
825
  message?: string;
806
826
  /**
807
827
  * @remarks
808
- * The message type. Default value: `[primary]`.
828
+ * The message type. Default value: `primary`.
809
829
  *
810
- * - For regular interactions with the Agent, set the message type to `[primary]`.
830
+ * - In normal interactions with the agent, the message type is `primary`.
811
831
  *
812
- * - When the message is a response to the Agent\\"s Human-in-Loop question, set the type to `[additional]`.
832
+ * - When the message is a response to a human-in-the-loop question from the agent, the type must be `additional`.
813
833
  *
814
- * - When the message is intended to trigger report generation, set the type to `[report]`.
834
+ * - When the message is intended to trigger report generation, the type must be `report`.
815
835
  *
816
- * - When the message is intended to cancel the current session, set the type to `[cancel]`.
836
+ * - When the message is intended to cancel the current session, the type must be `cancel`.
817
837
  *
818
838
  * @example
819
839
  * primary
@@ -821,7 +841,7 @@ export class SendChatMessageRequest extends $dara.Model {
821
841
  messageType?: string;
822
842
  /**
823
843
  * @remarks
824
- * The parent session ID.
844
+ * The ID of the parent session.
825
845
  *
826
846
  * @example
827
847
  * 20qrliuoo7p2vlsfg*****
@@ -829,15 +849,15 @@ export class SendChatMessageRequest extends $dara.Model {
829
849
  parentSessionId?: string;
830
850
  /**
831
851
  * @remarks
832
- * This field is required when the message type is `additional`. Specify the specific question that the Agent asks the user through Human-in-Loop.
852
+ * Required when the message type is `additional`. Specifies the specific question asked by the agent to the user through human-in-the-loop.
833
853
  *
834
854
  * @example
835
- * Provide the criteria for calculating GMV
855
+ * Provide the calculation criteria for GMV
836
856
  */
837
857
  question?: string;
838
858
  /**
839
859
  * @remarks
840
- * The quoted content. This is typically used during interactions with the Agent.
860
+ * The quoted content. This is typically used when interacting with the agent.
841
861
  *
842
862
  * @example
843
863
  * {"version":"v0"}
@@ -847,9 +867,9 @@ export class SendChatMessageRequest extends $dara.Model {
847
867
  * @remarks
848
868
  * **Important**
849
869
  *
850
- * 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".
870
+ * When this message is a reply to an agent message, such as an agent asking for clarification through ASK_HUMAN, `reply_to` must exactly match the checkpoint sequence number carried by that agent message. If this message is not a targeted reply, such as requesting the agent to perform further in-depth analysis after the initial analysis is complete, you can leave `reply_to` empty or set it to "0".
851
871
  *
852
- * This field affects how the Agent decides to process the message. Incorrect values may lead to analysis results that do not meet expectations.
872
+ * This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
853
873
  *
854
874
  * @example
855
875
  * 0
@@ -857,7 +877,7 @@ export class SendChatMessageRequest extends $dara.Model {
857
877
  replyTo?: string;
858
878
  /**
859
879
  * @remarks
860
- * The special configuration for the current session. For the same session, only the configuration included in the first SendMessage call takes effect.
880
+ * The special configurations for the current session. For the same session, only the configurations specified in the first SendMessage call take effect.
861
881
  *
862
882
  * **if can be null:**
863
883
  * true
@@ -865,10 +885,10 @@ export class SendChatMessageRequest extends $dara.Model {
865
885
  sessionConfig?: SendChatMessageRequestSessionConfig;
866
886
  /**
867
887
  * @remarks
868
- * The session ID. This is an optional field used for multi-turn sessions.
869
- * - You can start a session without specifying this field. The response includes the SessionID of the current session.
888
+ * The session ID. This optional field is used for multi-turn sessions.
889
+ * - You can start a session without specifying this field. The response will include the session ID for the current session.
870
890
  * - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating a session.
871
- * - For multi-turn conversations (such as follow-up questions or confirming execution plans), specify the SessionID returned by the previous SendChatMessage call.
891
+ * - If you need multi-turn conversations, such as follow-up questions or confirming execution plans, specify the session ID returned by the previous SendChatMessage operation in this operation.
872
892
  *
873
893
  * @example
874
894
  * sess_***
@@ -881,7 +901,7 @@ export class SendChatMessageRequest extends $dara.Model {
881
901
  taskConfig?: SendChatMessageRequestTaskConfig;
882
902
  /**
883
903
  * @remarks
884
- * The OSS bucket of the user. If this parameter is not specified, the analysis data is securely stored in built-in storage.
904
+ * The Object Storage Service (OSS) bucket of the user. If this parameter is left empty, the analysis process is securely stored in the built-in storage.
885
905
  *
886
906
  * @example
887
907
  * my-bucket