@alicloud/dms20250414 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/dist/client.d.ts +21 -6
  2. package/dist/client.js +60 -6
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateAgentRequest.d.ts +21 -0
  5. package/dist/models/CreateAgentRequest.js +64 -0
  6. package/dist/models/CreateAgentRequest.js.map +1 -0
  7. package/dist/models/CreateAgentResponse.d.ts +19 -0
  8. package/dist/models/CreateAgentResponse.js +69 -0
  9. package/dist/models/CreateAgentResponse.js.map +1 -0
  10. package/dist/models/CreateAgentResponseBody.d.ts +66 -0
  11. package/dist/models/CreateAgentResponseBody.js +154 -0
  12. package/dist/models/CreateAgentResponseBody.js.map +1 -0
  13. package/dist/models/CreateDataAgentSessionRequest.d.ts +42 -18
  14. package/dist/models/CreateDataAgentSessionRequest.js.map +1 -1
  15. package/dist/models/CreateDataAgentSessionResponseBody.d.ts +52 -29
  16. package/dist/models/CreateDataAgentSessionResponseBody.js.map +1 -1
  17. package/dist/models/CreateDataAgentSessionShrinkRequest.d.ts +2 -2
  18. package/dist/models/CreateDataAgentThemeRequest.d.ts +16 -8
  19. package/dist/models/CreateDataAgentThemeRequest.js +2 -0
  20. package/dist/models/CreateDataAgentThemeRequest.js.map +1 -1
  21. package/dist/models/CreateDataAgentThemeResponseBody.d.ts +2 -2
  22. package/dist/models/DescribeDataAgentSessionRequest.d.ts +1 -1
  23. package/dist/models/DescribeDataAgentSessionResponseBody.d.ts +19 -20
  24. package/dist/models/DescribeDataAgentSessionResponseBody.js.map +1 -1
  25. package/dist/models/DescribeDataAgentThemeResponseBody.d.ts +9 -13
  26. package/dist/models/DescribeDataAgentThemeResponseBody.js.map +1 -1
  27. package/dist/models/ListDataAgentAccuracyTestInstancesResponseBody.d.ts +9 -2
  28. package/dist/models/ListDataAgentAccuracyTestInstancesResponseBody.js.map +1 -1
  29. package/dist/models/ListDataAgentThemeRequest.d.ts +15 -7
  30. package/dist/models/ListDataAgentThemeRequest.js +2 -0
  31. package/dist/models/ListDataAgentThemeRequest.js.map +1 -1
  32. package/dist/models/ListDataAgentThemeResponseBody.d.ts +8 -8
  33. package/dist/models/model.d.ts +5 -0
  34. package/dist/models/model.js +23 -13
  35. package/dist/models/model.js.map +1 -1
  36. package/package.json +1 -1
  37. package/src/client.ts +68 -6
  38. package/src/models/CreateAgentRequest.ts +40 -0
  39. package/src/models/CreateAgentResponse.ts +40 -0
  40. package/src/models/CreateAgentResponseBody.ts +157 -0
  41. package/src/models/CreateDataAgentSessionRequest.ts +42 -18
  42. package/src/models/CreateDataAgentSessionResponseBody.ts +52 -29
  43. package/src/models/CreateDataAgentSessionShrinkRequest.ts +2 -2
  44. package/src/models/CreateDataAgentThemeRequest.ts +18 -8
  45. package/src/models/CreateDataAgentThemeResponseBody.ts +2 -2
  46. package/src/models/DescribeDataAgentSessionRequest.ts +1 -1
  47. package/src/models/DescribeDataAgentSessionResponseBody.ts +19 -20
  48. package/src/models/DescribeDataAgentThemeResponseBody.ts +9 -13
  49. package/src/models/ListDataAgentAccuracyTestInstancesResponseBody.ts +9 -2
  50. package/src/models/ListDataAgentThemeRequest.ts +17 -7
  51. package/src/models/ListDataAgentThemeResponseBody.ts +8 -8
  52. package/src/models/model.ts +5 -0
