@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.
- package/dist/client.d.ts +10 -10
- package/dist/client.js +13 -10
- package/dist/client.js.map +1 -1
- package/dist/models/CreateDataAgentSkillMetaRequest.d.ts +12 -6
- package/dist/models/CreateDataAgentSkillMetaRequest.js +2 -0
- package/dist/models/CreateDataAgentSkillMetaRequest.js.map +1 -1
- package/dist/models/CreateDataAgentSkillMetaResponseBody.d.ts +5 -8
- package/dist/models/CreateDataAgentSkillMetaResponseBody.js.map +1 -1
- package/dist/models/SendChatMessageRequest.d.ts +83 -67
- package/dist/models/SendChatMessageRequest.js +4 -0
- package/dist/models/SendChatMessageRequest.js.map +1 -1
- package/dist/models/SendChatMessageShrinkRequest.d.ts +20 -20
- package/dist/models/UpdateAgenticDataSourceRequest.d.ts +31 -16
- package/dist/models/UpdateAgenticDataSourceRequest.js.map +1 -1
- package/dist/models/UpdateAgenticDataSourceResponseBody.d.ts +21 -21
- package/package.json +1 -1
- package/src/client.ts +14 -10
- package/src/models/CreateDataAgentSkillMetaRequest.ts +14 -6
- package/src/models/CreateDataAgentSkillMetaResponseBody.ts +5 -8
- package/src/models/SendChatMessageRequest.ts +87 -67
- package/src/models/SendChatMessageShrinkRequest.ts +20 -20
- package/src/models/UpdateAgenticDataSourceRequest.ts +31 -16
- package/src/models/UpdateAgenticDataSourceResponseBody.ts +21 -21
|
@@ -2,8 +2,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class CreateDataAgentSkillMetaRequest extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The skill description.
|
|
6
|
-
* - Optional. If not specified, the system parses the ZIP package specified by UploadLocation to obtain the skill description.
|
|
5
|
+
* The skill description. This parameter is optional. If not specified, the backend parses the ZIP package specified by UploadLocation to obtain the skill description.
|
|
7
6
|
*
|
|
8
7
|
* @example
|
|
9
8
|
* This is a demo skill description.
|
|
@@ -11,8 +10,15 @@ export declare class CreateDataAgentSkillMetaRequest extends $dara.Model {
|
|
|
11
10
|
description?: string;
|
|
12
11
|
/**
|
|
13
12
|
* @remarks
|
|
14
|
-
* The skill name.
|
|
15
|
-
*
|
|
13
|
+
* The skill ID. If you specify this parameter, the uploaded skill overwrites the existing skill and replaces the original skill content. Note: The name of the original skill and the newly uploaded skill must be identical.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ski-04pomiln*************j0
|
|
17
|
+
*/
|
|
18
|
+
skillId?: string;
|
|
19
|
+
/**
|
|
20
|
+
* @remarks
|
|
21
|
+
* The skill name. This parameter is optional. If not specified, the backend parses the ZIP package specified by UploadLocation to obtain the skill name.
|
|
16
22
|
*
|
|
17
23
|
* @example
|
|
18
24
|
* data-query-skill
|
|
@@ -20,8 +26,8 @@ export declare class CreateDataAgentSkillMetaRequest extends $dara.Model {
|
|
|
20
26
|
skillName?: string;
|
|
21
27
|
/**
|
|
22
28
|
* @remarks
|
|
23
|
-
* The full path
|
|
24
|
-
* - Format:
|
|
29
|
+
* The full path for the skill ZIP file upload.
|
|
30
|
+
* - Format: The UploadDir field returned by the DescribeSkillFileUploadSignature operation concatenated with the file name.
|
|
25
31
|
* - Example: ${UploadDir}/${Filename}
|
|
26
32
|
*/
|
|
27
33
|
uploadLocation?: string;
|
|
@@ -40,6 +40,7 @@ class CreateDataAgentSkillMetaRequest extends $dara.Model {
|
|
|
40
40
|
static names() {
|
|
41
41
|
return {
|
|
42
42
|
description: 'Description',
|
|
43
|
+
skillId: 'SkillId',
|
|
43
44
|
skillName: 'SkillName',
|
|
44
45
|
uploadLocation: 'UploadLocation',
|
|
45
46
|
workspaceId: 'WorkspaceId',
|
|
@@ -48,6 +49,7 @@ class CreateDataAgentSkillMetaRequest extends $dara.Model {
|
|
|
48
49
|
static types() {
|
|
49
50
|
return {
|
|
50
51
|
description: 'string',
|
|
52
|
+
skillId: 'string',
|
|
51
53
|
skillName: 'string',
|
|
52
54
|
uploadLocation: 'string',
|
|
53
55
|
workspaceId: 'string',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateDataAgentSkillMetaRequest.js","sourceRoot":"","sources":["../../src/models/CreateDataAgentSkillMetaRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,+BAAgC,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"CreateDataAgentSkillMetaRequest.js","sourceRoot":"","sources":["../../src/models/CreateDataAgentSkillMetaRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,+BAAgC,SAAQ,KAAK,CAAC,KAAK;IAwC9D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,cAAc,EAAE,gBAAgB;YAChC,WAAW,EAAE,aAAa;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,cAAc,EAAE,QAAQ;YACxB,WAAW,EAAE,QAAQ;SACtB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAnED,0EAmEC"}
|
|
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class CreateDataAgentSkillMetaResponseBodyData extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The Alibaba Cloud account
|
|
5
|
+
* The ID of the parent Alibaba Cloud account.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
8
|
* 16738266********
|
|
@@ -10,7 +10,7 @@ export declare class CreateDataAgentSkillMetaResponseBodyData extends $dara.Mode
|
|
|
10
10
|
aliyunParentUid?: string;
|
|
11
11
|
/**
|
|
12
12
|
* @remarks
|
|
13
|
-
* The Alibaba Cloud
|
|
13
|
+
* The Alibaba Cloud account ID.
|
|
14
14
|
*
|
|
15
15
|
* @example
|
|
16
16
|
* 20372822********
|
|
@@ -34,9 +34,7 @@ export declare class CreateDataAgentSkillMetaResponseBodyData extends $dara.Mode
|
|
|
34
34
|
description?: string;
|
|
35
35
|
/**
|
|
36
36
|
* @remarks
|
|
37
|
-
* Indicates whether the skill is available. Valid values:
|
|
38
|
-
* - true: The skill is available.
|
|
39
|
-
* - false: The skill is not available.
|
|
37
|
+
* Indicates whether the skill is available. Valid values: true and false.
|
|
40
38
|
*
|
|
41
39
|
* @example
|
|
42
40
|
* true
|
|
@@ -52,7 +50,7 @@ export declare class CreateDataAgentSkillMetaResponseBodyData extends $dara.Mode
|
|
|
52
50
|
gmtCreated?: string;
|
|
53
51
|
/**
|
|
54
52
|
* @remarks
|
|
55
|
-
* The
|
|
53
|
+
* The modification time.
|
|
56
54
|
*
|
|
57
55
|
* @example
|
|
58
56
|
* 2025-12-11T14:04:32.000+00:00
|
|
@@ -60,8 +58,7 @@ export declare class CreateDataAgentSkillMetaResponseBodyData extends $dara.Mode
|
|
|
60
58
|
gmtModified?: string;
|
|
61
59
|
/**
|
|
62
60
|
* @remarks
|
|
63
|
-
* The skill parsing
|
|
64
|
-
* - This message is returned when the skill status is INVALID.
|
|
61
|
+
* The error message for skill parsing. This message is returned when the skill status is INVALID.
|
|
65
62
|
*
|
|
66
63
|
* @example
|
|
67
64
|
* SKILL.md file not exist.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateDataAgentSkillMetaResponseBody.js","sourceRoot":"","sources":["../../src/models/CreateDataAgentSkillMetaResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wCAAyC,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"CreateDataAgentSkillMetaResponseBody.js","sourceRoot":"","sources":["../../src/models/CreateDataAgentSkillMetaResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wCAAyC,SAAQ,KAAK,CAAC,KAAK;IAoHvE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,SAAS,EAAE,WAAW;YACtB,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;YACxB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,aAAa;YAC1B,WAAW,EAAE,aAAa;SAC3B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,SAAS,EAAE,QAAQ;YACnB,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,QAAQ;YACrB,WAAW,EAAE,QAAQ;SACtB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjKD,4FAiKC;AAED,MAAa,oCAAqC,SAAQ,KAAK,CAAC,KAAK;IAyCnE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,cAAc;YAC5B,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,wCAAwC;YAC9C,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,QAAQ;YACtB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,IAAI,IAAI,OAAQ,IAAI,CAAC,IAAY,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjE,IAAI,CAAC,IAAY,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAvED,oFAuEC"}
|
|
@@ -2,21 +2,21 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class SendChatMessageRequestDataSourcePermissionTables extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The list of columns that are allowed
|
|
5
|
+
* 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.
|
|
6
6
|
*/
|
|
7
7
|
allowedColumns?: string[];
|
|
8
8
|
/**
|
|
9
9
|
* @remarks
|
|
10
|
-
* The list of columns that are not allowed
|
|
10
|
+
* 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.
|
|
11
11
|
*
|
|
12
|
-
* If both the disallowed list and the allowed list are configured, the disallowed list takes
|
|
12
|
+
* 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.
|
|
13
13
|
*
|
|
14
|
-
* To ensure
|
|
14
|
+
* 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.
|
|
15
15
|
*/
|
|
16
16
|
disallowedColumns?: string[];
|
|
17
17
|
/**
|
|
18
18
|
* @remarks
|
|
19
|
-
* The
|
|
19
|
+
* 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.
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
22
22
|
* region = \\"east\\"
|
|
@@ -24,7 +24,7 @@ export declare class SendChatMessageRequestDataSourcePermissionTables extends $d
|
|
|
24
24
|
requiredRowFilter?: string;
|
|
25
25
|
/**
|
|
26
26
|
* @remarks
|
|
27
|
-
* The table
|
|
27
|
+
* The name of the table to which the permission constraint rules apply.
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
30
|
* sample_table
|
|
@@ -44,7 +44,7 @@ export declare class SendChatMessageRequestDataSourcePermissionTables extends $d
|
|
|
44
44
|
export declare class SendChatMessageRequestDataSourcePermission extends $dara.Model {
|
|
45
45
|
/**
|
|
46
46
|
* @remarks
|
|
47
|
-
* The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a table.
|
|
47
|
+
* The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a specific table.
|
|
48
48
|
*/
|
|
49
49
|
tables?: SendChatMessageRequestDataSourcePermissionTables[];
|
|
50
50
|
static names(): {
|
|
@@ -61,7 +61,7 @@ export declare class SendChatMessageRequestDataSourcePermission extends $dara.Mo
|
|
|
61
61
|
export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
62
62
|
/**
|
|
63
63
|
* @remarks
|
|
64
|
-
* Deprecated
|
|
64
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
67
|
* 123
|
|
@@ -69,7 +69,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
69
69
|
dataSourceId?: string;
|
|
70
70
|
/**
|
|
71
71
|
* @remarks
|
|
72
|
-
* The data source type. Valid values: `
|
|
72
|
+
* The data source type. Valid values: `remote_data_center` and `database`. `remote_data_center` indicates a file, and `database` indicates a database.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
75
|
* remote_data_center
|
|
@@ -77,7 +77,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
77
77
|
dataSourceType?: string;
|
|
78
78
|
/**
|
|
79
79
|
* @remarks
|
|
80
|
-
* Deprecated
|
|
80
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
81
81
|
*
|
|
82
82
|
* @example
|
|
83
83
|
* test_db
|
|
@@ -85,7 +85,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
85
85
|
database?: string;
|
|
86
86
|
/**
|
|
87
87
|
* @remarks
|
|
88
|
-
* The database
|
|
88
|
+
* The name of the database.
|
|
89
89
|
*
|
|
90
90
|
* @example
|
|
91
91
|
* ******
|
|
@@ -93,7 +93,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
93
93
|
dbName?: string;
|
|
94
94
|
/**
|
|
95
95
|
* @remarks
|
|
96
|
-
* The ID of the database in Data Management.
|
|
96
|
+
* The ID of the database in Data Management (DMS).
|
|
97
97
|
*
|
|
98
98
|
* @example
|
|
99
99
|
* 23******
|
|
@@ -101,7 +101,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
101
101
|
dmsDatabaseId?: string;
|
|
102
102
|
/**
|
|
103
103
|
* @remarks
|
|
104
|
-
* The ID of the instance in
|
|
104
|
+
* The ID of the instance in DMS.
|
|
105
105
|
*
|
|
106
106
|
* @example
|
|
107
107
|
* 12******
|
|
@@ -117,7 +117,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
117
117
|
engine?: string;
|
|
118
118
|
/**
|
|
119
119
|
* @remarks
|
|
120
|
-
* The file
|
|
120
|
+
* The ID of the file.
|
|
121
121
|
*
|
|
122
122
|
* @example
|
|
123
123
|
* 35****
|
|
@@ -125,7 +125,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
125
125
|
fileId?: string;
|
|
126
126
|
/**
|
|
127
127
|
* @remarks
|
|
128
|
-
* Deprecated
|
|
128
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
129
129
|
*
|
|
130
130
|
* @example
|
|
131
131
|
* localhost
|
|
@@ -133,7 +133,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
133
133
|
location?: string;
|
|
134
134
|
/**
|
|
135
135
|
* @remarks
|
|
136
|
-
* The permission constraints for querying the current data source. The permission constraint feature is
|
|
136
|
+
* 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.
|
|
137
137
|
*/
|
|
138
138
|
permission?: SendChatMessageRequestDataSourcePermission;
|
|
139
139
|
/**
|
|
@@ -146,9 +146,17 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
146
146
|
regionId?: string;
|
|
147
147
|
/**
|
|
148
148
|
* @remarks
|
|
149
|
-
* The list of
|
|
149
|
+
* The list of names of the tables to be analyzed.
|
|
150
150
|
*/
|
|
151
151
|
tables?: string[];
|
|
152
|
+
/**
|
|
153
|
+
* @remarks
|
|
154
|
+
* The data source resource identifier.
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* datalake://abc/def
|
|
158
|
+
*/
|
|
159
|
+
uri?: string;
|
|
152
160
|
static names(): {
|
|
153
161
|
[key: string]: string;
|
|
154
162
|
};
|
|
@@ -163,21 +171,21 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
163
171
|
export declare class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
|
|
164
172
|
/**
|
|
165
173
|
* @remarks
|
|
166
|
-
* The list of columns that are allowed
|
|
174
|
+
* 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.
|
|
167
175
|
*/
|
|
168
176
|
allowedColumns?: string[];
|
|
169
177
|
/**
|
|
170
178
|
* @remarks
|
|
171
|
-
* The list of columns that are not allowed
|
|
179
|
+
* 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.
|
|
172
180
|
*
|
|
173
|
-
* If both the disallowed list and the allowed list are configured, the disallowed list takes
|
|
181
|
+
* 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.
|
|
174
182
|
*
|
|
175
|
-
* To ensure
|
|
183
|
+
* 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.
|
|
176
184
|
*/
|
|
177
185
|
disallowedColumns?: string[];
|
|
178
186
|
/**
|
|
179
187
|
* @remarks
|
|
180
|
-
* The
|
|
188
|
+
* 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.
|
|
181
189
|
*
|
|
182
190
|
* @example
|
|
183
191
|
* region = \\"east\\"
|
|
@@ -185,7 +193,7 @@ export declare class SendChatMessageRequestDataSourcesPermissionTables extends $
|
|
|
185
193
|
requiredRowFilter?: string;
|
|
186
194
|
/**
|
|
187
195
|
* @remarks
|
|
188
|
-
* The table
|
|
196
|
+
* The name of the table to which the permission constraint rules apply.
|
|
189
197
|
*
|
|
190
198
|
* @example
|
|
191
199
|
* sample_table
|
|
@@ -205,7 +213,7 @@ export declare class SendChatMessageRequestDataSourcesPermissionTables extends $
|
|
|
205
213
|
export declare class SendChatMessageRequestDataSourcesPermission extends $dara.Model {
|
|
206
214
|
/**
|
|
207
215
|
* @remarks
|
|
208
|
-
* The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a table.
|
|
216
|
+
* The table-level permission constraints for querying the current data source. Each item in the list represents the permission constraints for a specific table.
|
|
209
217
|
*/
|
|
210
218
|
tables?: SendChatMessageRequestDataSourcesPermissionTables[];
|
|
211
219
|
static names(): {
|
|
@@ -222,7 +230,7 @@ export declare class SendChatMessageRequestDataSourcesPermission extends $dara.M
|
|
|
222
230
|
export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
223
231
|
/**
|
|
224
232
|
* @remarks
|
|
225
|
-
* Deprecated
|
|
233
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
226
234
|
*
|
|
227
235
|
* @example
|
|
228
236
|
* 123
|
|
@@ -230,7 +238,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
230
238
|
dataSourceId?: string;
|
|
231
239
|
/**
|
|
232
240
|
* @remarks
|
|
233
|
-
* The data source type. Valid values: remote_data_center
|
|
241
|
+
* 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.
|
|
234
242
|
*
|
|
235
243
|
* @example
|
|
236
244
|
* remote_data_center
|
|
@@ -238,7 +246,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
238
246
|
dataSourceType?: string;
|
|
239
247
|
/**
|
|
240
248
|
* @remarks
|
|
241
|
-
* Deprecated
|
|
249
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
242
250
|
*
|
|
243
251
|
* @example
|
|
244
252
|
* test_db
|
|
@@ -246,7 +254,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
246
254
|
database?: string;
|
|
247
255
|
/**
|
|
248
256
|
* @remarks
|
|
249
|
-
* The database
|
|
257
|
+
* The name of the database.
|
|
250
258
|
*
|
|
251
259
|
* @example
|
|
252
260
|
* mydatabase
|
|
@@ -254,7 +262,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
254
262
|
dbName?: string;
|
|
255
263
|
/**
|
|
256
264
|
* @remarks
|
|
257
|
-
* The ID of the database in Data Management.
|
|
265
|
+
* The ID of the database in Data Management (DMS).
|
|
258
266
|
*
|
|
259
267
|
* @example
|
|
260
268
|
* 123****
|
|
@@ -262,7 +270,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
262
270
|
dmsDatabaseId?: string;
|
|
263
271
|
/**
|
|
264
272
|
* @remarks
|
|
265
|
-
* The ID of the instance in
|
|
273
|
+
* The ID of the instance in DMS.
|
|
266
274
|
*
|
|
267
275
|
* @example
|
|
268
276
|
* 248*****
|
|
@@ -286,7 +294,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
286
294
|
fileId?: string;
|
|
287
295
|
/**
|
|
288
296
|
* @remarks
|
|
289
|
-
* Deprecated
|
|
297
|
+
* **[Deprecated]** You do not need to specify this field.
|
|
290
298
|
*
|
|
291
299
|
* @example
|
|
292
300
|
* localhost
|
|
@@ -294,7 +302,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
294
302
|
location?: string;
|
|
295
303
|
/**
|
|
296
304
|
* @remarks
|
|
297
|
-
* The permission constraints for querying the current data source. The permission constraint feature is
|
|
305
|
+
* 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.
|
|
298
306
|
*/
|
|
299
307
|
permission?: SendChatMessageRequestDataSourcesPermission;
|
|
300
308
|
/**
|
|
@@ -307,9 +315,17 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
307
315
|
regionId?: string;
|
|
308
316
|
/**
|
|
309
317
|
* @remarks
|
|
310
|
-
* The list of
|
|
318
|
+
* The list of names of the tables to be analyzed.
|
|
311
319
|
*/
|
|
312
320
|
tables?: string[];
|
|
321
|
+
/**
|
|
322
|
+
* @remarks
|
|
323
|
+
* The data source resource identifier.
|
|
324
|
+
*
|
|
325
|
+
* @example
|
|
326
|
+
* datalake://abc/def
|
|
327
|
+
*/
|
|
328
|
+
uri?: string;
|
|
313
329
|
static names(): {
|
|
314
330
|
[key: string]: string;
|
|
315
331
|
};
|
|
@@ -324,11 +340,11 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
324
340
|
export declare class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.Model {
|
|
325
341
|
/**
|
|
326
342
|
* @remarks
|
|
327
|
-
* The default
|
|
343
|
+
* 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`.
|
|
328
344
|
*
|
|
329
|
-
* - allow
|
|
345
|
+
* - `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.
|
|
330
346
|
*
|
|
331
|
-
* - deny
|
|
347
|
+
* - `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.
|
|
332
348
|
*
|
|
333
349
|
* @example
|
|
334
350
|
* allow
|
|
@@ -348,7 +364,7 @@ export declare class SendChatMessageRequestSessionConfigPermissionConfig extends
|
|
|
348
364
|
export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
349
365
|
/**
|
|
350
366
|
* @remarks
|
|
351
|
-
* The custom agent
|
|
367
|
+
* 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-`.
|
|
352
368
|
*
|
|
353
369
|
* @example
|
|
354
370
|
* ca-asfkjhqwe***aesrfqa
|
|
@@ -380,7 +396,7 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
380
396
|
kbUuidList?: string[];
|
|
381
397
|
/**
|
|
382
398
|
* @remarks
|
|
383
|
-
*
|
|
399
|
+
* The language. Only Chinese and English are supported. The default value is Chinese. Only uppercase letters are supported.
|
|
384
400
|
*
|
|
385
401
|
* @example
|
|
386
402
|
* ENGLISH
|
|
@@ -397,9 +413,9 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
397
413
|
/**
|
|
398
414
|
* @remarks
|
|
399
415
|
* The mode. Valid values:
|
|
400
|
-
* - **ASK_DATA**: data query mode.
|
|
401
|
-
* - **ANALYSIS**: analysis mode.
|
|
402
|
-
* - **INSIGHT**: insight mode.
|
|
416
|
+
* - **ASK_DATA**: the data query mode.
|
|
417
|
+
* - **ANALYSIS**: the analysis mode.
|
|
418
|
+
* - **INSIGHT**: the insight mode.
|
|
403
419
|
*
|
|
404
420
|
* @example
|
|
405
421
|
* ANALYSIS
|
|
@@ -407,12 +423,12 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
407
423
|
mode?: string;
|
|
408
424
|
/**
|
|
409
425
|
* @remarks
|
|
410
|
-
* The
|
|
426
|
+
* 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.
|
|
411
427
|
*/
|
|
412
428
|
permissionConfig?: SendChatMessageRequestSessionConfigPermissionConfig;
|
|
413
429
|
/**
|
|
414
430
|
* @remarks
|
|
415
|
-
* Specifies whether to enable the plan. Valid values: disable
|
|
431
|
+
* Specifies whether to enable the plan feature. Valid values: `disable`, `enable`, and `force`. Default value: `enable`.
|
|
416
432
|
*
|
|
417
433
|
* @example
|
|
418
434
|
* disable
|
|
@@ -420,7 +436,7 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
420
436
|
planMode?: string;
|
|
421
437
|
/**
|
|
422
438
|
* @remarks
|
|
423
|
-
* The text
|
|
439
|
+
* The watermark text. You can enter up to 64 characters. The text is used to add a watermark to the generated PDF report.
|
|
424
440
|
*
|
|
425
441
|
* @example
|
|
426
442
|
* sample-watermark
|
|
@@ -477,7 +493,7 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
477
493
|
export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
|
|
478
494
|
/**
|
|
479
495
|
* @remarks
|
|
480
|
-
* The prompt that the report
|
|
496
|
+
* The prompt that must be followed for the current report.
|
|
481
497
|
*
|
|
482
498
|
* @example
|
|
483
499
|
* generate a report
|
|
@@ -493,7 +509,7 @@ export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.
|
|
|
493
509
|
reportTheme?: string;
|
|
494
510
|
/**
|
|
495
511
|
* @remarks
|
|
496
|
-
* The service type. Valid values: TextReport and WebReport, which indicate that the task generates a text report or a web report.
|
|
512
|
+
* 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.
|
|
497
513
|
*
|
|
498
514
|
* @example
|
|
499
515
|
* WebReport
|
|
@@ -513,7 +529,7 @@ export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.
|
|
|
513
529
|
export declare class SendChatMessageRequestTaskConfig extends $dara.Model {
|
|
514
530
|
/**
|
|
515
531
|
* @remarks
|
|
516
|
-
* The configuration of the report
|
|
532
|
+
* The configuration of the report rules. A report task is executed based on this configuration only when MessageType is set to REPORT.
|
|
517
533
|
*/
|
|
518
534
|
reportConfig?: SendChatMessageRequestTaskConfigReportConfig;
|
|
519
535
|
static names(): {
|
|
@@ -530,7 +546,7 @@ export declare class SendChatMessageRequestTaskConfig extends $dara.Model {
|
|
|
530
546
|
export declare class SendChatMessageRequest extends $dara.Model {
|
|
531
547
|
/**
|
|
532
548
|
* @remarks
|
|
533
|
-
* **[Optimized]** This field is now automatically
|
|
549
|
+
* **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it.
|
|
534
550
|
*
|
|
535
551
|
* @example
|
|
536
552
|
* agent_***
|
|
@@ -538,7 +554,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
538
554
|
agentId?: string;
|
|
539
555
|
/**
|
|
540
556
|
* @remarks
|
|
541
|
-
* **[Optimized]** This field is now automatically
|
|
557
|
+
* **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it when calling the API.
|
|
542
558
|
*
|
|
543
559
|
* @example
|
|
544
560
|
* cn-hangzhou
|
|
@@ -546,7 +562,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
546
562
|
DMSUnit?: string;
|
|
547
563
|
/**
|
|
548
564
|
* @remarks
|
|
549
|
-
* The data source information. This parameter can be left empty.
|
|
565
|
+
* 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.
|
|
550
566
|
*
|
|
551
567
|
* @example
|
|
552
568
|
* null
|
|
@@ -559,7 +575,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
559
575
|
dataSources?: SendChatMessageRequestDataSources[];
|
|
560
576
|
/**
|
|
561
577
|
* @remarks
|
|
562
|
-
* The
|
|
578
|
+
* The content of the message sent to the agent.
|
|
563
579
|
*
|
|
564
580
|
* This parameter is required.
|
|
565
581
|
*
|
|
@@ -569,15 +585,15 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
569
585
|
message?: string;
|
|
570
586
|
/**
|
|
571
587
|
* @remarks
|
|
572
|
-
* The message type. Default value: `
|
|
588
|
+
* The message type. Default value: `primary`.
|
|
573
589
|
*
|
|
574
|
-
* -
|
|
590
|
+
* - In normal interactions with the agent, the message type is `primary`.
|
|
575
591
|
*
|
|
576
|
-
* - When the message is a response to
|
|
592
|
+
* - When the message is a response to a human-in-the-loop question from the agent, the type must be `additional`.
|
|
577
593
|
*
|
|
578
|
-
* - When the message is intended to trigger report generation,
|
|
594
|
+
* - When the message is intended to trigger report generation, the type must be `report`.
|
|
579
595
|
*
|
|
580
|
-
* - When the message is intended to cancel the current session,
|
|
596
|
+
* - When the message is intended to cancel the current session, the type must be `cancel`.
|
|
581
597
|
*
|
|
582
598
|
* @example
|
|
583
599
|
* primary
|
|
@@ -585,7 +601,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
585
601
|
messageType?: string;
|
|
586
602
|
/**
|
|
587
603
|
* @remarks
|
|
588
|
-
* The parent session
|
|
604
|
+
* The ID of the parent session.
|
|
589
605
|
*
|
|
590
606
|
* @example
|
|
591
607
|
* 20qrliuoo7p2vlsfg*****
|
|
@@ -593,15 +609,15 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
593
609
|
parentSessionId?: string;
|
|
594
610
|
/**
|
|
595
611
|
* @remarks
|
|
596
|
-
*
|
|
612
|
+
* Required when the message type is `additional`. Specifies the specific question asked by the agent to the user through human-in-the-loop.
|
|
597
613
|
*
|
|
598
614
|
* @example
|
|
599
|
-
* Provide the criteria for
|
|
615
|
+
* Provide the calculation criteria for GMV
|
|
600
616
|
*/
|
|
601
617
|
question?: string;
|
|
602
618
|
/**
|
|
603
619
|
* @remarks
|
|
604
|
-
* The quoted content. This is typically used
|
|
620
|
+
* The quoted content. This is typically used when interacting with the agent.
|
|
605
621
|
*
|
|
606
622
|
* @example
|
|
607
623
|
* {"version":"v0"}
|
|
@@ -611,9 +627,9 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
611
627
|
* @remarks
|
|
612
628
|
* **Important**
|
|
613
629
|
*
|
|
614
|
-
* When this message is a reply to an
|
|
630
|
+
* 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".
|
|
615
631
|
*
|
|
616
|
-
* This field affects how the
|
|
632
|
+
* This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
|
|
617
633
|
*
|
|
618
634
|
* @example
|
|
619
635
|
* 0
|
|
@@ -621,7 +637,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
621
637
|
replyTo?: string;
|
|
622
638
|
/**
|
|
623
639
|
* @remarks
|
|
624
|
-
* The special
|
|
640
|
+
* The special configurations for the current session. For the same session, only the configurations specified in the first SendMessage call take effect.
|
|
625
641
|
*
|
|
626
642
|
* **if can be null:**
|
|
627
643
|
* true
|
|
@@ -629,10 +645,10 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
629
645
|
sessionConfig?: SendChatMessageRequestSessionConfig;
|
|
630
646
|
/**
|
|
631
647
|
* @remarks
|
|
632
|
-
* The session ID. This
|
|
633
|
-
* - You can start a session without specifying this field. The response
|
|
648
|
+
* The session ID. This optional field is used for multi-turn sessions.
|
|
649
|
+
* - You can start a session without specifying this field. The response will include the session ID for the current session.
|
|
634
650
|
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating a session.
|
|
635
|
-
* -
|
|
651
|
+
* - 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.
|
|
636
652
|
*
|
|
637
653
|
* @example
|
|
638
654
|
* sess_***
|
|
@@ -645,7 +661,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
645
661
|
taskConfig?: SendChatMessageRequestTaskConfig;
|
|
646
662
|
/**
|
|
647
663
|
* @remarks
|
|
648
|
-
* The OSS bucket of the user. If this parameter is
|
|
664
|
+
* 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.
|
|
649
665
|
*
|
|
650
666
|
* @example
|
|
651
667
|
* my-bucket
|