@alicloud/dms20250414 4.0.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 +38 -8
- package/dist/client.js +119 -8
- package/dist/client.js.map +1 -1
- 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/DescribeCustomAgentMonitorMetricsRequest.d.ts +69 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsRequest.js +68 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsRequest.js.map +1 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponse.d.ts +19 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponse.js +69 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponse.js.map +1 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponseBody.d.ts +194 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponseBody.js +136 -0
- package/dist/models/DescribeCustomAgentMonitorMetricsResponseBody.js.map +1 -0
- 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/ListCustomAgentMonitorSessionsRequest.d.ts +75 -0
- package/dist/models/ListCustomAgentMonitorSessionsRequest.js +70 -0
- package/dist/models/ListCustomAgentMonitorSessionsRequest.js.map +1 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponse.d.ts +19 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponse.js +69 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponse.js.map +1 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponseBody.d.ts +208 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponseBody.js +138 -0
- package/dist/models/ListCustomAgentMonitorSessionsResponseBody.js.map +1 -0
- 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 +11 -0
- package/dist/models/model.js +39 -17
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +136 -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/DescribeCustomAgentMonitorMetricsRequest.ts +92 -0
- package/src/models/DescribeCustomAgentMonitorMetricsResponse.ts +40 -0
- package/src/models/DescribeCustomAgentMonitorMetricsResponseBody.ts +267 -0
- package/src/models/DescribeCustomAgentResponseBody.ts +84 -25
- package/src/models/DescribeDataAgentSessionRequest.ts +1 -1
- package/src/models/DescribeDataAgentSessionResponseBody.ts +115 -54
- package/src/models/ListCustomAgentMonitorSessionsRequest.ts +100 -0
- package/src/models/ListCustomAgentMonitorSessionsResponse.ts +40 -0
- package/src/models/ListCustomAgentMonitorSessionsResponseBody.ts +283 -0
- 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 +11 -0
package/src/client.ts
CHANGED
|
@@ -1922,7 +1922,7 @@ export default class Client extends OpenApi {
|
|
|
1922
1922
|
}
|
|
1923
1923
|
|
|
1924
1924
|
/**
|
|
1925
|
-
*
|
|
1925
|
+
* Queries the details of a custom agent by custom agent ID.
|
|
1926
1926
|
*
|
|
1927
1927
|
* @param request - DescribeCustomAgentRequest
|
|
1928
1928
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1957,7 +1957,7 @@ export default class Client extends OpenApi {
|
|
|
1957
1957
|
}
|
|
1958
1958
|
|
|
1959
1959
|
/**
|
|
1960
|
-
*
|
|
1960
|
+
* Queries the details of a custom agent by custom agent ID.
|
|
1961
1961
|
*
|
|
1962
1962
|
* @param request - DescribeCustomAgentRequest
|
|
1963
1963
|
* @returns DescribeCustomAgentResponse
|
|
@@ -1967,6 +1967,68 @@ export default class Client extends OpenApi {
|
|
|
1967
1967
|
return await this.describeCustomAgentWithOptions(request, runtime);
|
|
1968
1968
|
}
|
|
1969
1969
|
|
|
1970
|
+
/**
|
|
1971
|
+
* DescribeCustomAgentMonitorMetrics - Retrieves monitoring metrics data for custom agents, including trend data.
|
|
1972
|
+
*
|
|
1973
|
+
* @param request - DescribeCustomAgentMonitorMetricsRequest
|
|
1974
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1975
|
+
* @returns DescribeCustomAgentMonitorMetricsResponse
|
|
1976
|
+
*/
|
|
1977
|
+
async describeCustomAgentMonitorMetricsWithOptions(request: $_model.DescribeCustomAgentMonitorMetricsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeCustomAgentMonitorMetricsResponse> {
|
|
1978
|
+
request.validate();
|
|
1979
|
+
let query = { };
|
|
1980
|
+
if (!$dara.isNull(request.customAgentId)) {
|
|
1981
|
+
query["CustomAgentId"] = request.customAgentId;
|
|
1982
|
+
}
|
|
1983
|
+
|
|
1984
|
+
if (!$dara.isNull(request.endTime)) {
|
|
1985
|
+
query["EndTime"] = request.endTime;
|
|
1986
|
+
}
|
|
1987
|
+
|
|
1988
|
+
if (!$dara.isNull(request.granularity)) {
|
|
1989
|
+
query["Granularity"] = request.granularity;
|
|
1990
|
+
}
|
|
1991
|
+
|
|
1992
|
+
if (!$dara.isNull(request.queryType)) {
|
|
1993
|
+
query["QueryType"] = request.queryType;
|
|
1994
|
+
}
|
|
1995
|
+
|
|
1996
|
+
if (!$dara.isNull(request.startTime)) {
|
|
1997
|
+
query["StartTime"] = request.startTime;
|
|
1998
|
+
}
|
|
1999
|
+
|
|
2000
|
+
if (!$dara.isNull(request.workspaceId)) {
|
|
2001
|
+
query["WorkspaceId"] = request.workspaceId;
|
|
2002
|
+
}
|
|
2003
|
+
|
|
2004
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
2005
|
+
query: OpenApiUtil.query(query),
|
|
2006
|
+
});
|
|
2007
|
+
let params = new $OpenApiUtil.Params({
|
|
2008
|
+
action: "DescribeCustomAgentMonitorMetrics",
|
|
2009
|
+
version: "2025-04-14",
|
|
2010
|
+
protocol: "HTTPS",
|
|
2011
|
+
pathname: "/",
|
|
2012
|
+
method: "POST",
|
|
2013
|
+
authType: "AK",
|
|
2014
|
+
style: "RPC",
|
|
2015
|
+
reqBodyType: "formData",
|
|
2016
|
+
bodyType: "json",
|
|
2017
|
+
});
|
|
2018
|
+
return $dara.cast<$_model.DescribeCustomAgentMonitorMetricsResponse>(await this.callApi(params, req, runtime), new $_model.DescribeCustomAgentMonitorMetricsResponse({}));
|
|
2019
|
+
}
|
|
2020
|
+
|
|
2021
|
+
/**
|
|
2022
|
+
* DescribeCustomAgentMonitorMetrics - Retrieves monitoring metrics data for custom agents, including trend data.
|
|
2023
|
+
*
|
|
2024
|
+
* @param request - DescribeCustomAgentMonitorMetricsRequest
|
|
2025
|
+
* @returns DescribeCustomAgentMonitorMetricsResponse
|
|
2026
|
+
*/
|
|
2027
|
+
async describeCustomAgentMonitorMetrics(request: $_model.DescribeCustomAgentMonitorMetricsRequest): Promise<$_model.DescribeCustomAgentMonitorMetricsResponse> {
|
|
2028
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
2029
|
+
return await this.describeCustomAgentMonitorMetricsWithOptions(request, runtime);
|
|
2030
|
+
}
|
|
2031
|
+
|
|
1970
2032
|
/**
|
|
1971
2033
|
* Queries DataAgent metrics.
|
|
1972
2034
|
*
|
|
@@ -3686,7 +3748,7 @@ export default class Client extends OpenApi {
|
|
|
3686
3748
|
}
|
|
3687
3749
|
|
|
3688
3750
|
/**
|
|
3689
|
-
* Lists all custom agents in
|
|
3751
|
+
* Lists all custom agents in personal spaces and workspaces.
|
|
3690
3752
|
*
|
|
3691
3753
|
* @param request - ListCustomAgentRequest
|
|
3692
3754
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3737,7 +3799,7 @@ export default class Client extends OpenApi {
|
|
|
3737
3799
|
}
|
|
3738
3800
|
|
|
3739
3801
|
/**
|
|
3740
|
-
* Lists all custom agents in
|
|
3802
|
+
* Lists all custom agents in personal spaces and workspaces.
|
|
3741
3803
|
*
|
|
3742
3804
|
* @param request - ListCustomAgentRequest
|
|
3743
3805
|
* @returns ListCustomAgentResponse
|
|
@@ -3747,6 +3809,72 @@ export default class Client extends OpenApi {
|
|
|
3747
3809
|
return await this.listCustomAgentWithOptions(request, runtime);
|
|
3748
3810
|
}
|
|
3749
3811
|
|
|
3812
|
+
/**
|
|
3813
|
+
* ListCustomAgentMonitorSessions - Retrieves the list of monitoring sessions for custom agents.
|
|
3814
|
+
*
|
|
3815
|
+
* @param request - ListCustomAgentMonitorSessionsRequest
|
|
3816
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3817
|
+
* @returns ListCustomAgentMonitorSessionsResponse
|
|
3818
|
+
*/
|
|
3819
|
+
async listCustomAgentMonitorSessionsWithOptions(request: $_model.ListCustomAgentMonitorSessionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAgentMonitorSessionsResponse> {
|
|
3820
|
+
request.validate();
|
|
3821
|
+
let query = { };
|
|
3822
|
+
if (!$dara.isNull(request.customAgentId)) {
|
|
3823
|
+
query["CustomAgentId"] = request.customAgentId;
|
|
3824
|
+
}
|
|
3825
|
+
|
|
3826
|
+
if (!$dara.isNull(request.endTime)) {
|
|
3827
|
+
query["EndTime"] = request.endTime;
|
|
3828
|
+
}
|
|
3829
|
+
|
|
3830
|
+
if (!$dara.isNull(request.pageNumber)) {
|
|
3831
|
+
query["PageNumber"] = request.pageNumber;
|
|
3832
|
+
}
|
|
3833
|
+
|
|
3834
|
+
if (!$dara.isNull(request.pageSize)) {
|
|
3835
|
+
query["PageSize"] = request.pageSize;
|
|
3836
|
+
}
|
|
3837
|
+
|
|
3838
|
+
if (!$dara.isNull(request.queryType)) {
|
|
3839
|
+
query["QueryType"] = request.queryType;
|
|
3840
|
+
}
|
|
3841
|
+
|
|
3842
|
+
if (!$dara.isNull(request.startTime)) {
|
|
3843
|
+
query["StartTime"] = request.startTime;
|
|
3844
|
+
}
|
|
3845
|
+
|
|
3846
|
+
if (!$dara.isNull(request.workspaceId)) {
|
|
3847
|
+
query["WorkspaceId"] = request.workspaceId;
|
|
3848
|
+
}
|
|
3849
|
+
|
|
3850
|
+
let req = new $OpenApiUtil.OpenApiRequest({
|
|
3851
|
+
query: OpenApiUtil.query(query),
|
|
3852
|
+
});
|
|
3853
|
+
let params = new $OpenApiUtil.Params({
|
|
3854
|
+
action: "ListCustomAgentMonitorSessions",
|
|
3855
|
+
version: "2025-04-14",
|
|
3856
|
+
protocol: "HTTPS",
|
|
3857
|
+
pathname: "/",
|
|
3858
|
+
method: "POST",
|
|
3859
|
+
authType: "AK",
|
|
3860
|
+
style: "RPC",
|
|
3861
|
+
reqBodyType: "formData",
|
|
3862
|
+
bodyType: "json",
|
|
3863
|
+
});
|
|
3864
|
+
return $dara.cast<$_model.ListCustomAgentMonitorSessionsResponse>(await this.callApi(params, req, runtime), new $_model.ListCustomAgentMonitorSessionsResponse({}));
|
|
3865
|
+
}
|
|
3866
|
+
|
|
3867
|
+
/**
|
|
3868
|
+
* ListCustomAgentMonitorSessions - Retrieves the list of monitoring sessions for custom agents.
|
|
3869
|
+
*
|
|
3870
|
+
* @param request - ListCustomAgentMonitorSessionsRequest
|
|
3871
|
+
* @returns ListCustomAgentMonitorSessionsResponse
|
|
3872
|
+
*/
|
|
3873
|
+
async listCustomAgentMonitorSessions(request: $_model.ListCustomAgentMonitorSessionsRequest): Promise<$_model.ListCustomAgentMonitorSessionsResponse> {
|
|
3874
|
+
let runtime = new $dara.RuntimeOptions({ });
|
|
3875
|
+
return await this.listCustomAgentMonitorSessionsWithOptions(request, runtime);
|
|
3876
|
+
}
|
|
3877
|
+
|
|
3750
3878
|
/**
|
|
3751
3879
|
* Lists accuracy test configuration items that meet the specified conditions.
|
|
3752
3880
|
*
|
|
@@ -4338,7 +4466,7 @@ export default class Client extends OpenApi {
|
|
|
4338
4466
|
}
|
|
4339
4467
|
|
|
4340
4468
|
/**
|
|
4341
|
-
* Retrieves
|
|
4469
|
+
* Retrieves a paginated list of collaborative workspaces under the primary account.
|
|
4342
4470
|
*
|
|
4343
4471
|
* @param request - ListDataAgentWorkspaceRequest
|
|
4344
4472
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4405,7 +4533,7 @@ export default class Client extends OpenApi {
|
|
|
4405
4533
|
}
|
|
4406
4534
|
|
|
4407
4535
|
/**
|
|
4408
|
-
* Retrieves
|
|
4536
|
+
* Retrieves a paginated list of collaborative workspaces under the primary account.
|
|
4409
4537
|
*
|
|
4410
4538
|
* @param request - ListDataAgentWorkspaceRequest
|
|
4411
4539
|
* @returns ListDataAgentWorkspaceResponse
|
|
@@ -5090,7 +5218,7 @@ export default class Client extends OpenApi {
|
|
|
5090
5218
|
}
|
|
5091
5219
|
|
|
5092
5220
|
/**
|
|
5093
|
-
* Modifies a custom agent in a personal
|
|
5221
|
+
* Modifies a custom agent in a personal or shared workspace.
|
|
5094
5222
|
*
|
|
5095
5223
|
* @param tmpReq - ModifyCustomAgentRequest
|
|
5096
5224
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5215,7 +5343,7 @@ export default class Client extends OpenApi {
|
|
|
5215
5343
|
}
|
|
5216
5344
|
|
|
5217
5345
|
/**
|
|
5218
|
-
* Modifies a custom agent in a personal
|
|
5346
|
+
* Modifies a custom agent in a personal or shared workspace.
|
|
5219
5347
|
*
|
|
5220
5348
|
* @param request - ModifyCustomAgentRequest
|
|
5221
5349
|
* @returns ModifyCustomAgentResponse
|
|
@@ -38,6 +38,13 @@ export class CreateCustomAgentRequestCallbackConfig extends $dara.Model {
|
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
export class CreateCustomAgentRequestExecutionConfig 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
|
|
@@ -103,18 +110,25 @@ export class CreateCustomAgentRequestExecutionConfig extends $dara.Model {
|
|
|
103
110
|
export class CreateCustomAgentRequestKnowledgeConfigList extends $dara.Model {
|
|
104
111
|
/**
|
|
105
112
|
* @remarks
|
|
106
|
-
* The access type.
|
|
107
|
-
*
|
|
108
|
-
* -
|
|
113
|
+
* The access type. If you do not specify this parameter, the default value is mcp. Valid values:
|
|
114
|
+
* - mcp: Access through MCP. The McpServerId parameter is required.
|
|
115
|
+
* - dms_kb: Access through a DMS knowledge base. The KbUuid parameter is required.
|
|
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
|
|
131
|
+
* The ID of the MCP server.
|
|
118
132
|
*
|
|
119
133
|
* @example
|
|
120
134
|
* nhdpt9adf6ac**********ca
|
|
@@ -180,7 +194,7 @@ export class CreateCustomAgentRequestKnowledgeSemanticConfigList extends $dara.M
|
|
|
180
194
|
export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
|
|
181
195
|
/**
|
|
182
196
|
* @remarks
|
|
183
|
-
* The cron expression for
|
|
197
|
+
* The cron expression for periodic scheduling.
|
|
184
198
|
*
|
|
185
199
|
* @example
|
|
186
200
|
* 0 0 0 ? * 1-7
|
|
@@ -188,7 +202,7 @@ export class CreateCustomAgentRequestScheduleTaskConfig extends $dara.Model {
|
|
|
188
202
|
cronExpression?: string;
|
|
189
203
|
/**
|
|
190
204
|
* @remarks
|
|
191
|
-
* The query for the
|
|
205
|
+
* The query for the periodic task.
|
|
192
206
|
*
|
|
193
207
|
* @example
|
|
194
208
|
* Analyze this data and provide a brief report
|
|
@@ -239,19 +253,19 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
239
253
|
DMSUnit?: string;
|
|
240
254
|
/**
|
|
241
255
|
* @remarks
|
|
242
|
-
* The specified data scope in **JSON character string format**.
|
|
243
|
-
* - Common
|
|
244
|
-
* - tableFlag: true
|
|
256
|
+
* The specified data scope, in **JSON character string format**.
|
|
257
|
+
* - Common parameter description
|
|
258
|
+
* - tableFlag: true specifies the data scope.
|
|
245
259
|
* - scope: personal is a fixed value.
|
|
246
|
-
* - personal:
|
|
260
|
+
* - personal: the parameters for file and database types.
|
|
247
261
|
*
|
|
248
|
-
* **File type
|
|
262
|
+
* **File type**: Pass parameters in the following format:
|
|
249
263
|
* - DataSourceType: remote_data_center is a fixed value.
|
|
250
|
-
* - FileId:
|
|
251
|
-
* - Database:
|
|
252
|
-
* - Tables:
|
|
253
|
-
* - TableIds:
|
|
254
|
-
* - RegionId:
|
|
264
|
+
* - FileId: The file ID.
|
|
265
|
+
* - Database: The database name returned by the ListDataCenterTable operation, which is usually the file name.
|
|
266
|
+
* - Tables: The table names returned by the ListDataCenterTable operation.
|
|
267
|
+
* - TableIds: The table IDs returned by the ListDataCenterTable operation.
|
|
268
|
+
* - RegionId: The current region.
|
|
255
269
|
* ```
|
|
256
270
|
* {
|
|
257
271
|
* "tableFlag": true,
|
|
@@ -271,17 +285,17 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
271
285
|
* }
|
|
272
286
|
* ```
|
|
273
287
|
*
|
|
274
|
-
* **Database type
|
|
288
|
+
* **Database type**: Pass parameters as follows:
|
|
275
289
|
* - DataSourceType: database is a fixed value.
|
|
276
|
-
* - DmsInstanceId:
|
|
277
|
-
* - DmsDatabaseId:
|
|
278
|
-
* - FileId:
|
|
279
|
-
* - DbName:
|
|
280
|
-
* - Database:
|
|
281
|
-
* - Tables:
|
|
282
|
-
* - TableIds:
|
|
283
|
-
* - Engine:
|
|
284
|
-
* - RegionId:
|
|
290
|
+
* - DmsInstanceId: The DMS instance ID returned by the Data Center API.
|
|
291
|
+
* - DmsDatabaseId: The DMS database ID returned by the Data Center API.
|
|
292
|
+
* - FileId: The instance name. **[Deprecated]**
|
|
293
|
+
* - DbName: The database name returned by the Data Center API.
|
|
294
|
+
* - Database: The database name returned by the Data Center API.
|
|
295
|
+
* - Tables: The table names returned by the Data Center API.
|
|
296
|
+
* - TableIds: The table IDs returned by the Data Center API.
|
|
297
|
+
* - Engine: The engine type, such as mysql or postgresql.
|
|
298
|
+
* - RegionId: The current region.
|
|
285
299
|
* ```
|
|
286
300
|
* {
|
|
287
301
|
* "tableFlag": true,
|
|
@@ -312,7 +326,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
312
326
|
* "personal" : {
|
|
313
327
|
* "DataSourceType" : "remote_data_center",
|
|
314
328
|
* "FileId" : "f-5qlrwaw10********s3gpw1z",
|
|
315
|
-
* "Database" : "
|
|
329
|
+
* "Database" : "TestTable******.xlsx",
|
|
316
330
|
* "Tables" : [ "Sheet1" ],
|
|
317
331
|
* "TableIds" : [ "******" ],
|
|
318
332
|
* "RegionId" : "cn-hangzhou"
|
|
@@ -325,7 +339,7 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
325
339
|
* The description of the custom agent.
|
|
326
340
|
*
|
|
327
341
|
* @example
|
|
328
|
-
*
|
|
342
|
+
* Agent test description
|
|
329
343
|
*/
|
|
330
344
|
description?: string;
|
|
331
345
|
/**
|
|
@@ -335,33 +349,33 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
335
349
|
executionConfig?: CreateCustomAgentRequestExecutionConfig;
|
|
336
350
|
/**
|
|
337
351
|
* @remarks
|
|
338
|
-
* The
|
|
339
|
-
* - Input limit:
|
|
352
|
+
* The instructions.
|
|
353
|
+
* - Input limit: A maximum of 10,000 characters.
|
|
340
354
|
*
|
|
341
355
|
* @example
|
|
342
356
|
* Core metric definitions:
|
|
343
|
-
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
|
|
344
|
-
* 2. Order volume
|
|
345
|
-
* 3. UV (Unique Visitors) refers to the
|
|
346
|
-
* 4. Conversion rate =
|
|
357
|
+
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
|
|
358
|
+
* 2. Order volume refers to the number of valid orders placed per day.
|
|
359
|
+
* 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
|
|
360
|
+
* 4. Conversion rate = Number of paid orders / UV, which reflects the traffic conversion efficiency
|
|
347
361
|
*/
|
|
348
362
|
instruction?: string;
|
|
349
363
|
/**
|
|
350
364
|
* @remarks
|
|
351
365
|
* The knowledge.
|
|
352
|
-
* - Input limit:
|
|
366
|
+
* - Input limit: A maximum of 10,000 characters.
|
|
353
367
|
*
|
|
354
368
|
* @example
|
|
355
369
|
* Core metric definitions:
|
|
356
|
-
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
|
|
357
|
-
* 2. Order volume
|
|
358
|
-
* 3. UV (Unique Visitors) refers to the
|
|
359
|
-
* 4. Conversion rate =
|
|
370
|
+
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
|
|
371
|
+
* 2. Order volume refers to the number of valid orders placed per day.
|
|
372
|
+
* 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
|
|
373
|
+
* 4. Conversion rate = Number of paid orders / UV, which reflects the traffic conversion efficiency
|
|
360
374
|
*/
|
|
361
375
|
knowledge?: string;
|
|
362
376
|
/**
|
|
363
377
|
* @remarks
|
|
364
|
-
* The external knowledge
|
|
378
|
+
* The external knowledge bases.
|
|
365
379
|
*/
|
|
366
380
|
knowledgeConfigList?: CreateCustomAgentRequestKnowledgeConfigList[];
|
|
367
381
|
knowledgeSemanticConfigList?: CreateCustomAgentRequestKnowledgeSemanticConfigList[];
|
|
@@ -370,12 +384,15 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
370
384
|
* The name of the custom agent.
|
|
371
385
|
*
|
|
372
386
|
* @example
|
|
373
|
-
*
|
|
387
|
+
* Agent test name
|
|
374
388
|
*/
|
|
375
389
|
name?: string;
|
|
376
390
|
/**
|
|
377
391
|
* @remarks
|
|
378
392
|
* The ID of the referenced historical session.
|
|
393
|
+
*
|
|
394
|
+
* @example
|
|
395
|
+
* 99crainsjnveo*******vynid
|
|
379
396
|
*/
|
|
380
397
|
relatedSessionId?: string;
|
|
381
398
|
/**
|
|
@@ -388,18 +405,29 @@ export class CreateCustomAgentRequest extends $dara.Model {
|
|
|
388
405
|
* The text report format.
|
|
389
406
|
*
|
|
390
407
|
* @example
|
|
391
|
-
*
|
|
408
|
+
* All numbers in the text report must be written in Chinese characters instead of Arabic numerals
|
|
392
409
|
*/
|
|
393
410
|
textReportConfig?: string;
|
|
411
|
+
/**
|
|
412
|
+
* @remarks
|
|
413
|
+
* The list of user-specified skills.
|
|
414
|
+
*/
|
|
394
415
|
userSpecifiedSkillList?: string[];
|
|
395
416
|
/**
|
|
396
417
|
* @remarks
|
|
397
418
|
* The web report format.
|
|
398
419
|
*
|
|
399
420
|
* @example
|
|
400
|
-
*
|
|
421
|
+
* All numbers in the web report must be written in Chinese characters instead of Arabic numerals
|
|
401
422
|
*/
|
|
402
423
|
webReportConfig?: string;
|
|
424
|
+
/**
|
|
425
|
+
* @remarks
|
|
426
|
+
* The web report theme.
|
|
427
|
+
*
|
|
428
|
+
* @example
|
|
429
|
+
* Default
|
|
430
|
+
*/
|
|
403
431
|
webReportTheme?: string;
|
|
404
432
|
/**
|
|
405
433
|
* @remarks
|
|
@@ -38,6 +38,13 @@ export class CreateCustomAgentResponseBodyDataCallbackConfig extends $dara.Model
|
|
|
38
38
|
}
|
|
39
39
|
|
|
40
40
|
export class CreateCustomAgentResponseBodyDataExecutionConfig 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
|
|
@@ -103,18 +110,25 @@ export class CreateCustomAgentResponseBodyDataExecutionConfig extends $dara.Mode
|
|
|
103
110
|
export class CreateCustomAgentResponseBodyDataKnowledgeConfigList extends $dara.Model {
|
|
104
111
|
/**
|
|
105
112
|
* @remarks
|
|
106
|
-
* The access type.
|
|
107
|
-
*
|
|
108
|
-
* -
|
|
113
|
+
* The access type. Valid values:
|
|
114
|
+
* - mcp: MCP access.
|
|
115
|
+
* - dms_kb: DMS knowledge base access.
|
|
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
|
|
131
|
+
* The ID of the MCP server.
|
|
118
132
|
*
|
|
119
133
|
* @example
|
|
120
134
|
* nhdpt9adf6ac**********ca
|
|
@@ -180,7 +194,7 @@ export class CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList extend
|
|
|
180
194
|
export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.Model {
|
|
181
195
|
/**
|
|
182
196
|
* @remarks
|
|
183
|
-
* The cron expression for
|
|
197
|
+
* The cron expression for periodic scheduling.
|
|
184
198
|
*
|
|
185
199
|
* @example
|
|
186
200
|
* 0 0 0 ? * 1-7
|
|
@@ -188,7 +202,7 @@ export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
|
|
|
188
202
|
cronExpression?: string;
|
|
189
203
|
/**
|
|
190
204
|
* @remarks
|
|
191
|
-
* The query for the
|
|
205
|
+
* The query for the periodic task.
|
|
192
206
|
*
|
|
193
207
|
* @example
|
|
194
208
|
* Analyze this data and provide a brief report
|
|
@@ -230,7 +244,7 @@ export class CreateCustomAgentResponseBodyDataScheduleTaskConfig extends $dara.M
|
|
|
230
244
|
export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
231
245
|
/**
|
|
232
246
|
* @remarks
|
|
233
|
-
* The Alibaba Cloud account ID
|
|
247
|
+
* The primary Alibaba Cloud account ID.
|
|
234
248
|
*
|
|
235
249
|
* @example
|
|
236
250
|
* 16738266********
|
|
@@ -280,7 +294,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
280
294
|
* "personal" : {
|
|
281
295
|
* "DataSourceType" : "remote_data_center",
|
|
282
296
|
* "FileId" : "f-5qlrwaw10********s3gpw1z",
|
|
283
|
-
* "Database" : "
|
|
297
|
+
* "Database" : "TestTable******.xlsx",
|
|
284
298
|
* "Tables" : [ "Sheet1" ],
|
|
285
299
|
* "TableIds" : [ "******" ],
|
|
286
300
|
* "RegionId" : "cn-hangzhou"
|
|
@@ -293,7 +307,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
293
307
|
* The description of the custom agent.
|
|
294
308
|
*
|
|
295
309
|
* @example
|
|
296
|
-
*
|
|
310
|
+
* Agent test description
|
|
297
311
|
*/
|
|
298
312
|
description?: string;
|
|
299
313
|
/**
|
|
@@ -331,14 +345,14 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
331
345
|
*
|
|
332
346
|
* @example
|
|
333
347
|
* Analysis framework:
|
|
334
|
-
* 1. Monitor core metrics (GMV, order volume, UV, conversion rate) on a daily, weekly, and monthly basis, and analyze
|
|
335
|
-
* 2. Segment by new
|
|
336
|
-
* 3. Conduct funnel analysis based on user behavior
|
|
348
|
+
* 1. Monitor core metrics (GMV, order volume, UV, and conversion rate) on a daily, weekly, and monthly basis, and analyze trend changes and year-over-year or 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 the user behavior path (browse -> add to cart -> pay) to locate churn points
|
|
337
351
|
*/
|
|
338
352
|
instruction?: string;
|
|
339
353
|
/**
|
|
340
354
|
* @remarks
|
|
341
|
-
* Indicates whether a
|
|
355
|
+
* Indicates whether a scheduled task is configured.
|
|
342
356
|
*
|
|
343
357
|
* @example
|
|
344
358
|
* false
|
|
@@ -350,15 +364,15 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
350
364
|
*
|
|
351
365
|
* @example
|
|
352
366
|
* Core metric definitions:
|
|
353
|
-
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
|
|
354
|
-
* 2. Order volume
|
|
355
|
-
* 3. UV (Unique Visitors) refers to the
|
|
356
|
-
* 4. Conversion rate =
|
|
367
|
+
* 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both 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, which reflects the traffic conversion efficiency
|
|
357
371
|
*/
|
|
358
372
|
knowledge?: string;
|
|
359
373
|
/**
|
|
360
374
|
* @remarks
|
|
361
|
-
* The external knowledge
|
|
375
|
+
* The external knowledge bases.
|
|
362
376
|
*/
|
|
363
377
|
knowledgeConfigList?: CreateCustomAgentResponseBodyDataKnowledgeConfigList[];
|
|
364
378
|
knowledgeSemanticConfigList?: CreateCustomAgentResponseBodyDataKnowledgeSemanticConfigList[];
|
|
@@ -383,12 +397,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
383
397
|
* The name of the custom agent.
|
|
384
398
|
*
|
|
385
399
|
* @example
|
|
386
|
-
*
|
|
400
|
+
* Agent test name
|
|
387
401
|
*/
|
|
388
402
|
name?: string;
|
|
389
403
|
/**
|
|
390
404
|
* @remarks
|
|
391
|
-
* The next
|
|
405
|
+
* The next execution time of the scheduled task.
|
|
392
406
|
* - Timestamp format.
|
|
393
407
|
*
|
|
394
408
|
* @example
|
|
@@ -418,7 +432,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
418
432
|
relatedSessionId?: string;
|
|
419
433
|
/**
|
|
420
434
|
* @remarks
|
|
421
|
-
* The
|
|
435
|
+
* The release time.
|
|
422
436
|
*
|
|
423
437
|
* @example
|
|
424
438
|
* 2025-12-11T14:04:32.000+00:00
|
|
@@ -426,7 +440,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
426
440
|
releaseTime?: string;
|
|
427
441
|
/**
|
|
428
442
|
* @remarks
|
|
429
|
-
* The
|
|
443
|
+
* The scheduled task configuration.
|
|
430
444
|
*/
|
|
431
445
|
scheduleTaskConfig?: CreateCustomAgentResponseBodyDataScheduleTaskConfig;
|
|
432
446
|
/**
|
|
@@ -442,18 +456,34 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
|
|
|
442
456
|
* The text report format.
|
|
443
457
|
*
|
|
444
458
|
* @example
|
|
445
|
-
*
|
|
459
|
+
* All numbers in the text report must be written in Chinese characters instead of Arabic numerals
|
|
446
460
|
*/
|
|
447
461
|
textReportConfig?: string;
|
|
462
|
+
/**
|
|
463
|
+
* @remarks
|
|
464
|
+
* The list of user-specified skills.
|
|
465
|
+
*/
|
|
448
466
|
userSpecifiedSkillList?: string[];
|
|
449
467
|
/**
|
|
450
468
|
* @remarks
|
|
451
469
|
* The web report format.
|
|
452
470
|
*
|
|
453
471
|
* @example
|
|
454
|
-
*
|
|
472
|
+
* All numbers in the web report must be written in Chinese characters instead of Arabic numerals
|
|
455
473
|
*/
|
|
456
474
|
webReportConfig?: string;
|
|
475
|
+
/**
|
|
476
|
+
* @remarks
|
|
477
|
+
* The web report theme. Valid values:
|
|
478
|
+
* - default: Default.
|
|
479
|
+
* - journal: Journal.
|
|
480
|
+
* - legacy: Legacy.
|
|
481
|
+
* - neobrutalism: Neobrutalism.
|
|
482
|
+
* - infographic: Infographic.
|
|
483
|
+
*
|
|
484
|
+
* @example
|
|
485
|
+
* default
|
|
486
|
+
*/
|
|
457
487
|
webReportTheme?: string;
|
|
458
488
|
/**
|
|
459
489
|
* @remarks
|
|
@@ -580,7 +610,7 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
|
|
|
580
610
|
errorCode?: string;
|
|
581
611
|
/**
|
|
582
612
|
* @remarks
|
|
583
|
-
* The error message returned when the
|
|
613
|
+
* The error message returned when the call fails.
|
|
584
614
|
*
|
|
585
615
|
* @example
|
|
586
616
|
* Specified parameter Tid is not valid.
|
|
@@ -596,10 +626,9 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
|
|
|
596
626
|
requestId?: string;
|
|
597
627
|
/**
|
|
598
628
|
* @remarks
|
|
599
|
-
* Indicates whether the request
|
|
600
|
-
*
|
|
601
|
-
* -
|
|
602
|
-
* - False: The request failed.
|
|
629
|
+
* Indicates whether the request is successful. Valid values:
|
|
630
|
+
* - True: The request is successful.
|
|
631
|
+
* - False: The request fails.
|
|
603
632
|
*
|
|
604
633
|
* @example
|
|
605
634
|
* true
|