@alicloud/bailian20231229 2.14.0 → 2.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +38 -40
- package/dist/client.js +47 -41
- package/dist/client.js.map +1 -1
- package/dist/models/AddChunkRequest.d.ts +1 -1
- package/dist/models/AddChunkShrinkRequest.d.ts +1 -1
- package/dist/models/CreateIndexRequest.d.ts +163 -159
- package/dist/models/CreateIndexRequest.js.map +1 -1
- package/dist/models/CreateIndexResponseBody.d.ts +11 -13
- package/dist/models/CreateIndexResponseBody.js.map +1 -1
- package/dist/models/CreateIndexShrinkRequest.d.ts +137 -127
- package/dist/models/CreateIndexShrinkRequest.js.map +1 -1
- package/dist/models/DeleteConnectorResponseBody.d.ts +24 -0
- package/dist/models/DeleteConnectorResponseBody.js.map +1 -1
- package/dist/models/ListIndexFileDetailsRequest.d.ts +5 -5
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +11 -10
- package/dist/models/ListIndexFileDetailsResponseBody.js +2 -0
- package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
- package/dist/models/ListPublishedAgentRequest.d.ts +1 -0
- package/dist/models/ListPublishedAgentRequest.js +5 -0
- package/dist/models/ListPublishedAgentRequest.js.map +1 -1
- package/dist/models/ListPublishedAgentResponseBody.d.ts +3 -0
- package/dist/models/ListPublishedAgentResponseBody.js +6 -0
- package/dist/models/ListPublishedAgentResponseBody.js.map +1 -1
- package/dist/models/ListPublishedAgentShrinkRequest.d.ts +16 -0
- package/dist/models/ListPublishedAgentShrinkRequest.js +62 -0
- package/dist/models/ListPublishedAgentShrinkRequest.js.map +1 -0
- package/dist/models/model.d.ts +1 -0
- package/dist/models/model.js +4 -2
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +49 -41
- package/src/models/AddChunkRequest.ts +1 -1
- package/src/models/AddChunkShrinkRequest.ts +1 -1
- package/src/models/CreateIndexRequest.ts +163 -159
- package/src/models/CreateIndexResponseBody.ts +11 -13
- package/src/models/CreateIndexShrinkRequest.ts +137 -127
- package/src/models/DeleteConnectorResponseBody.ts +24 -0
- package/src/models/ListIndexFileDetailsRequest.ts +5 -5
- package/src/models/ListIndexFileDetailsResponseBody.ts +13 -10
- package/src/models/ListPublishedAgentRequest.ts +6 -0
- package/src/models/ListPublishedAgentResponseBody.ts +9 -0
- package/src/models/ListPublishedAgentShrinkRequest.ts +33 -0
- package/src/models/model.ts +1 -0
|
@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class CreateIndexRequestColumns extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* > This parameter is not
|
|
8
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
9
|
+
* >
|
|
9
10
|
*
|
|
10
11
|
* @example
|
|
11
12
|
* school
|
|
@@ -15,17 +16,18 @@ export class CreateIndexRequestColumns extends $dara.Model {
|
|
|
15
16
|
* @remarks
|
|
16
17
|
* <props="china">
|
|
17
18
|
*
|
|
18
|
-
* Specifies whether
|
|
19
|
+
* Specifies whether this column participates in model responses. When enabled, the search results of this column are used as input for the large language model to generate answers. Valid values:
|
|
19
20
|
*
|
|
20
21
|
* - true: Enabled.
|
|
21
|
-
*
|
|
22
22
|
* - false: Disabled.
|
|
23
23
|
*
|
|
24
24
|
*
|
|
25
25
|
*
|
|
26
|
+
*
|
|
26
27
|
* <props="intl">
|
|
27
28
|
*
|
|
28
|
-
* > This parameter is not
|
|
29
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
30
|
+
* >
|
|
29
31
|
*
|
|
30
32
|
* @example
|
|
31
33
|
* true
|
|
@@ -35,17 +37,18 @@ export class CreateIndexRequestColumns extends $dara.Model {
|
|
|
35
37
|
* @remarks
|
|
36
38
|
* <props="china">
|
|
37
39
|
*
|
|
38
|
-
* Specifies whether
|
|
40
|
+
* Specifies whether this column participates in knowledge base retrieval. When enabled, the knowledge base can search within the data of this column. Valid values:
|
|
39
41
|
*
|
|
40
42
|
* - true: Enabled.
|
|
41
|
-
*
|
|
42
43
|
* - false: Disabled.
|
|
43
44
|
*
|
|
44
45
|
*
|
|
45
46
|
*
|
|
47
|
+
*
|
|
46
48
|
* <props="intl">
|
|
47
49
|
*
|
|
48
|
-
* > This parameter is not
|
|
50
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
51
|
+
* >
|
|
49
52
|
*
|
|
50
53
|
* @example
|
|
51
54
|
* true
|
|
@@ -54,40 +57,37 @@ export class CreateIndexRequestColumns extends $dara.Model {
|
|
|
54
57
|
/**
|
|
55
58
|
* @remarks
|
|
56
59
|
* <props="china">
|
|
57
|
-
*
|
|
58
|
-
* The field name. It must be consistent with the table header of the data table created in Application Data.
|
|
60
|
+
* The field name. Must be consistent with the header of the data table created in Application Data.
|
|
59
61
|
*
|
|
60
62
|
*
|
|
61
63
|
*
|
|
62
64
|
* <props="intl">
|
|
63
65
|
*
|
|
64
|
-
* > This parameter is not
|
|
66
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
67
|
+
* >
|
|
65
68
|
*
|
|
66
69
|
* @example
|
|
67
|
-
*
|
|
70
|
+
* School.
|
|
68
71
|
*/
|
|
69
72
|
name?: string;
|
|
70
73
|
/**
|
|
71
74
|
* @remarks
|
|
72
75
|
* <props="china">
|
|
73
76
|
*
|
|
74
|
-
* The field type.
|
|
77
|
+
* The field type. Must be consistent with the header of the data table created in Application Data. Valid values:
|
|
75
78
|
*
|
|
76
79
|
* - string
|
|
77
|
-
*
|
|
78
80
|
* - double
|
|
79
|
-
*
|
|
80
81
|
* - long
|
|
81
|
-
*
|
|
82
82
|
* - datetime
|
|
83
|
-
*
|
|
84
83
|
* - image_url
|
|
85
84
|
*
|
|
86
85
|
*
|
|
87
86
|
*
|
|
88
87
|
* <props="intl">
|
|
89
88
|
*
|
|
90
|
-
* > This parameter is not
|
|
89
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
90
|
+
* >
|
|
91
91
|
*
|
|
92
92
|
* @example
|
|
93
93
|
* string
|
|
@@ -125,21 +125,20 @@ export class CreateIndexRequestColumns extends $dara.Model {
|
|
|
125
125
|
export class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
126
126
|
/**
|
|
127
127
|
* @remarks
|
|
128
|
-
* The Chinese description of the metadata field. The description can be
|
|
128
|
+
* The Chinese description of the metadata field. The description can be up to 1000 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and colons (:). Default value: empty.
|
|
129
129
|
*
|
|
130
130
|
* @example
|
|
131
|
-
*
|
|
131
|
+
* AuthorName.
|
|
132
132
|
*/
|
|
133
133
|
desc?: string;
|
|
134
134
|
/**
|
|
135
135
|
* @remarks
|
|
136
|
-
*
|
|
136
|
+
* Specifies whether this metadata field and its value participate in the large language model\\"s answer generation process along with the text chunk content. Valid values:
|
|
137
137
|
*
|
|
138
138
|
* - true: Enabled.
|
|
139
|
-
*
|
|
140
139
|
* - false: Disabled.
|
|
141
140
|
*
|
|
142
|
-
*
|
|
141
|
+
* Default value: false.
|
|
143
142
|
*
|
|
144
143
|
* @example
|
|
145
144
|
* false
|
|
@@ -147,13 +146,12 @@ export class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
147
146
|
enableLlm?: boolean;
|
|
148
147
|
/**
|
|
149
148
|
* @remarks
|
|
150
|
-
*
|
|
149
|
+
* Specifies whether this metadata field and its value participate in knowledge base retrieval along with the text chunk content. Valid values:
|
|
151
150
|
*
|
|
152
151
|
* - true: Enabled.
|
|
153
|
-
*
|
|
154
152
|
* - false: Disabled.
|
|
155
153
|
*
|
|
156
|
-
*
|
|
154
|
+
* Default value: false.
|
|
157
155
|
*
|
|
158
156
|
* @example
|
|
159
157
|
* false
|
|
@@ -161,7 +159,7 @@ export class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
161
159
|
enableSearch?: boolean;
|
|
162
160
|
/**
|
|
163
161
|
* @remarks
|
|
164
|
-
* The metadata field. The field
|
|
162
|
+
* The metadata field. The field must be 1 to 50 characters in length and can contain only letters and underscores. If this parameter is specified, you must also specify the `Value` and `Type` parameters.
|
|
165
163
|
*
|
|
166
164
|
* @example
|
|
167
165
|
* author
|
|
@@ -169,16 +167,12 @@ export class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
169
167
|
key?: string;
|
|
170
168
|
/**
|
|
171
169
|
* @remarks
|
|
172
|
-
* The method for
|
|
170
|
+
* The extraction method for the metadata field. Valid values:
|
|
173
171
|
*
|
|
174
172
|
* - constant: Constant.
|
|
175
|
-
*
|
|
176
173
|
* - variable: Variable.
|
|
177
|
-
*
|
|
178
|
-
* - custom_prompt: Large Language Model (LLM).
|
|
179
|
-
*
|
|
174
|
+
* - custom_prompt: Large language model.
|
|
180
175
|
* - regular: Regular expression.
|
|
181
|
-
*
|
|
182
176
|
* - keywords: Keyword search.
|
|
183
177
|
*
|
|
184
178
|
* @example
|
|
@@ -227,30 +221,28 @@ export class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
227
221
|
export class CreateIndexRequest extends $dara.Model {
|
|
228
222
|
/**
|
|
229
223
|
* @remarks
|
|
230
|
-
*
|
|
224
|
+
* The list of category IDs to import when creating the knowledge base. All files under the specified categories are imported. We recommend importing no more than 500 files. For remaining files, call the **SubmitIndexAddDocumentsJob** operation to continue importing.
|
|
231
225
|
*/
|
|
232
226
|
categoryIds?: string[];
|
|
233
227
|
/**
|
|
234
228
|
* @remarks
|
|
235
229
|
* <props="china">
|
|
236
230
|
*
|
|
237
|
-
* The chunk size, which
|
|
231
|
+
* The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded:
|
|
238
232
|
*
|
|
239
|
-
* - **
|
|
240
|
-
*
|
|
241
|
-
* - **Custom chunking** (the \\`chunkMode\\` parameter is specified): The text is forcibly truncated.
|
|
233
|
+
* - **Intelligent chunking** (when `chunkMode` is not specified): The text is likely to be truncated.
|
|
234
|
+
* - **Custom chunking** (when `chunkMode` is specified): The text is forcibly truncated.
|
|
242
235
|
*
|
|
243
236
|
*
|
|
244
237
|
*
|
|
245
238
|
* <props="intl">
|
|
246
|
-
*
|
|
247
|
-
* The chunk size, which is the maximum number of characters for each text chunk. If this length is exceeded, the text is likely to be truncated.
|
|
239
|
+
* The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded, the text is likely to be truncated.
|
|
248
240
|
*
|
|
249
241
|
*
|
|
250
242
|
*
|
|
251
|
-
*
|
|
243
|
+
* Value range: [1-6000]. If not specified, the default value is 500.
|
|
252
244
|
*
|
|
253
|
-
* > If
|
|
245
|
+
* > If `ChunkSize` is set to a value less than 100, you must also set `OverlapSize`. You can also leave both parameters unspecified, and the system uses default values.
|
|
254
246
|
*
|
|
255
247
|
* @example
|
|
256
248
|
* 128
|
|
@@ -259,19 +251,19 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
259
251
|
/**
|
|
260
252
|
* @remarks
|
|
261
253
|
* <props="china">
|
|
262
|
-
*
|
|
263
254
|
* The structure of the data table (column names, types, etc.).
|
|
264
255
|
*
|
|
265
256
|
*
|
|
266
|
-
*
|
|
267
257
|
* <props="intl">
|
|
268
258
|
*
|
|
269
|
-
* > This parameter is not
|
|
259
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
260
|
+
* >
|
|
270
261
|
*/
|
|
271
262
|
columns?: CreateIndexRequestColumns[];
|
|
272
263
|
/**
|
|
273
264
|
* @remarks
|
|
274
|
-
* > This parameter is not
|
|
265
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
266
|
+
* >
|
|
275
267
|
*
|
|
276
268
|
* @example
|
|
277
269
|
* standard
|
|
@@ -279,42 +271,40 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
279
271
|
createIndexType?: string;
|
|
280
272
|
/**
|
|
281
273
|
* @remarks
|
|
282
|
-
* The
|
|
283
|
-
*
|
|
274
|
+
* The knowledge base description. The description can be up to 1000 characters in length.
|
|
275
|
+
* Default value: empty.
|
|
284
276
|
*
|
|
285
277
|
* @example
|
|
286
|
-
*
|
|
278
|
+
* The enterprise help document library includes important materials such as company policies and product catalogs.
|
|
287
279
|
*/
|
|
288
280
|
description?: string;
|
|
289
281
|
/**
|
|
290
282
|
* @remarks
|
|
291
|
-
*
|
|
283
|
+
* The list of files to import when creating the knowledge base. Specify file IDs here. We recommend importing no more than 10,000 files. For remaining files, call the **SubmitIndexAddDocumentsJob** operation to continue importing.
|
|
292
284
|
*/
|
|
293
285
|
documentIds?: string[];
|
|
294
286
|
/**
|
|
295
287
|
* @remarks
|
|
296
288
|
* <props="china">
|
|
297
289
|
*
|
|
298
|
-
* The
|
|
299
|
-
*
|
|
290
|
+
* The embedding model used by the knowledge base. The embedding model transforms the original input prompt and knowledge text into numerical vectors for similarity comparison. The text-embedding-v4 model is a comprehensive upgrade over text-embedding-v3 in terms of language support, code snippet quantization, and vector dimensions selection, and is suitable for most scenarios. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
|
|
300
291
|
* - text-embedding-v4
|
|
301
|
-
*
|
|
302
292
|
* - text-embedding-v3
|
|
303
293
|
*
|
|
304
|
-
*
|
|
305
|
-
*
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
* <props="intl">
|
|
294
|
+
* Default value: empty, which uses the text-embedding-v3 model.
|
|
309
295
|
*
|
|
310
|
-
* - The vector model used by the knowledge base. A vector model converts the original input prompt and knowledge text into numerical vectors to compare their similarity. The default text-embedding-v2 model (which cannot be changed for now) supports both Chinese and English, along with multiple other languages, and normalizes the vector results. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
|
|
311
296
|
*
|
|
312
297
|
*
|
|
313
298
|
*
|
|
299
|
+
* <props="intl">
|
|
314
300
|
*
|
|
301
|
+
* The embedding model used by the knowledge base. The embedding model transforms the original input prompt and knowledge text into numerical vectors for similarity comparison. The default text-embedding-v2 model (cannot be changed) supports Chinese, English, and multiple other languages, and performs normalization on vector results. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
|
|
315
302
|
* - text-embedding-v2
|
|
316
303
|
*
|
|
317
|
-
*
|
|
304
|
+
* Default value: empty, which uses the text-embedding-v2 model.
|
|
305
|
+
*
|
|
306
|
+
* @example
|
|
307
|
+
* text-embedding-v4
|
|
318
308
|
*/
|
|
319
309
|
embeddingModelName?: string;
|
|
320
310
|
/**
|
|
@@ -322,10 +312,9 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
322
312
|
* Specifies whether to enable multi-turn conversation rewriting. Valid values:
|
|
323
313
|
*
|
|
324
314
|
* - true: Enabled.
|
|
325
|
-
*
|
|
326
315
|
* - false: Disabled.
|
|
327
316
|
*
|
|
328
|
-
* If
|
|
317
|
+
* If not specified, this feature is enabled by default.
|
|
329
318
|
*
|
|
330
319
|
* @example
|
|
331
320
|
* true
|
|
@@ -333,21 +322,20 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
333
322
|
enableRewrite?: boolean;
|
|
334
323
|
/**
|
|
335
324
|
* @remarks
|
|
336
|
-
* The
|
|
325
|
+
* The knowledge base name. The name must be 1 to 20 characters in length and can contain Chinese characters, letters, digits, underscores (_), hyphens (-), periods (.), and colons (:).
|
|
337
326
|
*
|
|
338
327
|
* This parameter is required.
|
|
339
328
|
*
|
|
340
329
|
* @example
|
|
341
|
-
*
|
|
330
|
+
* EnterpriseHelpDocLibrary.
|
|
342
331
|
*/
|
|
343
332
|
name?: string;
|
|
344
333
|
/**
|
|
345
334
|
* @remarks
|
|
346
|
-
* The overlap size, which
|
|
335
|
+
* The chunk overlap size, which specifies the number of overlapping characters between the current text chunk and the previous text chunk. Value range: [0-1024].
|
|
347
336
|
*
|
|
348
|
-
* If
|
|
349
|
-
*
|
|
350
|
-
* > \\`OverlapSize\\` must be smaller than \\`ChunkSize\\`. Otherwise, chunking errors will occur.
|
|
337
|
+
* If not specified, the default value is 100.
|
|
338
|
+
* >`OverlapSize` must be less than `ChunkSize`. Otherwise, chunking exceptions occur.
|
|
351
339
|
*
|
|
352
340
|
* @example
|
|
353
341
|
* 16
|
|
@@ -355,16 +343,17 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
355
343
|
overlapSize?: number;
|
|
356
344
|
/**
|
|
357
345
|
* @remarks
|
|
358
|
-
*
|
|
346
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
359
347
|
*
|
|
360
|
-
*
|
|
348
|
+
* <props="china">A natural language instruction for fine-grained control of the reranking model\\"s behavior.
|
|
349
|
+
* <notice>This parameter takes effect only when rerank_mode is set to "custom".
|
|
361
350
|
*/
|
|
362
351
|
rerankInstruct?: string;
|
|
363
352
|
/**
|
|
364
353
|
* @remarks
|
|
365
|
-
* The similarity threshold. Only text chunks with
|
|
354
|
+
* The similarity threshold. Only text chunks with similarity scores exceeding this value are recalled. This parameter filters the text chunks returned by the reranking model. Value range: [0.01-1.00].
|
|
366
355
|
*
|
|
367
|
-
* If
|
|
356
|
+
* If not specified, the default value is 0.01.
|
|
368
357
|
*
|
|
369
358
|
* @example
|
|
370
359
|
* 0.20
|
|
@@ -372,9 +361,26 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
372
361
|
rerankMinScore?: number;
|
|
373
362
|
/**
|
|
374
363
|
* @remarks
|
|
375
|
-
*
|
|
364
|
+
* <props="china">
|
|
365
|
+
* Specifies the instruction intervention mode for the reranking model to determine its scoring preference.
|
|
366
|
+
*
|
|
367
|
+
* **Valid values:**
|
|
368
|
+
*
|
|
369
|
+
* - **qa**: (Default) Q&A mode. The model tends to assign higher scores to candidates that directly answer the query. Recommended for Q&A scenarios.
|
|
370
|
+
*
|
|
371
|
+
* - **similar**: Similarity mode. The model tends to assign higher scores to candidates with high content consistency with the query. Recommended for matching and retrieval scenarios.
|
|
376
372
|
*
|
|
377
|
-
*
|
|
373
|
+
* - **custom**: Custom mode. The model\\"s ranking behavior is determined by the instruction in the rerank_instruct parameter.
|
|
374
|
+
*
|
|
375
|
+
*
|
|
376
|
+
*
|
|
377
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
378
|
+
* [_single.params.RerankMode.enum.similar: 相似模式。]similar: Similarity mode.
|
|
379
|
+
* [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Custom mode.
|
|
380
|
+
* [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
381
|
+
* [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Similarity mode.
|
|
382
|
+
* [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Custom mode.
|
|
383
|
+
* [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
378
384
|
*
|
|
379
385
|
* @example
|
|
380
386
|
* qa
|
|
@@ -382,47 +388,50 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
382
388
|
rerankMode?: string;
|
|
383
389
|
/**
|
|
384
390
|
* @remarks
|
|
385
|
-
* The reranking model used by the knowledge base. The reranking model is an external scoring system that calculates
|
|
391
|
+
* The reranking model used by the knowledge base. The reranking model is an external scoring system that calculates the similarity score between the user query and each text chunk in the knowledge base, sorts them in descending order, and returns the top K text chunks with the highest scores. Valid values:
|
|
386
392
|
*
|
|
387
|
-
* <props="china">
|
|
388
393
|
*
|
|
389
|
-
*
|
|
394
|
+
* <props="china">
|
|
390
395
|
*
|
|
396
|
+
* - qwen3-rerank-hybrid: qwen3-rerank(hybrid) reranking.
|
|
391
397
|
* - qwen3-rerank: qwen3-rerank reranking.
|
|
392
|
-
*
|
|
393
|
-
* - gte-rerank-hybrid: gte-rerank (hybrid) reranking.
|
|
394
|
-
*
|
|
398
|
+
* - gte-rerank-hybrid: gte-rerank(hybrid) reranking.
|
|
395
399
|
* - gte-rerank: gte-rerank reranking.
|
|
396
400
|
*
|
|
397
401
|
*
|
|
398
402
|
*
|
|
399
403
|
* <props="intl">
|
|
400
404
|
*
|
|
401
|
-
* - gte-rerank-hybrid:
|
|
402
|
-
*
|
|
405
|
+
* - gte-rerank-hybrid: official reranking.
|
|
403
406
|
* - gte-rerank: gte-rerank reranking.
|
|
404
407
|
*
|
|
405
408
|
*
|
|
406
409
|
*
|
|
410
|
+
*
|
|
411
|
+
*
|
|
407
412
|
* <props="china">
|
|
408
413
|
*
|
|
409
|
-
*
|
|
414
|
+
* Default value: empty, which uses qwen3-rerank.
|
|
415
|
+
* > If you only need semantic reranking, use `qwen3-rerank`. If you need both semantic reranking and text matching features to ensure relevance, use `qwen3-rerank-hybrid`.
|
|
416
|
+
* >
|
|
410
417
|
*
|
|
411
|
-
* > Use \\`qwen3-rerank\\` if you only need semantic sorting. Use \\`qwen3-rerank-hybrid\\` if you need both semantic sorting and text-matching features to ensure relevance.
|
|
412
418
|
*
|
|
413
419
|
*
|
|
414
420
|
*
|
|
415
421
|
* <props="intl">
|
|
416
422
|
*
|
|
417
|
-
*
|
|
423
|
+
* Default value: empty, which uses gte-rerank-hybrid.
|
|
424
|
+
* > If you only need semantic reranking, use `gte-rerank`. If you need both semantic reranking and text matching features to ensure relevance, use `gte-rerank-hybrid`.
|
|
425
|
+
* >
|
|
426
|
+
*
|
|
418
427
|
*
|
|
419
|
-
* > Use \\`gte-rerank\\` if you only need semantic sorting. Use \\`gte-rerank-hybrid\\` if you need both semantic sorting and text-matching features to ensure relevance.
|
|
420
428
|
*
|
|
421
429
|
*
|
|
422
430
|
*
|
|
423
431
|
* <props="china">
|
|
424
432
|
*
|
|
425
|
-
* >
|
|
433
|
+
* > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated and are not recommended.
|
|
434
|
+
* >
|
|
426
435
|
*
|
|
427
436
|
* @example
|
|
428
437
|
* gte-rerank-hybrid
|
|
@@ -432,15 +441,16 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
432
441
|
* @remarks
|
|
433
442
|
* <props="china">
|
|
434
443
|
*
|
|
435
|
-
* The sentence separator
|
|
444
|
+
* The sentence separator, which takes effect only when `chunkMode`=**regex** (it does not take effect in other modes even if specified). You can pass a single regular expression (multiple expressions are not supported) to split files into small text chunks.
|
|
445
|
+
*
|
|
446
|
+
* When using intelligent chunking (when `chunkMode` is not specified), keep the default empty value.
|
|
436
447
|
*
|
|
437
|
-
* For smart chunking (the \\`chunkMode\\` parameter is not specified), you can leave this parameter empty.
|
|
438
448
|
*
|
|
439
449
|
*
|
|
440
450
|
*
|
|
441
451
|
* <props="intl">
|
|
442
452
|
*
|
|
443
|
-
* > This parameter is not
|
|
453
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
444
454
|
*
|
|
445
455
|
* @example
|
|
446
456
|
* (?<=。)
|
|
@@ -448,7 +458,7 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
448
458
|
separator?: string;
|
|
449
459
|
/**
|
|
450
460
|
* @remarks
|
|
451
|
-
* The
|
|
461
|
+
* The AnalyticDB for PostgreSQL instance ID (required only when `SinkType` is set to ADB). Obtain this ID from the [AnalyticDB for PostgreSQL instance list](https://gpdbnext.console.aliyun.com/gpdb/list) page.
|
|
452
462
|
*
|
|
453
463
|
* @example
|
|
454
464
|
* gp-bp32109xxxx
|
|
@@ -456,7 +466,7 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
456
466
|
sinkInstanceId?: string;
|
|
457
467
|
/**
|
|
458
468
|
* @remarks
|
|
459
|
-
* The region
|
|
469
|
+
* The region of the AnalyticDB for PostgreSQL instance (required only when `SinkType` is set to ADB). Call <props="china">[DescribeRegions](https://www.alibabacloud.com/help/en/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions)<props="intl">[DescribeRegions](https://www.alibabacloud.com/help/zh/analyticdb/analyticdb-for-postgresql/developer-reference/api-gpdb-2016-05-03-describeregions?spm=a2c63.p38356.0.i3) to obtain the list of regions.
|
|
460
470
|
*
|
|
461
471
|
* @example
|
|
462
472
|
* cn-hangzhou
|
|
@@ -464,13 +474,10 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
464
474
|
sinkRegion?: string;
|
|
465
475
|
/**
|
|
466
476
|
* @remarks
|
|
467
|
-
* The storage
|
|
468
|
-
*
|
|
469
|
-
* -
|
|
470
|
-
*
|
|
471
|
-
* - ADB: AnalyticDB for PostgreSQL. We recommend choosing ADB if you need advanced features such as database management, auditing, and monitoring.
|
|
472
|
-
*
|
|
473
|
-
* > If you have not used ADB storage on Alibaba Cloud Model Studio, go to the <props="intl">[Create Knowledge Base](https://bailian.console.alibabacloud.com/#/knowledge-base/create) page, set the vector storage class to ADB-PG, and follow the on-screen instructions to grant the required permissions. If you set this parameter to ADB, you must specify the \\`SinkInstanceId\\` and \\`SinkRegion\\` parameters.
|
|
477
|
+
* The vector storage type of the knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values:
|
|
478
|
+
* - BUILT_IN: Vector data is hosted on the Alibaba Cloud Model Studio platform.
|
|
479
|
+
* - ADB: AnalyticDB for PostgreSQL database. If you need advanced features such as database management, auditing, and monitoring, select ADB.
|
|
480
|
+
* > If you have not used ADB storage on Alibaba Cloud Model Studio before, go to the <props="china">[Create Knowledge Base](https://bailian.console.aliyun.com/#/knowledge-base/create)<props="intl">[Create Knowledge Base](https://bailian.console.alibabacloud.com/#/knowledge-base/create) page, select ADB-PG as the vector storage type, and complete authorization as prompted. If you pass ADB, you must specify the `SinkInstanceId` and `SinkRegion` parameters.
|
|
474
481
|
*
|
|
475
482
|
* This parameter is required.
|
|
476
483
|
*
|
|
@@ -480,21 +487,17 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
480
487
|
sinkType?: string;
|
|
481
488
|
/**
|
|
482
489
|
* @remarks
|
|
483
|
-
* >Notice:
|
|
484
|
-
*
|
|
485
|
-
* In the latest SDK version, this parameter is required. Otherwise, calling the SubmitIndexJob operation will result in the error: Required parameter(data_sources) missing or invalid.
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
*
|
|
489
|
-
* The source of the imported data. Valid values:
|
|
490
|
+
* >Notice: This parameter is required in the latest SDK. Otherwise, calling the SubmitIndexJob operation returns an error: Required parameter(data_sources) missing or invalid.
|
|
490
491
|
*
|
|
491
|
-
*
|
|
492
|
+
* The data source type. Valid values:
|
|
493
|
+
* - DATA_CENTER_CATEGORY: Category type. Imports all files under specified categories in <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). Multiple categories can be imported simultaneously.
|
|
494
|
+
* - DATA_CENTER_FILE: File type. Imports specified files from <props="china">[Application Data](https://bailian.console.aliyun.com/?tab=app#/data-center)<props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). Multiple files can be imported simultaneously.
|
|
492
495
|
*
|
|
493
|
-
*
|
|
496
|
+
* > If this parameter is set to DATA_CENTER_CATEGORY, you must specify the `CategoryIds` parameter. If this parameter is set to DATA_CENTER_FILE, you must specify the `DocumentIds` parameter.
|
|
497
|
+
* >
|
|
494
498
|
*
|
|
495
|
-
* >
|
|
496
|
-
*
|
|
497
|
-
* > To create an empty knowledge base, use an empty category that contains no files. Set this parameter to DATA_CENTER_CATEGORY and specify the ID of the empty category for \\`CategoryIds\\`.
|
|
499
|
+
* > To create an empty knowledge base, use an empty category that contains no files: set this parameter to DATA_CENTER_CATEGORY and pass the empty category ID in `CategoryIds`.
|
|
500
|
+
* >
|
|
498
501
|
*
|
|
499
502
|
* @example
|
|
500
503
|
* DATA_CENTER_FILE
|
|
@@ -505,20 +508,20 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
505
508
|
sourceType?: string;
|
|
506
509
|
/**
|
|
507
510
|
* @remarks
|
|
508
|
-
* The
|
|
511
|
+
* The knowledge base type.
|
|
509
512
|
*
|
|
510
|
-
* **Valid values
|
|
513
|
+
* **Valid values:**
|
|
511
514
|
*
|
|
512
|
-
* - unstructured: A
|
|
515
|
+
* - unstructured: A document search or audio/video knowledge base. The default scenario for document search type is basic document Q&A. <props="china">To create other scenarios, pass the knowledgeType and knowledgeScene parameters.
|
|
513
516
|
*
|
|
514
517
|
* <props="china">
|
|
515
518
|
*
|
|
516
|
-
* - structured: A
|
|
519
|
+
* - structured: A data query or image-based Q&A knowledge base.
|
|
517
520
|
*
|
|
518
521
|
*
|
|
519
522
|
*
|
|
520
|
-
*
|
|
521
|
-
* >
|
|
523
|
+
* > The knowledge base type cannot be changed after creation.
|
|
524
|
+
* >
|
|
522
525
|
*
|
|
523
526
|
* This parameter is required.
|
|
524
527
|
*
|
|
@@ -530,13 +533,15 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
530
533
|
* @remarks
|
|
531
534
|
* <props="china">
|
|
532
535
|
*
|
|
533
|
-
*
|
|
536
|
+
* Obtained by clicking the ID icon next to the table name on the Tables tab of [Data Connections](https://bailian.console.aliyun.com/cn-beijing?tab=app#/connector/list) table connector. If the list contains multiple IDs, only the first one is used.
|
|
537
|
+
*
|
|
534
538
|
*
|
|
535
539
|
*
|
|
536
540
|
*
|
|
537
541
|
* <props="intl">
|
|
538
542
|
*
|
|
539
|
-
* > This parameter is not
|
|
543
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
544
|
+
* >
|
|
540
545
|
*/
|
|
541
546
|
tableIds?: string[];
|
|
542
547
|
/**
|
|
@@ -548,27 +553,24 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
548
553
|
* @remarks
|
|
549
554
|
* <props="china">
|
|
550
555
|
*
|
|
551
|
-
* Enables custom chunking and specifies the chunking
|
|
556
|
+
* Enables custom chunking and specifies the chunking strategy. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
552
557
|
*
|
|
553
|
-
*
|
|
558
|
+
* Valid values (only one value can be passed at a time):
|
|
554
559
|
*
|
|
555
|
-
* - **length**:
|
|
560
|
+
* - **length**: Chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If these two parameters are not passed, the system uses default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (it does not take effect even if specified).
|
|
561
|
+
* - **page**: Chunk by page. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by page does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
|
|
562
|
+
* - **h1**: Chunk by first-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by first-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
|
|
563
|
+
* - **h2**: Chunk by second-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by second-level headings does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
|
|
564
|
+
* - **regex**: Chunk by regular expression. The `Separator` parameter must be specified. If `ChunkSize` is specified, it is also considered during chunking (if not passed, the default value of 500 is used). Chunking by regular expression does not support `OverlapSize` (it does not take effect even if specified).
|
|
556
565
|
*
|
|
557
|
-
*
|
|
566
|
+
* If not specified, intelligent chunking is used by default.
|
|
558
567
|
*
|
|
559
|
-
* - **h1**: Chunks by level-1 heading. If \\`ChunkSize\\` is specified, it is also considered during chunking (if not specified, the default value 500 is used). Chunking by level-1 heading does not support \\`OverlapSize\\` or \\`Separator\\` (they are ignored even if specified).
|
|
560
|
-
*
|
|
561
|
-
* - **h2**: Chunks by level-2 heading. If \\`ChunkSize\\` is specified, it is also considered during chunking (if not specified, the default value 500 is used). Chunking by level-2 heading does not support \\`OverlapSize\\` or \\`Separator\\` (they are ignored even if specified).
|
|
562
|
-
*
|
|
563
|
-
* - **regex**: Chunks by regular expression. You must specify the \\`Separator\\` parameter. If \\`ChunkSize\\` is specified, it is also considered during chunking (if not specified, the default value 500 is used). Chunking by regular expression does not support \\`OverlapSize\\` (it is ignored even if specified).
|
|
564
|
-
*
|
|
565
|
-
* If you do not specify this parameter, smart chunking is used by default.
|
|
566
568
|
*
|
|
567
569
|
*
|
|
568
570
|
*
|
|
569
571
|
* <props="intl">
|
|
570
572
|
*
|
|
571
|
-
* > This parameter is not
|
|
573
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
572
574
|
*
|
|
573
575
|
* @example
|
|
574
576
|
* regex
|
|
@@ -583,17 +585,17 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
583
585
|
datasourceCode?: string;
|
|
584
586
|
/**
|
|
585
587
|
* @remarks
|
|
586
|
-
* Specifies whether to treat the first row of all
|
|
588
|
+
* Specifies whether to treat the first row of all xlsx and xls files as headers and concatenate them into each text chunk, preventing the large language model from treating headers as regular data rows.
|
|
587
589
|
*
|
|
588
|
-
* > We recommend enabling this feature only when all imported files are in .xlsx or .xls format and contain a header. Otherwise, do not enable it.
|
|
589
590
|
*
|
|
590
|
-
*
|
|
591
|
+
* > Enable this feature only when all imported files are in .xlsx or .xls format and contain headers. Otherwise, do not enable it.
|
|
592
|
+
* >
|
|
591
593
|
*
|
|
594
|
+
* Valid values:
|
|
592
595
|
* - true: Enabled.
|
|
593
|
-
*
|
|
594
596
|
* - false: Disabled.
|
|
595
597
|
*
|
|
596
|
-
* If
|
|
598
|
+
* If not specified, this feature is disabled by default.
|
|
597
599
|
*
|
|
598
600
|
* @example
|
|
599
601
|
* false
|
|
@@ -602,15 +604,22 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
602
604
|
knowledgeScene?: string;
|
|
603
605
|
/**
|
|
604
606
|
* @remarks
|
|
605
|
-
* The data source code. This parameter is required when creating a data query knowledge base and is used with \\`table\\` and \\`database\\`.
|
|
606
|
-
*
|
|
607
607
|
* <props="china">
|
|
608
|
+
* The specific knowledge type, which further specifies the type of data processed by the knowledge base.
|
|
609
|
+
* <notice>This parameter and knowledgeScene must be provided together or omitted together. They cannot be set independently. If both are omitted, the system uses default configurations based on structureType.
|
|
610
|
+
*
|
|
611
|
+
* **Settings constraint**: The value of this parameter must match the selected structureType and determines the active values for knowledgeScene.
|
|
612
|
+
*
|
|
613
|
+
* **Valid values**:
|
|
614
|
+
* - document: Document search. Must be used with structureType: unstructured.
|
|
615
|
+
* - table: Data query. Must be used with structureType: structured.
|
|
616
|
+
* - image: Image-based Q&A. Must be used with structureType: structured.
|
|
617
|
+
* - multimedia: Audio/video search. Must be used with structureType: unstructured.
|
|
608
618
|
*
|
|
609
|
-
* We recommend using the new \\`connectId\\` parameter, which you can obtain from the data connector card on the [Data Connections](https://modelstudio.console.alibabacloud.com/?tab=app#/connector/list) page. This parameter is still compatible but will no longer be maintained in the future.
|
|
610
619
|
*
|
|
611
620
|
*
|
|
612
621
|
*
|
|
613
|
-
* >
|
|
622
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
614
623
|
*
|
|
615
624
|
* @example
|
|
616
625
|
* document
|
|
@@ -618,20 +627,18 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
618
627
|
knowledgeType?: string;
|
|
619
628
|
/**
|
|
620
629
|
* @remarks
|
|
621
|
-
* The metadata extraction configuration. Metadata is a
|
|
630
|
+
* The metadata extraction configuration. Metadata is a set of additional attributes related to unstructured data content. These attributes are integrated into text chunks as key-value pairs. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
622
631
|
*/
|
|
623
632
|
metaExtractColumns?: CreateIndexRequestMetaExtractColumns[];
|
|
624
633
|
/**
|
|
625
634
|
* @remarks
|
|
626
|
-
* <props="china">
|
|
627
|
-
*
|
|
628
|
-
* The number of RCUs for the knowledge base. This parameter is required only when \\`pipelineCommercialType\\` is set to \\`enterprise\\`. The value must be between 1 and 200.
|
|
629
|
-
*
|
|
635
|
+
* <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Value range: [1-200].
|
|
630
636
|
*
|
|
631
637
|
*
|
|
632
638
|
* <props="intl">
|
|
633
639
|
*
|
|
634
|
-
* > This parameter is not
|
|
640
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
641
|
+
* >
|
|
635
642
|
*
|
|
636
643
|
* @example
|
|
637
644
|
* 1
|
|
@@ -641,17 +648,16 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
641
648
|
* @remarks
|
|
642
649
|
* <props="china">
|
|
643
650
|
*
|
|
644
|
-
* The [
|
|
645
|
-
*
|
|
646
|
-
* -
|
|
647
|
-
*
|
|
648
|
-
* - enterprise: Ultimate Edition
|
|
651
|
+
* The [specification type](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
|
|
652
|
+
* - standard: Standard Edition.
|
|
653
|
+
* - enterprise: Ultimate Edition.
|
|
649
654
|
*
|
|
650
655
|
*
|
|
651
656
|
*
|
|
652
657
|
* <props="intl">
|
|
653
658
|
*
|
|
654
|
-
* > This parameter is not
|
|
659
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
660
|
+
* >
|
|
655
661
|
*
|
|
656
662
|
* @example
|
|
657
663
|
* standard
|
|
@@ -659,18 +665,16 @@ export class CreateIndexRequest extends $dara.Model {
|
|
|
659
665
|
pipelineCommercialType?: string;
|
|
660
666
|
/**
|
|
661
667
|
* @remarks
|
|
662
|
-
* <props="china">
|
|
663
|
-
*
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
* downgrade: Degrades the service (switches to using a lightweight retrieval chain).
|
|
667
|
-
* If you do not specify this parameter, the default value \\`downgrade\\` is used.
|
|
668
|
-
*
|
|
668
|
+
* <props="china">The rate limiting strategy for knowledge base dependent links (required only when pipelineCommercialType is set to enterprise).
|
|
669
|
+
* Valid values:
|
|
670
|
+
* downgrade: Downgrade processing (switch to lightweight link retrieval).
|
|
671
|
+
* If not specified, the default value is downgrade.
|
|
669
672
|
*
|
|
670
673
|
*
|
|
671
674
|
* <props="intl">
|
|
672
675
|
*
|
|
673
|
-
* > This parameter is not
|
|
676
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
677
|
+
* >
|
|
674
678
|
*
|
|
675
679
|
* @example
|
|
676
680
|
* downgrade
|