@alicloud/dms20250414 4.2.2 → 4.3.1
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 +37 -8
- package/dist/client.js +70 -8
- package/dist/client.js.map +1 -1
- package/dist/models/AgenticDatabase.d.ts +0 -103
- package/dist/models/AgenticDatabase.js.map +1 -1
- package/dist/models/AgenticDatabaseEngineMeta.d.ts +0 -28
- package/dist/models/AgenticDatabaseEngineMeta.js.map +1 -1
- package/dist/models/AgenticTableBaseInfo.d.ts +0 -60
- package/dist/models/AgenticTableBaseInfo.js.map +1 -1
- package/dist/models/AgenticTableEngineMeta.d.ts +0 -84
- package/dist/models/AgenticTableEngineMeta.js.map +1 -1
- package/dist/models/AgenticTableIndex.d.ts +0 -49
- package/dist/models/AgenticTableIndex.js.map +1 -1
- package/dist/models/ListAgenticSecurityPoliciesRequest.d.ts +45 -0
- package/dist/models/ListAgenticSecurityPoliciesRequest.js +64 -0
- package/dist/models/ListAgenticSecurityPoliciesRequest.js.map +1 -0
- package/dist/models/ListAgenticSecurityPoliciesResponse.d.ts +19 -0
- package/dist/models/ListAgenticSecurityPoliciesResponse.js +69 -0
- package/dist/models/ListAgenticSecurityPoliciesResponse.js.map +1 -0
- package/dist/models/ListAgenticSecurityPoliciesResponseBody.d.ts +160 -0
- package/dist/models/ListAgenticSecurityPoliciesResponseBody.js +110 -0
- package/dist/models/ListAgenticSecurityPoliciesResponseBody.js.map +1 -0
- package/dist/models/SendChatMessageRequest.d.ts +59 -51
- package/dist/models/SendChatMessageRequest.js +2 -0
- package/dist/models/SendChatMessageRequest.js.map +1 -1
- package/dist/models/SendChatMessageShrinkRequest.d.ts +16 -19
- package/dist/models/SendChatMessageShrinkRequest.js.map +1 -1
- package/dist/models/model.d.ts +4 -0
- package/dist/models/model.js +20 -12
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +76 -8
- package/src/models/AgenticDatabase.ts +0 -103
- package/src/models/AgenticDatabaseEngineMeta.ts +0 -28
- package/src/models/AgenticTableBaseInfo.ts +0 -60
- package/src/models/AgenticTableEngineMeta.ts +0 -84
- package/src/models/AgenticTableIndex.ts +0 -49
- package/src/models/ListAgenticSecurityPoliciesRequest.ts +64 -0
- package/src/models/ListAgenticSecurityPoliciesResponse.ts +40 -0
- package/src/models/ListAgenticSecurityPoliciesResponseBody.ts +216 -0
- package/src/models/SendChatMessageRequest.ts +61 -51
- package/src/models/SendChatMessageShrinkRequest.ts +16 -19
- package/src/models/model.ts +4 -0
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import * as $dara from '@darabonba/typescript';
|
|
2
|
+
export declare class ListAgenticSecurityPoliciesResponseBodyData extends $dara.Model {
|
|
3
|
+
/**
|
|
4
|
+
* @remarks
|
|
5
|
+
* The UID of the Alibaba Cloud account to which the user policy belongs. This value is not returned for system default policies.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* 123456789012****
|
|
9
|
+
*/
|
|
10
|
+
aliyunAccountUid?: string;
|
|
11
|
+
/**
|
|
12
|
+
* @remarks
|
|
13
|
+
* The ID of the system default policy inherited by the user policy. This value is empty if no inheritance relationship is configured. This value is not returned for system default policies.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* sp-sys-default
|
|
17
|
+
*/
|
|
18
|
+
basePolicyId?: string;
|
|
19
|
+
/**
|
|
20
|
+
* @remarks
|
|
21
|
+
* The description of the security policy. The description of a system default policy is returned in the language of the request context.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* Read-only access policy for analytics
|
|
25
|
+
*/
|
|
26
|
+
description?: string;
|
|
27
|
+
/**
|
|
28
|
+
* @remarks
|
|
29
|
+
* The time when the security policy was created. The time is in the yyyy-MM-dd HH:mm:ss format and does not contain a time zone offset.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* 2026-10-13 14:30:00
|
|
33
|
+
*/
|
|
34
|
+
gmtCreate?: string;
|
|
35
|
+
/**
|
|
36
|
+
* @remarks
|
|
37
|
+
* The time when the security policy was last modified. The time is in the yyyy-MM-dd HH:mm:ss format and does not contain a time zone offset.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* 2026-10-13 14:35:00
|
|
41
|
+
*/
|
|
42
|
+
gmtModified?: string;
|
|
43
|
+
/**
|
|
44
|
+
* @remarks
|
|
45
|
+
* The business ID of the security policy. A system default policy ID starts with sp-sys-, and a user policy ID starts with sp-usr-.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* sp-sys-default
|
|
49
|
+
*/
|
|
50
|
+
policyId?: string;
|
|
51
|
+
/**
|
|
52
|
+
* @remarks
|
|
53
|
+
* The Policy Name of the security policy. The Policy Name of a system default policy is returned in the language of the request context.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* team-readonly-policy
|
|
57
|
+
*/
|
|
58
|
+
policyName?: string;
|
|
59
|
+
/**
|
|
60
|
+
* @remarks
|
|
61
|
+
* The current state of the security policy. Valid values:
|
|
62
|
+
* - ON: Enabled.
|
|
63
|
+
* - OFF: Disabled.
|
|
64
|
+
* - ARCHIVED: Archived.
|
|
65
|
+
* All system default policies returned by this operation are in the ON state.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ON
|
|
69
|
+
*/
|
|
70
|
+
policyStatus?: string;
|
|
71
|
+
/**
|
|
72
|
+
* @remarks
|
|
73
|
+
* Specifies whether the policy is read-only. Valid values:
|
|
74
|
+
* - true: The policy is a system default policy.
|
|
75
|
+
* - false: The policy is a user policy of the current account.
|
|
76
|
+
*/
|
|
77
|
+
readonly?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
* @remarks
|
|
80
|
+
* The tags of the system default policy. Multiple tags are separated by commas (,). This value is not returned for user policies.
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* default,phase1
|
|
84
|
+
*/
|
|
85
|
+
tags?: string;
|
|
86
|
+
/**
|
|
87
|
+
* @remarks
|
|
88
|
+
* The identifier of the operator that last modified the policy. For a user policy, the operator ID is recorded first. If no operator ID is available, the UID of the current Alibaba Cloud account is recorded.
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* system
|
|
92
|
+
*/
|
|
93
|
+
updatedBy?: string;
|
|
94
|
+
static names(): {
|
|
95
|
+
[key: string]: string;
|
|
96
|
+
};
|
|
97
|
+
static types(): {
|
|
98
|
+
[key: string]: any;
|
|
99
|
+
};
|
|
100
|
+
validate(): void;
|
|
101
|
+
constructor(map?: {
|
|
102
|
+
[key: string]: any;
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
export declare class ListAgenticSecurityPoliciesResponseBody extends $dara.Model {
|
|
106
|
+
/**
|
|
107
|
+
* @remarks
|
|
108
|
+
* The list of security policies returned by this query. Enabled system default policies are placed at the beginning, followed by the user policies on the current page. You can use Readonly to distinguish between the two types of policies.
|
|
109
|
+
*/
|
|
110
|
+
data?: ListAgenticSecurityPoliciesResponseBodyData[];
|
|
111
|
+
/**
|
|
112
|
+
* @remarks
|
|
113
|
+
* The error code returned when the request fails. This parameter is empty when the request is successful.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* INVALID_PARAMETER
|
|
117
|
+
*/
|
|
118
|
+
errorCode?: string;
|
|
119
|
+
/**
|
|
120
|
+
* @remarks
|
|
121
|
+
* The error message returned when the request fails. This parameter is empty when the request is successful.
|
|
122
|
+
*
|
|
123
|
+
* @example
|
|
124
|
+
* invalid policyStatus: ARCHIVED
|
|
125
|
+
*/
|
|
126
|
+
errorMessage?: string;
|
|
127
|
+
/**
|
|
128
|
+
* @remarks
|
|
129
|
+
* The request ID, which is used to locate and trace this call.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* request-1234567890
|
|
133
|
+
*/
|
|
134
|
+
requestId?: string;
|
|
135
|
+
/**
|
|
136
|
+
* @remarks
|
|
137
|
+
* Indicates whether the request is successful. Valid values:
|
|
138
|
+
* - true: The request is successful.
|
|
139
|
+
* - false: The request fails.
|
|
140
|
+
*/
|
|
141
|
+
success?: boolean;
|
|
142
|
+
/**
|
|
143
|
+
* @remarks
|
|
144
|
+
* The total number of policies that meet the query conditions. The value is the sum of the number of all enabled system default policies and the number of user policies of the current account that meet the filter conditions.
|
|
145
|
+
*
|
|
146
|
+
* @example
|
|
147
|
+
* 2
|
|
148
|
+
*/
|
|
149
|
+
totalCount?: number;
|
|
150
|
+
static names(): {
|
|
151
|
+
[key: string]: string;
|
|
152
|
+
};
|
|
153
|
+
static types(): {
|
|
154
|
+
[key: string]: any;
|
|
155
|
+
};
|
|
156
|
+
validate(): void;
|
|
157
|
+
constructor(map?: {
|
|
158
|
+
[key: string]: any;
|
|
159
|
+
});
|
|
160
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.ListAgenticSecurityPoliciesResponseBody = exports.ListAgenticSecurityPoliciesResponseBodyData = void 0;
|
|
37
|
+
// This file is auto-generated, don't edit it
|
|
38
|
+
const $dara = __importStar(require("@darabonba/typescript"));
|
|
39
|
+
class ListAgenticSecurityPoliciesResponseBodyData extends $dara.Model {
|
|
40
|
+
static names() {
|
|
41
|
+
return {
|
|
42
|
+
aliyunAccountUid: 'AliyunAccountUid',
|
|
43
|
+
basePolicyId: 'BasePolicyId',
|
|
44
|
+
description: 'Description',
|
|
45
|
+
gmtCreate: 'GmtCreate',
|
|
46
|
+
gmtModified: 'GmtModified',
|
|
47
|
+
policyId: 'PolicyId',
|
|
48
|
+
policyName: 'PolicyName',
|
|
49
|
+
policyStatus: 'PolicyStatus',
|
|
50
|
+
readonly: 'Readonly',
|
|
51
|
+
tags: 'Tags',
|
|
52
|
+
updatedBy: 'UpdatedBy',
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
static types() {
|
|
56
|
+
return {
|
|
57
|
+
aliyunAccountUid: 'string',
|
|
58
|
+
basePolicyId: 'string',
|
|
59
|
+
description: 'string',
|
|
60
|
+
gmtCreate: 'string',
|
|
61
|
+
gmtModified: 'string',
|
|
62
|
+
policyId: 'string',
|
|
63
|
+
policyName: 'string',
|
|
64
|
+
policyStatus: 'string',
|
|
65
|
+
readonly: 'boolean',
|
|
66
|
+
tags: 'string',
|
|
67
|
+
updatedBy: 'string',
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
validate() {
|
|
71
|
+
super.validate();
|
|
72
|
+
}
|
|
73
|
+
constructor(map) {
|
|
74
|
+
super(map);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
exports.ListAgenticSecurityPoliciesResponseBodyData = ListAgenticSecurityPoliciesResponseBodyData;
|
|
78
|
+
class ListAgenticSecurityPoliciesResponseBody extends $dara.Model {
|
|
79
|
+
static names() {
|
|
80
|
+
return {
|
|
81
|
+
data: 'Data',
|
|
82
|
+
errorCode: 'ErrorCode',
|
|
83
|
+
errorMessage: 'ErrorMessage',
|
|
84
|
+
requestId: 'RequestId',
|
|
85
|
+
success: 'Success',
|
|
86
|
+
totalCount: 'TotalCount',
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
static types() {
|
|
90
|
+
return {
|
|
91
|
+
data: { 'type': 'array', 'itemType': ListAgenticSecurityPoliciesResponseBodyData },
|
|
92
|
+
errorCode: 'string',
|
|
93
|
+
errorMessage: 'string',
|
|
94
|
+
requestId: 'string',
|
|
95
|
+
success: 'boolean',
|
|
96
|
+
totalCount: 'number',
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
validate() {
|
|
100
|
+
if (Array.isArray(this.data)) {
|
|
101
|
+
$dara.Model.validateArray(this.data);
|
|
102
|
+
}
|
|
103
|
+
super.validate();
|
|
104
|
+
}
|
|
105
|
+
constructor(map) {
|
|
106
|
+
super(map);
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
exports.ListAgenticSecurityPoliciesResponseBody = ListAgenticSecurityPoliciesResponseBody;
|
|
110
|
+
//# sourceMappingURL=ListAgenticSecurityPoliciesResponseBody.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ListAgenticSecurityPoliciesResponseBody.js","sourceRoot":"","sources":["../../src/models/ListAgenticSecurityPoliciesResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,2CAA4C,SAAQ,KAAK,CAAC,KAAK;IA4F1E,MAAM,CAAC,KAAK;QACV,OAAO;YACL,gBAAgB,EAAE,kBAAkB;YACpC,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,aAAa;YAC1B,QAAQ,EAAE,UAAU;YACpB,UAAU,EAAE,YAAY;YACxB,YAAY,EAAE,cAAc;YAC5B,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,gBAAgB,EAAE,QAAQ;YAC1B,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,QAAQ;YAClB,UAAU,EAAE,QAAQ;YACpB,YAAY,EAAE,QAAQ;YACtB,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAnID,kGAmIC;AAED,MAAa,uCAAwC,SAAQ,KAAK,CAAC,KAAK;IA6CtE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,cAAc;YAC5B,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,2CAA2C,EAAE;YAClF,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,QAAQ;YACtB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA7ED,0FA6EC"}
|
|
@@ -2,21 +2,21 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class SendChatMessageRequestDataSourcePermissionTables extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The list of
|
|
5
|
+
* The list of fields that are allowed to be queried in the current table. If you do not specify this parameter, all fields can be queried. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked. To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
|
|
6
6
|
*/
|
|
7
7
|
allowedColumns?: string[];
|
|
8
8
|
/**
|
|
9
9
|
* @remarks
|
|
10
|
-
* The list of
|
|
10
|
+
* The list of fields that are prohibited from being queried in the current table. If you do not specify this parameter, all fields **can be queried**. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked.
|
|
11
11
|
*
|
|
12
|
-
* If both the
|
|
12
|
+
* If both the prohibited list and the allowed list are configured, the prohibited list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as non-queryable while configuring columns B and C as queryable, only column C is ultimately queryable.
|
|
13
13
|
*
|
|
14
|
-
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include
|
|
14
|
+
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
|
|
15
15
|
*/
|
|
16
16
|
disallowedColumns?: string[];
|
|
17
17
|
/**
|
|
18
18
|
* @remarks
|
|
19
|
-
* The row filter condition that must be included for the current table. If you
|
|
19
|
+
* The row filter condition that must be included for the current table. If you do not specify this parameter, it is ignored. If you specify this parameter, the system checks whether all SQL statements involving this table include the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints will be rejected. Pay attention to the format of the validation condition.
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
22
22
|
* region = \\"east\\"
|
|
@@ -69,7 +69,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
69
69
|
dataSourceId?: string;
|
|
70
70
|
/**
|
|
71
71
|
* @remarks
|
|
72
|
-
* The data source type. Valid values:
|
|
72
|
+
* The data source type. Valid values: remote_data_center and database, which indicate that the analysis target is a file or a database, respectively.
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
75
|
* remote_data_center
|
|
@@ -109,7 +109,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
109
109
|
dmsInstanceId?: string;
|
|
110
110
|
/**
|
|
111
111
|
* @remarks
|
|
112
|
-
* The
|
|
112
|
+
* The type of the database.
|
|
113
113
|
*
|
|
114
114
|
* @example
|
|
115
115
|
* mysql
|
|
@@ -117,7 +117,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
117
117
|
engine?: string;
|
|
118
118
|
/**
|
|
119
119
|
* @remarks
|
|
120
|
-
* The ID
|
|
120
|
+
* The file ID.
|
|
121
121
|
*
|
|
122
122
|
* @example
|
|
123
123
|
* 35****
|
|
@@ -146,7 +146,7 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
146
146
|
regionId?: string;
|
|
147
147
|
/**
|
|
148
148
|
* @remarks
|
|
149
|
-
* The list of names
|
|
149
|
+
* The list of table names to be analyzed.
|
|
150
150
|
*/
|
|
151
151
|
tables?: string[];
|
|
152
152
|
/**
|
|
@@ -171,21 +171,21 @@ export declare class SendChatMessageRequestDataSource extends $dara.Model {
|
|
|
171
171
|
export declare class SendChatMessageRequestDataSourcesPermissionTables extends $dara.Model {
|
|
172
172
|
/**
|
|
173
173
|
* @remarks
|
|
174
|
-
* The list of columns that are allowed to be queried in the current table. If
|
|
174
|
+
* The list of columns that are allowed to be queried in the current table. If you do not specify this parameter, all columns can be queried. If you specify this parameter, SQL statements that query columns beyond the allowed scope are blocked. For example, syntax such as SELECT * is blocked. To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions of DataAgent do not include columns beyond the allowed scope. Otherwise, unauthorized SQL statements are generated and blocked, which reduces the analysis speed and performance of DataAgent.
|
|
175
175
|
*/
|
|
176
176
|
allowedColumns?: string[];
|
|
177
177
|
/**
|
|
178
178
|
* @remarks
|
|
179
|
-
* The list of
|
|
179
|
+
* The list of fields that are prohibited from being queried in the current table. If you do not specify this parameter, all fields **can be queried**. If you specify this parameter, SQL statements that query fields outside the allowed range, such as the `SELECT *` syntax, will be blocked.
|
|
180
180
|
*
|
|
181
|
-
* If both the
|
|
181
|
+
* If both the prohibited list and the allowed list are configured, the prohibited list takes precedence. For example, if Table 1 has columns A, B, C, and D, and you configure columns A and B as non-queryable while configuring columns B and C as queryable, only column C is ultimately queryable.
|
|
182
182
|
*
|
|
183
|
-
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include
|
|
183
|
+
* To ensure the analysis performance of DataAgent, make sure that the prompts, knowledge, and instructions modules of DataAgent do not include fields outside the allowed range. Otherwise, unauthorized SQL statements may be generated and blocked, which degrades the analysis speed and performance of DataAgent.
|
|
184
184
|
*/
|
|
185
185
|
disallowedColumns?: string[];
|
|
186
186
|
/**
|
|
187
187
|
* @remarks
|
|
188
|
-
* The row filter condition that must be included for the current table. If you
|
|
188
|
+
* The row filter condition that must be included for the current table. If you do not specify this parameter, it is ignored. If you specify this parameter, the system checks whether all SQL statements involving this table include the filter field and whether the WHERE condition meets the constraints. SQL statements that do not meet the constraints will be rejected. Pay attention to the format of the validation condition.
|
|
189
189
|
*
|
|
190
190
|
* @example
|
|
191
191
|
* region = \\"east\\"
|
|
@@ -238,7 +238,9 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
238
238
|
dataSourceId?: string;
|
|
239
239
|
/**
|
|
240
240
|
* @remarks
|
|
241
|
-
* The data source type. Valid values:
|
|
241
|
+
* The data source type. Valid values:
|
|
242
|
+
* - remote_data_center: The analysis is performed on a file.
|
|
243
|
+
* - database: The analysis is performed on a database.
|
|
242
244
|
*
|
|
243
245
|
* @example
|
|
244
246
|
* remote_data_center
|
|
@@ -278,7 +280,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
278
280
|
dmsInstanceId?: string;
|
|
279
281
|
/**
|
|
280
282
|
* @remarks
|
|
281
|
-
* The
|
|
283
|
+
* The type of the database.
|
|
282
284
|
*
|
|
283
285
|
* @example
|
|
284
286
|
* mysql
|
|
@@ -315,7 +317,7 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
315
317
|
regionId?: string;
|
|
316
318
|
/**
|
|
317
319
|
* @remarks
|
|
318
|
-
* The list of names
|
|
320
|
+
* The list of table names to be analyzed.
|
|
319
321
|
*/
|
|
320
322
|
tables?: string[];
|
|
321
323
|
/**
|
|
@@ -340,11 +342,9 @@ export declare class SendChatMessageRequestDataSources extends $dara.Model {
|
|
|
340
342
|
export declare class SendChatMessageRequestSessionConfigPermissionConfig extends $dara.Model {
|
|
341
343
|
/**
|
|
342
344
|
* @remarks
|
|
343
|
-
* The default behavior for table-level permissions. This parameter controls whether tables
|
|
344
|
-
*
|
|
345
|
-
* -
|
|
346
|
-
*
|
|
347
|
-
* - `deny`: This value indicates that the whitelist mode is used. You must manually specify this value. By default, no tables can be queried. A table can be queried only when you configure permissions for the table in DataSources.[item].Permission. You can grant full access to a table by not configuring any row-level or column-level restrictions.
|
|
345
|
+
* The default behavior for table-level permissions. This parameter controls whether tables not configured in DataSources.[item].Permission can be queried. Valid values:
|
|
346
|
+
* - allow: Works in blacklist mode. This is the default value. By default, all tables can be queried, and the actual permissions are subject to the permissions configured in DMS. Only when you configure **row- and column-level** permissions in DataSources.[item].Permission will row- and column-level permissions be enforced.
|
|
347
|
+
* - deny: Works in whitelist mode. You must manually specify this value. By default, no tables can be queried. A table can be queried only when you configure permissions for it in DataSources.[item].Permission. You can grant full access to a table by not configuring any row- or column-level restrictions.
|
|
348
348
|
*
|
|
349
349
|
* @example
|
|
350
350
|
* allow
|
|
@@ -364,7 +364,7 @@ export declare class SendChatMessageRequestSessionConfigPermissionConfig extends
|
|
|
364
364
|
export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
365
365
|
/**
|
|
366
366
|
* @remarks
|
|
367
|
-
* The
|
|
367
|
+
* The custom agent ID. A custom agent is an entity used to customize the analysis process. You can create it in the DataAgent console or by calling the CreateCustomAgent operation. A custom agent ID must be a string starting with ca-.
|
|
368
368
|
*
|
|
369
369
|
* @example
|
|
370
370
|
* ca-asfkjhqwe***aesrfqa
|
|
@@ -413,9 +413,9 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
413
413
|
/**
|
|
414
414
|
* @remarks
|
|
415
415
|
* The mode. Valid values:
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
416
|
+
* - **ASK_DATA**: Data query mode.
|
|
417
|
+
* - **ANALYSIS**: Analysis mode.
|
|
418
|
+
* - **INSIGHT**: Insight mode.
|
|
419
419
|
*
|
|
420
420
|
* @example
|
|
421
421
|
* ANALYSIS
|
|
@@ -423,12 +423,12 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
423
423
|
mode?: string;
|
|
424
424
|
/**
|
|
425
425
|
* @remarks
|
|
426
|
-
* The data permission settings at the session level. If
|
|
426
|
+
* The data permission settings at the session level. If configured multiple times in multi-turn conversations within the same session, the last configuration prevails.
|
|
427
427
|
*/
|
|
428
428
|
permissionConfig?: SendChatMessageRequestSessionConfigPermissionConfig;
|
|
429
429
|
/**
|
|
430
430
|
* @remarks
|
|
431
|
-
* Specifies whether to enable the plan feature. Valid values:
|
|
431
|
+
* Specifies whether to enable the plan feature. Valid values: disable, enable, and force. Default value: enable.
|
|
432
432
|
*
|
|
433
433
|
* @example
|
|
434
434
|
* disable
|
|
@@ -436,7 +436,7 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
436
436
|
planMode?: string;
|
|
437
437
|
/**
|
|
438
438
|
* @remarks
|
|
439
|
-
* The
|
|
439
|
+
* The text to be added as a watermark to the generated PDF report. The text can be up to 64 characters in length.
|
|
440
440
|
*
|
|
441
441
|
* @example
|
|
442
442
|
* sample-watermark
|
|
@@ -479,6 +479,14 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
479
479
|
* The list of user-specified skills.
|
|
480
480
|
*/
|
|
481
481
|
userSpecifiedSkillList?: string[];
|
|
482
|
+
/**
|
|
483
|
+
* @remarks
|
|
484
|
+
* The default report theme ID for the current session.
|
|
485
|
+
*
|
|
486
|
+
* @example
|
|
487
|
+
* default
|
|
488
|
+
*/
|
|
489
|
+
webReportTheme?: string;
|
|
482
490
|
static names(): {
|
|
483
491
|
[key: string]: string;
|
|
484
492
|
};
|
|
@@ -493,7 +501,7 @@ export declare class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
493
501
|
export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.Model {
|
|
494
502
|
/**
|
|
495
503
|
* @remarks
|
|
496
|
-
* The prompt that
|
|
504
|
+
* The prompt that the current report must follow.
|
|
497
505
|
*
|
|
498
506
|
* @example
|
|
499
507
|
* generate a report
|
|
@@ -501,7 +509,7 @@ export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.
|
|
|
501
509
|
reportPrompt?: string;
|
|
502
510
|
/**
|
|
503
511
|
* @remarks
|
|
504
|
-
* The report theme.
|
|
512
|
+
* The report theme. System themes include default, journal, legacy, and neobrutalism, which are globally available theme IDs. You can call the ListDataAgentTheme operation to obtain other available theme IDs.
|
|
505
513
|
*
|
|
506
514
|
* @example
|
|
507
515
|
* default
|
|
@@ -509,7 +517,10 @@ export declare class SendChatMessageRequestTaskConfigReportConfig extends $dara.
|
|
|
509
517
|
reportTheme?: string;
|
|
510
518
|
/**
|
|
511
519
|
* @remarks
|
|
512
|
-
* The service type. Valid values:
|
|
520
|
+
* The service type. Valid values:
|
|
521
|
+
* - TextReport: The task generates a text report.
|
|
522
|
+
* - WebReport: The task generates a web report.
|
|
523
|
+
* Currently, only WebReport is supported.
|
|
513
524
|
*
|
|
514
525
|
* @example
|
|
515
526
|
* WebReport
|
|
@@ -562,7 +573,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
562
573
|
DMSUnit?: string;
|
|
563
574
|
/**
|
|
564
575
|
* @remarks
|
|
565
|
-
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter.
|
|
576
|
+
* The data source information. This parameter can be left empty. You can specify only one data source for this parameter. We recommend that you use the DataSources parameter instead.
|
|
566
577
|
*
|
|
567
578
|
* @example
|
|
568
579
|
* null
|
|
@@ -585,15 +596,12 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
585
596
|
message?: string;
|
|
586
597
|
/**
|
|
587
598
|
* @remarks
|
|
588
|
-
* The message type. Default value:
|
|
589
|
-
*
|
|
590
|
-
* - In normal interactions with the agent, the message type is `primary`.
|
|
591
|
-
*
|
|
592
|
-
* - When the message is a response to a human-in-the-loop question from the agent, the type must be `additional`.
|
|
593
|
-
*
|
|
594
|
-
* - When the message is intended to trigger report generation, the type must be `report`.
|
|
599
|
+
* The message type. Default value: primary.
|
|
595
600
|
*
|
|
596
|
-
* -
|
|
601
|
+
* - In normal interactions with the agent, the message type is primary.
|
|
602
|
+
* - When the message is a response to a human-in-the-loop question from the agent, the type must be additional.
|
|
603
|
+
* - When the message is intended to trigger report generation, the type must be report.
|
|
604
|
+
* - When the message is intended to cancel the current session, the type must be cancel.
|
|
597
605
|
*
|
|
598
606
|
* @example
|
|
599
607
|
* primary
|
|
@@ -601,7 +609,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
601
609
|
messageType?: string;
|
|
602
610
|
/**
|
|
603
611
|
* @remarks
|
|
604
|
-
* The
|
|
612
|
+
* The parent session ID.
|
|
605
613
|
*
|
|
606
614
|
* @example
|
|
607
615
|
* 20qrliuoo7p2vlsfg*****
|
|
@@ -609,7 +617,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
609
617
|
parentSessionId?: string;
|
|
610
618
|
/**
|
|
611
619
|
* @remarks
|
|
612
|
-
* Required when the message type is
|
|
620
|
+
* Required when the message type is additional. Specifies the specific question asked by the agent to the user through human-in-the-loop.
|
|
613
621
|
*
|
|
614
622
|
* @example
|
|
615
623
|
* Provide the calculation criteria for GMV
|
|
@@ -617,7 +625,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
617
625
|
question?: string;
|
|
618
626
|
/**
|
|
619
627
|
* @remarks
|
|
620
|
-
* The quoted content. This is typically used
|
|
628
|
+
* The current quoted content. This is typically used during interactions with the agent.
|
|
621
629
|
*
|
|
622
630
|
* @example
|
|
623
631
|
* {"version":"v0"}
|
|
@@ -627,7 +635,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
627
635
|
* @remarks
|
|
628
636
|
* **Important**
|
|
629
637
|
*
|
|
630
|
-
* When this message is a reply to an agent message
|
|
638
|
+
* When this message is a reply to an agent message (such as the 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.
|
|
631
639
|
*
|
|
632
640
|
* This field affects how the agent decides to process the message. Passing an incorrect value may lead to suboptimal analysis results.
|
|
633
641
|
*
|
|
@@ -637,7 +645,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
637
645
|
replyTo?: string;
|
|
638
646
|
/**
|
|
639
647
|
* @remarks
|
|
640
|
-
* The special configurations for the current session. For the same session, only the configurations
|
|
648
|
+
* The special configurations for the current session. For the same session, only the configurations passed during the first SendMessage call take effect.
|
|
641
649
|
*
|
|
642
650
|
* **if can be null:**
|
|
643
651
|
* true
|
|
@@ -645,10 +653,10 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
645
653
|
sessionConfig?: SendChatMessageRequestSessionConfig;
|
|
646
654
|
/**
|
|
647
655
|
* @remarks
|
|
648
|
-
* The session ID. This optional field
|
|
649
|
-
* - You can start a session without specifying this field
|
|
650
|
-
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating
|
|
651
|
-
* - If you need multi-turn conversations
|
|
656
|
+
* The session ID. This is an optional field used for multi-turn sessions.
|
|
657
|
+
* - You can start a session without specifying this field, and the response will include the SessionID for the current session.
|
|
658
|
+
* - You can also manually create a session ID by calling the CreateDataAgentSession operation and include the ID when initiating the session.
|
|
659
|
+
* - If you need multi-turn conversations (such as follow-up questions or confirming execution plans), include the SessionID returned by the previous SendChatMessage operation in this API call.
|
|
652
660
|
*
|
|
653
661
|
* @example
|
|
654
662
|
* sess_***
|
|
@@ -661,7 +669,7 @@ export declare class SendChatMessageRequest extends $dara.Model {
|
|
|
661
669
|
taskConfig?: SendChatMessageRequestTaskConfig;
|
|
662
670
|
/**
|
|
663
671
|
* @remarks
|
|
664
|
-
* The Object Storage Service (OSS) bucket of the user. If
|
|
672
|
+
* The Object Storage Service (OSS) bucket of the user. If you do not specify this parameter, the analysis process is securely stored in the built-in storage.
|
|
665
673
|
*
|
|
666
674
|
* @example
|
|
667
675
|
* my-bucket
|
|
@@ -277,6 +277,7 @@ class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
277
277
|
skipSqlConfirm: 'SkipSqlConfirm',
|
|
278
278
|
skipWebReportConfirm: 'SkipWebReportConfirm',
|
|
279
279
|
userSpecifiedSkillList: 'UserSpecifiedSkillList',
|
|
280
|
+
webReportTheme: 'WebReportTheme',
|
|
280
281
|
};
|
|
281
282
|
}
|
|
282
283
|
static types() {
|
|
@@ -296,6 +297,7 @@ class SendChatMessageRequestSessionConfig extends $dara.Model {
|
|
|
296
297
|
skipSqlConfirm: 'boolean',
|
|
297
298
|
skipWebReportConfirm: 'boolean',
|
|
298
299
|
userSpecifiedSkillList: { 'type': 'array', 'itemType': 'string' },
|
|
300
|
+
webReportTheme: 'string',
|
|
299
301
|
};
|
|
300
302
|
}
|
|
301
303
|
validate() {
|