@alicloud/dms20250414 4.2.0 → 4.2.2
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 +10 -10
- package/dist/client.js +13 -10
- package/dist/client.js.map +1 -1
- package/dist/models/CreateDataAgentSkillMetaRequest.d.ts +12 -6
- package/dist/models/CreateDataAgentSkillMetaRequest.js +2 -0
- package/dist/models/CreateDataAgentSkillMetaRequest.js.map +1 -1
- package/dist/models/CreateDataAgentSkillMetaResponseBody.d.ts +5 -8
- package/dist/models/CreateDataAgentSkillMetaResponseBody.js.map +1 -1
- package/dist/models/SendChatMessageRequest.d.ts +83 -67
- package/dist/models/SendChatMessageRequest.js +4 -0
- package/dist/models/SendChatMessageRequest.js.map +1 -1
- package/dist/models/SendChatMessageShrinkRequest.d.ts +20 -20
- package/dist/models/UpdateAgenticDataSourceRequest.d.ts +31 -16
- package/dist/models/UpdateAgenticDataSourceRequest.js.map +1 -1
- package/dist/models/UpdateAgenticDataSourceResponseBody.d.ts +21 -21
- package/package.json +1 -1
- package/src/client.ts +14 -10
- package/src/models/CreateDataAgentSkillMetaRequest.ts +14 -6
- package/src/models/CreateDataAgentSkillMetaResponseBody.ts +5 -8
- package/src/models/SendChatMessageRequest.ts +87 -67
- package/src/models/SendChatMessageShrinkRequest.ts +20 -20
- package/src/models/UpdateAgenticDataSourceRequest.ts +31 -16
- package/src/models/UpdateAgenticDataSourceResponseBody.ts +21 -21
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* **[Optimized]** This field is now automatically
|
|
8
|
+
* **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* agent_***
|
|
@@ -13,7 +13,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
13
13
|
agentId?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* **[Optimized]** This field is now automatically
|
|
16
|
+
* **[Optimized]** This field is now automatically retrieved in the background. You do not need to specify it when calling the API.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* cn-hangzhou
|
|
@@ -21,7 +21,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
21
21
|
DMSUnit?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* The data source information. This parameter can be left empty.
|
|
24
|
+
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter. Use the DataSources parameter instead.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* null
|
|
@@ -34,7 +34,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
34
34
|
dataSourcesShrink?: string;
|
|
35
35
|
/**
|
|
36
36
|
* @remarks
|
|
37
|
-
* The
|
|
37
|
+
* The content of the message sent to the agent.
|
|
38
38
|
*
|
|
39
39
|
* This parameter is required.
|
|
40
40
|
*
|
|
@@ -44,15 +44,15 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
44
44
|
message?: string;
|
|
45
45
|
/**
|
|
46
46
|
* @remarks
|
|
47
|
-
* The message type. Default value: `
|
|
47
|
+
* The message type. Default value: `primary`.
|
|
48
48
|
*
|
|
49
|
-
* -
|
|
49
|
+
* - In normal interactions with the agent, the message type is `primary`.
|
|
50
50
|
*
|
|
51
|
-
* - When the message is a response to
|
|
51
|
+
* - When the message is a response to a human-in-the-loop question from the agent, the type must be `additional`.
|
|
52
52
|
*
|
|
53
|
-
* - When the message is intended to trigger report generation,
|
|
53
|
+
* - When the message is intended to trigger report generation, the type must be `report`.
|
|
54
54
|
*
|
|
55
|
-
* - When the message is intended to cancel the current session,
|
|
55
|
+
* - When the message is intended to cancel the current session, the type must be `cancel`.
|
|
56
56
|
*
|
|
57
57
|
* @example
|
|
58
58
|
* primary
|
|
@@ -60,7 +60,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
60
60
|
messageType?: string;
|
|
61
61
|
/**
|
|
62
62
|
* @remarks
|
|
63
|
-
* The parent session
|
|
63
|
+
* The ID of the parent session.
|
|
64
64
|
*
|
|
65
65
|
* @example
|
|
66
66
|
* 20qrliuoo7p2vlsfg*****
|
|
@@ -68,15 +68,15 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
68
68
|
parentSessionId?: string;
|
|
69
69
|
/**
|
|
70
70
|
* @remarks
|
|
71
|
-
*
|
|
71
|
+
* Required when the message type is `additional`. Specifies the specific question asked by the agent to the user through human-in-the-loop.
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
|
-
* Provide the criteria for
|
|
74
|
+
* Provide the calculation criteria for GMV
|
|
75
75
|
*/
|
|
76
76
|
question?: string;
|
|
77
77
|
/**
|
|
78
78
|
* @remarks
|
|
79
|
-
* The quoted content. This is typically used
|
|
79
|
+
* The quoted content. This is typically used when interacting with the agent.
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* {"version":"v0"}
|
|
@@ -86,9 +86,9 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
86
86
|
* @remarks
|
|
87
87
|
* **Important**
|
|
88
88
|
*
|
|
89
|
-
* When this message is a reply to an
|
|
89
|
+
* When this message is a reply to an agent message, such as an agent asking for clarification through ASK_HUMAN, `reply_to` must exactly match the checkpoint sequence number carried by that agent message. If this message is not a targeted reply, such as requesting the agent to perform further in-depth analysis after the initial analysis is complete, you can leave `reply_to` empty or set it to "0".
|
|
90
90
|
*
|
|
91
|
-
* This field affects how the
|
|
91
|
+
* This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
|
|
92
92
|
*
|
|
93
93
|
* @example
|
|
94
94
|
* 0
|
|
@@ -96,7 +96,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
96
96
|
replyTo?: string;
|
|
97
97
|
/**
|
|
98
98
|
* @remarks
|
|
99
|
-
* The special
|
|
99
|
+
* The special configurations for the current session. For the same session, only the configurations specified in the first SendMessage call take effect.
|
|
100
100
|
*
|
|
101
101
|
* **if can be null:**
|
|
102
102
|
* true
|
|
@@ -104,10 +104,10 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
104
104
|
sessionConfigShrink?: string;
|
|
105
105
|
/**
|
|
106
106
|
* @remarks
|
|
107
|
-
* The session ID. This
|
|
108
|
-
* - You can start a session without specifying this field. The response
|
|
107
|
+
* The session ID. This optional field is used for multi-turn sessions.
|
|
108
|
+
* - You can start a session without specifying this field. The response will include the session ID for the current session.
|
|
109
109
|
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating a session.
|
|
110
|
-
* -
|
|
110
|
+
* - If you need multi-turn conversations, such as follow-up questions or confirming execution plans, specify the session ID returned by the previous SendChatMessage operation in this operation.
|
|
111
111
|
*
|
|
112
112
|
* @example
|
|
113
113
|
* sess_***
|
|
@@ -120,7 +120,7 @@ export class SendChatMessageShrinkRequest extends $dara.Model {
|
|
|
120
120
|
taskConfigShrink?: string;
|
|
121
121
|
/**
|
|
122
122
|
* @remarks
|
|
123
|
-
* The OSS bucket of the user. If this parameter is
|
|
123
|
+
* The Object Storage Service (OSS) bucket of the user. If this parameter is left empty, the analysis process is securely stored in the built-in storage.
|
|
124
124
|
*
|
|
125
125
|
* @example
|
|
126
126
|
* my-bucket
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The new display name of the data source. If
|
|
8
|
+
* The new display name of the data source. If you do not specify this parameter, the alias is not updated.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* demo_mysql
|
|
@@ -13,7 +13,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
13
13
|
alias?: string;
|
|
14
14
|
/**
|
|
15
15
|
* @remarks
|
|
16
|
-
* The new logon username. If
|
|
16
|
+
* The new logon username. If you do not specify this parameter, the authentication account is not updated.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* db_user
|
|
@@ -21,7 +21,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
21
21
|
authAccount?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @remarks
|
|
24
|
-
* The new logon password. If
|
|
24
|
+
* The new logon password. If you do not specify this parameter, the authentication password is not updated. This is sensitive information. Do not record or disclose it.
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* P@ss****
|
|
@@ -29,7 +29,12 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
29
29
|
authPassword?: string;
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
|
-
* Optional.
|
|
32
|
+
* Optional. Valid values:
|
|
33
|
+
* - -1: No authentication required.
|
|
34
|
+
* - 0: Username and password.
|
|
35
|
+
* - 1: Password only.
|
|
36
|
+
* - 2: Password-free.
|
|
37
|
+
* If you do not specify this parameter, the authentication type is not updated.
|
|
33
38
|
*
|
|
34
39
|
* @example
|
|
35
40
|
* 0
|
|
@@ -37,7 +42,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
37
42
|
authType?: number;
|
|
38
43
|
/**
|
|
39
44
|
* @remarks
|
|
40
|
-
* The new metadata catalog
|
|
45
|
+
* The new name of the metadata catalog. If you do not specify this parameter, the catalog name is not updated. The name can be up to 128 characters in length. It must start with a Chinese character, a letter, or an underscore, and can contain digits and hyphens. It cannot contain only digits.
|
|
41
46
|
*
|
|
42
47
|
* @example
|
|
43
48
|
* demo_catalog
|
|
@@ -45,7 +50,10 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
45
50
|
catalogName?: string;
|
|
46
51
|
/**
|
|
47
52
|
* @remarks
|
|
48
|
-
* The registration method. Valid values:
|
|
53
|
+
* The registration method. Valid values:
|
|
54
|
+
* - INSTANCE_ID: Select an existing cloud instance.
|
|
55
|
+
* - HOST_PORT: Register by endpoint and port.
|
|
56
|
+
* If you do not specify this parameter, the creation mode is not updated.
|
|
49
57
|
*
|
|
50
58
|
* @example
|
|
51
59
|
* HOST_PORT
|
|
@@ -71,7 +79,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
71
79
|
dbType?: string;
|
|
72
80
|
/**
|
|
73
81
|
* @remarks
|
|
74
|
-
* The environment type. Valid values: product, pre, dev, test, sit, uat, pet, and stag. If
|
|
82
|
+
* The environment type. Valid values: product, pre, dev, test, sit, uat, pet, and stag. If you do not specify this parameter, the environment type is not updated.
|
|
75
83
|
*
|
|
76
84
|
* @example
|
|
77
85
|
* product
|
|
@@ -79,7 +87,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
79
87
|
envType?: string;
|
|
80
88
|
/**
|
|
81
89
|
* @remarks
|
|
82
|
-
* Optional. The new
|
|
90
|
+
* Optional. The new domain name or IP address of the database. Do not include the protocol, path, or port. If you do not specify this parameter, the host is not updated.
|
|
83
91
|
*
|
|
84
92
|
* @example
|
|
85
93
|
* mysql.example.com
|
|
@@ -87,7 +95,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
87
95
|
host?: string;
|
|
88
96
|
/**
|
|
89
97
|
* @remarks
|
|
90
|
-
* The new cloud resource instance
|
|
98
|
+
* The new ID of the cloud resource instance. If you do not specify this parameter, the instance resource ID is not updated.
|
|
91
99
|
*
|
|
92
100
|
* @example
|
|
93
101
|
* rm-bp1234567890
|
|
@@ -95,7 +103,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
95
103
|
instanceResourceId?: string;
|
|
96
104
|
/**
|
|
97
105
|
* @remarks
|
|
98
|
-
* The new KMS
|
|
106
|
+
* The new name of the KMS-managed credential. If you do not specify this parameter, the KMS secret is not updated.
|
|
99
107
|
*
|
|
100
108
|
* @example
|
|
101
109
|
* datasource-secret
|
|
@@ -103,7 +111,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
103
111
|
kmsSecret?: string;
|
|
104
112
|
/**
|
|
105
113
|
* @remarks
|
|
106
|
-
* Optional. The new data access security policy
|
|
114
|
+
* Optional. The new ID of the data access security policy. If you do not specify this parameter, the policy ID is not updated.
|
|
107
115
|
*
|
|
108
116
|
* @example
|
|
109
117
|
* sp-usr-example
|
|
@@ -111,7 +119,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
111
119
|
policyId?: string;
|
|
112
120
|
/**
|
|
113
121
|
* @remarks
|
|
114
|
-
* Optional. The new
|
|
122
|
+
* Optional. The new service port of the database. If you do not specify this parameter, the service port is not updated.
|
|
115
123
|
*
|
|
116
124
|
* @example
|
|
117
125
|
* 3306
|
|
@@ -119,7 +127,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
119
127
|
port?: number;
|
|
120
128
|
/**
|
|
121
129
|
* @remarks
|
|
122
|
-
* The new Alibaba Cloud RAM role
|
|
130
|
+
* The new ARN of the Alibaba Cloud RAM role. If you do not specify this parameter, the role ARN is not updated.
|
|
123
131
|
*
|
|
124
132
|
* @example
|
|
125
133
|
* acs:ram::123456789012****:role/DataSourceRole
|
|
@@ -127,7 +135,7 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
127
135
|
roleArn?: string;
|
|
128
136
|
/**
|
|
129
137
|
* @remarks
|
|
130
|
-
* Optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, specify the database name. For ORACLE, specify the SID or service name, and prefix the service name with a forward slash (/). For POLARDB_ORACLE, specify the SID. For MAXCOMPUTE, specify the project name. For other types, leave this parameter empty. If
|
|
138
|
+
* Optional. For ADB_POSTGRESQL, DRDS, POSTGRESQL, and POLARDB_POSTGRESQL, specify the database name. For ORACLE, specify the SID or service name, and prefix the service name with a forward slash (/). For POLARDB_ORACLE, specify the SID. For MAXCOMPUTE, specify the project name. For other types, leave this parameter empty. If you do not specify this parameter, the schema is not updated.
|
|
131
139
|
*
|
|
132
140
|
* @example
|
|
133
141
|
* postgres
|
|
@@ -151,7 +159,10 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
151
159
|
snowflakeWarehouse?: string;
|
|
152
160
|
/**
|
|
153
161
|
* @remarks
|
|
154
|
-
* Specifies whether to use the cloud instance name as the data source name. Valid values:
|
|
162
|
+
* Specifies whether to use the cloud instance name as the data source name. Valid values:
|
|
163
|
+
* - 1: Yes.
|
|
164
|
+
* - 0: No.
|
|
165
|
+
* If you do not specify this parameter, the sync alias setting is not updated.
|
|
155
166
|
*
|
|
156
167
|
* @example
|
|
157
168
|
* 0
|
|
@@ -159,7 +170,11 @@ export class UpdateAgenticDataSourceRequest extends $dara.Model {
|
|
|
159
170
|
syncAlias?: number;
|
|
160
171
|
/**
|
|
161
172
|
* @remarks
|
|
162
|
-
* The new SSL setting. Valid values:
|
|
173
|
+
* The new SSL setting. Valid values:
|
|
174
|
+
* - 1: Enable.
|
|
175
|
+
* - 0: Disable.
|
|
176
|
+
* - -1: Use default settings.
|
|
177
|
+
* If you do not specify this parameter, the SSL setting is not updated. SSL is supported only for ADB_MYSQL, CLICKHOUSE, MARIADB, MYSQL, OCEANBASEX, POLARDB, SELECTDB, and STARROCKS.
|
|
163
178
|
*
|
|
164
179
|
* @example
|
|
165
180
|
* 1
|
|
@@ -30,10 +30,10 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
30
30
|
/**
|
|
31
31
|
* @remarks
|
|
32
32
|
* The authentication method. Valid values:
|
|
33
|
-
* - -1:
|
|
34
|
-
* - 0:
|
|
35
|
-
* - 1:
|
|
36
|
-
* - 2:
|
|
33
|
+
* - -1: no authentication required
|
|
34
|
+
* - 0: username and password
|
|
35
|
+
* - 1: password only
|
|
36
|
+
* - 2: password-free
|
|
37
37
|
*
|
|
38
38
|
* @example
|
|
39
39
|
* 0
|
|
@@ -50,8 +50,8 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
50
50
|
/**
|
|
51
51
|
* @remarks
|
|
52
52
|
* The registration method of the data source. Valid values:
|
|
53
|
-
* - INSTANCE_ID:
|
|
54
|
-
* - HOST_PORT:
|
|
53
|
+
* - INSTANCE_ID: select an existing cloud instance
|
|
54
|
+
* - HOST_PORT: register by endpoint and port
|
|
55
55
|
*
|
|
56
56
|
* @example
|
|
57
57
|
* HOST_PORT
|
|
@@ -116,11 +116,11 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
116
116
|
/**
|
|
117
117
|
* @remarks
|
|
118
118
|
* The source of the data source. Valid values:
|
|
119
|
-
* - RDS: ApsaraDB instance
|
|
120
|
-
* - PUBLIC_OWN:
|
|
121
|
-
* - ECS_OWN:
|
|
122
|
-
* - GATEWAY:
|
|
123
|
-
* - VPC_IDC:
|
|
119
|
+
* - RDS: ApsaraDB instance
|
|
120
|
+
* - PUBLIC_OWN: self-managed database on the Internet
|
|
121
|
+
* - ECS_OWN: self-managed database on an ECS instance
|
|
122
|
+
* - GATEWAY: connected through Database Gateway
|
|
123
|
+
* - VPC_IDC: connected through a VPC or IDC
|
|
124
124
|
*
|
|
125
125
|
* @example
|
|
126
126
|
* RDS
|
|
@@ -168,7 +168,7 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
168
168
|
resourceAccountId?: string;
|
|
169
169
|
/**
|
|
170
170
|
* @remarks
|
|
171
|
-
* The ARN of the RAM role used to access the data source. This parameter is empty if role
|
|
171
|
+
* The ARN of the RAM role used to access the data source. This parameter is empty if role authorization is not used.
|
|
172
172
|
*
|
|
173
173
|
* @example
|
|
174
174
|
* acs:ram::123456789012****:role/DataSourceRole
|
|
@@ -185,9 +185,9 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
185
185
|
/**
|
|
186
186
|
* @remarks
|
|
187
187
|
* The status of the data source. Valid values:
|
|
188
|
-
* - 0:
|
|
189
|
-
* - -1:
|
|
190
|
-
* - -2:
|
|
188
|
+
* - 0: normal
|
|
189
|
+
* - -1: deleted
|
|
190
|
+
* - -2: disabled
|
|
191
191
|
*
|
|
192
192
|
* @example
|
|
193
193
|
* 0
|
|
@@ -196,8 +196,8 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
196
196
|
/**
|
|
197
197
|
* @remarks
|
|
198
198
|
* Specifies whether to use the cloud instance name as the data source name. Valid values:
|
|
199
|
-
* - 1:
|
|
200
|
-
* - 0:
|
|
199
|
+
* - 1: yes
|
|
200
|
+
* - 0: no
|
|
201
201
|
*
|
|
202
202
|
* @example
|
|
203
203
|
* 0
|
|
@@ -206,9 +206,9 @@ export class UpdateAgenticDataSourceResponseBodyData extends $dara.Model {
|
|
|
206
206
|
/**
|
|
207
207
|
* @remarks
|
|
208
208
|
* The SSL settings. Valid values:
|
|
209
|
-
* - 1:
|
|
210
|
-
* - 0:
|
|
211
|
-
* - -1:
|
|
209
|
+
* - 1: enabled
|
|
210
|
+
* - 0: disabled
|
|
211
|
+
* - -1: default settings
|
|
212
212
|
*
|
|
213
213
|
* @example
|
|
214
214
|
* 1
|
|
@@ -305,7 +305,7 @@ export class UpdateAgenticDataSourceResponseBody extends $dara.Model {
|
|
|
305
305
|
errorMessage?: string;
|
|
306
306
|
/**
|
|
307
307
|
* @remarks
|
|
308
|
-
* The
|
|
308
|
+
* The ID of the request.
|
|
309
309
|
*
|
|
310
310
|
* @example
|
|
311
311
|
* request-1234567890
|