@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.
Files changed (46) hide show
  1. package/dist/client.d.ts +8 -8
  2. package/dist/client.js +8 -8
  3. package/dist/models/CreateCustomAgentRequest.d.ts +71 -43
  4. package/dist/models/CreateCustomAgentRequest.js.map +1 -1
  5. package/dist/models/CreateCustomAgentResponseBody.d.ts +58 -29
  6. package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
  7. package/dist/models/CreateCustomAgentShrinkRequest.d.ts +51 -37
  8. package/dist/models/CreateCustomAgentShrinkRequest.js.map +1 -1
  9. package/dist/models/DescribeCustomAgentResponseBody.d.ts +84 -25
  10. package/dist/models/DescribeCustomAgentResponseBody.js.map +1 -1
  11. package/dist/models/DescribeDataAgentSessionRequest.d.ts +1 -1
  12. package/dist/models/DescribeDataAgentSessionResponseBody.d.ts +94 -54
  13. package/dist/models/DescribeDataAgentSessionResponseBody.js +31 -1
  14. package/dist/models/DescribeDataAgentSessionResponseBody.js.map +1 -1
  15. package/dist/models/ListCustomAgentRequest.d.ts +4 -4
  16. package/dist/models/ListCustomAgentResponseBody.d.ts +138 -28
  17. package/dist/models/ListCustomAgentResponseBody.js.map +1 -1
  18. package/dist/models/ListDataAgentWorkspaceRequest.d.ts +13 -6
  19. package/dist/models/ListDataAgentWorkspaceRequest.js.map +1 -1
  20. package/dist/models/ListDataAgentWorkspaceResponseBody.d.ts +28 -7
  21. package/dist/models/ListDataAgentWorkspaceResponseBody.js.map +1 -1
  22. package/dist/models/ModifyCustomAgentRequest.d.ts +71 -38
  23. package/dist/models/ModifyCustomAgentRequest.js.map +1 -1
  24. package/dist/models/ModifyCustomAgentResponseBody.d.ts +63 -30
  25. package/dist/models/ModifyCustomAgentResponseBody.js.map +1 -1
  26. package/dist/models/ModifyCustomAgentShrinkRequest.d.ts +51 -32
  27. package/dist/models/ModifyCustomAgentShrinkRequest.js.map +1 -1
  28. package/dist/models/model.d.ts +1 -0
  29. package/dist/models/model.js +18 -16
  30. package/dist/models/model.js.map +1 -1
  31. package/package.json +1 -1
  32. package/src/client.ts +8 -8
  33. package/src/models/CreateCustomAgentRequest.ts +71 -43
  34. package/src/models/CreateCustomAgentResponseBody.ts +58 -29
  35. package/src/models/CreateCustomAgentShrinkRequest.ts +51 -37
  36. package/src/models/DescribeCustomAgentResponseBody.ts +84 -25
  37. package/src/models/DescribeDataAgentSessionRequest.ts +1 -1
  38. package/src/models/DescribeDataAgentSessionResponseBody.ts +115 -54
  39. package/src/models/ListCustomAgentRequest.ts +4 -4
  40. package/src/models/ListCustomAgentResponseBody.ts +138 -28
  41. package/src/models/ListDataAgentWorkspaceRequest.ts +13 -6
  42. package/src/models/ListDataAgentWorkspaceResponseBody.ts +28 -7
  43. package/src/models/ModifyCustomAgentRequest.ts +71 -38
  44. package/src/models/ModifyCustomAgentResponseBody.ts +63 -30
  45. package/src/models/ModifyCustomAgentShrinkRequest.ts +51 -32
  46. package/src/models/model.ts +1 -0
@@ -38,6 +38,13 @@ export class ModifyCustomAgentRequestCallbackConfig extends $dara.Model {
38
38
  }
39
39
 
40
40
  export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
41
+ /**
42
+ * @remarks
43
+ * Specifies whether to prohibit appending data sources during the session.
44
+ *
45
+ * @example
46
+ * true
47
+ */
41
48
  forbiddenAppendDataSource?: boolean;