@@ -0,0 +1,157 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class CreateAgentResponseBodyDataApiKey extends $dara.Model {
6
+ agentId?: string;
7
+ agentName?: string;
8
+ agentType?: string;
9
+ createdAt?: string;
10
+ creatorId?: string;
11
+ creatorName?: string;
12
+ description?: string;
13
+ expireTime?: string;
14
+ id?: number;
15
+ isRevoked?: boolean;
16
+ keyPrefix?: string;
17
+ lastUsedTime?: string;
18
+ name?: string;
19
+ secret?: string;
20
+ source?: string;
21
+ static names(): { [key: string]: string } {
22
+ return {
23
+ agentId: 'AgentId',
24
+ agentName: 'AgentName',
25
+ agentType: 'AgentType',
26
+ createdAt: 'CreatedAt',
27
+ creatorId: 'CreatorId',
28
+ creatorName: 'CreatorName',
29
+ description: 'Description',
30
+ expireTime: 'ExpireTime',
31
+ id: 'Id',
32
+ isRevoked: 'IsRevoked',
33
+ keyPrefix: 'KeyPrefix',
34
+ lastUsedTime: 'LastUsedTime',
35
+ name: 'Name',
36
+ secret: 'Secret',
37
+ source: 'Source',
38
+ };
39
+ }
40
+
41
+ static types(): { [key: string]: any } {
42
+ return {
43
+ agentId: 'string',
44
+ agentName: 'string',
45
+ agentType: 'string',
46
+ createdAt: 'string',
47
+ creatorId: 'string',
48
+ creatorName: 'string',
49
+ description: 'string',
50
+ expireTime: 'string',
51
+ id: 'number',
52
+ isRevoked: 'boolean',
53
+ keyPrefix: 'string',
54
+ lastUsedTime: 'string',
55
+ name: 'string',
56
+ secret: 'string',
57
+ source: 'string',
58
+ };
59
+ }
60
+
61
+ validate() {
62
+ super.validate();
63
+ }
64
+
65
+ constructor(map?: { [key: string]: any }) {
66
+ super(map);
67
+ }
68
+ }
69
+
70
+ export class CreateAgentResponseBodyData extends $dara.Model {
71
+ agentId?: string;
72
+ agentName?: string;
73
+ agentType?: string;
74
+ apiKey?: CreateAgentResponseBodyDataApiKey;
75
+ createdAt?: string;
76
+ creationType?: string;
77
+ description?: string;
78
+ ownerId?: string;
79
+ status?: string;
80
+ static names(): { [key: string]: string } {
81
+ return {
82
+ agentId: 'AgentId',
83
+ agentName: 'AgentName',
84
+ agentType: 'AgentType',
85
+ apiKey: 'ApiKey',
86
+ createdAt: 'CreatedAt',
87
+ creationType: 'CreationType',
88
+ description: 'Description',
89
+ ownerId: 'OwnerId',
90
+ status: 'Status',
91
+ };
92
+ }
93
+
94
+ static types(): { [key: string]: any } {
95
+ return {
96
+ agentId: 'string',
97
+ agentName: 'string',
98
+ agentType: 'string',
99
+ apiKey: CreateAgentResponseBodyDataApiKey,
100
+ createdAt: 'string',
101
+ creationType: 'string',
102
+ description: 'string',
103
+ ownerId: 'string',
104
+ status: 'string',
105
+ };
106
+ }
107
+
108
+ validate() {
109
+ if(this.apiKey && typeof (this.apiKey as any).validate === 'function') {
110
+ (this.apiKey as any).validate();
111
+ }
112
+ super.validate();
113
+ }
114
+
115
+ constructor(map?: { [key: string]: any }) {
116
+ super(map);
117
+ }
118
+ }
119
+
120
+ export class CreateAgentResponseBody extends $dara.Model {
121
+ data?: CreateAgentResponseBodyData;
122
+ errorCode?: string;
123
+ errorMessage?: string;
124
+ requestId?: string;
125
+ success?: boolean;
126
+ static names(): { [key: string]: string } {
127
+ return {
128
+ data: 'Data',
129
+ errorCode: 'ErrorCode',
130
+ errorMessage: 'ErrorMessage',
131
+ requestId: 'RequestId',
132
+ success: 'Success',
133
+ };
134
+ }
135
+
136
+ static types(): { [key: string]: any } {
137
+ return {
138
+ data: CreateAgentResponseBodyData,
139
+ errorCode: 'string',
140
+ errorMessage: 'string',
141
+ requestId: 'string',
142
+ success: 'boolean',
143
+ };
144
+ }
145
+
146
+ validate() {
147
+ if(this.data && typeof (this.data as any).validate === 'function') {
148
+ (this.data as any).validate();
149
+ }
150
+ super.validate();
151
+ }
152
+
153
+ constructor(map?: { [key: string]: any }) {
154
+ super(map);
155
+ }
156
+ }
157
+
@@ -13,10 +13,8 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
13
13
  customAgentId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The custom agent stage. Valid values:
