@alicloud/dms20250414 1.19.0 → 1.20.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 (73) hide show
  1. package/dist/client.d.ts +44 -2
  2. package/dist/client.js +126 -6
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateCustomAgentRequest.d.ts +112 -8
  5. package/dist/models/CreateCustomAgentRequest.js +31 -1
  6. package/dist/models/CreateCustomAgentRequest.js.map +1 -1
  7. package/dist/models/CreateCustomAgentResponseBody.d.ts +54 -12
  8. package/dist/models/CreateCustomAgentResponseBody.js +31 -1
  9. package/dist/models/CreateCustomAgentResponseBody.js.map +1 -1
  10. package/dist/models/CreateCustomAgentShrinkRequest.d.ts +94 -6
  11. package/dist/models/CreateCustomAgentShrinkRequest.js +2 -0
  12. package/dist/models/CreateCustomAgentShrinkRequest.js.map +1 -1
  13. package/dist/models/DescribeCustomAgentResponseBody.d.ts +36 -9
  14. package/dist/models/DescribeCustomAgentResponseBody.js +31 -1
  15. package/dist/models/DescribeCustomAgentResponseBody.js.map +1 -1
  16. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.d.ts +45 -0
  17. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.js +64 -0
  18. package/dist/models/GetDataAgentTaskModelUsageMetricsRequest.js.map +1 -0
  19. package/dist/models/GetDataAgentTaskModelUsageMetricsResponse.d.ts +19 -0
  20. package/dist/models/GetDataAgentTaskModelUsageMetricsResponse.js +69 -0
  21. package/dist/models/GetDataAgentTaskModelUsageMetricsResponse.js.map +1 -0
  22. package/dist/models/GetDataAgentTaskModelUsageMetricsResponseBody.d.ts +86 -0
  23. package/dist/models/GetDataAgentTaskModelUsageMetricsResponseBody.js +92 -0
  24. package/dist/models/GetDataAgentTaskModelUsageMetricsResponseBody.js.map +1 -0
  25. package/dist/models/GetDataAgentTaskModelUsageRequest.d.ts +45 -0
  26. package/dist/models/GetDataAgentTaskModelUsageRequest.js +64 -0
  27. package/dist/models/GetDataAgentTaskModelUsageRequest.js.map +1 -0
  28. package/dist/models/GetDataAgentTaskModelUsageResponse.d.ts +19 -0
  29. package/dist/models/GetDataAgentTaskModelUsageResponse.js +69 -0
  30. package/dist/models/GetDataAgentTaskModelUsageResponse.js.map +1 -0
  31. package/dist/models/GetDataAgentTaskModelUsageResponseBody.d.ts +97 -0
  32. package/dist/models/GetDataAgentTaskModelUsageResponseBody.js +94 -0
  33. package/dist/models/GetDataAgentTaskModelUsageResponseBody.js.map +1 -0
  34. package/dist/models/ListCustomAgentResponseBody.d.ts +17 -0
  35. package/dist/models/ListCustomAgentResponseBody.js +31 -1
  36. package/dist/models/ListCustomAgentResponseBody.js.map +1 -1
  37. package/dist/models/ModifyCustomAgentRequest.d.ts +112 -9
  38. package/dist/models/ModifyCustomAgentRequest.js +31 -1
  39. package/dist/models/ModifyCustomAgentRequest.js.map +1 -1
  40. package/dist/models/ModifyCustomAgentResponseBody.d.ts +48 -9
  41. package/dist/models/ModifyCustomAgentResponseBody.js +31 -1
  42. package/dist/models/ModifyCustomAgentResponseBody.js.map +1 -1
  43. package/dist/models/ModifyCustomAgentShrinkRequest.d.ts +93 -6
  44. package/dist/models/ModifyCustomAgentShrinkRequest.js +2 -0
  45. package/dist/models/ModifyCustomAgentShrinkRequest.js.map +1 -1
  46. package/dist/models/OneMetaSqlTemplateView.d.ts +26 -0
  47. package/dist/models/OneMetaSqlTemplateView.js +82 -0
  48. package/dist/models/OneMetaSqlTemplateView.js.map +1 -0
  49. package/dist/models/OssieModelView.d.ts +29 -0
  50. package/dist/models/OssieModelView.js +88 -0
  51. package/dist/models/OssieModelView.js.map +1 -0
  52. package/dist/models/model.d.ts +16 -0
  53. package/dist/models/model.js +67 -35
  54. package/dist/models/model.js.map +1 -1
  55. package/package.json +1 -1
  56. package/src/client.ts +142 -6
  57. package/src/models/CreateCustomAgentRequest.ts +133 -8
  58. package/src/models/CreateCustomAgentResponseBody.ts +75 -12
  59. package/src/models/CreateCustomAgentShrinkRequest.ts +96 -6
  60. package/src/models/DescribeCustomAgentResponseBody.ts +57 -9
  61. package/src/models/GetDataAgentTaskModelUsageMetricsRequest.ts +64 -0
  62. package/src/models/GetDataAgentTaskModelUsageMetricsResponse.ts +40 -0
  63. package/src/models/GetDataAgentTaskModelUsageMetricsResponseBody.ts +124 -0
  64. package/src/models/GetDataAgentTaskModelUsageRequest.ts +64 -0
  65. package/src/models/GetDataAgentTaskModelUsageResponse.ts +40 -0
  66. package/src/models/GetDataAgentTaskModelUsageResponseBody.ts +137 -0
  67. package/src/models/ListCustomAgentResponseBody.ts +38 -0
  68. package/src/models/ModifyCustomAgentRequest.ts +133 -9
  69. package/src/models/ModifyCustomAgentResponseBody.ts +69 -9
  70. package/src/models/ModifyCustomAgentShrinkRequest.ts +95 -6
  71. package/src/models/OneMetaSqlTemplateView.ts +63 -0
  72. package/src/models/OssieModelView.ts +72 -0
  73. package/src/models/model.ts +16 -0