42
49
  /**
43
50
  * @remarks
@@ -65,7 +72,7 @@ export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
65
72
  skipSqlConfirm?: boolean;
66
73
  /**
67
74
  * @remarks
68
- * Specifies whether to skip the web report rendering confirmation.
75
+ * Specifies whether to skip the web report generation confirmation.
69
76
  *
70
77
  * @example
71
78
  * true
@@ -103,18 +110,25 @@ export class ModifyCustomAgentRequestExecutionConfig extends $dara.Model {
103
110
  export class ModifyCustomAgentRequestKnowledgeConfigList extends $dara.Model {
104
111
  /**
105
112
  * @remarks
106
- * The access type.
107
- *
108
- * - mcp: access through MCP.
113
+ * The access type. If this parameter is not specified, the default value is mcp. Valid values:
114
+ * - mcp: access through MCP. You must pass the McpServerId parameter.
115
+ * - dms_kb: access through DMS knowledge base. You must pass the KbUuid parameter.
109
116
  *
110
117
  * @example
111
118
  * mcp
112
119
  */
113
120
  accessType?: string;
121
+ /**
122
+ * @remarks
123
+ * The knowledge base ID.
124
+ *
125
+ * @example
126
+ * kb-HZ-6anhdzx7hddf9*******obx
127
+ */
114
128
  kbUuid?: string;
115
129
  /**
116
130
  * @remarks
117
- * The ID of the MCP Server.
131
+ * The ID of the MCP server.
118
132
  *
119
133
  * @example
120
134
  * nhdpt9adf6ac**********ca
@@ -180,7 +194,7 @@ export class ModifyCustomAgentRequestKnowledgeSemanticConfigList extends $dara.M
180
194
  export class ModifyCustomAgentRequestScheduleTaskConfig extends $dara.Model {
181
195
  /**
182
196
  * @remarks
183
- * The cron expression for timed scheduling.
197
+ * The cron expression for periodic scheduling.
184
198
  *
185
199
  * @example
186
200
  * 0 0 0,1 ? * 1-7
@@ -231,7 +245,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
231
245
  callbackConfig?: ModifyCustomAgentRequestCallbackConfig;
232
246
  /**
233
247
  * @remarks
234
- * The custom agent ID.
248
+ * The ID of the custom agent.
235
249
  *
236
250
  * This parameter is required.
237
251
  *
@@ -250,17 +264,17 @@ export class ModifyCustomAgentRequest extends $dara.Model {
250
264
  /**
251
265
  * @remarks
252
266
  * The specified data scope in **JSON character string format**.
253
- * - Common parameter description
254
- * - tableFlag: true indicates a specified data scope.
267
+ * - General parameter description
268
+ * - tableFlag: true specifies the data scope.
255
269
  * - scope: personal is a fixed value.
256
- * - personal: pass parameters for file or database types.
270
+ * - personal: parameters for file and database types.
257
271
  *
258
- * **File type**. Pass parameters in the following format:
272
+ * **File type**: pass parameters in the following format:
259
273
  * - DataSourceType: remote_data_center is a fixed value.
260
274
  * - FileId: the file ID.
261
- * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name.
262
- * - Tables: the table name returned by the ListDataCenterTable operation.
263
- * - TableIds: the TableId returned by the ListDataCenterTable operation.
275
+ * - Database: the database name returned by the ListDataCenterTable operation, which is usually the file name.
276
+ * - Tables: the table names returned by the ListDataCenterTable operation.
277
+ * - TableIds: the table IDs returned by the ListDataCenterTable operation.
264
278
  * - RegionId: the current region.
265
279
  * ```
266
280
  * {
@@ -281,16 +295,16 @@ export class ModifyCustomAgentRequest extends $dara.Model {
281
295
  * }
282
296
  * ```
283
297
  *
284
- * **Database type**. Pass parameters as follows:
298
+ * **Database type**: pass parameters as follows:
285
299
  * - DataSourceType: database is a fixed value.
286
- * - DmsInstanceId: the DMS instance ID returned by the data center operation.
287
- * - DmsDatabaseId: the DMS database ID returned by the data center operation.
288
- * - FileId: the instance name (deprecated).
289
- * - DbName: the database name returned by the data center operation.
290
- * - Database: the database name returned by the data center operation.
291
- * - Tables: the table name returned by the data center operation.
292
- * - TableIds: the TableId returned by the data center operation.
293
- * - Engine: the engine type (mysql or postgresql).
300
+ * - DmsInstanceId: the DMS instance ID returned by the Data Center operation.
301
+ * - DmsDatabaseId: the DMS database ID returned by the Data Center operation.
302
+ * - FileId: the instance name. **[Deprecated]**
303
+ * - DbName: the database name returned by the Data Center operation.
304
+ * - Database: the database name returned by the Data Center operation.
305
+ * - Tables: the table names returned by the Data Center operation.
306
+ * - TableIds: the table IDs returned by the Data Center operation.
307
+ * - Engine: the engine type, such as mysql or postgresql.
294
308
  * - RegionId: the current region.
295
309
  * ```
296
310
  * {
@@ -322,7 +336,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
322
336
  * "personal" : {
323
337
  * "DataSourceType" : "remote_data_center",
324
338
  * "FileId" : "f-5qlrwaw10********s3gpw1z",
325
- * "Database" : "TestTable******.xlsx",
339
+ * "Database" : "Test_spreadsheet******.xlsx",
326
340
  * "Tables" : [ "Sheet1" ],
327
341
  * "TableIds" : [ "******" ],
328
342
  * "RegionId" : "cn-hangzhou"
@@ -335,7 +349,7 @@ export class ModifyCustomAgentRequest extends $dara.Model {
335
349
  * The description of the custom agent.
336
350
  *
337
351
  * @example
338
- * AgentTestDescription
352
+ * Agent test description
339
353
  */