17
- *
18
- * - **debug**: Test stage.
19
- *
16
+ * The stage of the custom agent. Valid values:
17
+ * - **debug**: Debug stage.
20
18
  * - **prod**: Production stage.
21
19
  *
22
20
  * @example
@@ -31,16 +29,32 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
31
29
  * false
32
30
  */
33
31
  enableSearch?: boolean;
32
+ /**
33
+ * @remarks
34
+ * The encryption key.
35
+ *
36
+ * @example
37
+ * null
38
+ */
34
39
  encryptKey?: string;
40
+ /**
41
+ * @remarks
42
+ * The encryption type.
43
+ *
44
+ * @example
45
+ * null
46
+ */
35
47
  encryptType?: string;
48
+ /**
49
+ * @remarks
50
+ * The list of knowledge base IDs.
51
+ */
36
52
  kbUuidList?: string[];
37
53
  /**
38
54
  * @remarks
39
55
  * The language. Valid values:
40
- *
41
- * - **CHINESE**: Chinese
42
- *
43
- * - **ENGLISH**: English
56
+ * - **CHINESE**: Chinese.
57
+ * - **ENGLISH**: English.
44
58
  *
45
59
  * @example
46
60
  * CHINESE
@@ -48,30 +62,40 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
48
62
  language?: string;
49
63
  /**
50
64
  * @remarks
51
- * A list of MCP server IDs.
65
+ * The list of MCP server IDs in the session configuration.
52
66
  */
53
67
  mcpServerIds?: string[];
54
68
  /**
55
69
  * @remarks
56
70
  * The mode. Valid values:
57
- *
58
- * - **ASK_DATA**: Quick inquiry mode.
59
- *
71
+ * - **ASK_DATA**: Ask data mode.
60
72
  * - **ANALYSIS**: Analysis mode.
61
- *
62
73
  * - **INSIGHT**: Insight mode.
63
74
  *
64
75
  * @example
65
76
  * ANALYSIS
66
77
  */
67
78
  mode?: string;
79
+ /**
80
+ * @remarks
81
+ * The report page width.
82
+ *
83
+ * @example
84
+ * 0
85
+ */
68
86
  reportPageWidth?: number;
69
- reportWaterMark?: string;
70
87
  /**
71
88
  * @remarks
72
- * The OSS bucket name.
89
+ * The report watermark.
73
90
  *
74
- * - This bucket stores intermediate files and report artifacts from the analysis.
91
+ * @example
92
+ * null
93
+ */
94
+ reportWaterMark?: string;
95
+ /**
96
+ * @remarks
97
+ * The name of the user OSS bucket.
98
+ * - Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
75
99
  *
76
100
  * @example
77
101
  * user-oss-bucket
@@ -150,10 +174,10 @@ export class CreateDataAgentSessionRequest extends $dara.Model {
150
174
  sessionConfig?: CreateDataAgentSessionRequestSessionConfig;
151
175
  /**
152
176
  * @remarks
153
- * The session title. Supports Chinese and English. Maximum length: 128 characters.
177
+ * The title. Chinese and English characters are supported. Maximum length: 128 characters.
154
178
  *
155
179
  * @example
156
- * 帮我分析一下这份数据,给出报告。
180
+ * Help me analyze this data and generate a report
157
181
  */
158
182
  title?: string;
159
183
  /**
@@ -14,10 +14,8 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
14
14
  /**
15
15
  * @remarks
16
16
  * The stage of the custom agent. Valid values:
17
- *
18
- * - **debug**: Debug stage
19
- *
20
- * - **prod**: Production stage
17
+ * - **debug**: Debug stage.
18
+ * - **prod**: Production stage.
21
19
  *
22
20
  * @example
23
21
  * debug
@@ -25,22 +23,38 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
25
23
  customAgentStage?: string;
26
24
  /**
27
25
  * @remarks
28
- * Indicates whether web search is enabled.
26
+ * Specifies whether to enable web search.
29
27
  *
30
28
  * @example
31
29
  * true
32
30
  */
33
31
  enableSearch?: boolean;
32
+ /**
33
+ * @remarks
34
+ * The encryption key.
35
+ *
36
+ * @example
37
+ * null
38
+ */
34
39
  encryptKey?: string;
40
+ /**
41
+ * @remarks
42
+ * The encryption type.
43
+ *
44
+ * @example
45
+ * null
46
+ */
35
47
  encryptType?: string;
