@alicloud/gpdb20160503 3.7.0 → 3.8.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 +76 -34
- package/dist/client.js +130 -34
- package/dist/client.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseRequest.d.ts +68 -111
- package/dist/models/ChatWithKnowledgeBaseRequest.js +2 -0
- package/dist/models/ChatWithKnowledgeBaseRequest.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseResponseBody.d.ts +45 -52
- package/dist/models/ChatWithKnowledgeBaseResponseBody.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseShrinkRequest.d.ts +5 -6
- package/dist/models/ChatWithKnowledgeBaseShrinkRequest.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseStreamRequest.d.ts +71 -87
- package/dist/models/ChatWithKnowledgeBaseStreamRequest.js +2 -0
- package/dist/models/ChatWithKnowledgeBaseStreamRequest.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseStreamResponseBody.d.ts +44 -50
- package/dist/models/ChatWithKnowledgeBaseStreamResponseBody.js.map +1 -1
- package/dist/models/ChatWithKnowledgeBaseStreamShrinkRequest.d.ts +6 -6
- package/dist/models/PauseSaasServiceRequest.d.ts +26 -0
- package/dist/models/PauseSaasServiceRequest.js +60 -0
- package/dist/models/PauseSaasServiceRequest.js.map +1 -0
- package/dist/models/PauseSaasServiceResponse.d.ts +19 -0
- package/dist/models/PauseSaasServiceResponse.js +69 -0
- package/dist/models/PauseSaasServiceResponse.js.map +1 -0
- package/dist/models/PauseSaasServiceResponseBody.d.ts +23 -0
- package/dist/models/PauseSaasServiceResponseBody.js +60 -0
- package/dist/models/PauseSaasServiceResponseBody.js.map +1 -0
- package/dist/models/QueryContentAdvanceRequest.d.ts +57 -70
- package/dist/models/QueryContentAdvanceRequest.js +2 -0
- package/dist/models/QueryContentAdvanceRequest.js.map +1 -1
- package/dist/models/QueryContentRequest.d.ts +57 -70
- package/dist/models/QueryContentRequest.js +2 -0
- package/dist/models/QueryContentRequest.js.map +1 -1
- package/dist/models/QueryContentResponseBody.d.ts +10 -11
- package/dist/models/QueryContentResponseBody.js.map +1 -1
- package/dist/models/QueryContentShrinkRequest.d.ts +52 -66
- package/dist/models/QueryContentShrinkRequest.js.map +1 -1
- package/dist/models/QueryKnowledgeBasesContentRequest.d.ts +62 -78
- package/dist/models/QueryKnowledgeBasesContentRequest.js +2 -0
- package/dist/models/QueryKnowledgeBasesContentRequest.js.map +1 -1
- package/dist/models/QueryKnowledgeBasesContentResponseBody.d.ts +11 -25
- package/dist/models/QueryKnowledgeBasesContentResponseBody.js.map +1 -1
- package/dist/models/QueryKnowledgeBasesContentShrinkRequest.d.ts +11 -15
- package/dist/models/QueryKnowledgeBasesContentShrinkRequest.js.map +1 -1
- package/dist/models/ResumeSaasServiceRequest.d.ts +26 -0
- package/dist/models/ResumeSaasServiceRequest.js +60 -0
- package/dist/models/ResumeSaasServiceRequest.js.map +1 -0
- package/dist/models/ResumeSaasServiceResponse.d.ts +19 -0
- package/dist/models/ResumeSaasServiceResponse.js +69 -0
- package/dist/models/ResumeSaasServiceResponse.js.map +1 -0
- package/dist/models/ResumeSaasServiceResponseBody.d.ts +23 -0
- package/dist/models/ResumeSaasServiceResponseBody.js +60 -0
- package/dist/models/ResumeSaasServiceResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +6 -0
- package/dist/models/model.js +16 -4
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +138 -34
- package/src/models/ChatWithKnowledgeBaseRequest.ts +70 -111
- package/src/models/ChatWithKnowledgeBaseResponseBody.ts +45 -52
- package/src/models/ChatWithKnowledgeBaseShrinkRequest.ts +5 -6
- package/src/models/ChatWithKnowledgeBaseStreamRequest.ts +73 -87
- package/src/models/ChatWithKnowledgeBaseStreamResponseBody.ts +44 -50
- package/src/models/ChatWithKnowledgeBaseStreamShrinkRequest.ts +6 -6
- package/src/models/PauseSaasServiceRequest.ts +41 -0
- package/src/models/PauseSaasServiceResponse.ts +40 -0
- package/src/models/PauseSaasServiceResponseBody.ts +38 -0
- package/src/models/QueryContentAdvanceRequest.ts +60 -71
- package/src/models/QueryContentRequest.ts +60 -71
- package/src/models/QueryContentResponseBody.ts +10 -11
- package/src/models/QueryContentShrinkRequest.ts +53 -67
- package/src/models/QueryKnowledgeBasesContentRequest.ts +64 -78
- package/src/models/QueryKnowledgeBasesContentResponseBody.ts +11 -25
- package/src/models/QueryKnowledgeBasesContentShrinkRequest.ts +11 -15
- package/src/models/ResumeSaasServiceRequest.ts +41 -0
- package/src/models/ResumeSaasServiceResponse.ts +40 -0
- package/src/models/ResumeSaasServiceResponseBody.ts +38 -0
- package/src/models/model.ts +6 -0
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class QueryKnowledgeBasesContentRequestMergeMethodArgsRrf extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The constant
|
|
8
|
+
* The k constant in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* 60
|
|
@@ -35,7 +35,7 @@ export class QueryKnowledgeBasesContentRequestMergeMethodArgsRrf extends $dara.M
|
|
|
35
35
|
export class QueryKnowledgeBasesContentRequestMergeMethodArgsWeight extends $dara.Model {
|
|
36
36
|
/**
|
|
37
37
|
* @remarks
|
|
38
|
-
*
|
|
38
|
+
* The weight array for each SourceCollection.
|
|
39
39
|
*/
|
|
40
40
|
weights?: number[];
|
|
41
41
|
static names(): { [key: string]: string } {
|
|
@@ -65,12 +65,12 @@ export class QueryKnowledgeBasesContentRequestMergeMethodArgsWeight extends $dar
|
|
|
65
65
|
export class QueryKnowledgeBasesContentRequestMergeMethodArgs extends $dara.Model {
|
|
66
66
|
/**
|
|
67
67
|
* @remarks
|
|
68
|
-
* The parameters
|
|
68
|
+
* The configurable parameters when MergeMethod is set to RRF.
|
|
69
69
|
*/
|
|
70
70
|
rrf?: QueryKnowledgeBasesContentRequestMergeMethodArgsRrf;
|
|
71
71
|
/**
|
|
72
72
|
* @remarks
|
|
73
|
-
* The parameters
|
|
73
|
+
* The configurable parameters when MergeMethod is set to Weight.
|
|
74
74
|
*/
|
|
75
75
|
weight?: QueryKnowledgeBasesContentRequestMergeMethodArgsWeight;
|
|
76
76
|
static names(): { [key: string]: string } {
|
|
@@ -105,7 +105,7 @@ export class QueryKnowledgeBasesContentRequestMergeMethodArgs extends $dara.Mode
|
|
|
105
105
|
export class QueryKnowledgeBasesContentRequestRerankModel extends $dara.Model {
|
|
106
106
|
/**
|
|
107
107
|
* @remarks
|
|
108
|
-
* This parameter can be set
|
|
108
|
+
* This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description that guides the model to adopt different ranking strategies.
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* Given a web search query, retrieve relevant passages that answer the query
|
|
@@ -113,7 +113,7 @@ export class QueryKnowledgeBasesContentRequestRerankModel extends $dara.Model {
|
|
|
113
113
|
instruct?: string;
|
|
114
114
|
/**
|
|
115
115
|
* @remarks
|
|
116
|
-
* The name of the
|
|
116
|
+
* The name of the reranking model. Valid values: qwen3-rerank, gte-rerank-v2.
|
|
117
117
|
*
|
|
118
118
|
* @example
|
|
119
119
|
* qwen3-rerank
|
|
@@ -145,7 +145,7 @@ export class QueryKnowledgeBasesContentRequestRerankModel extends $dara.Model {
|
|
|
145
145
|
export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsGraphSearchArgs extends $dara.Model {
|
|
146
146
|
/**
|
|
147
147
|
* @remarks
|
|
148
|
-
* The number of top entities and relationship edges to return.
|
|
148
|
+
* The number of top entities and relationship edges to return. Default value: 60.
|
|
149
149
|
*
|
|
150
150
|
* @example
|
|
151
151
|
* 60
|
|
@@ -175,7 +175,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsGraphSe
|
|
|
175
175
|
export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsRerankModel extends $dara.Model {
|
|
176
176
|
/**
|
|
177
177
|
* @remarks
|
|
178
|
-
* This parameter can be set
|
|
178
|
+
* This parameter can be set when RerankModel.Name is set to qwen3-rerank. Specifies a custom ranking task type description that guides the model to adopt different ranking strategies.
|
|
179
179
|
*
|
|
180
180
|
* @example
|
|
181
181
|
* Given a web search query, retrieve relevant passages that answer the query
|
|
@@ -183,16 +183,18 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsRerankM
|
|
|
183
183
|
instruct?: string;
|
|
184
184
|
/**
|
|
185
185
|
* @remarks
|
|
186
|
-
* The name of the
|
|
186
|
+
* The name of the reranking model. Valid values: qwen3-rerank, gte-rerank-v2.
|
|
187
187
|
*
|
|
188
188
|
* @example
|
|
189
189
|
* qwen3-rerank
|
|
190
190
|
*/
|
|
191
191
|
name?: string;
|
|
192
|
+
rerankMetadataFields?: string;
|
|
192
193
|
static names(): { [key: string]: string } {
|
|
193
194
|
return {
|
|
194
195
|
instruct: 'Instruct',
|
|
195
196
|
name: 'Name',
|
|
197
|
+
rerankMetadataFields: 'RerankMetadataFields',
|
|
196
198
|
};
|
|
197
199
|
}
|
|
198
200
|
|
|
@@ -200,6 +202,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsRerankM
|
|
|
200
202
|
return {
|
|
201
203
|
instruct: 'string',
|
|
202
204
|
name: 'string',
|
|
205
|
+
rerankMetadataFields: 'string',
|
|
203
206
|
};
|
|
204
207
|
}
|
|
205
208
|
|
|
@@ -215,9 +218,10 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsRerankM
|
|
|
215
218
|
export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extends $dara.Model {
|
|
216
219
|
/**
|
|
217
220
|
* @remarks
|
|
218
|
-
*
|
|
221
|
+
* The filter conditions for the data to query, in SQL WHERE clause format. This is an expression that returns a Boolean value (true or false). The 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 (<=). They can also be more complex expressions combined with logical operators (AND, OR, NOT), as well as conditions that use keywords such as IN, BETWEEN, and LIKE.
|
|
219
222
|
*
|
|
220
|
-
* >
|
|
223
|
+
* >
|
|
224
|
+
* > - For detailed syntax, refer to: https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/.
|
|
221
225
|
*
|
|
222
226
|
* @example
|
|
223
227
|
* id = \\"llm-52tvykqt6u67iw73_j6ovptwjk7_file_6ce3da1f7e69495d9f491f2180c86973_11967297\\"
|
|
@@ -225,7 +229,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
225
229
|
filter?: string;
|
|
226
230
|
/**
|
|
227
231
|
* @remarks
|
|
228
|
-
* Specifies whether to enable knowledge graph enhancement.
|
|
232
|
+
* Specifies whether to enable knowledge graph enhancement. Default value: false.
|
|
229
233
|
*
|
|
230
234
|
* @example
|
|
231
235
|
* true
|
|
@@ -233,20 +237,18 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
233
237
|
graphEnhance?: boolean;
|
|
234
238
|
/**
|
|
235
239
|
* @remarks
|
|
236
|
-
*
|
|
240
|
+
* The number of top entities and relationship edges to return. Default value: 60.
|
|
237
241
|
*/
|
|
238
242
|
graphSearchArgs?: QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsGraphSearchArgs;
|
|
239
243
|
/**
|
|
240
244
|
* @remarks
|
|
241
|
-
* The
|
|
245
|
+
* The multi-channel recall algorithm. Default value: empty (the scores from dense vectors and full-text retrieval are directly compared and sorted).
|
|
242
246
|
*
|
|
243
247
|
* Valid values:
|
|
244
248
|
*
|
|
245
|
-
* -
|
|
246
|
-
*
|
|
247
|
-
* -
|
|
248
|
-
*
|
|
249
|
-
* - `Cascaded`: Performs a full-text search first, and then performs a vector search on the results.
|
|
249
|
+
* - RRF: reciprocal rank fusion. A parameter k controls the fusion effect. For more information, see the HybridSearchArgs configuration.
|
|
250
|
+
* - Weight: weighted ranking. Parameters control the score weights of vector retrieval and full-text retrieval before sorting. For more information, see the HybridSearchArgs configuration.
|
|
251
|
+
* - Cascaded: full-text retrieval is performed first, followed by vector retrieval on the full-text results.
|
|
250
252
|
*
|
|
251
253
|
* @example
|
|
252
254
|
* Cascaded
|
|
@@ -254,10 +256,9 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
254
256
|
hybridSearch?: string;
|
|
255
257
|
/**
|
|
256
258
|
* @remarks
|
|
257
|
-
* The parameters for
|
|
258
|
-
*
|
|
259
|
-
* - `RRF`: Specifies the constant `k` in the scoring formula `1/(k+rank_i)`. `k` must be a positive integer greater than 1. Format:
|
|
259
|
+
* 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 retrieval (fulltext). If this value is empty, dense vectors (dense) and full-text retrieval (fulltext) are used by default.
|
|
260
260
|
*
|
|
261
|
+
* - RRF: specifies the k constant in the scoring algorithm `1/(k+rank_i)`. The value must be a positive integer greater than 1. Format:
|
|
261
262
|
* ```
|
|
262
263
|
* {
|
|
263
264
|
* "HybridPathsSetting": {
|
|
@@ -269,12 +270,9 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
269
270
|
* }
|
|
270
271
|
* ```
|
|
271
272
|
*
|
|
272
|
-
* -
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
* - Scoring formula: `alpha * dense_score + (1-alpha) * fulltext_score`. The `alpha` parameter represents the score weight of dense vectors relative to full-text search. The value must be in the range of [0, 1]. A value of 0 indicates full-text search only, and a value of 1 indicates dense vector search only.
|
|
277
|
-
*
|
|
273
|
+
* - Weight:
|
|
274
|
+
* - Dual-path recall (without specifying HybridPathsSetting, only specifying alpha):
|
|
275
|
+
* - Formula: alpha * dense_score + (1-alpha) * fulltext_score. The alpha parameter specifies the score weight between dense vectors and full-text retrieval. Valid values: 0 to 1, where 0 indicates full-text retrieval only and 1 indicates dense vectors only:
|
|
278
276
|
* ```
|
|
279
277
|
* {
|
|
280
278
|
* "Weight": {
|
|
@@ -282,11 +280,8 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
282
280
|
* }
|
|
283
281
|
* }
|
|
284
282
|
* ```
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* - Scoring formula: `normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score`. The `dense`, `sparse`, and `fulltext` parameters represent the weights for dense vectors, sparse vectors, and full-text search, respectively. The value of each weight must be greater than or equal to 0. The system automatically normalizes the weights to a range of [0, 1] (for example, `normalized_x = x / (dense + sparse + fulltext)`).
|
|
289
|
-
*
|
|
283
|
+
* - Three-path recall pattern:
|
|
284
|
+
* - Formula: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score. dense, sparse, and fulltext represent the weights for dense vectors, sparse vectors, and full-text retrieval respectively. Valid values: greater than or equal to 0. The system automatically performs normalization on the weights to 0 to 1 (normalized_x = x / (dense + sparse + fulltext)).
|
|
290
285
|
* ```
|
|
291
286
|
* {
|
|
292
287
|
* "HybridPathsSetting": {
|
|
@@ -303,13 +298,10 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
303
298
|
hybridSearchArgs?: { [key: string]: any };
|
|
304
299
|
/**
|
|
305
300
|
* @remarks
|
|
306
|
-
* The
|
|
307
|
-
*
|
|
308
|
-
* -
|
|
309
|
-
*
|
|
310
|
-
* - `ip`: Inner product distance.
|
|
311
|
-
*
|
|
312
|
-
* - `cosine`: Cosine similarity.
|
|
301
|
+
* The method used to build the vector index. Valid values:
|
|
302
|
+
* - l2: Euclidean distance.
|
|
303
|
+
* - ip: inner product distance.
|
|
304
|
+
* - cosine: cosine similarity.
|
|
313
305
|
*
|
|
314
306
|
* @example
|
|
315
307
|
* cosine
|
|
@@ -317,7 +309,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
317
309
|
metrics?: string;
|
|
318
310
|
/**
|
|
319
311
|
* @remarks
|
|
320
|
-
* The offset for
|
|
312
|
+
* The offset for paging query.
|
|
321
313
|
*
|
|
322
314
|
* @example
|
|
323
315
|
* 20
|
|
@@ -325,11 +317,13 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
325
317
|
offset?: number;
|
|
326
318
|
/**
|
|
327
319
|
* @remarks
|
|
328
|
-
*
|
|
320
|
+
* The field used for sorting. Default value: empty.
|
|
329
321
|
*
|
|
330
|
-
* The field must
|
|
322
|
+
* The field must belong to metadata or a default field in the table, such as id. Supported formats:
|
|
331
323
|
*
|
|
332
|
-
* A single field, such as
|
|
324
|
+
* A single field, such as chunk_id.
|
|
325
|
+
* Multiple fields separated by commas, such as block_id, chunk_id.
|
|
326
|
+
* Descending order is supported, such as block_id DESC, chunk_id DESC.
|
|
333
327
|
*
|
|
334
328
|
* @example
|
|
335
329
|
* file_id,sort_num
|
|
@@ -337,20 +331,16 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
337
331
|
orderBy?: string;
|
|
338
332
|
/**
|
|
339
333
|
* @remarks
|
|
340
|
-
* The recall window. If
|
|
341
|
-
*
|
|
342
|
-
* > -
|
|
343
|
-
* >
|
|
344
|
-
* > - The system applies reranking before applying the recall window.
|
|
334
|
+
* The recall window. If this value is not empty, the context of the retrieval results is included. The format is a two-element array: List<A, B>, where -10 <= A <= 0 and 0 <= B <= 10.
|
|
335
|
+
* > - Use this parameter when document chunks are too small and retrieval may lose context information.
|
|
336
|
+
* > - Reranking takes priority over windowing. Reranking is performed first, followed by windowing.
|
|
345
337
|
*/
|
|
346
338
|
recallWindow?: number[];
|
|
347
339
|
/**
|
|
348
340
|
* @remarks
|
|
349
|
-
* The reranking factor. If
|
|
350
|
-
*
|
|
351
|
-
* > -
|
|
352
|
-
* >
|
|
353
|
-
* > - We recommend that the number of items to rerank (TopK × Factor, rounded up) does not exceed 50.
|
|
341
|
+
* The reranking factor. If this parameter is not empty, the vector retrieval results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
342
|
+
* > - Reranking is slow when document chunks are sparse.
|
|
343
|
+
* > - The recommended reranking count (TopK × Factor, rounded up) should not exceed 50.
|
|
354
344
|
*
|
|
355
345
|
* @example
|
|
356
346
|
* 2.0
|
|
@@ -358,12 +348,12 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
358
348
|
rerankFactor?: number;
|
|
359
349
|
/**
|
|
360
350
|
* @remarks
|
|
361
|
-
*
|
|
351
|
+
* The reranking model parameters.
|
|
362
352
|
*/
|
|
363
353
|
rerankModel?: QueryKnowledgeBasesContentRequestSourceCollectionQueryParamsRerankModel;
|
|
364
354
|
/**
|
|
365
355
|
* @remarks
|
|
366
|
-
* The number of top results to return
|
|
356
|
+
* The number of top results to return.
|
|
367
357
|
*
|
|
368
358
|
* @example
|
|
369
359
|
* 776
|
|
@@ -371,7 +361,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
371
361
|
topK?: number;
|
|
372
362
|
/**
|
|
373
363
|
* @remarks
|
|
374
|
-
* Specifies whether to use full-text
|
|
364
|
+
* Specifies whether to use full-text retrieval (dual-path recall). Default value: false, which indicates that only vector retrieval is used.
|
|
375
365
|
*
|
|
376
366
|
* @example
|
|
377
367
|
* false
|
|
@@ -437,9 +427,9 @@ export class QueryKnowledgeBasesContentRequestSourceCollectionQueryParams extend
|
|
|
437
427
|
export class QueryKnowledgeBasesContentRequestSourceCollection extends $dara.Model {
|
|
438
428
|
/**
|
|
439
429
|
* @remarks
|
|
440
|
-
* The document collection
|
|
430
|
+
* The name of the document collection.
|
|
441
431
|
*
|
|
442
|
-
* >
|
|
432
|
+
* > The document collection is created by calling the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation. You can call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to view existing document collections.
|
|
443
433
|
*
|
|
444
434
|
* This parameter is required.
|
|
445
435
|
*
|
|
@@ -451,7 +441,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollection extends $dara.Mod
|
|
|
451
441
|
* @remarks
|
|
452
442
|
* The namespace.
|
|
453
443
|
*
|
|
454
|
-
* > You can
|
|
444
|
+
* > You can create a namespace by calling the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation and view the list by calling the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
|
|
455
445
|
*
|
|
456
446
|
* @example
|
|
457
447
|
* ns_cloud_index
|
|
@@ -459,9 +449,9 @@ export class QueryKnowledgeBasesContentRequestSourceCollection extends $dara.Mod
|
|
|
459
449
|
namespace?: string;
|
|
460
450
|
/**
|
|
461
451
|
* @remarks
|
|
462
|
-
* The password
|
|
452
|
+
* The password of the namespace.
|
|
463
453
|
*
|
|
464
|
-
* >
|
|
454
|
+
* > This value is specified by the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation.
|
|
465
455
|
*
|
|
466
456
|
* This parameter is required.
|
|
467
457
|
*
|
|
@@ -471,7 +461,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollection extends $dara.Mod
|
|
|
471
461
|
namespacePassword?: string;
|
|
472
462
|
/**
|
|
473
463
|
* @remarks
|
|
474
|
-
* The
|
|
464
|
+
* The filter conditions for the data to query, in SQL WHERE clause format.
|
|
475
465
|
*/
|
|
476
466
|
queryParams?: QueryKnowledgeBasesContentRequestSourceCollectionQueryParams;
|
|
477
467
|
static names(): { [key: string]: string } {
|
|
@@ -507,7 +497,7 @@ export class QueryKnowledgeBasesContentRequestSourceCollection extends $dara.Mod
|
|
|
507
497
|
export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
508
498
|
/**
|
|
509
499
|
* @remarks
|
|
510
|
-
* The text content
|
|
500
|
+
* The text content used for retrieval.
|
|
511
501
|
*
|
|
512
502
|
* This parameter is required.
|
|
513
503
|
*
|
|
@@ -519,7 +509,7 @@ export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
|
519
509
|
* @remarks
|
|
520
510
|
* The instance ID.
|
|
521
511
|
*
|
|
522
|
-
* > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to
|
|
512
|
+
* > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
|
|
523
513
|
*
|
|
524
514
|
* This parameter is required.
|
|
525
515
|
*
|
|
@@ -529,11 +519,9 @@ export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
|
529
519
|
DBInstanceId?: string;
|
|
530
520
|
/**
|
|
531
521
|
* @remarks
|
|
532
|
-
* The method
|
|
533
|
-
*
|
|
522
|
+
* The method used to merge results from multiple knowledge bases. Default value: RRF. Valid values:
|
|
534
523
|
* - RRF
|
|
535
|
-
*
|
|
536
|
-
* - Weight
|
|
524
|
+
* - Weight.
|
|
537
525
|
*
|
|
538
526
|
* @example
|
|
539
527
|
* RRF
|
|
@@ -541,7 +529,7 @@ export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
|
541
529
|
mergeMethod?: string;
|
|
542
530
|
/**
|
|
543
531
|
* @remarks
|
|
544
|
-
* The
|
|
532
|
+
* The parameters for the merge method of each SourceCollection.
|
|
545
533
|
*/
|
|
546
534
|
mergeMethodArgs?: QueryKnowledgeBasesContentRequestMergeMethodArgs;
|
|
547
535
|
ownerId?: number;
|
|
@@ -557,11 +545,9 @@ export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
|
557
545
|
regionId?: string;
|
|
558
546
|
/**
|
|
559
547
|
* @remarks
|
|
560
|
-
* The reranking factor. If
|
|
561
|
-
*
|
|
562
|
-
* > -
|
|
563
|
-
* >
|
|
564
|
-
* > - We recommend that the number of items to rerank (TopK × Factor, rounded up) does not exceed 50.
|
|
548
|
+
* The reranking factor. If this parameter is not empty, the vector retrieval results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
549
|
+
* > - Reranking is slow when document chunks are sparse.
|
|
550
|
+
* > - The recommended reranking count (TopK × Factor, rounded up) should not exceed 50.
|
|
565
551
|
*
|
|
566
552
|
* @example
|
|
567
553
|
* 2
|
|
@@ -569,19 +555,19 @@ export class QueryKnowledgeBasesContentRequest extends $dara.Model {
|
|
|
569
555
|
rerankFactor?: number;
|
|
570
556
|
/**
|
|
571
557
|
* @remarks
|
|
572
|
-
*
|
|
558
|
+
* The reranking model parameters for performing an additional reranking on the overall results after multi-channel merging.
|
|
573
559
|
*/
|
|
574
560
|
rerankModel?: QueryKnowledgeBasesContentRequestRerankModel;
|
|
575
561
|
/**
|
|
576
562
|
* @remarks
|
|
577
|
-
* The
|
|
563
|
+
* The information about the multiple collections to retrieve.
|
|
578
564
|
*
|
|
579
565
|
* This parameter is required.
|
|
580
566
|
*/
|
|
581
567
|
sourceCollection?: QueryKnowledgeBasesContentRequestSourceCollection[];
|
|
582
568
|
/**
|
|
583
569
|
* @remarks
|
|
584
|
-
* The number of top results to return after
|
|
570
|
+
* The number of top results to return after multi-channel recall merging.
|
|
585
571
|
*
|
|
586
572
|
* @example
|
|
587
573
|
* 10
|
|
@@ -203,9 +203,9 @@ export class QueryKnowledgeBasesContentResponseBodyRelations extends $dara.Model
|
|
|
203
203
|
export class QueryKnowledgeBasesContentResponseBodyUsage extends $dara.Model {
|
|
204
204
|
/**
|
|
205
205
|
* @remarks
|
|
206
|
-
* The number of entries used
|
|
206
|
+
* The number of entries used during vectorization.
|
|
207
207
|
*
|
|
208
|
-
* > An entry
|
|
208
|
+
* > An entry refers to the number of items processed during vectorization of text or images. For example, processing text once counts as 1 entry, and processing an image once counts as 2 entries.
|
|
209
209
|
*
|
|
210
210
|
* @example
|
|
211
211
|
* 10
|
|
@@ -213,9 +213,9 @@ export class QueryKnowledgeBasesContentResponseBodyUsage extends $dara.Model {
|
|
|
213
213
|
embeddingEntries?: string;
|
|
214
214
|
/**
|
|
215
215
|
* @remarks
|
|
216
|
-
* The number of tokens used
|
|
216
|
+
* The number of tokens used during vectorization.
|
|
217
217
|
*
|
|
218
|
-
* > A token is the smallest unit
|
|
218
|
+
* > A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.
|
|
219
219
|
*
|
|
220
220
|
* @example
|
|
221
221
|
* 475
|
|
@@ -247,36 +247,24 @@ export class QueryKnowledgeBasesContentResponseBodyUsage extends $dara.Model {
|
|
|
247
247
|
export class QueryKnowledgeBasesContentResponseBody extends $dara.Model {
|
|
248
248
|
/**
|
|
249
249
|
* @remarks
|
|
250
|
-
* The number of tokens used
|
|
250
|
+
* The number of tokens used during vectorization.
|
|
251
251
|
*
|
|
252
|
-
* > A token is the smallest unit
|
|
252
|
+
* > A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.
|
|
253
253
|
*
|
|
254
254
|
* @example
|
|
255
255
|
* 100
|
|
256
256
|
*/
|
|
257
257
|
embeddingTokens?: string;
|
|
258
|
-
/**
|
|
259
|
-
* @remarks
|
|
260
|
-
* The extracted entities.
|
|
261
|
-
*/
|
|
262
258
|
entities?: QueryKnowledgeBasesContentResponseBodyEntities;
|
|
263
|
-
/**
|
|
264
|
-
* @remarks
|
|
265
|
-
* The matched data.
|
|
266
|
-
*/
|
|
267
259
|
matches?: QueryKnowledgeBasesContentResponseBodyMatches;
|
|
268
260
|
/**
|
|
269
261
|
* @remarks
|
|
270
|
-
* The
|
|
262
|
+
* The returned message.
|
|
271
263
|
*
|
|
272
264
|
* @example
|
|
273
265
|
* success
|
|
274
266
|
*/
|
|
275
267
|
message?: string;
|
|
276
|
-
/**
|
|
277
|
-
* @remarks
|
|
278
|
-
* The extracted relationships.
|
|
279
|
-
*/
|
|
280
268
|
relations?: QueryKnowledgeBasesContentResponseBodyRelations;
|
|
281
269
|
/**
|
|
282
270
|
* @remarks
|
|
@@ -288,11 +276,9 @@ export class QueryKnowledgeBasesContentResponseBody extends $dara.Model {
|
|
|
288
276
|
requestId?: string;
|
|
289
277
|
/**
|
|
290
278
|
* @remarks
|
|
291
|
-
* The
|
|
292
|
-
*
|
|
293
|
-
* - **
|
|
294
|
-
*
|
|
295
|
-
* - **fail**: The request failed.
|
|
279
|
+
* The API execution status. Valid values:
|
|
280
|
+
* - **success**: The execution is successful.
|
|
281
|
+
* - **fail**: The execution failed.
|
|
296
282
|
*
|
|
297
283
|
* @example
|
|
298
284
|
* success
|
|
@@ -300,7 +286,7 @@ export class QueryKnowledgeBasesContentResponseBody extends $dara.Model {
|
|
|
300
286
|
status?: string;
|
|
301
287
|
/**
|
|
302
288
|
* @remarks
|
|
303
|
-
* The resource usage
|
|
289
|
+
* The resource usage of this query.
|
|
304
290
|
*/
|
|
305
291
|
usage?: QueryKnowledgeBasesContentResponseBodyUsage;
|
|
306
292
|
static names(): { [key: string]: string } {
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The text content
|
|
8
|
+
* The text content used for retrieval.
|
|
9
9
|
*
|
|
10
10
|
* This parameter is required.
|
|
11
11
|
*
|
|
@@ -17,7 +17,7 @@ export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
|
17
17
|
* @remarks
|
|
18
18
|
* The instance ID.
|
|
19
19
|
*
|
|
20
|
-
* > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to
|
|
20
|
+
* > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
|
|
21
21
|
*
|
|
22
22
|
* This parameter is required.
|
|
23
23
|
*
|
|
@@ -27,11 +27,9 @@ export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
|
27
27
|
DBInstanceId?: string;
|
|
28
28
|
/**
|
|
29
29
|
* @remarks
|
|
30
|
-
* The method
|
|
31
|
-
*
|
|
30
|
+
* The method used to merge results from multiple knowledge bases. Default value: RRF. Valid values:
|
|
32
31
|
* - RRF
|
|
33
|
-
*
|
|
34
|
-
* - Weight
|
|
32
|
+
* - Weight.
|
|
35
33
|
*
|
|
36
34
|
* @example
|
|
37
35
|
* RRF
|
|
@@ -39,7 +37,7 @@ export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
|
39
37
|
mergeMethod?: string;
|
|
40
38
|
/**
|
|
41
39
|
* @remarks
|
|
42
|
-
* The
|
|
40
|
+
* The parameters for the merge method of each SourceCollection.
|
|
43
41
|
*/
|
|
44
42
|
mergeMethodArgsShrink?: string;
|
|
45
43
|
ownerId?: number;
|
|
@@ -55,11 +53,9 @@ export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
|
55
53
|
regionId?: string;
|
|
56
54
|
/**
|
|
57
55
|
* @remarks
|
|
58
|
-
* The reranking factor. If
|
|
59
|
-
*
|
|
60
|
-
* > -
|
|
61
|
-
* >
|
|
62
|
-
* > - We recommend that the number of items to rerank (TopK × Factor, rounded up) does not exceed 50.
|
|
56
|
+
* The reranking factor. If this parameter is not empty, the vector retrieval results are reranked. Valid values: 1 < RerankFactor <= 5.
|
|
57
|
+
* > - Reranking is slow when document chunks are sparse.
|
|
58
|
+
* > - The recommended reranking count (TopK × Factor, rounded up) should not exceed 50.
|
|
63
59
|
*
|
|
64
60
|
* @example
|
|
65
61
|
* 2
|
|
@@ -67,19 +63,19 @@ export class QueryKnowledgeBasesContentShrinkRequest extends $dara.Model {
|
|
|
67
63
|
rerankFactor?: number;
|
|
68
64
|
/**
|
|
69
65
|
* @remarks
|
|
70
|
-
*
|
|
66
|
+
* The reranking model parameters for performing an additional reranking on the overall results after multi-channel merging.
|
|
71
67
|
*/
|
|
72
68
|
rerankModelShrink?: string;
|
|
73
69
|
/**
|
|
74
70
|
* @remarks
|
|
75
|
-
* The
|
|
71
|
+
* The information about the multiple collections to retrieve.
|
|
76
72
|
*
|
|
77
73
|
* This parameter is required.
|
|
78
74
|
*/
|
|
79
75
|
sourceCollectionShrink?: string;
|
|
80
76
|
/**
|
|
81
77
|
* @remarks
|
|
82
|
-
* The number of top results to return after
|
|
78
|
+
* The number of top results to return after multi-channel recall merging.
|
|
83
79
|
*
|
|
84
80
|
* @example
|
|
85
81
|
* 10
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// This file is auto-generated, don't edit it
|
|
2
|
+
import * as $dara from '@darabonba/typescript';
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
export class ResumeSaasServiceRequest extends $dara.Model {
|
|
6
|
+
/**
|
|
7
|
+
* @example
|
|
8
|
+
* cn-hangzhou
|
|
9
|
+
*/
|
|
10
|
+
regionId?: string;
|
|
11
|
+
/**
|
|
12
|
+
* @remarks
|
|
13
|
+
* This parameter is required.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* agdb-xxxxx
|
|
17
|
+
*/
|
|
18
|
+
serviceId?: string;
|
|
19
|
+
static names(): { [key: string]: string } {
|
|
20
|
+
return {
|
|
21
|
+
regionId: 'RegionId',
|
|
22
|
+
serviceId: 'ServiceId',
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
static types(): { [key: string]: any } {
|
|
27
|
+
return {
|
|
28
|
+
regionId: 'string',
|
|
29
|
+
serviceId: 'string',
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
validate() {
|
|
34
|
+
super.validate();
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
constructor(map?: { [key: string]: any }) {
|
|
38
|
+
super(map);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// This file is auto-generated, don't edit it
|
|
2
|
+
import * as $dara from '@darabonba/typescript';
|
|
3
|
+
import { ResumeSaasServiceResponseBody } from "./ResumeSaasServiceResponseBody";
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
export class ResumeSaasServiceResponse extends $dara.Model {
|
|
7
|
+
headers?: { [key: string]: string };
|
|
8
|
+
statusCode?: number;
|
|
9
|
+
body?: ResumeSaasServiceResponseBody;
|
|
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: ResumeSaasServiceResponseBody,
|
|
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
|
+
|