@alicloud/gpdb20160503 3.11.0 → 3.12.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 +182 -56
- package/dist/client.js +377 -59
- package/dist/client.js.map +1 -1
- package/dist/models/CheckSaasServiceVersionRequest.d.ts +31 -0
- package/dist/models/CheckSaasServiceVersionRequest.js +60 -0
- package/dist/models/CheckSaasServiceVersionRequest.js.map +1 -0
- package/dist/models/CheckSaasServiceVersionResponse.d.ts +19 -0
- package/dist/models/CheckSaasServiceVersionResponse.js +69 -0
- package/dist/models/CheckSaasServiceVersionResponse.js.map +1 -0
- package/dist/models/CheckSaasServiceVersionResponseBody.d.ts +45 -0
- package/dist/models/CheckSaasServiceVersionResponseBody.js +64 -0
- package/dist/models/CheckSaasServiceVersionResponseBody.js.map +1 -0
- package/dist/models/CreateApiKeyRequest.d.ts +14 -0
- package/dist/models/CreateApiKeyRequest.js.map +1 -1
- package/dist/models/CreateApiKeyResponseBody.d.ts +9 -0
- package/dist/models/CreateApiKeyResponseBody.js.map +1 -1
- package/dist/models/CreateApiKeyShrinkRequest.d.ts +14 -0
- package/dist/models/CreateApiKeyShrinkRequest.js.map +1 -1
- package/dist/models/CreateDbinstanceRequest.d.ts +116 -171
- package/dist/models/CreateDbinstanceRequest.js.map +1 -1
- package/dist/models/CreateDbinstanceResponseBody.d.ts +3 -3
- package/dist/models/CreateSupabaseProjectRequest.d.ts +20 -5
- package/dist/models/CreateSupabaseProjectRequest.js +27 -1
- package/dist/models/CreateSupabaseProjectRequest.js.map +1 -1
- package/dist/models/CreateSupabaseProjectResponseBody.d.ts +2 -2
- package/dist/models/DeleteApiKeyRequest.d.ts +5 -0
- package/dist/models/DeleteApiKeyRequest.js.map +1 -1
- package/dist/models/DeleteApiKeyResponseBody.d.ts +6 -0
- package/dist/models/DeleteApiKeyResponseBody.js.map +1 -1
- package/dist/models/DeleteWorkspaceRequest.d.ts +5 -0
- package/dist/models/DeleteWorkspaceRequest.js.map +1 -1
- package/dist/models/DeleteWorkspaceResponseBody.d.ts +6 -0
- package/dist/models/DeleteWorkspaceResponseBody.js.map +1 -1
- package/dist/models/GetApiEndpointsRequest.d.ts +37 -0
- package/dist/models/GetApiEndpointsRequest.js +62 -0
- package/dist/models/GetApiEndpointsRequest.js.map +1 -0
- package/dist/models/GetApiEndpointsResponse.d.ts +19 -0
- package/dist/models/GetApiEndpointsResponse.js +69 -0
- package/dist/models/GetApiEndpointsResponse.js.map +1 -0
- package/dist/models/GetApiEndpointsResponseBody.d.ts +89 -0
- package/dist/models/GetApiEndpointsResponseBody.js +92 -0
- package/dist/models/GetApiEndpointsResponseBody.js.map +1 -0
- package/dist/models/GetApiKeyRequest.d.ts +5 -0
- package/dist/models/GetApiKeyRequest.js.map +1 -1
- package/dist/models/GetApiKeyResponseBody.d.ts +34 -0
- package/dist/models/GetApiKeyResponseBody.js.map +1 -1
- package/dist/models/GetSaasServiceRequest.d.ts +5 -0
- package/dist/models/GetSaasServiceRequest.js.map +1 -1
- package/dist/models/GetSaasServiceResponseBody.d.ts +38 -0
- package/dist/models/GetSaasServiceResponseBody.js.map +1 -1
- package/dist/models/GetServiceAccessInfoRequest.d.ts +5 -0
- package/dist/models/GetServiceAccessInfoRequest.js.map +1 -1
- package/dist/models/GetServiceAccessInfoResponseBody.d.ts +9 -0
- package/dist/models/GetServiceAccessInfoResponseBody.js.map +1 -1
- package/dist/models/GetWorkspaceRequest.d.ts +5 -0
- package/dist/models/GetWorkspaceRequest.js.map +1 -1
- package/dist/models/GetWorkspaceResponseBody.d.ts +83 -0
- package/dist/models/GetWorkspaceResponseBody.js.map +1 -1
- package/dist/models/GrantApiKeyRequest.d.ts +48 -0
- package/dist/models/GrantApiKeyRequest.js +67 -0
- package/dist/models/GrantApiKeyRequest.js.map +1 -0
- package/dist/models/GrantApiKeyResponse.d.ts +19 -0
- package/dist/models/GrantApiKeyResponse.js +69 -0
- package/dist/models/GrantApiKeyResponse.js.map +1 -0
- package/dist/models/GrantApiKeyResponseBody.d.ts +21 -0
- package/dist/models/GrantApiKeyResponseBody.js +58 -0
- package/dist/models/GrantApiKeyResponseBody.js.map +1 -0
- package/dist/models/GrantApiKeyShrinkRequest.d.ts +48 -0
- package/dist/models/GrantApiKeyShrinkRequest.js +64 -0
- package/dist/models/GrantApiKeyShrinkRequest.js.map +1 -0
- package/dist/models/ListApiKeysRequest.d.ts +14 -0
- package/dist/models/ListApiKeysRequest.js.map +1 -1
- package/dist/models/ListApiKeysResponseBody.d.ts +45 -0
- package/dist/models/ListApiKeysResponseBody.js.map +1 -1
- package/dist/models/ListSaasServiceRequest.d.ts +1 -1
- package/dist/models/ListSaasServiceResponseBody.d.ts +80 -1
- package/dist/models/ListSaasServiceResponseBody.js +37 -1
- package/dist/models/ListSaasServiceResponseBody.js.map +1 -1
- package/dist/models/ListWorkspacesResponseBody.d.ts +21 -1
- package/dist/models/ListWorkspacesResponseBody.js +37 -1
- package/dist/models/ListWorkspacesResponseBody.js.map +1 -1
- package/dist/models/ModifySaasServiceDeletionProtectionRequest.d.ts +39 -0
- package/dist/models/ModifySaasServiceDeletionProtectionRequest.js +62 -0
- package/dist/models/ModifySaasServiceDeletionProtectionRequest.js.map +1 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponse.d.ts +19 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponse.js +69 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponse.js.map +1 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.d.ts +37 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.js +62 -0
- package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.js.map +1 -0
- package/dist/models/PauseSaasServiceRequest.d.ts +5 -0
- package/dist/models/PauseSaasServiceRequest.js.map +1 -1
- package/dist/models/PauseSaasServiceResponseBody.d.ts +6 -0
- package/dist/models/PauseSaasServiceResponseBody.js.map +1 -1
- package/dist/models/QueryContentAdvanceRequest.d.ts +26 -27
- package/dist/models/QueryContentAdvanceRequest.js.map +1 -1
- package/dist/models/QueryContentRequest.d.ts +26 -27
- package/dist/models/QueryContentRequest.js.map +1 -1
- package/dist/models/QueryContentResponseBody.d.ts +2 -2
- package/dist/models/QueryContentShrinkRequest.d.ts +24 -24
- package/dist/models/ResumeSaasServiceRequest.d.ts +5 -0
- package/dist/models/ResumeSaasServiceRequest.js.map +1 -1
- package/dist/models/ResumeSaasServiceResponseBody.d.ts +6 -0
- package/dist/models/ResumeSaasServiceResponseBody.js.map +1 -1
- package/dist/models/RevokeApiKeyRequest.d.ts +48 -0
- package/dist/models/RevokeApiKeyRequest.js +67 -0
- package/dist/models/RevokeApiKeyRequest.js.map +1 -0
- package/dist/models/RevokeApiKeyResponse.d.ts +19 -0
- package/dist/models/RevokeApiKeyResponse.js +69 -0
- package/dist/models/RevokeApiKeyResponse.js.map +1 -0
- package/dist/models/RevokeApiKeyResponseBody.d.ts +21 -0
- package/dist/models/RevokeApiKeyResponseBody.js +58 -0
- package/dist/models/RevokeApiKeyResponseBody.js.map +1 -0
- package/dist/models/RevokeApiKeyShrinkRequest.d.ts +48 -0
- package/dist/models/RevokeApiKeyShrinkRequest.js +64 -0
- package/dist/models/RevokeApiKeyShrinkRequest.js.map +1 -0
- package/dist/models/UpdateSaasServiceVersionRequest.d.ts +31 -0
- package/dist/models/UpdateSaasServiceVersionRequest.js +60 -0
- package/dist/models/UpdateSaasServiceVersionRequest.js.map +1 -0
- package/dist/models/UpdateSaasServiceVersionResponse.d.ts +19 -0
- package/dist/models/UpdateSaasServiceVersionResponse.js +69 -0
- package/dist/models/UpdateSaasServiceVersionResponse.js.map +1 -0
- package/dist/models/UpdateSaasServiceVersionResponseBody.d.ts +37 -0
- package/dist/models/UpdateSaasServiceVersionResponseBody.js +62 -0
- package/dist/models/UpdateSaasServiceVersionResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +24 -0
- package/dist/models/model.js +80 -32
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +410 -59
- package/src/models/CheckSaasServiceVersionRequest.ts +46 -0
- package/src/models/CheckSaasServiceVersionResponse.ts +40 -0
- package/src/models/CheckSaasServiceVersionResponseBody.ts +64 -0
- package/src/models/CreateApiKeyRequest.ts +14 -0
- package/src/models/CreateApiKeyResponseBody.ts +9 -0
- package/src/models/CreateApiKeyShrinkRequest.ts +14 -0
- package/src/models/CreateDbinstanceRequest.ts +124 -179
- package/src/models/CreateDbinstanceResponseBody.ts +3 -3
- package/src/models/CreateSupabaseProjectRequest.ts +37 -5
- package/src/models/CreateSupabaseProjectResponseBody.ts +2 -2
- package/src/models/DeleteApiKeyRequest.ts +5 -0
- package/src/models/DeleteApiKeyResponseBody.ts +6 -0
- package/src/models/DeleteWorkspaceRequest.ts +5 -0
- package/src/models/DeleteWorkspaceResponseBody.ts +6 -0
- package/src/models/GetApiEndpointsRequest.ts +54 -0
- package/src/models/GetApiEndpointsResponse.ts +40 -0
- package/src/models/GetApiEndpointsResponseBody.ts +127 -0
- package/src/models/GetApiKeyRequest.ts +5 -0
- package/src/models/GetApiKeyResponseBody.ts +34 -0
- package/src/models/GetSaasServiceRequest.ts +5 -0
- package/src/models/GetSaasServiceResponseBody.ts +38 -0
- package/src/models/GetServiceAccessInfoRequest.ts +5 -0
- package/src/models/GetServiceAccessInfoResponseBody.ts +9 -0
- package/src/models/GetWorkspaceRequest.ts +5 -0
- package/src/models/GetWorkspaceResponseBody.ts +83 -0
- package/src/models/GrantApiKeyRequest.ts +70 -0
- package/src/models/GrantApiKeyResponse.ts +40 -0
- package/src/models/GrantApiKeyResponseBody.ts +34 -0
- package/src/models/GrantApiKeyShrinkRequest.ts +67 -0
- package/src/models/ListApiKeysRequest.ts +14 -0
- package/src/models/ListApiKeysResponseBody.ts +45 -0
- package/src/models/ListSaasServiceRequest.ts +1 -1
- package/src/models/ListSaasServiceResponseBody.ts +107 -1
- package/src/models/ListWorkspacesResponseBody.ts +48 -1
- package/src/models/ModifySaasServiceDeletionProtectionRequest.ts +56 -0
- package/src/models/ModifySaasServiceDeletionProtectionResponse.ts +40 -0
- package/src/models/ModifySaasServiceDeletionProtectionResponseBody.ts +54 -0
- package/src/models/PauseSaasServiceRequest.ts +5 -0
- package/src/models/PauseSaasServiceResponseBody.ts +6 -0
- package/src/models/QueryContentAdvanceRequest.ts +26 -27
- package/src/models/QueryContentRequest.ts +26 -27
- package/src/models/QueryContentResponseBody.ts +2 -2
- package/src/models/QueryContentShrinkRequest.ts +24 -24
- package/src/models/ResumeSaasServiceRequest.ts +5 -0
- package/src/models/ResumeSaasServiceResponseBody.ts +6 -0
- package/src/models/RevokeApiKeyRequest.ts +70 -0
- package/src/models/RevokeApiKeyResponse.ts +40 -0
- package/src/models/RevokeApiKeyResponseBody.ts +34 -0
- package/src/models/RevokeApiKeyShrinkRequest.ts +67 -0
- package/src/models/UpdateSaasServiceVersionRequest.ts +46 -0
- package/src/models/UpdateSaasServiceVersionResponse.ts +40 -0
- package/src/models/UpdateSaasServiceVersionResponseBody.ts +54 -0
- package/src/models/model.ts +24 -0
|
@@ -125,7 +125,46 @@ export class ListWorkspacesResponseBodyItemsApikeys extends $dara.Model {
|
|
|
125
125
|
}
|
|
126
126
|
}
|
|
127
127
|
|
|
128
|
+
export class ListWorkspacesResponseBodyItemsServicesComponents extends $dara.Model {
|
|
129
|
+
createTime?: string;
|
|
130
|
+
cu?: string;
|
|
131
|
+
deletionProtection?: boolean;
|
|
132
|
+
status?: string;
|
|
133
|
+
componentId?: string;
|
|
134
|
+
componentType?: string;
|
|
135
|
+
static names(): { [key: string]: string } {
|
|
136
|
+
return {
|
|
137
|
+
createTime: 'CreateTime',
|
|
138
|
+
cu: 'Cu',
|
|
139
|
+
deletionProtection: 'DeletionProtection',
|
|
140
|
+
status: 'Status',
|
|
141
|
+
componentId: 'componentId',
|
|
142
|
+
componentType: 'componentType',
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
static types(): { [key: string]: any } {
|
|
147
|
+
return {
|
|
148
|
+
createTime: 'string',
|
|
149
|
+
cu: 'string',
|
|
150
|
+
deletionProtection: 'boolean',
|
|
151
|
+
status: 'string',
|
|
152
|
+
componentId: 'string',
|
|
153
|
+
componentType: 'string',
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
validate() {
|
|
158
|
+
super.validate();
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
constructor(map?: { [key: string]: any }) {
|
|
162
|
+
super(map);
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
|
|
128
166
|
export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
167
|
+
components?: ListWorkspacesResponseBodyItemsServicesComponents[];
|
|
129
168
|
/**
|
|
130
169
|
* @remarks
|
|
131
170
|
* The creation time.
|
|
@@ -142,6 +181,7 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
|
142
181
|
* 1
|
|
143
182
|
*/
|
|
144
183
|
cu?: string;
|
|
184
|
+
deletionProtection?: boolean;
|
|
145
185
|
/**
|
|
146
186
|
* @remarks
|
|
147
187
|
* The expiration time.
|
|
@@ -166,7 +206,7 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
|
166
206
|
payType?: string;
|
|
167
207
|
/**
|
|
168
208
|
* @remarks
|
|
169
|
-
* [Deprecated]
|
|
209
|
+
* **[Deprecated]**
|
|
170
210
|
*
|
|
171
211
|
* @example
|
|
172
212
|
* deprecated
|
|
@@ -212,8 +252,10 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
|
212
252
|
status?: string;
|
|
213
253
|
static names(): { [key: string]: string } {
|
|
214
254
|
return {
|
|
255
|
+
components: 'Components',
|
|
215
256
|
createTime: 'CreateTime',
|
|
216
257
|
cu: 'Cu',
|
|
258
|
+
deletionProtection: 'DeletionProtection',
|
|
217
259
|
expireTime: 'ExpireTime',
|
|
218
260
|
payType: 'PayType',
|
|
219
261
|
plan: 'Plan',
|
|
@@ -226,8 +268,10 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
|
226
268
|
|
|
227
269
|
static types(): { [key: string]: any } {
|
|
228
270
|
return {
|
|
271
|
+
components: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItemsServicesComponents },
|
|
229
272
|
createTime: 'string',
|
|
230
273
|
cu: 'string',
|
|
274
|
+
deletionProtection: 'boolean',
|
|
231
275
|
expireTime: 'string',
|
|
232
276
|
payType: 'string',
|
|
233
277
|
plan: 'string',
|
|
@@ -239,6 +283,9 @@ export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
|
|
|
239
283
|
}
|
|
240
284
|
|
|
241
285
|
validate() {
|
|
286
|
+
if(Array.isArray(this.components)) {
|
|
287
|
+
$dara.Model.validateArray(this.components);
|
|
288
|
+
}
|
|
242
289
|
super.validate();
|
|
243
290
|
}
|
|
244
291
|
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
// This file is auto-generated, don't edit it
|
|
2
|
+
import * as $dara from '@darabonba/typescript';
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
export class ModifySaasServiceDeletionProtectionRequest extends $dara.Model {
|
|
6
|
+
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* Specifies whether to enable deletion protection.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* true
|
|
12
|
+
*/
|
|
13
|
+
deletionProtection?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* @remarks
|
|
16
|
+
* The region ID.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* cn-hangzhou
|
|
20
|
+
*/
|
|
21
|
+
regionId?: string;
|
|
22
|
+
/**
|
|
23
|
+
* @remarks
|
|
24
|
+
* The service ID.
|
|
25
|
+
*
|
|
26
|
+
* This parameter is required.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* agdb-xxxxx
|
|
30
|
+
*/
|
|
31
|
+
serviceId?: string;
|
|
32
|
+
static names(): { [key: string]: string } {
|
|
33
|
+
return {
|
|
34
|
+
deletionProtection: 'DeletionProtection',
|
|
35
|
+
regionId: 'RegionId',
|
|
36
|
+
serviceId: 'ServiceId',
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
static types(): { [key: string]: any } {
|
|
41
|
+
return {
|
|
42
|
+
deletionProtection: 'boolean',
|
|
43
|
+
regionId: 'string',
|
|
44
|
+
serviceId: 'string',
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
validate() {
|
|
49
|
+
super.validate();
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
constructor(map?: { [key: string]: any }) {
|
|
53
|
+
super(map);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// This file is auto-generated, don't edit it
|
|
2
|
+
import * as $dara from '@darabonba/typescript';
|
|
3
|
+
import { ModifySaasServiceDeletionProtectionResponseBody } from "./ModifySaasServiceDeletionProtectionResponseBody";
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
export class ModifySaasServiceDeletionProtectionResponse extends $dara.Model {
|
|
7
|
+
headers?: { [key: string]: string };
|
|
8
|
+
statusCode?: number;
|
|
9
|
+
body?: ModifySaasServiceDeletionProtectionResponseBody;
|
|
10
|
+
static names(): { [key: string]: string } {
|
|
11
|
+
return {
|
|
12
|
+
headers: 'headers',
|
|
13
|
+
statusCode: 'statusCode',
|
|
14
|
+
body: 'body',
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
static types(): { [key: string]: any } {
|
|
19
|
+
return {
|
|
20
|
+
headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
|
|
21
|
+
statusCode: 'number',
|
|
22
|
+
body: ModifySaasServiceDeletionProtectionResponseBody,
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
validate() {
|
|
27
|
+
if(this.headers) {
|
|
28
|
+
$dara.Model.validateMap(this.headers);
|
|
29
|
+
}
|
|
30
|
+
if(this.body && typeof (this.body as any).validate === 'function') {
|
|
31
|
+
(this.body as any).validate();
|
|
32
|
+
}
|
|
33
|
+
super.validate();
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
constructor(map?: { [key: string]: any }) {
|
|
37
|
+
super(map);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
// This file is auto-generated, don't edit it
|
|
2
|
+
import * as $dara from '@darabonba/typescript';
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
export class ModifySaasServiceDeletionProtectionResponseBody extends $dara.Model {
|
|
6
|
+
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* The response message.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* success
|
|
12
|
+
*/
|
|
13
|
+
message?: string;
|
|
14
|
+
/**
|
|
15
|
+
* @remarks
|
|
16
|
+
* The request ID.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* 7565770E-7C45-462D-BA4A-8A5396F2CAD1
|
|
20
|
+
*/
|
|
21
|
+
requestId?: string;
|
|
22
|
+
/**
|
|
23
|
+
* @remarks
|
|
24
|
+
* The service ID.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* agdb-xxxxxx
|
|
28
|
+
*/
|
|
29
|
+
serviceId?: string;
|
|
30
|
+
static names(): { [key: string]: string } {
|
|
31
|
+
return {
|
|
32
|
+
message: 'Message',
|
|
33
|
+
requestId: 'RequestId',
|
|
34
|
+
serviceId: 'ServiceId',
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
static types(): { [key: string]: any } {
|
|
39
|
+
return {
|
|
40
|
+
message: 'string',
|
|
41
|
+
requestId: 'string',
|
|
42
|
+
serviceId: 'string',
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
validate() {
|
|
47
|
+
super.validate();
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
constructor(map?: { [key: string]: any }) {
|
|
51
|
+
super(map);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
|
|
|
4
4
|
|
|
5
5
|
export class PauseSaasServiceRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* The region ID of the service.
|
|
9
|
+
*
|
|
7
10
|
* @example
|
|
8
11
|
* cn-beijing
|
|
9
12
|
*/
|
|
10
13
|
regionId?: string;
|
|
11
14
|
/**
|
|
12
15
|
* @remarks
|
|
16
|
+
* The service ID.
|
|
17
|
+
*
|
|
13
18
|
* This parameter is required.
|
|
14
19
|
*
|
|
15
20
|
* @example
|
|
@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
|
|
|
4
4
|
|
|
5
5
|
export class PauseSaasServiceResponseBody extends $dara.Model {
|
|
6
6
|
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* The request ID.
|
|
9
|
+
*
|
|
7
10
|
* @example
|
|
8
11
|
* ABB39CC3-4488-4857-905D-2E4A051D0521
|
|
9
12
|
*/
|
|
10
13
|
requestId?: string;
|
|
11
14
|
/**
|
|
15
|
+
* @remarks
|
|
16
|
+
* The service ID.
|
|
17
|
+
*
|
|
12
18
|
* @example
|
|
13
19
|
* drama-123456
|
|
14
20
|
*/
|
|
@@ -36,8 +36,7 @@ export class QueryContentAdvanceRequestGraphSearchArgs extends $dara.Model {
|
|
|
36
36
|
export class QueryContentAdvanceRequestRerankModel extends $dara.Model {
|
|
37
37
|
/**
|
|
38
38
|
* @remarks
|
|
39
|
-
* This parameter can be set when RerankModel.Name is qwen3-rerank.
|
|
40
|
-
* Adds a custom sorting task type description. This parameter guides the model to adopt different sorting strategies.
|
|
39
|
+
* This parameter can be set when RerankModel.Name is qwen3-rerank. Specifies a custom sorting task type description that guides the model to adopt different sorting strategies.
|
|
41
40
|
*
|
|
42
41
|
* @example
|
|
43
42
|
* Given a web search query, retrieve relevant passages that answer the query
|
|
@@ -45,7 +44,7 @@ export class QueryContentAdvanceRequestRerankModel extends $dara.Model {
|
|
|
45
44
|
instruct?: string;
|
|
46
45
|
/**
|
|
47
46
|
* @remarks
|
|
48
|
-
* The
|
|
47
|
+
* The rerank model name. Valid values: qwen3-rerank, gte-rerank-v2.
|
|
49
48
|
*
|
|
50
49
|
* @example
|
|
51
50
|
* qwen3-rerank
|
|
@@ -114,7 +113,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
114
113
|
* @remarks
|
|
115
114
|
* The name of the source image file to search in image-to-image search scenarios.
|
|
116
115
|
*
|
|
117
|
-
* > The image file must have a file extension.
|
|
116
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
118
117
|
*
|
|
119
118
|
* @example
|
|
120
119
|
* test.jpg
|
|
@@ -124,7 +123,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
124
123
|
* @remarks
|
|
125
124
|
* The publicly accessible URL of the image file in image-to-image search scenarios.
|
|
126
125
|
*
|
|
127
|
-
* > The image file must have a file extension.
|
|
126
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
128
127
|
*
|
|
129
128
|
* @example
|
|
130
129
|
* https://xx/myImage.jpg
|
|
@@ -132,10 +131,10 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
132
131
|
fileUrlObject?: Readable;
|
|
133
132
|
/**
|
|
134
133
|
* @remarks
|
|
135
|
-
* The filter condition for the data to query, in SQL WHERE clause format. The
|
|
134
|
+
* The filter condition for the data to query, in SQL WHERE clause format. The expression returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using IN, BETWEEN, and LIKE keywords.
|
|
136
135
|
*
|
|
137
136
|
* >
|
|
138
|
-
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where
|
|
137
|
+
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/
|
|
139
138
|
*
|
|
140
139
|
* @example
|
|
141
140
|
* title = \\"test\\" AND name like \\"test%\\"
|
|
@@ -156,13 +155,13 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
156
155
|
graphSearchArgs?: QueryContentAdvanceRequestGraphSearchArgs;
|
|
157
156
|
/**
|
|
158
157
|
* @remarks
|
|
159
|
-
* The multi-channel recall algorithm. Default value: empty
|
|
158
|
+
* The multi-channel recall algorithm. Default value: empty (scores from dense vectors and full-text retrieve are directly compared and sorting is performed).
|
|
160
159
|
*
|
|
161
160
|
* Valid values:
|
|
162
161
|
*
|
|
163
|
-
* - RRF: Reciprocal
|
|
164
|
-
* - Weight: Weighted sorting. Parameters control the score weights of
|
|
165
|
-
* - Cascaded: Full-text
|
|
162
|
+
* - RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
|
|
163
|
+
* - Weight: Weighted sorting. Parameters control the score weights of vector retrieve and full-text retrieve results before sorting. For more information, see the HybridSearchArgs configuration.
|
|
164
|
+
* - Cascaded: Full-text retrieve is performed first, followed by vector retrieve on the full-text retrieve results.
|
|
166
165
|
*
|
|
167
166
|
* @example
|
|
168
167
|
* RRF
|
|
@@ -170,9 +169,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
170
169
|
hybridSearch?: string;
|
|
171
170
|
/**
|
|
172
171
|
* @remarks
|
|
173
|
-
* The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text
|
|
172
|
+
* The algorithm parameters for multi-channel recall. Currently, RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text retrieve (fulltext). If the value is empty, dense vectors (dense) and full-text retrieve (fulltext) are recalled by default.
|
|
174
173
|
*
|
|
175
|
-
* - RRF: Specifies the constant
|
|
174
|
+
* - RRF: Specifies the k constant in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
|
|
176
175
|
* ```
|
|
177
176
|
* {
|
|
178
177
|
* "HybridPathsSetting": {
|
|
@@ -186,7 +185,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
186
185
|
*
|
|
187
186
|
* - Weight:
|
|
188
187
|
* - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
|
|
189
|
-
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text
|
|
188
|
+
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text retrieve. Valid values: 0 to 1, where 0 indicates full-text retrieve only and 1 indicates dense vectors only:
|
|
190
189
|
* ```
|
|
191
190
|
* {
|
|
192
191
|
* "Weight": {
|
|
@@ -195,7 +194,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
195
194
|
* }
|
|
196
195
|
* ```
|
|
197
196
|
* - Three-path recall pattern:
|
|
198
|
-
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext
|
|
197
|
+
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext parameters represent the weights of dense vectors, sparse vectors, and full-text retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization on the weights to 0–1 (normalized_x = x / (dense + sparse + fulltext)).
|
|
199
198
|
* ```
|
|
200
199
|
* {
|
|
201
200
|
* "HybridPathsSetting": {
|
|
@@ -220,7 +219,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
220
219
|
includeFileUrl?: boolean;
|
|
221
220
|
/**
|
|
222
221
|
* @remarks
|
|
223
|
-
* The metadata fields to return. Default value: empty.
|
|
222
|
+
* The metadata fields to return, separated by commas. Default value: empty.
|
|
224
223
|
*
|
|
225
224
|
* @example
|
|
226
225
|
* title,page
|
|
@@ -238,7 +237,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
238
237
|
includeVector?: boolean;
|
|
239
238
|
/**
|
|
240
239
|
* @remarks
|
|
241
|
-
* The similarity algorithm used
|
|
240
|
+
* The similarity algorithm used during retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.
|
|
242
241
|
*
|
|
243
242
|
* > Valid values:
|
|
244
243
|
* > - **l2**: Euclidean distance.
|
|
@@ -253,7 +252,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
253
252
|
* @remarks
|
|
254
253
|
* The namespace. Default value: public.
|
|
255
254
|
*
|
|
256
|
-
* > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
|
|
255
|
+
* > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query the list of namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
|
|
257
256
|
*
|
|
258
257
|
* @example
|
|
259
258
|
* mynamespace
|
|
@@ -273,7 +272,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
273
272
|
namespacePassword?: string;
|
|
274
273
|
/**
|
|
275
274
|
* @remarks
|
|
276
|
-
* The offset for
|
|
275
|
+
* The offset for paging query.
|
|
277
276
|
*
|
|
278
277
|
* @example
|
|
279
278
|
* 0
|
|
@@ -283,9 +282,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
283
282
|
* @remarks
|
|
284
283
|
* The field used for sorting. Default value: empty.
|
|
285
284
|
*
|
|
286
|
-
* The field must belong to metadata or a default field in the table
|
|
285
|
+
* The field must belong to metadata or a default field in the table such as id. Supported formats:
|
|
287
286
|
*
|
|
288
|
-
*
|
|
287
|
+
* Single field, such as chunk_id.
|
|
289
288
|
* Multiple fields separated by commas, such as block_id, chunk_id.
|
|
290
289
|
* Descending order, such as block_id DESC, chunk_id DESC.
|
|
291
290
|
*
|
|
@@ -296,9 +295,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
296
295
|
ownerId?: number;
|
|
297
296
|
/**
|
|
298
297
|
* @remarks
|
|
299
|
-
* The recall window. When this value is not empty,
|
|
298
|
+
* The recall window. When this value is not empty, the context of the retrieval results is also returned. The format is a 2-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.
|
|
300
299
|
* > - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.
|
|
301
|
-
* > - Reranking takes priority over windowing
|
|
300
|
+
* > - Reranking takes priority over windowing, meaning reranking is performed first, followed by windowing.
|
|
302
301
|
*/
|
|
303
302
|
recallWindow?: number[];
|
|
304
303
|
/**
|
|
@@ -313,9 +312,9 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
313
312
|
regionId?: string;
|
|
314
313
|
/**
|
|
315
314
|
* @remarks
|
|
316
|
-
* The reranking factor. When this value is not empty, the
|
|
317
|
-
* > - Reranking is
|
|
318
|
-
* > - The total number of
|
|
315
|
+
* The reranking factor. When this value is not empty, the vector retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
316
|
+
* > - Reranking is slower when documents are sparsely chunked.
|
|
317
|
+
* > - The total number of items to rerank (TopK × Factor, rounded up) should not exceed 50.
|
|
319
318
|
*
|
|
320
319
|
* @example
|
|
321
320
|
* 2
|
|
@@ -349,7 +348,7 @@ export class QueryContentAdvanceRequest extends $dara.Model {
|
|
|
349
348
|
urlExpiration?: string;
|
|
350
349
|
/**
|
|
351
350
|
* @remarks
|
|
352
|
-
*
|
|
351
|
+
* **[Deprecated]** Specifies whether to use full-text retrieve (dual-path recall). Default value: false, which indicates that only vector retrieve is used.
|
|
353
352
|
*
|
|
354
353
|
* @example
|
|
355
354
|
* true
|
|
@@ -35,8 +35,7 @@ export class QueryContentRequestGraphSearchArgs extends $dara.Model {
|
|
|
35
35
|
export class QueryContentRequestRerankModel extends $dara.Model {
|
|
36
36
|
/**
|
|
37
37
|
* @remarks
|
|
38
|
-
* This parameter can be set when RerankModel.Name is qwen3-rerank.
|
|
39
|
-
* Adds a custom sorting task type description. This parameter guides the model to adopt different sorting strategies.
|
|
38
|
+
* This parameter can be set when RerankModel.Name is qwen3-rerank. Specifies a custom sorting task type description that guides the model to adopt different sorting strategies.
|
|
40
39
|
*
|
|
41
40
|
* @example
|
|
42
41
|
* Given a web search query, retrieve relevant passages that answer the query
|
|
@@ -44,7 +43,7 @@ export class QueryContentRequestRerankModel extends $dara.Model {
|
|
|
44
43
|
instruct?: string;
|
|
45
44
|
/**
|
|
46
45
|
* @remarks
|
|
47
|
-
* The
|
|
46
|
+
* The rerank model name. Valid values: qwen3-rerank, gte-rerank-v2.
|
|
48
47
|
*
|
|
49
48
|
* @example
|
|
50
49
|
* qwen3-rerank
|
|
@@ -113,7 +112,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
113
112
|
* @remarks
|
|
114
113
|
* The name of the source image file to search in image-to-image search scenarios.
|
|
115
114
|
*
|
|
116
|
-
* > The image file must have a file extension.
|
|
115
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
117
116
|
*
|
|
118
117
|
* @example
|
|
119
118
|
* test.jpg
|
|
@@ -123,7 +122,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
123
122
|
* @remarks
|
|
124
123
|
* The publicly accessible URL of the image file in image-to-image search scenarios.
|
|
125
124
|
*
|
|
126
|
-
* > The image file must have a file extension.
|
|
125
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
127
126
|
*
|
|
128
127
|
* @example
|
|
129
128
|
* https://xx/myImage.jpg
|
|
@@ -131,10 +130,10 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
131
130
|
fileUrl?: string;
|
|
132
131
|
/**
|
|
133
132
|
* @remarks
|
|
134
|
-
* The filter condition for the data to query, in SQL WHERE clause format. The
|
|
133
|
+
* The filter condition for the data to query, in SQL WHERE clause format. The expression returns a Boolean value (true or false). Conditions can be simple comparison operators such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). Conditions can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions using IN, BETWEEN, and LIKE keywords.
|
|
135
134
|
*
|
|
136
135
|
* >
|
|
137
|
-
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where
|
|
136
|
+
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/
|
|
138
137
|
*
|
|
139
138
|
* @example
|
|
140
139
|
* title = \\"test\\" AND name like \\"test%\\"
|
|
@@ -155,13 +154,13 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
155
154
|
graphSearchArgs?: QueryContentRequestGraphSearchArgs;
|
|
156
155
|
/**
|
|
157
156
|
* @remarks
|
|
158
|
-
* The multi-channel recall algorithm. Default value: empty
|
|
157
|
+
* The multi-channel recall algorithm. Default value: empty (scores from dense vectors and full-text retrieve are directly compared and sorting is performed).
|
|
159
158
|
*
|
|
160
159
|
* Valid values:
|
|
161
160
|
*
|
|
162
|
-
* - RRF: Reciprocal
|
|
163
|
-
* - Weight: Weighted sorting. Parameters control the score weights of
|
|
164
|
-
* - Cascaded: Full-text
|
|
161
|
+
* - RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
|
|
162
|
+
* - Weight: Weighted sorting. Parameters control the score weights of vector retrieve and full-text retrieve results before sorting. For more information, see the HybridSearchArgs configuration.
|
|
163
|
+
* - Cascaded: Full-text retrieve is performed first, followed by vector retrieve on the full-text retrieve results.
|
|
165
164
|
*
|
|
166
165
|
* @example
|
|
167
166
|
* RRF
|
|
@@ -169,9 +168,9 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
169
168
|
hybridSearch?: string;
|
|
170
169
|
/**
|
|
171
170
|
* @remarks
|
|
172
|
-
* The algorithm parameters for multi-channel recall. RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text
|
|
171
|
+
* The algorithm parameters for multi-channel recall. Currently, RRF and Weight are supported. HybridPathsSetting specifies the recall paths: dense vectors (dense), sparse vectors (sparse), and full-text retrieve (fulltext). If the value is empty, dense vectors (dense) and full-text retrieve (fulltext) are recalled by default.
|
|
173
172
|
*
|
|
174
|
-
* - RRF: Specifies the constant
|
|
173
|
+
* - RRF: Specifies the k constant in the score calculation formula `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
|
|
175
174
|
* ```
|
|
176
175
|
* {
|
|
177
176
|
* "HybridPathsSetting": {
|
|
@@ -185,7 +184,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
185
184
|
*
|
|
186
185
|
* - Weight:
|
|
187
186
|
* - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
|
|
188
|
-
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text
|
|
187
|
+
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text retrieve. Valid values: 0 to 1, where 0 indicates full-text retrieve only and 1 indicates dense vectors only:
|
|
189
188
|
* ```
|
|
190
189
|
* {
|
|
191
190
|
* "Weight": {
|
|
@@ -194,7 +193,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
194
193
|
* }
|
|
195
194
|
* ```
|
|
196
195
|
* - Three-path recall pattern:
|
|
197
|
-
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext
|
|
196
|
+
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext parameters represent the weights of dense vectors, sparse vectors, and full-text retrieve respectively. Valid values: greater than or equal to 0. The system automatically performs normalization on the weights to 0–1 (normalized_x = x / (dense + sparse + fulltext)).
|
|
198
197
|
* ```
|
|
199
198
|
* {
|
|
200
199
|
* "HybridPathsSetting": {
|
|
@@ -219,7 +218,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
219
218
|
includeFileUrl?: boolean;
|
|
220
219
|
/**
|
|
221
220
|
* @remarks
|
|
222
|
-
* The metadata fields to return. Default value: empty.
|
|
221
|
+
* The metadata fields to return, separated by commas. Default value: empty.
|
|
223
222
|
*
|
|
224
223
|
* @example
|
|
225
224
|
* title,page
|
|
@@ -237,7 +236,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
237
236
|
includeVector?: boolean;
|
|
238
237
|
/**
|
|
239
238
|
* @remarks
|
|
240
|
-
* The similarity algorithm used
|
|
239
|
+
* The similarity algorithm used during retrieval. If this value is empty, the algorithm specified when the knowledge base was created is used. Leave this parameter empty unless you have specific requirements.
|
|
241
240
|
*
|
|
242
241
|
* > Valid values:
|
|
243
242
|
* > - **l2**: Euclidean distance.
|
|
@@ -252,7 +251,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
252
251
|
* @remarks
|
|
253
252
|
* The namespace. Default value: public.
|
|
254
253
|
*
|
|
255
|
-
* > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
|
|
254
|
+
* > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and query the list of namespaces by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
|
|
256
255
|
*
|
|
257
256
|
* @example
|
|
258
257
|
* mynamespace
|
|
@@ -272,7 +271,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
272
271
|
namespacePassword?: string;
|
|
273
272
|
/**
|
|
274
273
|
* @remarks
|
|
275
|
-
* The offset for
|
|
274
|
+
* The offset for paging query.
|
|
276
275
|
*
|
|
277
276
|
* @example
|
|
278
277
|
* 0
|
|
@@ -282,9 +281,9 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
282
281
|
* @remarks
|
|
283
282
|
* The field used for sorting. Default value: empty.
|
|
284
283
|
*
|
|
285
|
-
* The field must belong to metadata or a default field in the table
|
|
284
|
+
* The field must belong to metadata or a default field in the table such as id. Supported formats:
|
|
286
285
|
*
|
|
287
|
-
*
|
|
286
|
+
* Single field, such as chunk_id.
|
|
288
287
|
* Multiple fields separated by commas, such as block_id, chunk_id.
|
|
289
288
|
* Descending order, such as block_id DESC, chunk_id DESC.
|
|
290
289
|
*
|
|
@@ -295,9 +294,9 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
295
294
|
ownerId?: number;
|
|
296
295
|
/**
|
|
297
296
|
* @remarks
|
|
298
|
-
* The recall window. When this value is not empty,
|
|
297
|
+
* The recall window. When this value is not empty, the context of the retrieval results is also returned. The format is a 2-element array: List<A, B>, where -10<=A<=0 and 0<=B<=10.
|
|
299
298
|
* > - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.
|
|
300
|
-
* > - Reranking takes priority over windowing
|
|
299
|
+
* > - Reranking takes priority over windowing, meaning reranking is performed first, followed by windowing.
|
|
301
300
|
*/
|
|
302
301
|
recallWindow?: number[];
|
|
303
302
|
/**
|
|
@@ -312,9 +311,9 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
312
311
|
regionId?: string;
|
|
313
312
|
/**
|
|
314
313
|
* @remarks
|
|
315
|
-
* The reranking factor. When this value is not empty, the
|
|
316
|
-
* > - Reranking is
|
|
317
|
-
* > - The total number of
|
|
314
|
+
* The reranking factor. When this value is not empty, the vector retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
315
|
+
* > - Reranking is slower when documents are sparsely chunked.
|
|
316
|
+
* > - The total number of items to rerank (TopK × Factor, rounded up) should not exceed 50.
|
|
318
317
|
*
|
|
319
318
|
* @example
|
|
320
319
|
* 2
|
|
@@ -348,7 +347,7 @@ export class QueryContentRequest extends $dara.Model {
|
|
|
348
347
|
urlExpiration?: string;
|
|
349
348
|
/**
|
|
350
349
|
* @remarks
|
|
351
|
-
*
|
|
350
|
+
* **[Deprecated]** Specifies whether to use full-text retrieve (dual-path recall). Default value: false, which indicates that only vector retrieve is used.
|
|
352
351
|
*
|
|
353
352
|
* @example
|
|
354
353
|
* true
|
|
@@ -426,8 +426,8 @@ export class QueryContentResponseBody extends $dara.Model {
|
|
|
426
426
|
* @remarks
|
|
427
427
|
* The status. Valid values:
|
|
428
428
|
*
|
|
429
|
-
* - **success**:
|
|
430
|
-
* - **fail**:
|
|
429
|
+
* - **success**: The operation is successful.
|
|
430
|
+
* - **fail**: The operation failed.
|
|
431
431
|
*
|
|
432
432
|
* @example
|
|
433
433
|
* success
|