48
+ /**
49
+ * @remarks
50
+ * The list of knowledge base IDs.
51
+ */
36
52
  kbUuidList?: string[];
37
53
  /**
38
54
  * @remarks
39
55
  * The language. Valid values:
40
- *
41
- * - **CHINESE**: Chinese
42
- *
43
- * - **ENGLISH**: English
56
+ * - **CHINESE**: Chinese.
57
+ * - **ENGLISH**: English.
44
58
  *
45
59
  * @example
46
60
  * CHINESE
@@ -48,30 +62,40 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
48
62
  language?: string;
49
63
  /**
50
64
  * @remarks
51
- * A list of MCP server IDs.
65
+ * The list of MCP server IDs in the session configuration.
52
66
  */
53
67
  mcpServerIds?: string[];
54
68
  /**
55
69
  * @remarks
56
70
  * The mode. Valid values:
57
- *
58
- * - **ASK_DATA**: Quick Inquiry Mode
59
- *
60
- * - **ANALYSIS**: Analysis Mode
61
- *
62
- * - **INSIGHT**: Insight Mode
71
+ * - **ASK_DATA**: Ask data mode.
72
+ * - **ANALYSIS**: Analysis mode.
73
+ * - **INSIGHT**: Insight mode.
63
74
  *
64
75
  * @example
65
76
  * ANALYSIS
66
77
  */
67
78
  mode?: string;
79
+ /**
80
+ * @remarks
81
+ * The report page width.
82
+ *
83
+ * @example
84
+ * 0
85
+ */
68
86
  reportPageWidth?: number;
69
- reportWaterMark?: string;
70
87
  /**
71
88
  * @remarks
72
- * The name of the user\\"s OSS bucket.
89
+ * The report watermark.
73
90
  *
74
- * - Analysis files and report artifacts can be uploaded to this OSS bucket.
91
+ * @example
92
+ * null
93
+ */
94
+ reportWaterMark?: string;
95
+ /**
96
+ * @remarks
97
+ * The name of the user OSS bucket.
98
+ * - Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
75
99
  *
76
100
  * @example
77
101
  * user-oss-bucket
@@ -129,7 +153,7 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
129
153
  export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
130
154
  /**
131
155
  * @remarks
132
- * The agent ID.
156
+ * Agent Id
133
157
  *
134
158
  * @example
135
159
  * cu0cs*******mf
@@ -145,7 +169,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
145
169
  agentStatus?: string;
146
170
  /**
147
171
  * @remarks
148
- * The time when the session was created, in Unix milliseconds.
172
+ * The time when the session was created.
149
173
  *
150
174
  * @example
151
175
  * 1765262307992
@@ -153,7 +177,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
153
177
  createTime?: number;
154
178
  /**
155
179
  * @remarks
156
- * The ID of the associated file.
180
+ * The basic information about the file.
157
181
  *
158
182
  * @example
159
183
  * f-8*******01m
@@ -161,7 +185,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
161
185
  file?: string;
162
186
  /**
163
187
  * @remarks
164
- * Indicates whether the current user has favorited the session.
188
+ * Indicates whether the session is saved to the favorites of the current user.
165
189
  *
166
190
  * @example
167
191
  * false
@@ -190,10 +214,10 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
190
214
  sessionStatus?: string;
191
215
  /**
192
216
  * @remarks
193
- * The session title.
217
+ * The title.
194
218
  *
195
219
  * @example
196
- * 帮我分析一下这份数据,给出报告。
220
+ * Help me analyze this data and generate a report
197
221
  */
198
222
  title?: string;