package/src/client.ts CHANGED
@@ -13,14 +13,14 @@ export default class Client extends OpenApi {
13
13
  super(config);
14
14
  this._endpointRule = "regional";
15
15
  this._endpointMap = {
16
- 'us-west-1': "dms.us-west-1.aliyuncs.com",
17
- 'us-east-1': "dms.us-east-1.aliyuncs.com",
18
16
  'cn-shenzhen': "dms.cn-shenzhen.aliyuncs.com",
17
+ 'cn-beijing': "dms.cn-beijing.aliyuncs.com",
19
18
  'cn-shanghai': "dms.cn-shanghai.aliyuncs.com",
20
19
  'cn-hongkong': "dms.cn-hongkong.aliyuncs.com",
21
- 'cn-hangzhou': "dms.cn-hangzhou.aliyuncs.com",
22
- 'cn-beijing': "dms.cn-beijing.aliyuncs.com",
23
20
  'ap-southeast-1': "dms.ap-southeast-1.aliyuncs.com",
21
+ 'cn-hangzhou': "dms.cn-hangzhou.aliyuncs.com",
22
+ 'us-west-1': "dms.us-west-1.aliyuncs.com",
23
+ 'us-east-1': "dms.us-east-1.aliyuncs.com",
24
24
  };
25
25
  this.checkConfig(config);
26
26
  this._endpoint = this.getEndpoint("dms", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
@@ -656,6 +656,10 @@ export default class Client extends OpenApi {
656
656
  request.knowledgeConfigListShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.knowledgeConfigList, "KnowledgeConfigList", "json");
657
657
  }
658
658
 
659
+ if (!$dara.isNull(tmpReq.knowledgeSemanticConfigList)) {
660
+ request.knowledgeSemanticConfigListShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.knowledgeSemanticConfigList, "KnowledgeSemanticConfigList", "json");
661
+ }
662
+
659
663
  if (!$dara.isNull(tmpReq.scheduleTaskConfig)) {
660
664
  request.scheduleTaskConfigShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.scheduleTaskConfig, "ScheduleTaskConfig", "json");
661
665
  }
@@ -693,6 +697,10 @@ export default class Client extends OpenApi {
693
697
  query["KnowledgeConfigList"] = request.knowledgeConfigListShrink;
694
698
  }
695
699
 
700
+ if (!$dara.isNull(request.knowledgeSemanticConfigListShrink)) {
701
+ query["KnowledgeSemanticConfigList"] = request.knowledgeSemanticConfigListShrink;
702
+ }
703
+
696
704
  if (!$dara.isNull(request.name)) {
697
705
  query["Name"] = request.name;
698
706
  }
@@ -2148,7 +2156,7 @@ export default class Client extends OpenApi {
2148
2156
  }
2149
2157
 
