@alicloud/gpdb20160503 3.11.0 → 3.11.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 +56 -56
- package/dist/client.js +61 -59
- package/dist/client.js.map +1 -1
- 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/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/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 +21 -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/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/model.d.ts +3 -0
- package/dist/models/model.js +38 -32
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +62 -59
- 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/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/ListApiKeysRequest.ts +14 -0
- package/src/models/ListApiKeysResponseBody.ts +45 -0
- package/src/models/ListSaasServiceRequest.ts +1 -1
- package/src/models/ListSaasServiceResponseBody.ts +48 -1
- package/src/models/ListWorkspacesResponseBody.ts +48 -1
- 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/model.ts +3 -0
|
@@ -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
|
|
@@ -39,7 +39,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
39
39
|
* @remarks
|
|
40
40
|
* The name of the source image file to search in image-to-image search scenarios.
|
|
41
41
|
*
|
|
42
|
-
* > The image file must have a file extension.
|
|
42
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
43
43
|
*
|
|
44
44
|
* @example
|
|
45
45
|
* test.jpg
|
|
@@ -49,7 +49,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
49
49
|
* @remarks
|
|
50
50
|
* The publicly accessible URL of the image file in image-to-image search scenarios.
|
|
51
51
|
*
|
|
52
|
-
* > The image file must have a file extension.
|
|
52
|
+
* > The image file must have a file extension. Currently supported image extensions: bmp, jpg, jpeg, png, and tiff.
|
|
53
53
|
*
|
|
54
54
|
* @example
|
|
55
55
|
* https://xx/myImage.jpg
|
|
@@ -57,10 +57,10 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
57
57
|
fileUrl?: string;
|
|
58
58
|
/**
|
|
59
59
|
* @remarks
|
|
60
|
-
* The filter condition for the data to query, in SQL WHERE clause format. The
|
|
60
|
+
* 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.
|
|
61
61
|
*
|
|
62
62
|
* >
|
|
63
|
-
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where
|
|
63
|
+
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/
|
|
64
64
|
*
|
|
65
65
|
* @example
|
|
66
66
|
* title = \\"test\\" AND name like \\"test%\\"
|
|
@@ -81,13 +81,13 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
81
81
|
graphSearchArgsShrink?: string;
|
|
82
82
|
/**
|
|
83
83
|
* @remarks
|
|
84
|
-
* The multi-channel recall algorithm. Default value: empty
|
|
84
|
+
* The multi-channel recall algorithm. Default value: empty (scores from dense vectors and full-text retrieve are directly compared and sorting is performed).
|
|
85
85
|
*
|
|
86
86
|
* Valid values:
|
|
87
87
|
*
|
|
88
|
-
* - RRF: Reciprocal
|
|
89
|
-
* - Weight: Weighted sorting. Parameters control the score weights of
|
|
90
|
-
* - Cascaded: Full-text
|
|
88
|
+
* - RRF: Reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
|
|
89
|
+
* - 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.
|
|
90
|
+
* - Cascaded: Full-text retrieve is performed first, followed by vector retrieve on the full-text retrieve results.
|
|
91
91
|
*
|
|
92
92
|
* @example
|
|
93
93
|
* RRF
|
|
@@ -95,9 +95,9 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
95
95
|
hybridSearch?: string;
|
|
96
96
|
/**
|
|
97
97
|
* @remarks
|
|
98
|
-
* 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
|
|
98
|
+
* 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.
|
|
99
99
|
*
|
|
100
|
-
* - RRF: Specifies the constant
|
|
100
|
+
* - 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:
|
|
101
101
|
* ```
|
|
102
102
|
* {
|
|
103
103
|
* "HybridPathsSetting": {
|
|
@@ -111,7 +111,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
111
111
|
*
|
|
112
112
|
* - Weight:
|
|
113
113
|
* - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
|
|
114
|
-
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text
|
|
114
|
+
* - 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:
|
|
115
115
|
* ```
|
|
116
116
|
* {
|
|
117
117
|
* "Weight": {
|
|
@@ -120,7 +120,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
120
120
|
* }
|
|
121
121
|
* ```
|
|
122
122
|
* - Three-path recall pattern:
|
|
123
|
-
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. The dense, sparse, and fulltext
|
|
123
|
+
* - 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)).
|
|
124
124
|
* ```
|
|
125
125
|
* {
|
|
126
126
|
* "HybridPathsSetting": {
|
|
@@ -145,7 +145,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
145
145
|
includeFileUrl?: boolean;
|
|
146
146
|
/**
|
|
147
147
|
* @remarks
|
|
148
|
-
* The metadata fields to return. Default value: empty.
|
|
148
|
+
* The metadata fields to return, separated by commas. Default value: empty.
|
|
149
149
|
*
|
|
150
150
|
* @example
|
|
151
151
|
* title,page
|
|
@@ -163,7 +163,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
163
163
|
includeVector?: boolean;
|
|
164
164
|
/**
|
|
165
165
|
* @remarks
|
|
166
|
-
* The similarity algorithm used
|
|
166
|
+
* 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.
|
|
167
167
|
*
|
|
168
168
|
* > Valid values:
|
|
169
169
|
* > - **l2**: Euclidean distance.
|
|
@@ -178,7 +178,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
178
178
|
* @remarks
|
|
179
179
|
* The namespace. Default value: public.
|
|
180
180
|
*
|
|
181
|
-
* > 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.
|
|
181
|
+
* > 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.
|
|
182
182
|
*
|
|
183
183
|
* @example
|
|
184
184
|
* mynamespace
|
|
@@ -198,7 +198,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
198
198
|
namespacePassword?: string;
|
|
199
199
|
/**
|
|
200
200
|
* @remarks
|
|
201
|
-
* The offset for
|
|
201
|
+
* The offset for paging query.
|
|
202
202
|
*
|
|
203
203
|
* @example
|
|
204
204
|
* 0
|
|
@@ -208,9 +208,9 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
208
208
|
* @remarks
|
|
209
209
|
* The field used for sorting. Default value: empty.
|
|
210
210
|
*
|
|
211
|
-
* The field must belong to metadata or a default field in the table
|
|
211
|
+
* The field must belong to metadata or a default field in the table such as id. Supported formats:
|
|
212
212
|
*
|
|
213
|
-
*
|
|
213
|
+
* Single field, such as chunk_id.
|
|
214
214
|
* Multiple fields separated by commas, such as block_id, chunk_id.
|
|
215
215
|
* Descending order, such as block_id DESC, chunk_id DESC.
|
|
216
216
|
*
|
|
@@ -221,9 +221,9 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
221
221
|
ownerId?: number;
|
|
222
222
|
/**
|
|
223
223
|
* @remarks
|
|
224
|
-
* The recall window. When this value is not empty,
|
|
224
|
+
* 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.
|
|
225
225
|
* > - Use this parameter when documents are split into overly small chunks and retrieval may lose contextual information.
|
|
226
|
-
* > - Reranking takes priority over windowing
|
|
226
|
+
* > - Reranking takes priority over windowing, meaning reranking is performed first, followed by windowing.
|
|
227
227
|
*/
|
|
228
228
|
recallWindowShrink?: string;
|
|
229
229
|
/**
|
|
@@ -238,9 +238,9 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
238
238
|
regionId?: string;
|
|
239
239
|
/**
|
|
240
240
|
* @remarks
|
|
241
|
-
* The reranking factor. When this value is not empty, the
|
|
242
|
-
* > - Reranking is
|
|
243
|
-
* > - The total number of
|
|
241
|
+
* The reranking factor. When this value is not empty, the vector retrieve results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
242
|
+
* > - Reranking is slower when documents are sparsely chunked.
|
|
243
|
+
* > - The total number of items to rerank (TopK × Factor, rounded up) should not exceed 50.
|
|
244
244
|
*
|
|
245
245
|
* @example
|
|
246
246
|
* 2
|
|
@@ -274,7 +274,7 @@ export class QueryContentShrinkRequest extends $dara.Model {
|
|
|
274
274
|
urlExpiration?: string;
|
|
275
275
|
/**
|
|
276
276
|
* @remarks
|
|
277
|
-
*
|
|
277
|
+
* **[Deprecated]** Specifies whether to use full-text retrieve (dual-path recall). Default value: false, which indicates that only vector retrieve is used.
|
|
278
278
|
*
|
|
279
279
|
* @example
|
|
280
280
|
* true
|
|
@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
|
|
|
4
4
|
|
|
5
5
|
export class ResumeSaasServiceRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
|
+
* @remarks
|
|
8
|
+
* The region ID of the SaaS service.
|
|
9
|
+
*
|
|
7
10
|
* @example
|
|
8
11
|
* cn-hangzhou
|
|
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 ResumeSaasServiceResponseBody 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
|
*/
|
package/src/models/model.ts
CHANGED
|
@@ -53,6 +53,7 @@ export { CreateDBInstanceRequestTag } from './CreateDbinstanceRequest';
|
|
|
53
53
|
export { CreateDocumentCollectionRequestSparseVectorIndexConfig } from './CreateDocumentCollectionRequest';
|
|
54
54
|
export { CreateDocumentCollectionRequestVectorIndexConfig } from './CreateDocumentCollectionRequest';
|
|
55
55
|
export { CreateRemoteADBDataSourceResponseBodyDataSourceItem } from './CreateRemoteAdbdataSourceResponseBody';
|
|
56
|
+
export { CreateSupabaseProjectRequestTags } from './CreateSupabaseProjectRequest';
|
|
56
57
|
export { DescribeAccountsResponseBodyAccountsDBInstanceAccount } from './DescribeAccountsResponseBody';
|
|
57
58
|
export { DescribeAccountsResponseBodyAccounts } from './DescribeAccountsResponseBody';
|
|
58
59
|
export { DescribeActiveSQLRecordsResponseBodyQueries } from './DescribeActiveSqlrecordsResponseBody';
|
|
@@ -205,6 +206,7 @@ export { ListModelServicesResponseBodyModelServices } from './ListModelServicesR
|
|
|
205
206
|
export { ListNamespacesResponseBodyNamespaces } from './ListNamespacesResponseBody';
|
|
206
207
|
export { ListRemoteADBDataSourcesResponseBodyDataSourceItemsRemoteDataSources } from './ListRemoteAdbdataSourcesResponseBody';
|
|
207
208
|
export { ListRemoteADBDataSourcesResponseBodyDataSourceItems } from './ListRemoteAdbdataSourcesResponseBody';
|
|
209
|
+
export { ListSaasServiceResponseBodyItemsComponents } from './ListSaasServiceResponseBody';
|
|
208
210
|
export { ListSaasServiceResponseBodyItems } from './ListSaasServiceResponseBody';
|
|
209
211
|
export { ListSchemasResponseBodySchemas } from './ListSchemasResponseBody';
|
|
210
212
|
export { ListSecretsResponseBodySecretsSecrets } from './ListSecretsResponseBody';
|
|
@@ -223,6 +225,7 @@ export { ListTagResourcesResponseBodyTagResourcesTagResource } from './ListTagRe
|
|
|
223
225
|
export { ListTagResourcesResponseBodyTagResources } from './ListTagResourcesResponseBody';
|
|
224
226
|
export { ListWorkspacesResponseBodyItemsApikeysAuthServices } from './ListWorkspacesResponseBody';
|
|
225
227
|
export { ListWorkspacesResponseBodyItemsApikeys } from './ListWorkspacesResponseBody';
|
|
228
|
+
export { ListWorkspacesResponseBodyItemsServicesComponents } from './ListWorkspacesResponseBody';
|
|
226
229
|
export { ListWorkspacesResponseBodyItemsServices } from './ListWorkspacesResponseBody';
|
|
227
230
|
export { ListWorkspacesResponseBodyItems } from './ListWorkspacesResponseBody';
|
|
228
231
|
export { ModifyDBResourceGroupRequestResourceGroupItems } from './ModifyDbresourceGroupRequest';
|