199
223
  static names(): { [key: string]: string } {
@@ -239,7 +263,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
239
263
  export class CreateDataAgentSessionResponseBody extends $dara.Model {
240
264
  /**
241
265
  * @remarks
242
- * The response structure.
266
+ * The response struct.
243
267
  */
244
268
  data?: CreateDataAgentSessionResponseBodyData;
245
269
  /**
@@ -252,7 +276,7 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
252
276
  errorCode?: string;
253
277
  /**
254
278
  * @remarks
255
- * The error message returned if the request fails.
279
+ * The error message returned when the request failed.
256
280
  *
257
281
  * @example
258
282
  * UnknownError
@@ -260,7 +284,7 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
260
284
  errorMessage?: string;
261
285
  /**
262
286
  * @remarks
263
- * The request ID.
287
+ * Id of the request
264
288
  *
265
289
  * @example
266
290
  * 1CB***********3F1A
@@ -271,7 +295,6 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
271
295
  * Indicates whether the request was successful. Valid values:
272
296
  *
273
297
  * - **true**: The request was successful.
274
- *
275
298
  * - **false**: The request failed.
276
299
  *
277
300
  * @example
@@ -26,10 +26,10 @@ export class CreateDataAgentSessionShrinkRequest extends $dara.Model {
26
26
  sessionConfigShrink?: string;
27
27
  /**
28
28
  * @remarks
29
- * The session title. Supports Chinese and English. Maximum length: 128 characters.
29
+ * The title. Chinese and English characters are supported. Maximum length: 128 characters.
30
30
  *
31
31
  * @example
32
- * 帮我分析一下这份数据,给出报告。
32
+ * Help me analyze this data and generate a report
33
33
  */
34
34
  title?: string;
35
35
  /**
@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateDataAgentThemeRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The application scenario, which affects filtering when viewing the theme list in the console. Valid values:
8
+ * The scenario, which affects the filtering when you view the theme list in the console. Valid values:
9
9
  *
10
- * - (Recommended) custom: a user-uploaded custom theme with no preset style or information organization structure.
11
- * - report: a web report that conforms to the DataAgent information organization structure.
12
- * - (Not supported) infographic: an infographic that conforms to the DataAgent information organization structure.
10
+ * - (Recommended) custom: A user-uploaded custom theme with no preset style or information organization structure.
11
+ * - report: A web report that conforms to the DataAgent information organization structure.
12
+ * - (Not supported) infographic: An infographic that conforms to the DataAgent information organization structure.
13
13
  *
14
14
  * @example
15
15
  * custom
@@ -27,9 +27,9 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
27
27
  * @remarks
28
28
  * The file source, which affects the backend logic for determining whether the theme is valid. Valid values:
29
29
  *
30
- * - upload: uploaded through OSS.
31
- * - (Not supported) public_url: provided through an OSS URL that allows public network access.
32
- * - (Not supported) user_oss: provided through a user OSS URL.
30
+ * - upload: The file is uploaded through OSS.
31
+ * - (Not supported) public_url: The file is provided through a public network access OSS URL.
32
+ * - (Not supported) user_oss: The file is provided through a user OSS URL.
33
33
  *
34
34
  * @example
35
35
  * upload
@@ -45,7 +45,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
45
45
  themeId?: string;
46
46
  /**
47
47
  * @remarks
48
- * The display name of the theme. The value can be up to 64 characters in length. This parameter is required during creation.
48
+ * The display name of the theme. The value can be up to 64 characters in length. This parameter is required when you create a theme.
49
49
  *
50
50
  * @example
51
51
  * weekly report
@@ -62,6 +62,14 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
62
62
  * template
63
63
  */
64
64
  themeType?: string;
65
+ /**
66
+ * @remarks
67
+ * The workspace to which the theme belongs. If this parameter is not specified or is set to personal, the personal workspace is used. You can also specify a collaboration workspace ID.
68
+ *
69
+ * @example
70
+ * 99fad******qg6c0l4nlacu
71
+ */
72
+ workspaceId?: string;
65
73
  static names(): { [key: string]: string } {
66
74
  return {
67
75
  category: 'Category',
@@ -70,6 +78,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
70
78
  themeId: 'ThemeId',
71
79
  themeName: 'ThemeName',
72
80
  themeType: 'ThemeType',
81
+ workspaceId: 'WorkspaceId',
73
82
  };
74
83
  }
75
84
 
@@ -81,6 +90,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
81
90
  themeId: 'string',
82
91
  themeName: 'string',
83
92
  themeType: 'string',
93
+ workspaceId: 'string',
84
94
  };
85
95
  }
86
96
 
@@ -47,7 +47,7 @@ export class CreateDataAgentThemeResponseBody extends $dara.Model {
47
47
  data?: CreateDataAgentThemeResponseBodyData;
48
48
  /**
49
49
  * @remarks
50
- * The error code returned when the request is abnormal.
50
+ * The error code returned when the request fails.
51
51
  *
52
52
  * @example
53
53
  * UnknownError
@@ -55,7 +55,7 @@ export class CreateDataAgentThemeResponseBody extends $dara.Model {
55
55
  errorCode?: string;
56
56
  /**
57
57
  * @remarks
58
- * The error message returned when the call fails.
58
+ * The error message returned when the request fails.
59
59
  *
60
60
  * @example
61
61
  * UnknownError
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeDataAgentSessionRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The current Data Management unit.
8
+ * The current DMS unit.
9
9
  *
10
10
  * @example
11
11
  * cn-hangzhou