340
354
  description?: string;
341
355
  /**
@@ -345,14 +359,14 @@ export class ModifyCustomAgentRequest extends $dara.Model {
345
359
  executionConfig?: ModifyCustomAgentRequestExecutionConfig;
346
360
  /**
347
361
  * @remarks
348
- * The instruction.
362
+ * The instructions.
349
363
  * - Input limit: up to 10,000 characters.
350
364
  *
351
365
  * @example
352
366
  * Analysis framework:
353
- * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) by day, week, and month dimensions, and analyze trends and year-over-year/month-over-month fluctuations.
354
- * 2. Segment by new/existing customers, channels, and regions to identify growth sources and weaknesses.
355
- * 3. Conduct funnel analysis based on user behavior paths (browse → add to cart → payment) to identify drop-off points
367
+ * 1. Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis, and analyze trend changes as well as year-over-year and month-over-month fluctuations.
368
+ * 2. Segment data by new and returning customers, channels, and regions to identify growth drivers and weaknesses.
369
+ * 3. Conduct funnel analysis based on user behavior paths (browse -> add to cart -> pay) to locate churn points
356
370
  */
357
371
  instruction?: string;
358
372
  /**
@@ -362,15 +376,15 @@ export class ModifyCustomAgentRequest extends $dara.Model {
362
376
  *
363
377
  * @example
364
378
  * Core metric definitions:
365
- * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
366
- * 2. Order volume is the number of valid orders placed per day.
367
- * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
368
- * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency
379
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both successfully paid and unpaid orders.
380
+ * 2. Order volume refers to the number of valid orders placed per day.
381
+ * 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
382
+ * 4. Conversion rate = Number of paid orders / UV, reflecting the traffic conversion efficiency
369
383
  */
370
384
  knowledge?: string;
371
385
  /**
372
386
  * @remarks
373
- * The external knowledge base list.
387
+ * The external knowledge bases.
374
388
  */
375
389
  knowledgeConfigList?: ModifyCustomAgentRequestKnowledgeConfigList[];
376
390
  knowledgeSemanticConfigList?: ModifyCustomAgentRequestKnowledgeSemanticConfigList[];