2150
2158
  /**
2151
- * Retrieves the details of a custom agent by custom agent ID.
2159
+ * Retrieves the details of a custom agent by its ID.
2152
2160
  *
2153
2161
  * @param request - DescribeCustomAgentRequest
2154
2162
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2183,7 +2191,7 @@ export default class Client extends OpenApi {
2183
2191
  }
2184
2192
 
2185
2193
  /**
2186
- * Retrieves the details of a custom agent by custom agent ID.
2194
+ * Retrieves the details of a custom agent by its ID.
2187
2195
  *
2188
2196
  * @param request - DescribeCustomAgentRequest
2189
2197
  * @returns DescribeCustomAgentResponse
@@ -2849,6 +2857,126 @@ export default class Client extends OpenApi {
2849
2857
  return await this.getDataAgentSubAccountInfoWithOptions(request, runtime);
2850
2858
  }
2851
2859
 
2860
+ /**
2861
+ * Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the number of models used, total call count, total tokens consumed, and peak TPM.
2862
+ *
2863
+ * @remarks
2864
+ * Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the number of models used, total model call count, total tokens consumed, and peak TPM. This operation is used to analyze and monitor the model resource consumption of DataAgent analysis tasks.
2865
+ *
2866
+ * @param request - GetDataAgentTaskModelUsageRequest
2867
+ * @param runtime - runtime options for this request RuntimeOptions
2868
+ * @returns GetDataAgentTaskModelUsageResponse
2869
+ */
2870
+ async getDataAgentTaskModelUsageWithOptions(request: $_model.GetDataAgentTaskModelUsageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataAgentTaskModelUsageResponse> {
2871
+ request.validate();
2872
+ let query = { };
2873
+ if (!$dara.isNull(request.beginTime)) {
2874
+ query["BeginTime"] = request.beginTime;
2875
+ }
2876
+
2877
+ if (!$dara.isNull(request.DMSUnit)) {
2878
+ query["DMSUnit"] = request.DMSUnit;
2879
+ }
2880
+
2881
+ if (!$dara.isNull(request.endTime)) {
2882
+ query["EndTime"] = request.endTime;
2883
+ }
2884
+
2885
+ if (!$dara.isNull(request.regionId)) {
2886
+ query["RegionId"] = request.regionId;
2887
+ }
2888
+
2889
+ let req = new $OpenApiUtil.OpenApiRequest({
2890
+ query: OpenApiUtil.query(query),
2891
+ });
2892
+ let params = new $OpenApiUtil.Params({
2893
+ action: "GetDataAgentTaskModelUsage",
2894
+ version: "2025-04-14",
2895
+ protocol: "HTTPS",
2896
+ pathname: "/",
2897
+ method: "POST",
2898
+ authType: "AK",
2899
+ style: "RPC",
2900
+ reqBodyType: "formData",
2901
+ bodyType: "json",
2902
+ });
2903
+ return $dara.cast<$_model.GetDataAgentTaskModelUsageResponse>(await this.callApi(params, req, runtime), new $_model.GetDataAgentTaskModelUsageResponse({}));
2904
+ }
2905
+
2906
+ /**
2907
+ * Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the number of models used, total call count, total tokens consumed, and peak TPM.
2908
+ *
2909
+ * @remarks
2910
+ * Queries the model usage summary of DataAgent analysis tasks within a specified time range, including the number of models used, total model call count, total tokens consumed, and peak TPM. This operation is used to analyze and monitor the model resource consumption of DataAgent analysis tasks.
2911
+ *
2912
+ * @param request - GetDataAgentTaskModelUsageRequest
2913
+ * @returns GetDataAgentTaskModelUsageResponse
2914
+ */
2915
+ async getDataAgentTaskModelUsage(request: $_model.GetDataAgentTaskModelUsageRequest): Promise<$_model.GetDataAgentTaskModelUsageResponse> {
2916
+ let runtime = new $dara.RuntimeOptions({ });
2917
+ return await this.getDataAgentTaskModelUsageWithOptions(request, runtime);
2918
+ }
2919
+
2920
+ /**
2921
+ * Queries the TPM time series metrics of DataAgent analysis task model usage within a specified time range, returning token consumption at each time point with minute-level granularity.
2922
+ *
2923
+ * @remarks
2924
+ * Queries the TPM time series metrics of DataAgent analysis task model usage within a specified time range. The metrics are returned at minute-level granularity, showing the number of tokens consumed in each statistical interval for analyzing model usage trends over time.
2925
+ *
2926
+ * @param request - GetDataAgentTaskModelUsageMetricsRequest
2927
+ * @param runtime - runtime options for this request RuntimeOptions
2928
+ * @returns GetDataAgentTaskModelUsageMetricsResponse
2929
+ */
2930
+ async getDataAgentTaskModelUsageMetricsWithOptions(request: $_model.GetDataAgentTaskModelUsageMetricsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataAgentTaskModelUsageMetricsResponse> {
2931
+ request.validate();
2932
+ let query = { };
2933
+ if (!$dara.isNull(request.beginTime)) {
2934
+ query["BeginTime"] = request.beginTime;
2935
+ }
2936
+
2937
+ if (!$dara.isNull(request.DMSUnit)) {
2938
+ query["DMSUnit"] = request.DMSUnit;
2939
+ }
2940
+
2941
+ if (!$dara.isNull(request.endTime)) {
2942
+ query["EndTime"] = request.endTime;
2943
+ }
2944
+
2945
+ if (!$dara.isNull(request.regionId)) {
2946
+ query["RegionId"] = request.regionId;
2947
+ }
2948
+
2949
+ let req = new $OpenApiUtil.OpenApiRequest({
2950
+ query: OpenApiUtil.query(query),
2951
+ });
2952
+ let params = new $OpenApiUtil.Params({
2953
+ action: "GetDataAgentTaskModelUsageMetrics",
2954
+ version: "2025-04-14",
2955
+ protocol: "HTTPS",
2956
+ pathname: "/",
2957
+ method: "POST",
2958
+ authType: "AK",
2959
+ style: "RPC",
2960
+ reqBodyType: "formData",
2961
+ bodyType: "json",
2962
+ });
2963
+ return $dara.cast<$_model.GetDataAgentTaskModelUsageMetricsResponse>(await this.callApi(params, req, runtime), new $_model.GetDataAgentTaskModelUsageMetricsResponse({}));
2964
+ }
2965
+
2966
+ /**
2967
+ * Queries the TPM time series metrics of DataAgent analysis task model usage within a specified time range, returning token consumption at each time point with minute-level granularity.
2968
+ *
2969
+ * @remarks
2970
+ * Queries the TPM time series metrics of DataAgent analysis task model usage within a specified time range. The metrics are returned at minute-level granularity, showing the number of tokens consumed in each statistical interval for analyzing model usage trends over time.
2971
+ *
2972
+ * @param request - GetDataAgentTaskModelUsageMetricsRequest
2973
+ * @returns GetDataAgentTaskModelUsageMetricsResponse
2974
+ */
2975
+ async getDataAgentTaskModelUsageMetrics(request: $_model.GetDataAgentTaskModelUsageMetricsRequest): Promise<$_model.GetDataAgentTaskModelUsageMetricsResponse> {
2976
+ let runtime = new $dara.RuntimeOptions({ });
2977
+ return await this.getDataAgentTaskModelUsageMetricsWithOptions(request, runtime);
2978
+ }
2979
+
2852
2980
  /**
2853
2981
  * Retrieves the details of a collaborative workspace.
2854
2982
  *
@@ -5622,6 +5750,10 @@ export default class Client extends OpenApi {
5622
5750
  request.knowledgeConfigListShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.knowledgeConfigList, "KnowledgeConfigList", "json");
5623
5751
  }
5624
5752
 
5753
+ if (!$dara.isNull(tmpReq.knowledgeSemanticConfigList)) {
5754
+ request.knowledgeSemanticConfigListShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.knowledgeSemanticConfigList, "KnowledgeSemanticConfigList", "json");
5755
+ }
5756
+
5625
5757
  if (!$dara.isNull(tmpReq.scheduleTaskConfig)) {
5626
5758
  request.scheduleTaskConfigShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.scheduleTaskConfig, "ScheduleTaskConfig", "json");
5627
5759
  }
@@ -5663,6 +5795,10 @@ export default class Client extends OpenApi {
5663
5795
  query["KnowledgeConfigList"] = request.knowledgeConfigListShrink;
5664
5796
  }
5665
5797
 
5798
+ if (!$dara.isNull(request.knowledgeSemanticConfigListShrink)) {
5799
+ query["KnowledgeSemanticConfigList"] = request.knowledgeSemanticConfigListShrink;
5800
+ }
5801
+
5666
5802
  if (!$dara.isNull(request.name)) {
5667
5803
  query["Name"] = request.name;
5668
5804
  }
@@ -140,10 +140,42 @@ export class CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
140
140
  }
141
141
  }
142
142
 
143
+ export class CreateCustomAgentRequestKnowledgeSemanticConfigList extends $dara.Model {
144
+ dbId?: string;
145
+ instanceId?: string;
146
+ knowledgeUuid?: string;
147
+ type?: string;
148
+ static names(): { [key: string]: string } {
149
+ return {
150
+ dbId: 'DbId',
151
+ instanceId: 'InstanceId',
152
+ knowledgeUuid: 'KnowledgeUuid',
153
+ type: 'Type',
154
+ };
155
+ }
156
+
157
+ static types(): { [key: string]: any } {
158
+ return {
159
+ dbId: 'string',
160
+ instanceId: 'string',
161
+ knowledgeUuid: 'string',
162
+ type: 'string',
163
+ };
164
+ }
165
+
166
+ validate() {
167
+ super.validate();
168
+ }
169
+
170
+ constructor(map?: { [key: string]: any }) {
171
+ super(map);
172
+ }
173
+ }
174
+
143
175
  export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
144
176
  /**
145
177
  * @remarks
146
- * The cron expression for the time-based scheduling.
178
+ * The cron expression for time-based scheduling.
147
179
  *
148
180
  * @example
149
181
  * 0 0 0 ? * 1-7
@@ -154,7 +186,7 @@ export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
154
186
  * The query for the scheduled task.
155
187
  *
156
188
  * @example
157
- * Analyze this data and provide a brief report.
189
+ * Analyze this data and provide a brief report
158
190
  */
159
191
  query?: string;
160
192
  /**
@@ -194,7 +226,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
194
226
  callbackConfig?: CreateCustomAgentRequestCallbackConfig;
195
227
  /**
196
228
  * @remarks
197
- * The current DMS unit.
229
+ * The current Data Management unit.
198
230
  *
199
231
  * @example
200
232
  * cn-hangzhou
@@ -202,10 +234,85 @@ export class CreateCustomAgentRequest extends $dara.Model {
202
234
  DMSUnit?: string;
203
235
  /**
204
236
  * @remarks
205
- * The specified data scope, in **JSON string format**.
237
+ * The specified data scope in **JSON string format**.
238
+ * - Common parameter description
239
+ * - tableFlag: true indicates a specified data scope
240
+ * - scope: personal is a fixed value
241
+ * - personal: pass parameters for file or database types
242
+ *
243
+ * **File type**. Pass parameters in the following format:
244
+ * - DataSourceType: remote_data_center is a fixed value
245
+ * - FileId: the file ID
246
+ * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name
247
+ * - Tables: the table name returned by the ListDataCenterTable operation
248
+ * - TableIds: the TableId returned by the ListDataCenterTable operation
249
+ * - RegionId: the current region
250
+ * ```
251
+ * {
252
+ * "tableFlag": true,
253
+ * "scope": "personal",
254
+ * "personal": {
255
+ * "DataSourceType": "remote_data_center",
256
+ * "FileId": "f-f0jksn001ibmkoo********6v2zn6",
257
+ * "Database": "diamonds.csv",
258
+ * "Tables": [
259
+ * "diamonds"
260
+ * ],
261
+ * "TableIds": [
262
+ * "35hfn94pxl********50pi"
263
+ * ],
264
+ * "RegionId": "ap-southeast-1"
265
+ * }
266
+ * }
267
+ * ```
268
+ *
269
+ * **Database type**. Pass parameters in the following format:
270
+ * - DataSourceType: database is a fixed value
271
+ * - DmsInstanceId: the DMS instance ID returned by the data center operation
272
+ * - DmsDatabaseId: the DMS database ID returned by the data center operation
273
+ * - FileId: the instance name (deprecated)
274
+ * - DbName: the database name returned by the data center operation
275
+ * - Database: the database name returned by the data center operation
276
+ * - Tables: the table name returned by the data center operation
277
+ * - TableIds: the TableId returned by the data center operation
278
+ * - Engine: the engine type (mysql or postgresql)
279
+ * - RegionId: the current region
280
+ * ```
281
+ * {
282
+ * "tableFlag": true,
283
+ * "scope": "personal",
284
+ * "personal": {
285
+ * "DataSourceType": "database",
286
+ * "DmsInstanceId": "284***8",
287
+ * "DmsDatabaseId": "769***45",
288
+ * "FileId": "pgm-bp15095e*******6t",
289
+ * "DbName": "pg_catalog",
290
+ * "Database": "pg_catalog",
291
+ * "Tables": [
292
+ * "pg_aggregate"
293
+ * ],
294
+ * "TableIds": [
295
+ * "5263****31"
296
+ * ],
297
+ * "Engine": "postgresql",
298
+ * "RegionId": "ap-southeast-1"
299
+ * }
300
+ * }
301
+ * ```
206
302
  *
207
303
  * @example
208
304
  * {
305
+ * "tableFlag" : true,
306
+ * "scope" : "personal",
307
+ * "personal" : {
308
+ * "DataSourceType" : "remote_data_center",
309
+ * "FileId" : "f-5qlrwaw10********s3gpw1z",
310
+ * "Database" : "TestTable******.xlsx",
311
+ * "Tables" : [ "Sheet1" ],
312
+ * "TableIds" : [ "******" ],
313
+ * "RegionId" : "ap-southeast-1"
314
+ * }
315
+ * }
209
316
  */
210
317
  dataJson?: string;
211
318
  /**
@@ -213,7 +320,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
213
320
  * The description of the custom agent.
214
321
  *
215
322
  * @example
216
- * AgentTestDescription.
323
+ * AgentTestDescription
217
324
  */
218
325
  description?: string;
219
326
  /**
@@ -227,6 +334,10 @@ export class CreateCustomAgentRequest extends $dara.Model {
227
334
  *
228
335
  * @example
229
336
  * Core metric definitions:
337
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders;
338
+ * 2. Order volume is the number of valid orders placed per day;
339
+ * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app;
340
+ * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency;
230
341
  */
231
342
  instruction?: string;
232
343
  /**
@@ -235,6 +346,10 @@ export class CreateCustomAgentRequest extends $dara.Model {
235
346
  *
236
347
  * @example
237
348
  * Core metric definitions:
349
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
350
+ * 2. Order volume is the number of valid orders placed per day.
351
+ * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
352
+ * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency.
238
353
  */
239
354
  knowledge?: string;
240
355
  /**
@@ -242,14 +357,19 @@ export class CreateCustomAgentRequest extends $dara.Model {
242
357
  * The external knowledge base configurations.
243
358
  */
244
359
  knowledgeConfigList?: CreateCustomAgentRequestKnowledgeConfigList[];
360
+ knowledgeSemanticConfigList?: CreateCustomAgentRequestKnowledgeSemanticConfigList[];
245
361
  /**
246
362
  * @remarks
247
363
  * The name of the custom agent.
248
364
  *
249
365
  * @example
250
- * AgentTestName.
366
+ * AgentTestName
251
367
  */
252
368
  name?: string;
369
+ /**
370
+ * @remarks
371
+ * The ID of the referenced historical session.
372
+ */
253
373
  relatedSessionId?: string;
254
374
  /**
255
375
  * @remarks
@@ -261,7 +381,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
261
381
  * The text report format.
262
382
  *
263
383
  * @example
264
- * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals.
384
+ * The text report requires all numbers to be written in words instead of Arabic numerals
265
385
  */
266
386
  textReportConfig?: string;
267
387
  /**
@@ -269,7 +389,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
269
389
  * The web report format.
270
390
  *
271
391
  * @example
272
- * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals.
392
+ * The web report requires all numbers to be written in words instead of Arabic numerals
273
393
  */
274
394
  webReportConfig?: string;
275
395
  webReportTheme?: string;
@@ -291,6 +411,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
291
411
  instruction: 'Instruction',
292
412
  knowledge: 'Knowledge',
293
413
  knowledgeConfigList: 'KnowledgeConfigList',
414
+ knowledgeSemanticConfigList: 'KnowledgeSemanticConfigList',
294
415
  name: 'Name',
295
416
  relatedSessionId: 'RelatedSessionId',
296
417
  scheduleTaskConfig: 'ScheduleTaskConfig',
@@ -311,6 +432,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
311
432
  instruction: 'string',
312
433
  knowledge: 'string',
313
434
  knowledgeConfigList: { 'type': 'array', 'itemType': CreateCustomAgentRequestKnowledgeConfigList },
435
+ knowledgeSemanticConfigList: { 'type': 'array', 'itemType': CreateCustomAgentRequestKnowledgeSemanticConfigList },
314
436
  name: 'string',
315
437
  relatedSessionId: 'string',
316
438
  scheduleTaskConfig: CreateCustomAgentRequestScheduleTaskConfig,
@@ -331,6 +453,9 @@ export class CreateCustomAgentRequest extends $dara.Model {
331
453
  if(Array.isArray(this.knowledgeConfigList)) {
332
454
  $dara.Model.validateArray(this.knowledgeConfigList);
333
455
  }
456
+ if(Array.isArray(this.knowledgeSemanticConfigList)) {
457
+ $dara.Model.validateArray(this.knowledgeSemanticConfigList);
458
+ }
334
459
  if(this.scheduleTaskConfig && typeof (this.scheduleTaskConfig as any).validate === 'function') {
335
460
  (this.scheduleTaskConfig as any).validate();
336
461
  }
@@ -140,10 +140,42 @@ export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.
140
140
  }
141
141
  }
142
142
 
143
+ export class CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList extends $dara.Model {
144
+ dbId?: string;
145
+ instanceId?: string;
146
+ knowledgeUuid?: string;
147
+ type?: string;
148
+ static names(): { [key: string]: string } {
149
+ return {
150
+ dbId: 'DbId',
151
+ instanceId: 'InstanceId',
152
+ knowledgeUuid: 'KnowledgeUuid',
153
+ type: 'Type',
154
+ };
155
+ }
156
+
157
+ static types(): { [key: string]: any } {
158
+ return {
159
+ dbId: 'string',
160
+ instanceId: 'string',
161
+ knowledgeUuid: 'string',
162
+ type: 'string',
163
+ };
164
+ }
165
+
166
+ validate() {
167
+ super.validate();
168
+ }
169
+
170
+ constructor(map?: { [key: string]: any }) {
171
+ super(map);
172
+ }
173
+ }
174
+
143
175
  export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
144
176
  /**
145
177
  * @remarks
146
- * The cron expression for the time-based scheduling.
178
+ * The cron expression for time-based scheduling.
147
179
  *
148
180
  * @example
149
181
  * 0 0 0 ? * 1-7
@@ -154,7 +186,7 @@ export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
154
186
  * The query for the scheduled task.
155
187
  *
156
188
  * @example
157
- * Analyze this data and provide a brief report.
189
+ * Analyze this data and provide a brief report
158
190
  */
159
191
  query?: string;
160
192
  /**
@@ -226,7 +258,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
226
258
  customAgentId?: string;
227
259
  /**
228
260
  * @remarks
229
- * The current DMS unit.
261
+ * The current Data Management unit.
230
262
  *
231
263
  * @example
232
264
  * cn-hangzhou
@@ -238,6 +270,17 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
238
270
  *
239
271
  * @example
240
272
  * {
273
+ * "tableFlag" : true,
274
+ * "scope" : "personal",
275
+ * "personal" : {
276
+ * "DataSourceType" : "remote_data_center",
277
+ * "FileId" : "f-5qlrwaw10********s3gpw1z",
278
+ * "Database" : "TestTable******.xlsx",
279
+ * "Tables" : [ "Sheet1" ],
280
+ * "TableIds" : [ "******" ],
281
+ * "RegionId" : "cn-hangzhou"
282
+ * }
283
+ * }
241
284
  */
242
285
  dataJson?: string;
243
286
  /**
@@ -245,12 +288,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
245
288
  * The description of the custom agent.
246
289
  *
247
290
  * @example
248
- * AgentTestDescription.
291
+ * AgentTestDescription
249
292
  */
250
293
  description?: string;
251
294
  /**
252
295
  * @remarks
253
- * The current DMS unit.
296
+ * The current Data Management unit.
254
297
  *
255
298
  * @example
256
299
  * cn-hangzhou
@@ -283,11 +326,14 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
283
326
  *
284
327
  * @example
285
328
  * Analysis framework:
329
+ * 1. Monitor core metrics (GMV, order volume, UV, conversion rate) on a daily, weekly, and monthly basis, analyze trends and year-over-year/month-over-month fluctuations;
330
+ * 2. Segment by new/existing customers, channels, and regions to identify growth drivers and weaknesses;
331
+ * 3. Conduct funnel analysis based on user behavior paths (browsing → add to cart → payment) to pinpoint drop-off stages;
286
332
  */
287
333
  instruction?: string;
288
334
  /**
289
335
  * @remarks
290
- * Indicates whether a periodic task is configured.
336
+ * Indicates whether a scheduled task is configured.
291
337
  *
292
338
  * @example
293
339
  * false
@@ -299,6 +345,10 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
299
345
  *
300
346
  * @example
301
347
  * Core metric definitions:
348
+ * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
349
+ * 2. Order volume is the number of valid orders placed per day.
350
+ * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
351
+ * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency.
302
352
  */
303
353
  knowledge?: string;
304
354
  /**
@@ -306,6 +356,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
306
356
  * The external knowledge base configurations.
307
357
  */
308
358
  knowledgeConfigList?: CreateCustomAgentResponseBodyDataKnowledgeConfigList[];
359
+ knowledgeSemanticConfigList?: CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
309
360
  /**
310
361
  * @remarks
311
362
  * The modifier.
@@ -327,12 +378,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
327
378
  * The name of the custom agent.
328
379
  *
329
380
  * @example
330
- * AgentTestName.
381
+ * AgentTestName
331
382
  */
332
383
  name?: string;
333
384
  /**
334
385
  * @remarks
335
- * The next run time of the periodic task.
386
+ * The next run time of the scheduled task.
336
387
  *
337
388
  * @example
338
389
  * 1767715200
@@ -354,6 +405,10 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
354
405
  * cn-hangzhou
355
406
  */
356
407
  region?: string;
408
+ /**
409
+ * @remarks
410
+ * The ID of the referenced historical session.
411
+ */
357
412
  relatedSessionId?: string;
358
413
  /**
359
414
  * @remarks
@@ -365,7 +420,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
365
420
  releaseTime?: string;
366
421
  /**
367
422
  * @remarks
368
- * The periodic task configuration.
423
+ * The scheduled task configuration.
369
424
  */
370
425
  scheduleTaskConfig?: CreateCustomAgentResponseBodyDataScheduleTaskConfig;
371
426
  /**
@@ -381,7 +436,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
381
436
  * The text report format.
382
437
  *
383
438
  * @example
384
- * The text report requires all numbers to be written in Chinese characters instead of Arabic numerals.
439
+ * The text report requires all numbers to be written in words instead of Arabic numerals
385
440
  */
386
441
  textReportConfig?: string;
387
442
  /**
@@ -389,7 +444,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
389
444
  * The web report format.
390
445
  *
391
446
  * @example
392
- * The web report requires all numbers to be written in Chinese characters instead of Arabic numerals.
447
+ * The web report requires all numbers to be written in words instead of Arabic numerals
393
448
  */
394
449
  webReportConfig?: string;
395
450
  webReportTheme?: string;
@@ -419,6 +474,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
419
474
  isScheduleTask: 'IsScheduleTask',
420
475
  knowledge: 'Knowledge',
421
476
  knowledgeConfigList: 'KnowledgeConfigList',
477
+ knowledgeSemanticConfigList: 'KnowledgeSemanticConfigList',
422
478
  modifier: 'Modifier',
423
479
  modifierUserName: 'ModifierUserName',
424
480
  name: 'Name',
@@ -454,6 +510,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
454
510
  isScheduleTask: 'boolean',
455
511
  knowledge: 'string',
456
512
  knowledgeConfigList: { 'type': 'array', 'itemType': CreateCustomAgentResponseBodyDataKnowledgeConfigList },
513
+ knowledgeSemanticConfigList: { 'type': 'array', 'itemType': CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList },
457
514
  modifier: 'string',
458
515
  modifierUserName: 'string',
459
516
  name: 'string',
@@ -481,6 +538,9 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
481
538
  if(Array.isArray(this.knowledgeConfigList)) {
482
539
  $dara.Model.validateArray(this.knowledgeConfigList);
483
540
  }
541
+ if(Array.isArray(this.knowledgeSemanticConfigList)) {
542
+ $dara.Model.validateArray(this.knowledgeSemanticConfigList);
543
+ }
484
544
  if(this.scheduleTaskConfig && typeof (this.scheduleTaskConfig as any).validate === 'function') {
485
545
  (this.scheduleTaskConfig as any).validate();
486
546
  }
@@ -524,7 +584,10 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
524
584
  requestId?: string;
525
585
  /**
526
586
  * @remarks
527
- * Indicates whether the request was successful. Valid values:
587
+ * Indicates whether the request is successful. Valid values:
588
+ *
589
+ * - True: The request is successful.
590
+ * - False: The request fails.
528
591
  *
529
592
  * @example
530
593
  * true