@alicloud/dms20250414 4.3.0 → 4.3.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.
- package/dist/client.d.ts +12 -12
- package/dist/client.js +12 -12
- package/dist/models/CreateDataAgentSkillMetaRequest.d.ts +8 -5
- package/dist/models/CreateDataAgentSkillMetaRequest.js.map +1 -1
- package/dist/models/CreateDataAgentSkillMetaResponseBody.d.ts +6 -6
- package/dist/models/CreateDataAgentSkillMetaResponseBody.js.map +1 -1
- package/dist/models/ListAgenticGlobalSqlExecutionHistoriesRequest.d.ts +9 -12
- package/dist/models/ListAgenticGlobalSqlExecutionHistoriesRequest.js.map +1 -1
- package/dist/models/ListAgenticGlobalSqlExecutionHistoriesResponseBody.d.ts +13 -20
- package/dist/models/ListAgenticGlobalSqlExecutionHistoriesResponseBody.js.map +1 -1
- package/dist/models/ListAgenticSqlExecutionHistoriesRequest.d.ts +7 -8
- package/dist/models/ListAgenticSqlExecutionHistoriesRequest.js.map +1 -1
- package/dist/models/ListAgenticSqlExecutionHistoriesResponseBody.d.ts +18 -16
- package/dist/models/ListAgenticSqlExecutionHistoriesResponseBody.js.map +1 -1
- package/dist/models/SendChatMessageRequest.d.ts +59 -51
- package/dist/models/SendChatMessageRequest.js +2 -0
- package/dist/models/SendChatMessageRequest.js.map +1 -1
- package/dist/models/SendChatMessageShrinkRequest.d.ts +16 -19
- package/dist/models/SendChatMessageShrinkRequest.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +12 -12
- package/src/models/CreateDataAgentSkillMetaRequest.ts +8 -5
- package/src/models/CreateDataAgentSkillMetaResponseBody.ts +7 -7
- package/src/models/ListAgenticGlobalSqlExecutionHistoriesRequest.ts +9 -12
- package/src/models/ListAgenticGlobalSqlExecutionHistoriesResponseBody.ts +13 -20
- package/src/models/ListAgenticSqlExecutionHistoriesRequest.ts +7 -8
- package/src/models/ListAgenticSqlExecutionHistoriesResponseBody.ts +18 -16
- package/src/models/SendChatMessageRequest.ts +61 -51
- package/src/models/SendChatMessageShrinkRequest.ts +16 -19
|
@@ -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
|
|
8
|
+
* The list of fields that are allowed to be queried in the current table. If you do not specify this parameter, all fields can be queried. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked. To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. 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
|
|
13
|
+
* The list of fields that are prohibited from being queried in the current table. If you do not specify this parameter, all fields **can be queried**. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked.
|
|
14
14
|
*
|
|
15
|
-
* If both the
|
|
15
|
+
* If both the prohibited list and the allowed list are configured, the prohibited list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as non-queryable while configuring columns B and C as queryable, only column C is ultimately queryable.
|
|
16
16
|
*
|
|
17
|
-
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include
|
|
17
|
+
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. 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 row filter condition that must be included for the current table. If you
|
|
22
|
+
* The row filter condition that must be included for the current table. If you do not specify this parameter, it is ignored. If you specify this parameter, the system checks whether all SQL statements involving this table include the filter field and whether the WHERE condition 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\\"
|
|
@@ -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:
|
|
110
|
+
* The data source type. Valid values: remote_data_center and database, which indicate that the analysis target is a file or a database, respectively.
|
|
111
111
|
*
|
|
112
112
|
* @example
|
|
113
113
|
* remote_data_center
|
|
@@ -147,7 +147,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
147
147
|
dmsInstanceId?: string;
|
|
148
148
|
/**
|
|
149
149
|
* @remarks
|
|
150
|
-
* The
|
|
150
|
+
* The type of the database.
|
|
151
151
|
*
|
|
152
152
|
* @example
|
|
153
153
|
* mysql
|
|
@@ -155,7 +155,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
155
155
|
engine?: string;
|
|
156
156
|
/**
|
|
157
157
|
* @remarks
|
|
158
|
-
* The ID
|
|
158
|
+
* The file ID.
|
|
159
159
|
*
|
|
160
160
|
* @example
|
|
161
161
|
* 35****
|
|
@@ -184,7 +184,7 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
184
184
|
regionId?: string;
|
|
185
185
|
/**
|
|
186
186
|
* @remarks
|
|
187
|
-
* The list of names
|
|
187
|
+
* The list of table names to be analyzed.
|
|
188
188
|
*/
|
|
189
189
|
tables?: string[];
|
|
190
190
|
/**
|
|
@@ -249,21 +249,21 @@ export class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
249
249
|
export class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
|
|
250
250
|
/**
|
|
251
251
|
* @remarks
|
|
252
|
-
* The list of columns that are allowed to be queried in the current table. If
|
|
252
|
+
* The list of columns that are allowed to be queried in the current table. If you do not specify this parameter, all columns can be queried. If you specify this parameter, SQL statements that query columns beyond the allowed scope are blocked. For example, syntax such as SELECT * is blocked. 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 are generated and blocked, which reduces the analysis speed and performance of DataAgent.
|
|
253
253
|
*/
|
|
254
254
|
allowedColumns?: string[];
|
|
255
255
|
/**
|
|
256
256
|
* @remarks
|
|
257
|
-
* The list of
|
|
257
|
+
* The list of fields that are prohibited from being queried in the current table. If you do not specify this parameter, all fields **can be queried**. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked.
|
|
258
258
|
*
|
|
259
|
-
* If both the
|
|
259
|
+
* If both the prohibited list and the allowed list are configured, the prohibited list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as non-queryable while configuring columns B and C as queryable, only column C is ultimately queryable.
|
|
260
260
|
*
|
|
261
|
-
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include
|
|
261
|
+
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
|
|
262
262
|
*/
|
|
263
263
|
disallowedColumns?: string[];
|
|
264
264
|
/**
|
|
265
265
|
* @remarks
|
|
266
|
-
* The row filter condition that must be included for the current table. If you
|
|
266
|
+
* The row filter condition that must be included for the current table. If you do not specify this parameter, it is ignored. If you specify this parameter, the system checks whether all SQL statements involving this table include the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints will be rejected. Pay attention to the format of the validation condition.
|
|
267
267
|
*
|
|
268
268
|
* @example
|
|
269
269
|
* region = \\"east\\"
|
|
@@ -351,7 +351,9 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
351
351
|
dataSourceId?: string;
|
|
352
352
|
/**
|
|
353
353
|
* @remarks
|
|
354
|
-
* The data source type. Valid values:
|
|
354
|
+
* The data source type. Valid values:
|
|
355
|
+
* - remote_data_center: The analysis is performed on a file.
|
|
356
|
+
* - database: The analysis is performed on a database.
|
|
355
357
|
*
|
|
356
358
|
* @example
|
|
357
359
|
* remote_data_center
|
|
@@ -391,7 +393,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
391
393
|
dmsInstanceId?: string;
|
|
392
394
|
/**
|
|
393
395
|
* @remarks
|
|
394
|
-
* The
|
|
396
|
+
* The type of the database.
|
|
395
397
|
*
|
|
396
398
|
* @example
|
|
397
399
|
* mysql
|
|
@@ -428,7 +430,7 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
428
430
|
regionId?: string;
|
|
429
431
|
/**
|
|
430
432
|
* @remarks
|
|
431
|
-
* The list of names
|
|
433
|
+
* The list of table names to be analyzed.
|
|
432
434
|
*/
|
|
433
435
|
tables?: string[];
|
|
434
436
|
/**
|
|
@@ -493,11 +495,9 @@ export class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
493
495
|
export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.Model {
|
|
494
496
|
/**
|
|
495
497
|
* @remarks
|
|
496
|
-
* The default behavior for table-level permissions. This parameter controls whether tables
|
|
497
|
-
*
|
|
498
|
-
* -
|
|
499
|
-
*
|
|
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.
|
|
498
|
+
* The default behavior for table-level permissions. This parameter controls whether tables not configured in DataSources.[item].Permission can be queried. Valid values:
|
|
499
|
+
* - allow: Works in blacklist mode. This is the default value. By default, all tables can be queried, and the actual permissions are subject to the permissions configured in DMS. Only when you configure **row- and column-level** permissions in DataSources.[item].Permission will row- and column-level permissions be enforced.
|
|
500
|
+
* - deny: Works in whitelist mode. You must manually specify this value. 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- or column-level restrictions.
|
|
501
501
|
*
|
|
502
502
|
* @example
|
|
503
503
|
* allow
|
|
@@ -527,7 +527,7 @@ export class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.M
|
|
|
527
527
|
export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
528
528
|
/**
|
|
529
529
|
* @remarks
|
|
530
|
-
* The
|
|
530
|
+
* The custom agent ID. A custom agent is an entity used to customize the analysis process. You can create it in the DataAgent console or by calling the CreateCustomAgent operation. A custom agent ID must be a string starting with ca-.
|
|
531
531
|
*
|
|
532
532
|
* @example
|
|
533
533
|
* ca-asfkjhqwe***aesrfqa
|
|
@@ -576,9 +576,9 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
576
576
|
/**
|
|
577
577
|
* @remarks
|
|
578
578
|
* The mode. Valid values:
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
579
|
+
* - **ASK_DATA**: Data query mode.
|
|
580
|
+
* - **ANALYSIS**: Analysis mode.
|
|
581
|
+
* - **INSIGHT**: Insight mode.
|
|
582
582
|
*
|
|
583
583
|
* @example
|
|
584
584
|
* ANALYSIS
|
|
@@ -586,12 +586,12 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
586
586
|
mode?: string;
|
|
587
587
|
/**
|
|
588
588
|
* @remarks
|
|
589
|
-
* The data permission settings at the session level. If
|
|
589
|
+
* The data permission settings at the session level. If configured multiple times in multi-turn conversations within the same session, the last configuration prevails.
|
|
590
590
|
*/
|
|
591
591
|
permissionConfig?: SendChatMessageRequestSessionConfigPermissionConfig;
|
|
592
592
|
/**
|
|
593
593
|
* @remarks
|
|
594
|
-
* Specifies whether to enable the plan feature. Valid values:
|
|
594
|
+
* Specifies whether to enable the plan feature. Valid values: disable, enable, and force. Default value: enable.
|
|
595
595
|
*
|
|
596
596
|
* @example
|
|
597
597
|
* disable
|
|
@@ -599,7 +599,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
599
599
|
planMode?: string;
|
|
600
600
|
/**
|
|
601
601
|
* @remarks
|
|
602
|
-
* The
|
|
602
|
+
* The text to be added as a watermark to the generated PDF report. The text can be up to 64 characters in length.
|
|
603
603
|
*
|
|
604
604
|
* @example
|
|
605
605
|
* sample-watermark
|
|
@@ -642,6 +642,14 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
642
642
|
* The list of user-specified skills.
|
|
643
643
|
*/
|
|
644
644
|
userSpecifiedSkillList?: string[];
|
|
645
|
+
/**
|
|
646
|
+
* @remarks
|
|
647
|
+
* The default report theme ID for the current session.
|
|
648
|
+
*
|
|
649
|
+
* @example
|
|
650
|
+
* default
|
|
651
|
+
*/
|
|
652
|
+
webReportTheme?: string;
|
|
645
653
|
static names(): { [key: string]: string } {
|
|
646
654
|
return {
|
|
647
655
|
customAgentId: 'CustomAgentId',
|
|
@@ -659,6 +667,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
659
667
|
skipSqlConfirm: 'SkipSqlConfirm',
|
|
660
668
|
skipWebReportConfirm: 'SkipWebReportConfirm',
|
|
661
669
|
userSpecifiedSkillList: 'UserSpecifiedSkillList',
|
|
670
|
+
webReportTheme: 'WebReportTheme',
|
|
662
671
|
};
|
|
663
672
|
}
|
|
664
673
|
|
|
@@ -679,6 +688,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
679
688
|
skipSqlConfirm: 'boolean',
|
|
680
689
|
skipWebReportConfirm: 'boolean',
|
|
681
690
|
userSpecifiedSkillList: { 'type': 'array', 'itemType': 'string' },
|
|
691
|
+
webReportTheme: 'string',
|
|
682
692
|
};
|
|
683
693
|
}
|
|
684
694
|
|
|
@@ -706,7 +716,7 @@ export class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
706
716
|
export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
|
|
707
717
|
/**
|
|
708
718
|
* @remarks
|
|
709
|
-
* The prompt that
|
|
719
|
+
* The prompt that the current report must follow.
|
|
710
720
|
*
|
|
711
721
|
* @example
|
|
712
722
|
* generate a report
|
|
@@ -714,7 +724,7 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
|
|
|
714
724
|
reportPrompt?: string;
|
|
715
725
|
/**
|
|
716
726
|
* @remarks
|
|
717
|
-
* The report theme.
|
|
727
|
+
* The report theme. System themes include default, journal, legacy, and neobrutalism, which are globally available theme IDs. You can call the ListDataAgentTheme operation to obtain other available theme IDs.
|
|
718
728
|
*
|
|
719
729
|
* @example
|
|
720
730
|
* default
|
|
@@ -722,7 +732,10 @@ export class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
|
|
|
722
732
|
reportTheme?: string;
|
|
723
733
|
/**
|
|
724
734
|
* @remarks
|
|
725
|
-
* The service type. Valid values:
|
|
735
|
+
* The service type. Valid values:
|
|
736
|
+
* - TextReport: The task generates a text report.
|
|
737
|
+
* - WebReport: The task generates a web report.
|
|
738
|
+
* Currently, only WebReport is supported.
|
|
726
739
|
*
|
|
727
740
|
* @example
|
|
728
741
|
* WebReport
|
|
@@ -802,7 +815,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
802
815
|
DMSUnit?: string;
|
|
803
816
|
/**
|
|
804
817
|
* @remarks
|
|
805
|
-
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter.
|
|
818
|
+
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter. We recommend that you use the DataSources parameter instead.
|
|
806
819
|
*
|
|
807
820
|
* @example
|
|
808
821
|
* null
|
|
@@ -825,15 +838,12 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
825
838
|
message?: string;
|
|
826
839
|
/**
|
|
827
840
|
* @remarks
|
|
828
|
-
* The message type. Default value:
|
|
829
|
-
*
|
|
830
|
-
* - In normal interactions with the agent, the message type is `primary`.
|
|
831
|
-
*
|
|
832
|
-
* - When the message is a response to a human-in-the-loop question from the agent, the type must be `additional`.
|
|
833
|
-
*
|
|
834
|
-
* - When the message is intended to trigger report generation, the type must be `report`.
|
|
841
|
+
* The message type. Default value: primary.
|
|
835
842
|
*
|
|
836
|
-
* -
|
|
843
|
+
* - In normal interactions with the agent, the message type is primary.
|
|
844
|
+
* - When the message is a response to a human-in-the-loop question from the agent, the type must be additional.
|
|
845
|
+
* - When the message is intended to trigger report generation, the type must be report.
|
|
846
|
+
* - When the message is intended to cancel the current session, the type must be cancel.
|
|
837
847
|
*
|
|
838
848
|
* @example
|
|
839
849
|
* primary
|
|
@@ -841,7 +851,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
841
851
|
messageType?: string;
|
|
842
852
|
/**
|
|
843
853
|
* @remarks
|
|
844
|
-
* The
|
|
854
|
+
* The parent session ID.
|
|
845
855
|
*
|
|
846
856
|
* @example
|
|
847
857
|
* 20qrliuoo7p2vlsfg*****
|
|
@@ -849,7 +859,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
849
859
|
parentSessionId?: string;
|
|
850
860
|
/**
|
|
851
861
|
* @remarks
|
|
852
|
-
* Required when the message type is
|
|
862
|
+
* Required when the message type is additional. Specifies the specific question asked by the agent to the user through human-in-the-loop.
|
|
853
863
|
*
|
|
854
864
|
* @example
|
|
855
865
|
* Provide the calculation criteria for GMV
|
|
@@ -857,7 +867,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
857
867
|
question?: string;
|
|
858
868
|
/**
|
|
859
869
|
* @remarks
|
|
860
|
-
* The quoted content. This is typically used
|
|
870
|
+
* The current quoted content. This is typically used during interactions with the agent.
|
|
861
871
|
*
|
|
862
872
|
* @example
|
|
863
873
|
* {"version":"v0"}
|
|
@@ -867,7 +877,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
867
877
|
* @remarks
|
|
868
878
|
* **Important**
|
|
869
879
|
*
|
|
870
|
-
* When this message is a reply to an agent message
|
|
880
|
+
* When this message is a reply to an agent message (such as the 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.
|
|
871
881
|
*
|
|
872
882
|
* This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
|
|
873
883
|
*
|
|
@@ -877,7 +887,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
877
887
|
replyTo?: string;
|
|
878
888
|
/**
|
|
879
889
|
* @remarks
|
|
880
|
-
* The special configurations for the current session. For the same session, only the configurations
|
|
890
|
+
* The special configurations for the current session. For the same session, only the configurations passed during the first SendMessage call take effect.
|
|
881
891
|
*
|
|
882
892
|
* **if can be null:**
|
|
883
893
|
* true
|
|
@@ -885,10 +895,10 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
885
895
|
sessionConfig?: SendChatMessageRequestSessionConfig;
|
|
886
896
|
/**
|
|
887
897
|
* @remarks
|
|
888
|
-
* The session ID. This optional field
|
|
889
|
-
* - You can start a session without specifying this field
|
|
890
|
-
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating
|
|
891
|
-
* - If you need multi-turn conversations
|
|
898
|
+
* The session ID. This is an optional field used for multi-turn sessions.
|
|
899
|
+
* - You can start a session without specifying this field, and the response will include the SessionID for the current session.
|
|
900
|
+
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating the session.
|
|
901
|
+
* - If you need multi-turn conversations (such as follow-up questions or confirming execution plans), include the SessionID returned by the previous SendChatMessage operation in this API call.
|
|
892
902
|
*
|
|
893
903
|
* @example
|
|
894
904
|
* sess_***
|
|
@@ -901,7 +911,7 @@ export class SendChatMessageRequest extends $dara.Model {
|
|
|
901
911
|
taskConfig?: SendChatMessageRequestTaskConfig;
|
|
902
912
|
/**
|
|
903
913
|
* @remarks
|
|
904
|
-
* The Object Storage Service (OSS) bucket of the user. If
|
|
914
|
+
* The Object Storage Service (OSS) bucket of the user. If you do not specify this parameter, the analysis process is securely stored in the built-in storage.
|
|
905
915
|
*
|
|
906
916
|
* @example
|
|
907
917
|
* my-bucket
|
|
@@ -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. You can specify only one data source for this parameter.
|
|
24
|
+
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter. We recommend that you use the DataSources parameter instead.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* null
|
|
@@ -44,15 +44,12 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
44
44
|
message?: string;
|
|
45
45
|
/**
|
|
46
46
|
* @remarks
|
|
47
|
-
* The message type. Default value:
|
|
47
|
+
* The message type. Default value: primary.
|
|
48
48
|
*
|
|
49
|
-
* - In normal interactions with the agent, the message type is
|
|
50
|
-
*
|
|
51
|
-
* - When the message is
|
|
52
|
-
*
|
|
53
|
-
* - When the message is intended to trigger report generation, the type must be `report`.
|
|
54
|
-
*
|
|
55
|
-
* - When the message is intended to cancel the current session, the type must be `cancel`.
|
|
49
|
+
* - In normal interactions with the agent, the message type is primary.
|
|
50
|
+
* - When the message is a response to a human-in-the-loop question from the agent, the type must be additional.
|
|
51
|
+
* - When the message is intended to trigger report generation, the type must be report.
|
|
52
|
+
* - When the message is intended to cancel the current session, the type must be cancel.
|
|
56
53
|
*
|
|
57
54
|
* @example
|
|
58
55
|
* primary
|
|
@@ -60,7 +57,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
60
57
|
messageType?: string;
|
|
61
58
|
/**
|
|
62
59
|
* @remarks
|
|
63
|
-
* The
|
|
60
|
+
* The parent session ID.
|
|
64
61
|
*
|
|
65
62
|
* @example
|
|
66
63
|
* 20qrliuoo7p2vlsfg*****
|
|
@@ -68,7 +65,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
68
65
|
parentSessionId?: string;
|
|
69
66
|
/**
|
|
70
67
|
* @remarks
|
|
71
|
-
* Required when the message type is
|
|
68
|
+
* Required when the message type is additional. Specifies the specific question asked by the agent to the user through human-in-the-loop.
|
|
72
69
|
*
|
|
73
70
|
* @example
|
|
74
71
|
* Provide the calculation criteria for GMV
|
|
@@ -76,7 +73,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
76
73
|
question?: string;
|
|
77
74
|
/**
|
|
78
75
|
* @remarks
|
|
79
|
-
* The quoted content. This is typically used
|
|
76
|
+
* The current quoted content. This is typically used during interactions with the agent.
|
|
80
77
|
*
|
|
81
78
|
* @example
|
|
82
79
|
* {"version":"v0"}
|
|
@@ -86,7 +83,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
86
83
|
* @remarks
|
|
87
84
|
* **Important**
|
|
88
85
|
*
|
|
89
|
-
* When this message is a reply to an agent message
|
|
86
|
+
* When this message is a reply to an agent message (such as the 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.
|
|
90
87
|
*
|
|
91
88
|
* This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
|
|
92
89
|
*
|
|
@@ -96,7 +93,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
96
93
|
replyTo?: string;
|
|
97
94
|
/**
|
|
98
95
|
* @remarks
|
|
99
|
-
* The special configurations for the current session. For the same session, only the configurations
|
|
96
|
+
* The special configurations for the current session. For the same session, only the configurations passed during the first SendMessage call take effect.
|
|
100
97
|
*
|
|
101
98
|
* **if can be null:**
|
|
102
99
|
* true
|
|
@@ -104,10 +101,10 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
104
101
|
sessionConfigShrink?: string;
|
|
105
102
|
/**
|
|
106
103
|
* @remarks
|
|
107
|
-
* The session ID. This optional field
|
|
108
|
-
* - You can start a session without specifying this field
|
|
109
|
-
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating
|
|
110
|
-
* - If you need multi-turn conversations
|
|
104
|
+
* The session ID. This is an optional field used for multi-turn sessions.
|
|
105
|
+
* - You can start a session without specifying this field, and the response will include the SessionID for the current session.
|
|
106
|
+
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating the session.
|
|
107
|
+
* - If you need multi-turn conversations (such as follow-up questions or confirming execution plans), include the SessionID returned by the previous SendChatMessage operation in this API call.
|
|
111
108
|
*
|
|
112
109
|
* @example
|
|
113
110
|
* sess_***
|
|
@@ -120,7 +117,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
120
117
|
taskConfigShrink?: string;
|
|
121
118
|
/**
|
|
122
119
|
* @remarks
|
|
123
|
-
* The Object Storage Service (OSS) bucket of the user. If
|
|
120
|
+
* The Object Storage Service (OSS) bucket of the user. If you do not specify this parameter, the analysis process is securely stored in the built-in storage.
|
|
124
121
|
*
|
|
125
122
|
* @example
|
|
126
123
|
* my-bucket
|