@alicloud/dms20250414 3.1.0 → 4.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.
- package/dist/client.d.ts +8 -8
- package/dist/client.js +8 -8
- package/dist/models/CreateCustomAgentRequest.d.ts +71 -43
- package/dist/models/CreateCustomAgentRequest.js.map +1 -1
- package/dist/models/CreateCustomAgentResponseBody.d.ts +58 -29
- package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
- package/dist/models/CreateCustomAgentShrinkRequest.d.ts +51 -37
- package/dist/models/CreateCustomAgentShrinkRequest.js.map +1 -1
- package/dist/models/DescribeCustomAgentResponseBody.d.ts +84 -25
- package/dist/models/DescribeCustomAgentResponseBody.js.map +1 -1
- package/dist/models/DescribeDataAgentSessionRequest.d.ts +1 -1
- package/dist/models/DescribeDataAgentSessionResponseBody.d.ts +94 -54
- package/dist/models/DescribeDataAgentSessionResponseBody.js +31 -1
- package/dist/models/DescribeDataAgentSessionResponseBody.js.map +1 -1
- package/dist/models/ListCustomAgentRequest.d.ts +4 -4
- package/dist/models/ListCustomAgentResponseBody.d.ts +138 -28
- package/dist/models/ListCustomAgentResponseBody.js.map +1 -1
- package/dist/models/ListDataAgentWorkspaceRequest.d.ts +13 -6
- package/dist/models/ListDataAgentWorkspaceRequest.js.map +1 -1
- package/dist/models/ListDataAgentWorkspaceResponseBody.d.ts +28 -7
- package/dist/models/ListDataAgentWorkspaceResponseBody.js.map +1 -1
- package/dist/models/ModifyCustomAgentRequest.d.ts +71 -38
- package/dist/models/ModifyCustomAgentRequest.js.map +1 -1
- package/dist/models/ModifyCustomAgentResponseBody.d.ts +63 -30
- package/dist/models/ModifyCustomAgentResponseBody.js.map +1 -1
- package/dist/models/ModifyCustomAgentShrinkRequest.d.ts +51 -32
- package/dist/models/ModifyCustomAgentShrinkRequest.js.map +1 -1
- package/dist/models/model.d.ts +1 -0
- package/dist/models/model.js +18 -16
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +8 -8
- package/src/models/CreateCustomAgentRequest.ts +71 -43
- package/src/models/CreateCustomAgentResponseBody.ts +58 -29
- package/src/models/CreateCustomAgentShrinkRequest.ts +51 -37
- package/src/models/DescribeCustomAgentResponseBody.ts +84 -25
- package/src/models/DescribeDataAgentSessionRequest.ts +1 -1
- package/src/models/DescribeDataAgentSessionResponseBody.ts +115 -54
- package/src/models/ListCustomAgentRequest.ts +4 -4
- package/src/models/ListCustomAgentResponseBody.ts +138 -28
- package/src/models/ListDataAgentWorkspaceRequest.ts +13 -6
- package/src/models/ListDataAgentWorkspaceResponseBody.ts +28 -7
- package/src/models/ModifyCustomAgentRequest.ts +71 -38
- package/src/models/ModifyCustomAgentResponseBody.ts +63 -30
- package/src/models/ModifyCustomAgentShrinkRequest.ts +51 -32
- package/src/models/model.ts +1 -0
|
@@ -38,10 +38,17 @@ export class DescribeCustomAgentResponseBodyDataCallbackConfig extends $dara.Mod
|
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
|
|
41
|
+
/**
|
|
42
|
+
* @remarks
|
|
43
|
+
* Specifies whether to prohibit appending data sources during a session.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* true
|
|
47
|
+
*/
|
|
41
48
|
forbiddenAppendDataSource?: boolean;
|
|
42
49
|
/**
|
|
43
50
|
* @remarks
|
|
44
|
-
* Specifies whether to
|
|
51
|
+
* Specifies whether to prohibit user inquiries during the process.
|
|
45
52
|
*
|
|
46
53
|
* @example
|
|
47
54
|
* false
|
|
@@ -65,7 +72,7 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
|
|
|
65
72
|
skipSqlConfirm?: boolean;
|
|
66
73
|
/**
|
|
67
74
|
* @remarks
|
|
68
|
-
* Specifies whether to skip the web report
|
|
75
|
+
* Specifies whether to skip the confirmation for generating a web report.
|
|
69
76
|
*
|
|
70
77
|
* @example
|
|
71
78
|
* false
|
|
@@ -101,8 +108,31 @@ export class DescribeCustomAgentResponseBodyDataExecutionConfig extends $dara.Mo
|
|
|
101
108
|
}
|
|
102
109
|
|
|
103
110
|
export class DescribeCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
|
|
111
|
+
/**
|
|
112
|
+
* @remarks
|
|
113
|
+
* The access type. Valid values:
|
|
114
|
+
* - mcp: Accessed through MCP.
|
|
115
|
+
* - dms_kb: Accessed through DMS knowledge base.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* mcp
|
|
119
|
+
*/
|
|
104
120
|
accessType?: string;
|
|
121
|
+
/**
|
|
122
|
+
* @remarks
|
|
123
|
+
* The knowledge base ID.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* kb-HZ-6anhdzx7hddf9*******obx
|
|
127
|
+
*/
|
|
105
128
|
kbUuid?: string;
|
|
129
|
+
/**
|
|
130
|
+
* @remarks
|
|
131
|
+
* The MCP server ID.
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* nhdpt9adf6ac**********ca
|
|
135
|
+
*/
|
|
106
136
|
mcpServerId?: string;
|
|
107
137
|
static names(): { [key: string]: string } {
|
|
108
138
|
return {
|
|
@@ -164,7 +194,7 @@ export class DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList exte
|
|
|
164
194
|
export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
|
|
165
195
|
/**
|
|
166
196
|
* @remarks
|
|
167
|
-
* The cron expression for
|
|
197
|
+
* The cron expression for time-based scheduling.
|
|
168
198
|
*
|
|
169
199
|
* @example
|
|
170
200
|
* 0 0 0 ? * 1-7
|
|
@@ -175,7 +205,7 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
|
|
|
175
205
|
* The query for the scheduled task.
|
|
176
206
|
*
|
|
177
207
|
* @example
|
|
178
|
-
* Analyze
|
|
208
|
+
* Analyze the data and provide the report
|
|
179
209
|
*/
|
|
180
210
|
query?: string;
|
|
181
211
|
/**
|
|
@@ -214,7 +244,7 @@ export class DescribeCustomAgentResponseBodyDataScheduleTaskConfig extends $dara
|
|
|
214
244
|
export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
215
245
|
/**
|
|
216
246
|
* @remarks
|
|
217
|
-
* The Alibaba Cloud
|
|
247
|
+
* The primary Alibaba Cloud account ID.
|
|
218
248
|
*
|
|
219
249
|
* @example
|
|
220
250
|
* 16738266********
|
|
@@ -264,7 +294,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
264
294
|
* "personal" : {
|
|
265
295
|
* "DataSourceType" : "remote_data_center",
|
|
266
296
|
* "FileId" : "f-5qlrwaw10********s3gpw1z",
|
|
267
|
-
* "Database" : "
|
|
297
|
+
* "Database" : "test-table******.xlsx",
|
|
268
298
|
* "Tables" : [ "Sheet1" ],
|
|
269
299
|
* "TableIds" : [ "******" ],
|
|
270
300
|
* "RegionId" : "cn-hangzhou"
|
|
@@ -272,13 +302,20 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
272
302
|
* }
|
|
273
303
|
*/
|
|
274
304
|
dataJson?: string;
|
|
305
|
+
/**
|
|
306
|
+
* @remarks
|
|
307
|
+
* Indicates whether the agent is displayed by default.
|
|
308
|
+
*
|
|
309
|
+
* @example
|
|
310
|
+
* 1
|
|
311
|
+
*/
|
|
275
312
|
defaultAgent?: number;
|
|
276
313
|
/**
|
|
277
314
|
* @remarks
|
|
278
315
|
* The description of the custom agent.
|
|
279
316
|
*
|
|
280
317
|
* @example
|
|
281
|
-
*
|
|
318
|
+
* Description for the test agent
|
|
282
319
|
*/
|
|
283
320
|
description?: string;
|
|
284
321
|
/**
|
|
@@ -312,18 +349,19 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
312
349
|
gmtModified?: string;
|
|
313
350
|
/**
|
|
314
351
|
* @remarks
|
|
315
|
-
* The
|
|
352
|
+
* The instructions.
|
|
316
353
|
*
|
|
317
354
|
* @example
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
355
|
+
* Analytical framework:
|
|
356
|
+
*
|
|
357
|
+
* Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis to analyze trends and identify year-over-year and month-over-month fluctuations.
|
|
358
|
+
* Segment by new vs. returning customers, channels, and regions to identify growth drivers and areas of weakness.
|
|
359
|
+
* Conduct funnel analysis based on user behavior paths (browse → add to cart → purchase) to pinpoint stages where user drop-off occurs.
|
|
322
360
|
*/
|
|
323
361
|
instruction?: string;
|
|
324
362
|
/**
|
|
325
363
|
* @remarks
|
|
326
|
-
*
|
|
364
|
+
* Indicates whether a scheduled task is configured.
|
|
327
365
|
*
|
|
328
366
|
* @example
|
|
329
367
|
* true
|
|
@@ -335,12 +373,17 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
335
373
|
*
|
|
336
374
|
* @example
|
|
337
375
|
* Core metric definitions:
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
376
|
+
*
|
|
377
|
+
* GMV (Gross Merchandise Volume) refers to the total sum of order amounts, including both paid and unpaid orders.
|
|
378
|
+
* Order volume refers to the number of valid orders placed per day.
|
|
379
|
+
* UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
|
|
380
|
+
* Conversion rate = paid orders / UV, reflecting the efficiency of traffic conversion.
|
|
342
381
|
*/
|
|
343
382
|
knowledge?: string;
|
|
383
|
+
/**
|
|
384
|
+
* @remarks
|
|
385
|
+
* The external knowledge bases.
|
|
386
|
+
*/
|
|
344
387
|
knowledgeConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeConfigList[];
|
|
345
388
|
knowledgeSemanticConfigList?: DescribeCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
|
|
346
389
|
/**
|
|
@@ -364,7 +407,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
364
407
|
* The name of the custom agent.
|
|
365
408
|
*
|
|
366
409
|
* @example
|
|
367
|
-
*
|
|
410
|
+
* Test agent name
|
|
368
411
|
*/
|
|
369
412
|
name?: string;
|
|
370
413
|
/**
|
|
@@ -401,7 +444,7 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
401
444
|
relatedSessionId?: string;
|
|
402
445
|
/**
|
|
403
446
|
* @remarks
|
|
404
|
-
* The
|
|
447
|
+
* The release time.
|
|
405
448
|
*
|
|
406
449
|
* @example
|
|
407
450
|
* 2025-12-11T14:04:32.000+00:00
|
|
@@ -425,18 +468,34 @@ export class DescribeCustomAgentResponseBodyData extends $dara.Model {
|
|
|
425
468
|
* The text report format.
|
|
426
469
|
*
|
|
427
470
|
* @example
|
|
428
|
-
* The text report requires all numbers
|
|
471
|
+
* The text report requires that all numbers be written in Chinese numerals rather than Arabic numerals.
|
|
429
472
|
*/
|
|
430
473
|
textReportConfig?: string;
|
|
474
|
+
/**
|
|
475
|
+
* @remarks
|
|
476
|
+
* The list of user-specified skills.
|
|
477
|
+
*/
|
|
431
478
|
userSpecifiedSkillList?: string[];
|
|
432
479
|
/**
|
|
433
480
|
* @remarks
|
|
434
481
|
* The web report format.
|
|
435
482
|
*
|
|
436
483
|
* @example
|
|
437
|
-
* The web report requires all numbers
|
|
484
|
+
* The web report requires that all numbers be written in Chinese numerals rather than Arabic numerals.
|
|
438
485
|
*/
|
|
439
486
|
webReportConfig?: string;
|
|
487
|
+
/**
|
|
488
|
+
* @remarks
|
|
489
|
+
* The web report theme. Valid values:
|
|
490
|
+
* - default: Default.
|
|
491
|
+
* - journal: Journal.
|
|
492
|
+
* - legacy: Classic.
|
|
493
|
+
* - neobrutalism: Stylized.
|
|
494
|
+
* - infographic: Infographic.
|
|
495
|
+
*
|
|
496
|
+
* @example
|
|
497
|
+
* default
|
|
498
|
+
*/
|
|
440
499
|
webReportTheme?: string;
|
|
441
500
|
/**
|
|
442
501
|
* @remarks
|
|
@@ -565,7 +624,7 @@ export class DescribeCustomAgentResponseBody extends $dara.Model {
|
|
|
565
624
|
errorCode?: string;
|
|
566
625
|
/**
|
|
567
626
|
* @remarks
|
|
568
|
-
* The error message returned
|
|
627
|
+
* The error message returned when the call fails.
|
|
569
628
|
*
|
|
570
629
|
* @example
|
|
571
630
|
* Specified parameter Tid is not valid.
|
|
@@ -581,10 +640,10 @@ export class DescribeCustomAgentResponseBody extends $dara.Model {
|
|
|
581
640
|
requestId?: string;
|
|
582
641
|
/**
|
|
583
642
|
* @remarks
|
|
584
|
-
* Indicates whether the request
|
|
643
|
+
* Indicates whether the request is successful. Valid values:
|
|
585
644
|
*
|
|
586
|
-
* - **true**: The request
|
|
587
|
-
* - **false**: The request
|
|
645
|
+
* - **true**: The request is successful.
|
|
646
|
+
* - **false**: The request fails.
|
|
588
647
|
*
|
|
589
648
|
* @example
|
|
590
649
|
* true
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The brief description of the artifact. This
|
|
8
|
+
* The brief description of the artifact. This field may be empty.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* a simple report
|
|
@@ -13,7 +13,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
13
13
|
description?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The time when the backend completed the artifact task.
|
|
16
|
+
* The time when the backend completed the artifact task. The value is a UNIX timestamp accurate to seconds.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* 1778743587
|
|
@@ -21,7 +21,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
21
21
|
finishTime?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* The artifact ID
|
|
24
|
+
* The globally unique artifact ID. If the artifact is a report generated by specifying MessageType as REPORT in the SendChatMessage operation, the artifact ID is the same as the MessageId value returned by the SendChatMessage operation.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* bab******33e1
|
|
@@ -29,7 +29,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
29
29
|
id?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* The artifact name
|
|
32
|
+
* The artifact name. This is usually a concatenated string generated by the project and aligns with the name field in the ListFileUpload operation. You can use this field to query the download URL of the artifact file.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* report_****_2026****
|
|
@@ -37,7 +37,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
37
37
|
name?: string;
|
|
38
38
|
/**
|
|
39
39
|
* @remarks
|
|
40
|
-
* The time when the backend received the artifact request.
|
|
40
|
+
* The time when the backend received the artifact request. The value is a UNIX timestamp accurate to seconds.
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* 1778743587
|
|
@@ -45,7 +45,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
45
45
|
receiveTime?: string;
|
|
46
46
|
/**
|
|
47
47
|
* @remarks
|
|
48
|
-
* The time when the backend actually started running the artifact task.
|
|
48
|
+
* The time when the backend actually started running the artifact task. The value is a UNIX timestamp accurate to seconds.
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* 1778743587
|
|
@@ -54,13 +54,9 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
54
54
|
/**
|
|
55
55
|
* @remarks
|
|
56
56
|
* The artifact status. Valid values:
|
|
57
|
-
*
|
|
58
57
|
* - PENDING: The backend has received the task but has not started it.
|
|
59
|
-
*
|
|
60
58
|
* - RUNNING: The backend has started the task but has not completed it.
|
|
61
|
-
*
|
|
62
59
|
* - SUCCESS: The task succeeded. You can query the file information by calling the ListFileUpload operation.
|
|
63
|
-
*
|
|
64
60
|
* - FAILED: The task failed.
|
|
65
61
|
*
|
|
66
62
|
* @example
|
|
@@ -69,7 +65,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
|
|
|
69
65
|
status?: string;
|
|
70
66
|
/**
|
|
71
67
|
* @remarks
|
|
72
|
-
* The artifact type. Valid values:
|
|
68
|
+
* The artifact type. Valid values: TextReport and WebReport.
|
|
73
69
|
*
|
|
74
70
|
* @example
|
|
75
71
|
* WebReport
|
|
@@ -114,8 +110,8 @@ export class DescribeDataAgentSessionResponseBodyDataCapabilities extends $dara.
|
|
|
114
110
|
/**
|
|
115
111
|
* @remarks
|
|
116
112
|
* The ID of the mounted capability.
|
|
117
|
-
* - If Type is set to skill, this
|
|
118
|
-
* - If Type is set to dms_kb, this
|
|
113
|
+
* - If Type is set to skill, this parameter indicates the skill ID.
|
|
114
|
+
* - If Type is set to dms_kb, this parameter indicates the knowledge base ID.
|
|
119
115
|
*
|
|
120
116
|
* @example
|
|
121
117
|
* kb-HZ-s3df*******ld08d
|
|
@@ -123,9 +119,9 @@ export class DescribeDataAgentSessionResponseBodyDataCapabilities extends $dara.
|
|
|
123
119
|
id?: string;
|
|
124
120
|
/**
|
|
125
121
|
* @remarks
|
|
126
|
-
* The type. Valid values:
|
|
127
|
-
* - skill:
|
|
128
|
-
* - dms_kb:
|
|
122
|
+
* The capability type. Valid values:
|
|
123
|
+
* - skill: Skill.
|
|
124
|
+
* - dms_kb: Knowledge base.
|
|
129
125
|
*
|
|
130
126
|
* @example
|
|
131
127
|
* dms_kb
|
|
@@ -157,7 +153,7 @@ export class DescribeDataAgentSessionResponseBodyDataCapabilities extends $dara.
|
|
|
157
153
|
export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extends $dara.Model {
|
|
158
154
|
/**
|
|
159
155
|
* @remarks
|
|
160
|
-
* The key of the
|
|
156
|
+
* The key of the session playback history.
|
|
161
157
|
*
|
|
162
158
|
* @example
|
|
163
159
|
* testKey1
|
|
@@ -165,7 +161,7 @@ export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extend
|
|
|
165
161
|
key?: string;
|
|
166
162
|
/**
|
|
167
163
|
* @remarks
|
|
168
|
-
* The OSS download URL of the
|
|
164
|
+
* The OSS download URL of the session playback history.
|
|
169
165
|
*
|
|
170
166
|
* @example
|
|
171
167
|
* ****
|
|
@@ -198,10 +194,8 @@ export class DescribeDataAgentSessionResponseBodyDataDataSources extends $dara.M
|
|
|
198
194
|
/**
|
|
199
195
|
* @remarks
|
|
200
196
|
* The source of the data source. Valid values:
|
|
201
|
-
*
|
|
202
|
-
* -
|
|
203
|
-
*
|
|
204
|
-
* - **CUSTOM_AGENT**: Derived from the preset analysis data scope in a custom agent.
|
|
197
|
+
* - CHAT: The data source is specified in a conversation by calling the CreateDataAgentSession or SendChatMessage operation.
|
|
198
|
+
* - CUSTOM_AGENT: The data source is from the preset analysis data scope in a custom agent.
|
|
205
199
|
*
|
|
206
200
|
* @example
|
|
207
201
|
* CHAT
|
|
@@ -209,9 +203,7 @@ export class DescribeDataAgentSessionResponseBodyDataDataSources extends $dara.M
|
|
|
209
203
|
category?: string;
|
|
210
204
|
/**
|
|
211
205
|
* @remarks
|
|
212
|
-
* The data source details.
|
|
213
|
-
*
|
|
214
|
-
* When Category is CHAT or CUSTOM_AGENT, the structure of Detail is aligned with the structure of a single element in the DataSources parameter of the SendChatMessage operation.
|
|
206
|
+
* The data source details. When Category is set to CHAT or CUSTOM_AGENT, the structure of Detail aligns with the structure of a single element in the DataSources parameter of the SendChatMessage operation.
|
|
215
207
|
*
|
|
216
208
|
* @example
|
|
217
209
|
* {}
|
|
@@ -240,10 +232,70 @@ export class DescribeDataAgentSessionResponseBodyDataDataSources extends $dara.M
|
|
|
240
232
|
}
|
|
241
233
|
}
|
|
242
234
|
|
|
235
|
+
export class DescribeDataAgentSessionResponseBodyDataMessages extends $dara.Model {
|
|
236
|
+
/**
|
|
237
|
+
* @remarks
|
|
238
|
+
* The content of the historical session message.
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* Show me the sales of restaurants in the UK in 2022
|
|
242
|
+
*/
|
|
243
|
+
content?: string;
|
|
244
|
+
/**
|
|
245
|
+
* @remarks
|
|
246
|
+
* The unique ID of the historical session message.
|
|
247
|
+
*
|
|
248
|
+
* @example
|
|
249
|
+
* a5bb5ff643de4124afd4317f79417a81
|
|
250
|
+
*/
|
|
251
|
+
id?: string;
|
|
252
|
+
/**
|
|
253
|
+
* @remarks
|
|
254
|
+
* The time when the historical session message was sent.
|
|
255
|
+
*
|
|
256
|
+
* @example
|
|
257
|
+
* 1790650646000
|
|
258
|
+
*/
|
|
259
|
+
sendTime?: number;
|
|
260
|
+
/**
|
|
261
|
+
* @remarks
|
|
262
|
+
* The status of the historical session message.
|
|
263
|
+
*
|
|
264
|
+
* @example
|
|
265
|
+
* SENT
|
|
266
|
+
*/
|
|
267
|
+
status?: string;
|
|
268
|
+
static names(): { [key: string]: string } {
|
|
269
|
+
return {
|
|
270
|
+
content: 'Content',
|
|
271
|
+
id: 'Id',
|
|
272
|
+
sendTime: 'SendTime',
|
|
273
|
+
status: 'Status',
|
|
274
|
+
};
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
static types(): { [key: string]: any } {
|
|
278
|
+
return {
|
|
279
|
+
content: 'string',
|
|
280
|
+
id: 'string',
|
|
281
|
+
sendTime: 'number',
|
|
282
|
+
status: 'string',
|
|
283
|
+
};
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
validate() {
|
|
287
|
+
super.validate();
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
constructor(map?: { [key: string]: any }) {
|
|
291
|
+
super(map);
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
|
|
243
295
|
export class DescribeDataAgentSessionResponseBodyDataRecallResults extends $dara.Model {
|
|
244
296
|
/**
|
|
245
297
|
* @remarks
|
|
246
|
-
* The content of the recalled knowledge
|
|
298
|
+
* The content of the recalled knowledge block.
|
|
247
299
|
*
|
|
248
300
|
* @example
|
|
249
301
|
* sky is blue
|
|
@@ -251,7 +303,7 @@ export class DescribeDataAgentSessionResponseBodyDataRecallResults extends $dara
|
|
|
251
303
|
content?: string;
|
|
252
304
|
/**
|
|
253
305
|
* @remarks
|
|
254
|
-
* The similarity score of this
|
|
306
|
+
* The similarity score of this data entry. The scoring algorithm is related to the algorithm specified when the index was created, such as l2, ip, or cosine.
|
|
255
307
|
*
|
|
256
308
|
* @example
|
|
257
309
|
* 0.65
|
|
@@ -301,9 +353,9 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
301
353
|
customAgentId?: string;
|
|
302
354
|
/**
|
|
303
355
|
* @remarks
|
|
304
|
-
* The stage of the custom agent. Valid values:
|
|
305
|
-
* -
|
|
306
|
-
* -
|
|
356
|
+
* The usage stage of the custom agent. Valid values:
|
|
357
|
+
* - debug: Debugging stage.
|
|
358
|
+
* - prod: Production stage.
|
|
307
359
|
*
|
|
308
360
|
* @example
|
|
309
361
|
* debug
|
|
@@ -311,7 +363,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
311
363
|
customAgentStage?: string;
|
|
312
364
|
/**
|
|
313
365
|
* @remarks
|
|
314
|
-
* Specifies whether web search
|
|
366
|
+
* Specifies whether to enable web search.
|
|
315
367
|
*
|
|
316
368
|
* @example
|
|
317
369
|
* True
|
|
@@ -319,7 +371,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
319
371
|
enableSearch?: boolean;
|
|
320
372
|
/**
|
|
321
373
|
* @remarks
|
|
322
|
-
* The encryption key
|
|
374
|
+
* The encryption key for artifacts stored in OSS, including built-in and user OSS buckets. This key is usually specified in the CreateDataAgentSession operation.
|
|
323
375
|
*
|
|
324
376
|
* @example
|
|
325
377
|
* ay***1Te
|
|
@@ -327,7 +379,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
327
379
|
encryptKey?: string;
|
|
328
380
|
/**
|
|
329
381
|
* @remarks
|
|
330
|
-
* The encryption type
|
|
382
|
+
* The encryption type for artifacts stored in OSS, including built-in and user OSS buckets.
|
|
331
383
|
*
|
|
332
384
|
* @example
|
|
333
385
|
* null
|
|
@@ -335,14 +387,14 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
335
387
|
encryptType?: string;
|
|
336
388
|
/**
|
|
337
389
|
* @remarks
|
|
338
|
-
* The list of knowledge base IDs for
|
|
390
|
+
* The list of knowledge base IDs for the current session.
|
|
339
391
|
*/
|
|
340
392
|
kbUuidList?: string[];
|
|
341
393
|
/**
|
|
342
394
|
* @remarks
|
|
343
395
|
* The language. Valid values:
|
|
344
|
-
* -
|
|
345
|
-
* -
|
|
396
|
+
* - CHINESE: Chinese.
|
|
397
|
+
* - ENGLISH: English.
|
|
346
398
|
*
|
|
347
399
|
* @example
|
|
348
400
|
* CHINESE
|
|
@@ -350,15 +402,15 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
350
402
|
language?: string;
|
|
351
403
|
/**
|
|
352
404
|
* @remarks
|
|
353
|
-
* The list of MCP server IDs in the session
|
|
405
|
+
* The list of MCP server IDs in the session configurations.
|
|
354
406
|
*/
|
|
355
407
|
mcpServerIds?: string[];
|
|
356
408
|
/**
|
|
357
409
|
* @remarks
|
|
358
410
|
* The mode. Valid values:
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
411
|
+
* - ASK_DATA: Data query mode.
|
|
412
|
+
* - ANALYSIS: Analysis mode.
|
|
413
|
+
* - INSIGHT: Insight mode.
|
|
362
414
|
*
|
|
363
415
|
* @example
|
|
364
416
|
* ANALYSIS
|
|
@@ -366,7 +418,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
366
418
|
mode?: string;
|
|
367
419
|
/**
|
|
368
420
|
* @remarks
|
|
369
|
-
* The
|
|
421
|
+
* The page width of the report.
|
|
370
422
|
*
|
|
371
423
|
* @example
|
|
372
424
|
* 300mm
|
|
@@ -374,7 +426,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
374
426
|
reportPageWidth?: number;
|
|
375
427
|
/**
|
|
376
428
|
* @remarks
|
|
377
|
-
* The report
|
|
429
|
+
* The watermark of the report.
|
|
378
430
|
*
|
|
379
431
|
* @example
|
|
380
432
|
* ""
|
|
@@ -383,7 +435,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
|
|
|
383
435
|
/**
|
|
384
436
|
* @remarks
|
|
385
437
|
* The name of the user OSS bucket.
|
|
386
|
-
* -
|
|
438
|
+
* - Files generated during the analysis process and report artifacts can be uploaded to the user-specified OSS bucket.
|
|
387
439
|
*
|
|
388
440
|
* @example
|
|
389
441
|
* user-oss-bucket
|
|
@@ -457,17 +509,17 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
457
509
|
agentStatus?: string;
|
|
458
510
|
/**
|
|
459
511
|
* @remarks
|
|
460
|
-
* The list of artifacts
|
|
512
|
+
* The list of artifacts generated by the session. Currently, only reports are included.
|
|
461
513
|
*/
|
|
462
514
|
artifacts?: DescribeDataAgentSessionResponseBodyDataArtifacts[];
|
|
463
515
|
/**
|
|
464
516
|
* @remarks
|
|
465
|
-
* The capabilities
|
|
517
|
+
* The capabilities mounted to the session, such as knowledge bases and skills.
|
|
466
518
|
*/
|
|
467
519
|
capabilities?: DescribeDataAgentSessionResponseBodyDataCapabilities[];
|
|
468
520
|
/**
|
|
469
521
|
* @remarks
|
|
470
|
-
* The
|
|
522
|
+
* The session playback history.
|
|
471
523
|
*/
|
|
472
524
|
chatHistoryLocations?: DescribeDataAgentSessionResponseBodyDataChatHistoryLocations[];
|
|
473
525
|
/**
|
|
@@ -485,7 +537,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
485
537
|
dataSources?: DescribeDataAgentSessionResponseBodyDataDataSources[];
|
|
486
538
|
/**
|
|
487
539
|
* @remarks
|
|
488
|
-
* Indicates whether the session is favorited by the current user in the workspace.
|
|
540
|
+
* Indicates whether the session is favorited by the current logged-on user in the workspace.
|
|
489
541
|
*
|
|
490
542
|
* @example
|
|
491
543
|
* true
|
|
@@ -501,12 +553,17 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
501
553
|
file?: string;
|
|
502
554
|
/**
|
|
503
555
|
* @remarks
|
|
504
|
-
* The
|
|
556
|
+
* The list of historical session messages.
|
|
557
|
+
*/
|
|
558
|
+
messages?: DescribeDataAgentSessionResponseBodyDataMessages[];
|
|
559
|
+
/**
|
|
560
|
+
* @remarks
|
|
561
|
+
* The recall results from the knowledge base and memory for the current session.
|
|
505
562
|
*/
|
|
506
563
|
recallResults?: DescribeDataAgentSessionResponseBodyDataRecallResults[];
|
|
507
564
|
/**
|
|
508
565
|
* @remarks
|
|
509
|
-
* Indicates whether the session is favorited by the current user.
|
|
566
|
+
* Indicates whether the session is favorited by the current logged-on user.
|
|
510
567
|
*
|
|
511
568
|
* @example
|
|
512
569
|
* true
|
|
@@ -514,7 +571,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
514
571
|
saved?: boolean;
|
|
515
572
|
/**
|
|
516
573
|
* @remarks
|
|
517
|
-
* The session
|
|
574
|
+
* The session configurations.
|
|
518
575
|
*/
|
|
519
576
|
sessionConfig?: DescribeDataAgentSessionResponseBodyDataSessionConfig;
|
|
520
577
|
/**
|
|
@@ -560,6 +617,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
560
617
|
dataSources: 'DataSources',
|
|
561
618
|
favoriteInWorkspace: 'FavoriteInWorkspace',
|
|
562
619
|
file: 'File',
|
|
620
|
+
messages: 'Messages',
|
|
563
621
|
recallResults: 'RecallResults',
|
|
564
622
|
saved: 'Saved',
|
|
565
623
|
sessionConfig: 'SessionConfig',
|
|
@@ -581,6 +639,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
581
639
|
dataSources: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataDataSources },
|
|
582
640
|
favoriteInWorkspace: 'string',
|
|
583
641
|
file: 'string',
|
|
642
|
+
messages: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataMessages },
|
|
584
643
|
recallResults: { 'type': 'array', 'itemType': DescribeDataAgentSessionResponseBodyDataRecallResults },
|
|
585
644
|
saved: 'boolean',
|
|
586
645
|
sessionConfig: DescribeDataAgentSessionResponseBodyDataSessionConfig,
|
|
@@ -604,6 +663,9 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
604
663
|
if(Array.isArray(this.dataSources)) {
|
|
605
664
|
$dara.Model.validateArray(this.dataSources);
|
|
606
665
|
}
|
|
666
|
+
if(Array.isArray(this.messages)) {
|
|
667
|
+
$dara.Model.validateArray(this.messages);
|
|
668
|
+
}
|
|
607
669
|
if(Array.isArray(this.recallResults)) {
|
|
608
670
|
$dara.Model.validateArray(this.recallResults);
|
|
609
671
|
}
|
|
@@ -621,7 +683,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
|
|
|
621
683
|
export class DescribeDataAgentSessionResponseBody extends $dara.Model {
|
|
622
684
|
/**
|
|
623
685
|
* @remarks
|
|
624
|
-
* The
|
|
686
|
+
* The returned struct.
|
|
625
687
|
*/
|
|
626
688
|
data?: DescribeDataAgentSessionResponseBodyData;
|
|
627
689
|
/**
|
|
@@ -651,9 +713,8 @@ export class DescribeDataAgentSessionResponseBody extends $dara.Model {
|
|
|
651
713
|
/**
|
|
652
714
|
* @remarks
|
|
653
715
|
* The return value description. Valid values:
|
|
654
|
-
*
|
|
655
|
-
* -
|
|
656
|
-
* - **false**: Failed.
|
|
716
|
+
* - true: The deletion succeeded.
|
|
717
|
+
* - false: The deletion failed.
|
|
657
718
|
*
|
|
658
719
|
* @example
|
|
659
720
|
* true
|