@@ -379,12 +393,15 @@ export class ModifyCustomAgentRequest extends $dara.Model {
379
393
  * The name of the custom agent.
380
394
  *
381
395
  * @example
382
- * AgentTestName
396
+ * Agent test name
383
397
  */
384
398
  name?: string;
385
399
  /**
386
400
  * @remarks
387
401
  * The ID of the referenced historical session.
402
+ *
403
+ * @example
404
+ * ski-sldk8v******3owd
388
405
  */
389
406
  relatedSessionId?: string;
390
407
  /**
@@ -395,12 +412,16 @@ export class ModifyCustomAgentRequest extends $dara.Model {
395
412
  /**
396
413
  * @remarks
397
414
  * The text report format.
398
- * - Input limit: up to 10,000 characters.
415
+ * - Input limit: up to 10,000 characters.
399
416
  *
400
417
  * @example
401
- * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
418
+ * Require all numbers in the text report to be written in Chinese characters instead of Arabic numerals
402
419
  */
403
420
  textReportConfig?: string;
421
+ /**
422
+ * @remarks
423
+ * The list of user-specified skills.
424
+ */
404
425
  userSpecifiedSkillList?: string[];
405
426
  /**
406
427
  * @remarks
@@ -408,9 +429,21 @@ export class ModifyCustomAgentRequest extends $dara.Model {
408
429
  * - Input limit: up to 50,000 characters.
409
430
  *
410
431
  * @example
411
- * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
432
+ * Require all numbers in the web report to be written in Chinese characters instead of Arabic numerals
412
433
  */
413
434
  webReportConfig?: string;
435
+ /**
436
+ * @remarks
437
+ * The web report theme. Valid values:
438
+ * - default: default.
439
+ * - journal: journal.
440
+ * - legacy: classic.
441
+ * - neobrutalism: stylized.
442
+ * - infographic: infographic.
443
+ *
444
+ * @example
445
+ * default
446
+ */
414
447
  webReportTheme?: string;
415
448
  /**
416
449
  * @remarks
@@ -38,6 +38,13 @@ export class ModifyCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
38
38
  }
39
39
 
40
40
  export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Model {
41
+ /**
42
+ * @remarks
43
+ * Specifies whether to prohibit appending data sources during the session.
44
+ *
45
+ * @example
46
+ * true
47
+ */
41
48
  forbiddenAppendDataSource?: boolean;
42
49
  /**
43
50
  * @remarks
@@ -65,7 +72,7 @@ export class ModifyCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
65
72
  skipSqlConfirm?: boolean;
66
73
  /**
67
74
  * @remarks
68
- * Specifies whether to skip the web report rendering confirmation.
75
+ * Specifies whether to skip the web report generation confirmation.
69
76
  *
70
77
  * @example
71
78
  * true
@@ -104,16 +111,24 @@ export class ModifyCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.
104
111
  /**
105
112
  * @remarks
106
113
  * The access type. Valid values:
107
- * - mcp: accessed through MCP.
114
+ * - mcp: Access through MCP.
115
+ * - dms_kb: Access through the DMS knowledge base.
108
116
  *
109
117
  * @example
110
118
  * mcp
111
119
  */
112
120
  accessType?: string;
121
+ /**
122
+ * @remarks
123
+ * The knowledge base ID.
124
+ *
125
+ * @example
126
+ * kb-HZ-6anhdzx7hddf9*******obx
127
+ */
113
128
  kbUuid?: string;
114
129
  /**
115
130
  * @remarks
116
- * The ID of the MCP Server.
131
+ * The ID of the MCP server.
117
132
  *
118
133
  * @example
119
134
  * nhdpt9adf6ac**********ca
@@ -179,7 +194,7 @@ export class ModifyCustomAgentResponseBodyDataKnowledgeSemanticConfigList extend
179
194
  export class ModifyCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
180
195
  /**
181
196
  * @remarks
182
- * The cron expression for timed scheduling.
197
+ * The cron expression for periodic scheduling.
183
198
  *
184
199
  * @example
185
200
  * 0 0 0 ? * 1-7
@@ -229,7 +244,7 @@ export class ModifyCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
229
244
  export class ModifyCustomAgentResponseBodyData extends $dara.Model {
230
245
  /**
231
246
  * @remarks
232
- * The Alibaba Cloud account ID of the parent account.
247
+ * The primary Alibaba Cloud account ID.
233
248
  *
234
249
  * @example
235
250
  * 16738266********
@@ -246,7 +261,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
246
261
  callbackConfig?: ModifyCustomAgentResponseBodyDataCallbackConfig;
247
262
  /**
248
263
  * @remarks
249
- * The creator name.
264
+ * The name of the creator.
250
265
  *
251
266
  * @example
252
267
  * HaoY*****
@@ -254,7 +269,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
254
269
  creatorUserName?: string;
255
270
  /**
256
271
  * @remarks
257
- * The custom agent ID.
272
+ * The ID of the custom agent.
258
273
  *
259
274
  * @example
260
275
  * ca-4y3ca4khkcu**********ysf
@@ -270,7 +285,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
270
285
  DMSUnit?: string;
271
286
  /**
272
287
  * @remarks
273
- * The specified data range in JSON string format.
288
+ * The specified data scope in JSON string format.
274
289
  *
275
290
  * @example
276
291
  * {
@@ -279,7 +294,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
279
294
  * "personal" : {
280
295
  * "DataSourceType" : "remote_data_center",
281
296
  * "FileId" : "f-5qlrwaw10********s3gpw1z",
282
- * "Database" : "TestTable******.xlsx",
297
+ * "Database" : "Test_spreadsheet******.xlsx",
283
298
  * "Tables" : [ "Sheet1" ],
284
299
  * "TableIds" : [ "******" ],
285
300
  * "RegionId" : "cn-hangzhou"
@@ -292,7 +307,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
292
307
  * The description of the custom agent.
293
308
  *
294
309
  * @example
295
- * AgentTestDescription
310
+ * Agent test description
296
311
  */
297
312
  description?: string;
298
313
  /**
@@ -330,14 +345,14 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
330
345
  *
331
346
  * @example
332
347
  * Analysis framework:
333
- * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) by day, week, and month dimensions, and analyze trends and year-over-year/month-over-month fluctuations.
334
- * 2. Segment by new/existing customers, channels, and regions to identify growth sources and weaknesses.
335
- * 3. Conduct funnel analysis based on user behavior paths (browse → add to cart → payment) to identify drop-off points
348
+ * 1. Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis, and analyze trend changes as well as year-over-year and month-over-month fluctuations.
349
+ * 2. Segment data by new and returning customers, channels, and regions to identify growth drivers and weaknesses.
350
+ * 3. Conduct funnel analysis based on user behavior paths (browse -> add to cart -> pay) to locate churn points
336
351
  */
337
352
  instruction?: string;
338
353
  /**
339
354
  * @remarks
340
- * Indicates whether a periodic task is configured.
355
+ * Indicates whether a scheduled task is configured.
341
356
  *
342
357
  * @example
343
358
  * false
@@ -349,15 +364,15 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
349
364
  *
350
365
  * @example
351
366
  * Core metric definitions:
352
- * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
353
- * 2. Order volume is the number of valid orders placed per day.
354
- * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
355
- * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency
367
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both successfully paid and unpaid orders.
368
+ * 2. Order volume refers to the number of valid orders placed per day.
369
+ * 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
370
+ * 4. Conversion rate = Number of paid orders / UV, reflecting the traffic conversion efficiency
356
371
  */
357
372
  knowledge?: string;
358
373
  /**
359
374
  * @remarks
360
- * The external knowledge base list.
375
+ * The external knowledge bases.
361
376
  */
362
377
  knowledgeConfigList?: ModifyCustomAgentResponseBodyDataKnowledgeConfigList[];
363
378
  knowledgeSemanticConfigList?: ModifyCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
@@ -371,7 +386,7 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
371
386
  modifier?: string;
372
387
  /**
373
388
  * @remarks
374
- * The modifier name.
389
+ * The name of the modifier.
375
390
  *
376
391
  * @example
377
392
  * HaoY*****
@@ -382,13 +397,12 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
382
397
  * The name of the custom agent.
383
398
  *
384
399
  * @example
385
- * AgentTestName
400
+ * Agent test name
386
401
  */
387
402
  name?: string;
388
403
  /**
389
404
  * @remarks
390
- * The next run time of the periodic task.
391
- * - In timestamp format.
405
+ * The next execution time of the scheduled task in timestamp format.
392
406
  *
393
407
  * @example
394
408
  * 1767715200
@@ -413,11 +427,14 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
413
427
  /**
414
428
  * @remarks
415
429
  * The ID of the referenced historical session.
430
+ *
431
+ * @example
432
+ * 99crainsjnv*******vynid
416
433
  */
417
434
  relatedSessionId?: string;
418
435
  /**
419
436
  * @remarks
420
- * The publish time.
437
+ * The release time.
421
438
  *
422
439
  * @example
423
440
  * 2025-12-11T14:04:32.000+00:00
@@ -425,12 +442,12 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
425
442
  releaseTime?: string;
426
443
  /**
427
444
  * @remarks
428
- * The periodic task configuration.
445
+ * The scheduled task configuration.
429
446
  */
430
447
  scheduleTaskConfig?: ModifyCustomAgentResponseBodyDataScheduleTaskConfig;
431
448
  /**
432
449
  * @remarks
433
- * The custom agent status.
450
+ * The status of the custom agent.
434
451
  *
435
452
  * @example
436
453
  * RELEASED
@@ -441,18 +458,34 @@ export class ModifyCustomAgentResponseBodyData extends $dara.Model {
441
458
  * The text report format.
442
459
  *
443
460
  * @example
444
- * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
461
+ * Require all numbers in the text report to be written in Chinese characters instead of Arabic numerals
445
462
  */
446
463
  textReportConfig?: string;
464
+ /**
465
+ * @remarks
466
+ * The list of user-specified skills.
467
+ */
447
468
  userSpecifiedSkillList?: string[];
448
469
  /**
449
470
  * @remarks
450
471
  * The web report format.
451
472
  *
452
473
  * @example
453
- * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
474
+ * Require all numbers in the web report to be written in Chinese characters instead of Arabic numerals
454
475
  */
455
476
  webReportConfig?: string;
477
+ /**
478
+ * @remarks
479
+ * The web report theme. Valid values:
480
+ * - default: default.
481
+ * - journal: journal.
482
+ * - legacy: classic.
483
+ * - neobrutalism: stylized.
484
+ * - infographic: infographic.
485
+ *
486
+ * @example
487
+ * default
488
+ */
456
489
  webReportTheme?: string;
457
490
  /**
458
491
  * @remarks
@@ -579,7 +612,7 @@ export class ModifyCustomAgentResponseBody extends $dara.Model {
579
612
  errorCode?: string;
580
613
  /**
581
614
  * @remarks
582
- * The error message returned if the request failed.
615
+ * The error message returned when the call fails.
583
616
  *
584
617
  * @example
585
618
  * Specified parameter Tid is not valid.
@@ -598,7 +631,7 @@ export class ModifyCustomAgentResponseBody extends $dara.Model {
598
631
  * Indicates whether the request is successful. Valid values:
599
632
  *
600
633
  * - **true**: The request is successful.
601
- * - **false**: The request failed.
634
+ * - **false**: The request fails.
602
635
  *
603
636
  * @example
604
637
  * true
@@ -6,7 +6,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
6
6
  callbackConfigShrink?: string;
7
7
  /**
8
8
  * @remarks
9
- * The custom agent ID.
9
+ * The ID of the custom agent.
10
10
  *
11
11
  * This parameter is required.
12
12
  *
@@ -25,17 +25,17 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
25
25
  /**
26
26
  * @remarks
27
27
  * The specified data scope in **JSON character string format**.
28
- * - Common parameter description
29
- * - tableFlag: true indicates a specified data scope.
28
+ * - General parameter description
29
+ * - tableFlag: true specifies the data scope.
30
30
  * - scope: personal is a fixed value.
31
- * - personal: pass parameters for file or database types.
31
+ * - personal: parameters for file and database types.
32
32
  *
33
- * **File type**. Pass parameters in the following format:
33
+ * **File type**: pass parameters in the following format:
34
34
  * - DataSourceType: remote_data_center is a fixed value.
35
35
  * - FileId: the file ID.
36
- * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name.
37
- * - Tables: the table name returned by the ListDataCenterTable operation.
38
- * - TableIds: the TableId returned by the ListDataCenterTable operation.
36
+ * - Database: the database name returned by the ListDataCenterTable operation, which is usually the file name.
37
+ * - Tables: the table names returned by the ListDataCenterTable operation.
38
+ * - TableIds: the table IDs returned by the ListDataCenterTable operation.
39
39
  * - RegionId: the current region.
40
40
  * ```
41
41
  * {
@@ -56,16 +56,16 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
56
56
  * }
57
57
  * ```
58
58
  *
59
- * **Database type**. Pass parameters as follows:
59
+ * **Database type**: pass parameters as follows:
60
60
  * - DataSourceType: database is a fixed value.
61
- * - DmsInstanceId: the DMS instance ID returned by the data center operation.
62
- * - DmsDatabaseId: the DMS database ID returned by the data center operation.
63
- * - FileId: the instance name (deprecated).
64
- * - DbName: the database name returned by the data center operation.
65
- * - Database: the database name returned by the data center operation.
66
- * - Tables: the table name returned by the data center operation.
67
- * - TableIds: the TableId returned by the data center operation.
68
- * - Engine: the engine type (mysql or postgresql).
61
+ * - DmsInstanceId: the DMS instance ID returned by the Data Center operation.
62
+ * - DmsDatabaseId: the DMS database ID returned by the Data Center operation.
63
+ * - FileId: the instance name. **[Deprecated]**
64
+ * - DbName: the database name returned by the Data Center operation.
65
+ * - Database: the database name returned by the Data Center operation.
66
+ * - Tables: the table names returned by the Data Center operation.
67
+ * - TableIds: the table IDs returned by the Data Center operation.
68
+ * - Engine: the engine type, such as mysql or postgresql.
69
69
  * - RegionId: the current region.
70
70
  * ```
71
71
  * {
@@ -97,7 +97,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
97
97
  * "personal" : {
98
98
  * "DataSourceType" : "remote_data_center",
99
99
  * "FileId" : "f-5qlrwaw10********s3gpw1z",
100
- * "Database" : "TestTable******.xlsx",
100
+ * "Database" : "Test_spreadsheet******.xlsx",
101
101
  * "Tables" : [ "Sheet1" ],
102
102
  * "TableIds" : [ "******" ],
103
103
  * "RegionId" : "cn-hangzhou"
@@ -110,7 +110,7 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
110
110
  * The description of the custom agent.
111
111
  *
112
112
  * @example
113
- * AgentTestDescription
113
+ * Agent test description
114
114
  */
115
115
  description?: string;
116
116
  /**
@@ -120,14 +120,14 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
120
120
  executionConfigShrink?: string;
121
121
  /**
122
122
  * @remarks
123
- * The instruction.
123
+ * The instructions.
124
124
  * - Input limit: up to 10,000 characters.
125
125
  *
126
126
  * @example
127
127
  * Analysis framework:
128
- * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) by day, week, and month dimensions, and analyze trends and year-over-year/month-over-month fluctuations.
129
- * 2. Segment by new/existing customers, channels, and regions to identify growth sources and weaknesses.
130
- * 3. Conduct funnel analysis based on user behavior paths (browse → add to cart → payment) to identify drop-off points
128
+ * 1. Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis, and analyze trend changes as well as year-over-year and month-over-month fluctuations.
129
+ * 2. Segment data by new and returning customers, channels, and regions to identify growth drivers and weaknesses.
130
+ * 3. Conduct funnel analysis based on user behavior paths (browse -> add to cart -> pay) to locate churn points
131
131
  */
132
132
  instruction?: string;
133
133
  /**
@@ -137,15 +137,15 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
137
137
  *
138
138
  * @example
139
139
  * Core metric definitions:
140
- * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
141
- * 2. Order volume is the number of valid orders placed per day.
142
- * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
143
- * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency
140
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both successfully paid and unpaid orders.
141
+ * 2. Order volume refers to the number of valid orders placed per day.
142
+ * 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
143
+ * 4. Conversion rate = Number of paid orders / UV, reflecting the traffic conversion efficiency
144
144
  */
145
145
  knowledge?: string;
146
146
  /**
147
147
  * @remarks
148
- * The external knowledge base list.
148
+ * The external knowledge bases.
149
149
  */
150
150
  knowledgeConfigListShrink?: string;
151
151
  knowledgeSemanticConfigListShrink?: string;
@@ -154,12 +154,15 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
154
154
  * The name of the custom agent.
155
155
  *
156
156
  * @example
157
- * AgentTestName
157
+ * Agent test name
158
158
  */
159
159
  name?: string;
160
160
  /**
161
161
  * @remarks
162
162
  * The ID of the referenced historical session.
163
+ *
164
+ * @example
165
+ * ski-sldk8v******3owd
163
166
  */
164
167
  relatedSessionId?: string;
165
168
  /**
@@ -170,12 +173,16 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
170
173
  /**
171
174
  * @remarks
172
175
  * The text report format.
173
- * - Input limit: up to 10,000 characters.
176
+ * - Input limit: up to 10,000 characters.
174
177
  *
175
178
  * @example
176
- * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals
179
+ * Require all numbers in the text report to be written in Chinese characters instead of Arabic numerals
177
180
  */
178
181
  textReportConfig?: string;
182
+ /**
183
+ * @remarks
184
+ * The list of user-specified skills.
185
+ */
179
186
  userSpecifiedSkillListShrink?: string;
180
187
  /**
181
188
  * @remarks
@@ -183,9 +190,21 @@ export class ModifyCustomAgentShrinkRequest extends $dara.Model {
183
190
  * - Input limit: up to 50,000 characters.
184
191
  *
185
192
  * @example
186
- * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals
193
+ * Require all numbers in the web report to be written in Chinese characters instead of Arabic numerals
187
194
  */
188
195
  webReportConfig?: string;
196
+ /**
197
+ * @remarks
198
+ * The web report theme. Valid values:
199
+ * - default: default.
200
+ * - journal: journal.
201
+ * - legacy: classic.
202
+ * - neobrutalism: stylized.
203
+ * - infographic: infographic.
204
+ *
205
+ * @example
206
+ * default
207
+ */
189
208
  webReportTheme?: string;
190
209
  /**
191
210
  * @remarks
@@ -53,6 +53,7 @@ export { DescribeDataAgentSessionResponseBodyDataArtifacts } from './DescribeDat
53
53
  export { DescribeDataAgentSessionResponseBodyDataCapabilities } from './DescribeDataAgentSessionResponseBody';
54
54
  export { DescribeDataAgentSessionResponseBodyDataChatHistoryLocations } from './DescribeDataAgentSessionResponseBody';
55
55
  export { DescribeDataAgentSessionResponseBodyDataDataSources } from './DescribeDataAgentSessionResponseBody';
56
+ export { DescribeDataAgentSessionResponseBodyDataMessages } from './DescribeDataAgentSessionResponseBody';
56
57
  export { DescribeDataAgentSessionResponseBodyDataRecallResults } from './DescribeDataAgentSessionResponseBody';
57
58
  export { DescribeDataAgentSessionResponseBodyDataSessionConfig } from './DescribeDataAgentSessionResponseBody';
58
59
  export { DescribeDataAgentSessionResponseBodyData } from './DescribeDataAgentSessionResponseBody';