@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
|
@@ -2,7 +2,8 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class CreateIndexRequestColumns extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* > This parameter is not
|
|
5
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
6
|
+
* >
|
|
6
7
|
*
|
|
7
8
|
* @example
|
|
8
9
|
* school
|
|
@@ -12,17 +13,18 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
|
|
|
12
13
|
* @remarks
|
|
13
14
|
* <props="china">
|
|
14
15
|
*
|
|
15
|
-
* Specifies whether
|
|
16
|
+
* 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:
|
|
16
17
|
*
|
|
17
18
|
* - true: Enabled.
|
|
18
|
-
*
|
|
19
19
|
* - false: Disabled.
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*
|
|
23
|
+
*
|
|
23
24
|
* <props="intl">
|
|
24
25
|
*
|
|
25
|
-
* > This parameter is not
|
|
26
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
27
|
+
* >
|
|
26
28
|
*
|
|
27
29
|
* @example
|
|
28
30
|
* true
|
|
@@ -32,17 +34,18 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
|
|
|
32
34
|
* @remarks
|
|
33
35
|
* <props="china">
|
|
34
36
|
*
|
|
35
|
-
* Specifies whether
|
|
37
|
+
* Specifies whether this column participates in knowledge base retrieval. When enabled, the knowledge base can search within the data of this column. Valid values:
|
|
36
38
|
*
|
|
37
39
|
* - true: Enabled.
|
|
38
|
-
*
|
|
39
40
|
* - false: Disabled.
|
|
40
41
|
*
|
|
41
42
|
*
|
|
42
43
|
*
|
|
44
|
+
*
|
|
43
45
|
* <props="intl">
|
|
44
46
|
*
|
|
45
|
-
* > This parameter is not
|
|
47
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
48
|
+
* >
|
|
46
49
|
*
|
|
47
50
|
* @example
|
|
48
51
|
* true
|
|
@@ -51,40 +54,37 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
|
|
|
51
54
|
/**
|
|
52
55
|
* @remarks
|
|
53
56
|
* <props="china">
|
|
54
|
-
*
|
|
55
|
-
* The field name. It must be consistent with the table header of the data table created in Application Data.
|
|
57
|
+
* The field name. Must be consistent with the header of the data table created in Application Data.
|
|
56
58
|
*
|
|
57
59
|
*
|
|
58
60
|
*
|
|
59
61
|
* <props="intl">
|
|
60
62
|
*
|
|
61
|
-
* > This parameter is not
|
|
63
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
64
|
+
* >
|
|
62
65
|
*
|
|
63
66
|
* @example
|
|
64
|
-
*
|
|
67
|
+
* School.
|
|
65
68
|
*/
|
|
66
69
|
name?: string;
|
|
67
70
|
/**
|
|
68
71
|
* @remarks
|
|
69
72
|
* <props="china">
|
|
70
73
|
*
|
|
71
|
-
* The field type.
|
|
74
|
+
* The field type. Must be consistent with the header of the data table created in Application Data. Valid values:
|
|
72
75
|
*
|
|
73
76
|
* - string
|
|
74
|
-
*
|
|
75
77
|
* - double
|
|
76
|
-
*
|
|
77
78
|
* - long
|
|
78
|
-
*
|
|
79
79
|
* - datetime
|
|
80
|
-
*
|
|
81
80
|
* - image_url
|
|
82
81
|
*
|
|
83
82
|
*
|
|
84
83
|
*
|
|
85
84
|
* <props="intl">
|
|
86
85
|
*
|
|
87
|
-
* > This parameter is not
|
|
86
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
87
|
+
* >
|
|
88
88
|
*
|
|
89
89
|
* @example
|
|
90
90
|
* string
|
|
@@ -104,21 +104,20 @@ export declare class CreateIndexRequestColumns extends $dara.Model {
|
|
|
104
104
|
export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
105
105
|
/**
|
|
106
106
|
* @remarks
|
|
107
|
-
* The Chinese description of the metadata field. The description can be
|
|
107
|
+
* 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.
|
|
108
108
|
*
|
|
109
109
|
* @example
|
|
110
|
-
*
|
|
110
|
+
* AuthorName.
|
|
111
111
|
*/
|
|
112
112
|
desc?: string;
|
|
113
113
|
/**
|
|
114
114
|
* @remarks
|
|
115
|
-
*
|
|
115
|
+
* 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:
|
|
116
116
|
*
|
|
117
117
|
* - true: Enabled.
|
|
118
|
-
*
|
|
119
118
|
* - false: Disabled.
|
|
120
119
|
*
|
|
121
|
-
*
|
|
120
|
+
* Default value: false.
|
|
122
121
|
*
|
|
123
122
|
* @example
|
|
124
123
|
* false
|
|
@@ -126,13 +125,12 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
126
125
|
enableLlm?: boolean;
|
|
127
126
|
/**
|
|
128
127
|
* @remarks
|
|
129
|
-
*
|
|
128
|
+
* Specifies whether this metadata field and its value participate in knowledge base retrieval along with the text chunk content. Valid values:
|
|
130
129
|
*
|
|
131
130
|
* - true: Enabled.
|
|
132
|
-
*
|
|
133
131
|
* - false: Disabled.
|
|
134
132
|
*
|
|
135
|
-
*
|
|
133
|
+
* Default value: false.
|
|
136
134
|
*
|
|
137
135
|
* @example
|
|
138
136
|
* false
|
|
@@ -140,7 +138,7 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
140
138
|
enableSearch?: boolean;
|
|
141
139
|
/**
|
|
142
140
|
* @remarks
|
|
143
|
-
* The metadata field. The field
|
|
141
|
+
* 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.
|
|
144
142
|
*
|
|
145
143
|
* @example
|
|
146
144
|
* author
|
|
@@ -148,16 +146,12 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
148
146
|
key?: string;
|
|
149
147
|
/**
|
|
150
148
|
* @remarks
|
|
151
|
-
* The method for
|
|
149
|
+
* The extraction method for the metadata field. Valid values:
|
|
152
150
|
*
|
|
153
151
|
* - constant: Constant.
|
|
154
|
-
*
|
|
155
152
|
* - variable: Variable.
|
|
156
|
-
*
|
|
157
|
-
* - custom_prompt: Large Language Model (LLM).
|
|
158
|
-
*
|
|
153
|
+
* - custom_prompt: Large language model.
|
|
159
154
|
* - regular: Regular expression.
|
|
160
|
-
*
|
|
161
155
|
* - keywords: Keyword search.
|
|
162
156
|
*
|
|
163
157
|
* @example
|
|
@@ -186,30 +180,28 @@ export declare class CreateIndexRequestMetaExtractColumns extends $dara.Model {
|
|
|
186
180
|
export declare class CreateIndexRequest extends $dara.Model {
|
|
187
181
|
/**
|
|
188
182
|
* @remarks
|
|
189
|
-
*
|
|
183
|
+
* 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.
|
|
190
184
|
*/
|
|
191
185
|
categoryIds?: string[];
|
|
192
186
|
/**
|
|
193
187
|
* @remarks
|
|
194
188
|
* <props="china">
|
|
195
189
|
*
|
|
196
|
-
* The chunk size, which
|
|
190
|
+
* The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded:
|
|
197
191
|
*
|
|
198
|
-
* - **
|
|
199
|
-
*
|
|
200
|
-
* - **Custom chunking** (the \\`chunkMode\\` parameter is specified): The text is forcibly truncated.
|
|
192
|
+
* - **Intelligent chunking** (when `chunkMode` is not specified): The text is likely to be truncated.
|
|
193
|
+
* - **Custom chunking** (when `chunkMode` is specified): The text is forcibly truncated.
|
|
201
194
|
*
|
|
202
195
|
*
|
|
203
196
|
*
|
|
204
197
|
* <props="intl">
|
|
205
|
-
*
|
|
206
|
-
* 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.
|
|
198
|
+
* 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.
|
|
207
199
|
*
|
|
208
200
|
*
|
|
209
201
|
*
|
|
210
|
-
*
|
|
202
|
+
* Value range: [1-6000]. If not specified, the default value is 500.
|
|
211
203
|
*
|
|
212
|
-
* > If
|
|
204
|
+
* > 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.
|
|
213
205
|
*
|
|
214
206
|
* @example
|
|
215
207
|
* 128
|
|
@@ -218,19 +210,19 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
218
210
|
/**
|
|
219
211
|
* @remarks
|
|
220
212
|
* <props="china">
|
|
221
|
-
*
|
|
222
213
|
* The structure of the data table (column names, types, etc.).
|
|
223
214
|
*
|
|
224
215
|
*
|
|
225
|
-
*
|
|
226
216
|
* <props="intl">
|
|
227
217
|
*
|
|
228
|
-
* > This parameter is not
|
|
218
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
219
|
+
* >
|
|
229
220
|
*/
|
|
230
221
|
columns?: CreateIndexRequestColumns[];
|
|
231
222
|
/**
|
|
232
223
|
* @remarks
|
|
233
|
-
* > This parameter is not
|
|
224
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
225
|
+
* >
|
|
234
226
|
*
|
|
235
227
|
* @example
|
|
236
228
|
* standard
|
|
@@ -238,42 +230,40 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
238
230
|
createIndexType?: string;
|
|
239
231
|
/**
|
|
240
232
|
* @remarks
|
|
241
|
-
* The
|
|
242
|
-
*
|
|
233
|
+
* The knowledge base description. The description can be up to 1000 characters in length.
|
|
234
|
+
* Default value: empty.
|
|
243
235
|
*
|
|
244
236
|
* @example
|
|
245
|
-
*
|
|
237
|
+
* The enterprise help document library includes important materials such as company policies and product catalogs.
|
|
246
238
|
*/
|
|
247
239
|
description?: string;
|
|
248
240
|
/**
|
|
249
241
|
* @remarks
|
|
250
|
-
*
|
|
242
|
+
* 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.
|
|
251
243
|
*/
|
|
252
244
|
documentIds?: string[];
|
|
253
245
|
/**
|
|
254
246
|
* @remarks
|
|
255
247
|
* <props="china">
|
|
256
248
|
*
|
|
257
|
-
* The
|
|
258
|
-
*
|
|
249
|
+
* 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:
|
|
259
250
|
* - text-embedding-v4
|
|
260
|
-
*
|
|
261
251
|
* - text-embedding-v3
|
|
262
252
|
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* <props="intl">
|
|
253
|
+
* Default value: empty, which uses the text-embedding-v3 model.
|
|
268
254
|
*
|
|
269
|
-
* - 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:
|
|
270
255
|
*
|
|
271
256
|
*
|
|
272
257
|
*
|
|
258
|
+
* <props="intl">
|
|
273
259
|
*
|
|
260
|
+
* 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:
|
|
274
261
|
* - text-embedding-v2
|
|
275
262
|
*
|
|
276
|
-
*
|
|
263
|
+
* Default value: empty, which uses the text-embedding-v2 model.
|
|
264
|
+
*
|
|
265
|
+
* @example
|
|
266
|
+
* text-embedding-v4
|
|
277
267
|
*/
|
|
278
268
|
embeddingModelName?: string;
|
|
279
269
|
/**
|
|
@@ -281,10 +271,9 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
281
271
|
* Specifies whether to enable multi-turn conversation rewriting. Valid values:
|
|
282
272
|
*
|
|
283
273
|
* - true: Enabled.
|
|
284
|
-
*
|
|
285
274
|
* - false: Disabled.
|
|
286
275
|
*
|
|
287
|
-
* If
|
|
276
|
+
* If not specified, this feature is enabled by default.
|
|
288
277
|
*
|
|
289
278
|
* @example
|
|
290
279
|
* true
|
|
@@ -292,21 +281,20 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
292
281
|
enableRewrite?: boolean;
|
|
293
282
|
/**
|
|
294
283
|
* @remarks
|
|
295
|
-
* The
|
|
284
|
+
* 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 (:).
|
|
296
285
|
*
|
|
297
286
|
* This parameter is required.
|
|
298
287
|
*
|
|
299
288
|
* @example
|
|
300
|
-
*
|
|
289
|
+
* EnterpriseHelpDocLibrary.
|
|
301
290
|
*/
|
|
302
291
|
name?: string;
|
|
303
292
|
/**
|
|
304
293
|
* @remarks
|
|
305
|
-
* The overlap size, which
|
|
294
|
+
* 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].
|
|
306
295
|
*
|
|
307
|
-
* If
|
|
308
|
-
*
|
|
309
|
-
* > \\`OverlapSize\\` must be smaller than \\`ChunkSize\\`. Otherwise, chunking errors will occur.
|
|
296
|
+
* If not specified, the default value is 100.
|
|
297
|
+
* >`OverlapSize` must be less than `ChunkSize`. Otherwise, chunking exceptions occur.
|
|
310
298
|
*
|
|
311
299
|
* @example
|
|
312
300
|
* 16
|
|
@@ -314,16 +302,17 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
314
302
|
overlapSize?: number;
|
|
315
303
|
/**
|
|
316
304
|
* @remarks
|
|
317
|
-
*
|
|
305
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
318
306
|
*
|
|
319
|
-
*
|
|
307
|
+
* <props="china">A natural language instruction for fine-grained control of the reranking model\\"s behavior.
|
|
308
|
+
* <notice>This parameter takes effect only when rerank_mode is set to "custom".
|
|
320
309
|
*/
|
|
321
310
|
rerankInstruct?: string;
|
|
322
311
|
/**
|
|
323
312
|
* @remarks
|
|
324
|
-
* The similarity threshold. Only text chunks with
|
|
313
|
+
* 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].
|
|
325
314
|
*
|
|
326
|
-
* If
|
|
315
|
+
* If not specified, the default value is 0.01.
|
|
327
316
|
*
|
|
328
317
|
* @example
|
|
329
318
|
* 0.20
|
|
@@ -331,9 +320,26 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
331
320
|
rerankMinScore?: number;
|
|
332
321
|
/**
|
|
333
322
|
* @remarks
|
|
334
|
-
*
|
|
323
|
+
* <props="china">
|
|
324
|
+
* Specifies the instruction intervention mode for the reranking model to determine its scoring preference.
|
|
325
|
+
*
|
|
326
|
+
* **Valid values:**
|
|
327
|
+
*
|
|
328
|
+
* - **qa**: (Default) Q&A mode. The model tends to assign higher scores to candidates that directly answer the query. Recommended for Q&A scenarios.
|
|
329
|
+
*
|
|
330
|
+
* - **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.
|
|
335
331
|
*
|
|
336
|
-
*
|
|
332
|
+
* - **custom**: Custom mode. The model\\"s ranking behavior is determined by the instruction in the rerank_instruct parameter.
|
|
333
|
+
*
|
|
334
|
+
*
|
|
335
|
+
*
|
|
336
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
337
|
+
* [_single.params.RerankMode.enum.similar: 相似模式。]similar: Similarity mode.
|
|
338
|
+
* [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Custom mode.
|
|
339
|
+
* [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
340
|
+
* [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Similarity mode.
|
|
341
|
+
* [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Custom mode.
|
|
342
|
+
* [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
337
343
|
*
|
|
338
344
|
* @example
|
|
339
345
|
* qa
|
|
@@ -341,47 +347,50 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
341
347
|
rerankMode?: string;
|
|
342
348
|
/**
|
|
343
349
|
* @remarks
|
|
344
|
-
* The reranking model used by the knowledge base. The reranking model is an external scoring system that calculates
|
|
350
|
+
* 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:
|
|
345
351
|
*
|
|
346
|
-
* <props="china">
|
|
347
352
|
*
|
|
348
|
-
*
|
|
353
|
+
* <props="china">
|
|
349
354
|
*
|
|
355
|
+
* - qwen3-rerank-hybrid: qwen3-rerank(hybrid) reranking.
|
|
350
356
|
* - qwen3-rerank: qwen3-rerank reranking.
|
|
351
|
-
*
|
|
352
|
-
* - gte-rerank-hybrid: gte-rerank (hybrid) reranking.
|
|
353
|
-
*
|
|
357
|
+
* - gte-rerank-hybrid: gte-rerank(hybrid) reranking.
|
|
354
358
|
* - gte-rerank: gte-rerank reranking.
|
|
355
359
|
*
|
|
356
360
|
*
|
|
357
361
|
*
|
|
358
362
|
* <props="intl">
|
|
359
363
|
*
|
|
360
|
-
* - gte-rerank-hybrid:
|
|
361
|
-
*
|
|
364
|
+
* - gte-rerank-hybrid: official reranking.
|
|
362
365
|
* - gte-rerank: gte-rerank reranking.
|
|
363
366
|
*
|
|
364
367
|
*
|
|
365
368
|
*
|
|
369
|
+
*
|
|
370
|
+
*
|
|
366
371
|
* <props="china">
|
|
367
372
|
*
|
|
368
|
-
*
|
|
373
|
+
* Default value: empty, which uses qwen3-rerank.
|
|
374
|
+
* > 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`.
|
|
375
|
+
* >
|
|
369
376
|
*
|
|
370
|
-
* > 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.
|
|
371
377
|
*
|
|
372
378
|
*
|
|
373
379
|
*
|
|
374
380
|
* <props="intl">
|
|
375
381
|
*
|
|
376
|
-
*
|
|
382
|
+
* Default value: empty, which uses gte-rerank-hybrid.
|
|
383
|
+
* > 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`.
|
|
384
|
+
* >
|
|
385
|
+
*
|
|
377
386
|
*
|
|
378
|
-
* > 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.
|
|
379
387
|
*
|
|
380
388
|
*
|
|
381
389
|
*
|
|
382
390
|
* <props="china">
|
|
383
391
|
*
|
|
384
|
-
* >
|
|
392
|
+
* > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated and are not recommended.
|
|
393
|
+
* >
|
|
385
394
|
*
|
|
386
395
|
* @example
|
|
387
396
|
* gte-rerank-hybrid
|
|
@@ -391,15 +400,16 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
391
400
|
* @remarks
|
|
392
401
|
* <props="china">
|
|
393
402
|
*
|
|
394
|
-
* The sentence separator
|
|
403
|
+
* 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.
|
|
404
|
+
*
|
|
405
|
+
* When using intelligent chunking (when `chunkMode` is not specified), keep the default empty value.
|
|
395
406
|
*
|
|
396
|
-
* For smart chunking (the \\`chunkMode\\` parameter is not specified), you can leave this parameter empty.
|
|
397
407
|
*
|
|
398
408
|
*
|
|
399
409
|
*
|
|
400
410
|
* <props="intl">
|
|
401
411
|
*
|
|
402
|
-
* > This parameter is not
|
|
412
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
403
413
|
*
|
|
404
414
|
* @example
|
|
405
415
|
* (?<=。)
|
|
@@ -407,7 +417,7 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
407
417
|
separator?: string;
|
|
408
418
|
/**
|
|
409
419
|
* @remarks
|
|
410
|
-
* The
|
|
420
|
+
* 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.
|
|
411
421
|
*
|
|
412
422
|
* @example
|
|
413
423
|
* gp-bp32109xxxx
|
|
@@ -415,7 +425,7 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
415
425
|
sinkInstanceId?: string;
|
|
416
426
|
/**
|
|
417
427
|
* @remarks
|
|
418
|
-
* The region
|
|
428
|
+
* 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.
|
|
419
429
|
*
|
|
420
430
|
* @example
|
|
421
431
|
* cn-hangzhou
|
|
@@ -423,13 +433,10 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
423
433
|
sinkRegion?: string;
|
|
424
434
|
/**
|
|
425
435
|
* @remarks
|
|
426
|
-
* The storage
|
|
427
|
-
*
|
|
428
|
-
* -
|
|
429
|
-
*
|
|
430
|
-
* - ADB: AnalyticDB for PostgreSQL. We recommend choosing ADB if you need advanced features such as database management, auditing, and monitoring.
|
|
431
|
-
*
|
|
432
|
-
* > 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.
|
|
436
|
+
* The vector storage type of the knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values:
|
|
437
|
+
* - BUILT_IN: Vector data is hosted on the Alibaba Cloud Model Studio platform.
|
|
438
|
+
* - ADB: AnalyticDB for PostgreSQL database. If you need advanced features such as database management, auditing, and monitoring, select ADB.
|
|
439
|
+
* > 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.
|
|
433
440
|
*
|
|
434
441
|
* This parameter is required.
|
|
435
442
|
*
|
|
@@ -439,21 +446,17 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
439
446
|
sinkType?: string;
|
|
440
447
|
/**
|
|
441
448
|
* @remarks
|
|
442
|
-
* >Notice:
|
|
443
|
-
*
|
|
444
|
-
* 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.
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
* The source of the imported data. Valid values:
|
|
449
|
+
* >Notice: This parameter is required in the latest SDK. Otherwise, calling the SubmitIndexJob operation returns an error: Required parameter(data_sources) missing or invalid.
|
|
449
450
|
*
|
|
450
|
-
*
|
|
451
|
+
* The data source type. Valid values:
|
|
452
|
+
* - 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.
|
|
453
|
+
* - 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.
|
|
451
454
|
*
|
|
452
|
-
*
|
|
455
|
+
* > 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.
|
|
456
|
+
* >
|
|
453
457
|
*
|
|
454
|
-
* >
|
|
455
|
-
*
|
|
456
|
-
* > 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\\`.
|
|
458
|
+
* > 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`.
|
|
459
|
+
* >
|
|
457
460
|
*
|
|
458
461
|
* @example
|
|
459
462
|
* DATA_CENTER_FILE
|
|
@@ -464,20 +467,20 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
464
467
|
sourceType?: string;
|
|
465
468
|
/**
|
|
466
469
|
* @remarks
|
|
467
|
-
* The
|
|
470
|
+
* The knowledge base type.
|
|
468
471
|
*
|
|
469
|
-
* **Valid values
|
|
472
|
+
* **Valid values:**
|
|
470
473
|
*
|
|
471
|
-
* - unstructured: A
|
|
474
|
+
* - 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.
|
|
472
475
|
*
|
|
473
476
|
* <props="china">
|
|
474
477
|
*
|
|
475
|
-
* - structured: A
|
|
478
|
+
* - structured: A data query or image-based Q&A knowledge base.
|
|
476
479
|
*
|
|
477
480
|
*
|
|
478
481
|
*
|
|
479
|
-
*
|
|
480
|
-
* >
|
|
482
|
+
* > The knowledge base type cannot be changed after creation.
|
|
483
|
+
* >
|
|
481
484
|
*
|
|
482
485
|
* This parameter is required.
|
|
483
486
|
*
|
|
@@ -489,13 +492,15 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
489
492
|
* @remarks
|
|
490
493
|
* <props="china">
|
|
491
494
|
*
|
|
492
|
-
*
|
|
495
|
+
* 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.
|
|
496
|
+
*
|
|
493
497
|
*
|
|
494
498
|
*
|
|
495
499
|
*
|
|
496
500
|
* <props="intl">
|
|
497
501
|
*
|
|
498
|
-
* > This parameter is not
|
|
502
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
503
|
+
* >
|
|
499
504
|
*/
|
|
500
505
|
tableIds?: string[];
|
|
501
506
|
/**
|
|
@@ -507,27 +512,24 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
507
512
|
* @remarks
|
|
508
513
|
* <props="china">
|
|
509
514
|
*
|
|
510
|
-
* Enables custom chunking and specifies the chunking
|
|
515
|
+
* Enables custom chunking and specifies the chunking strategy. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
511
516
|
*
|
|
512
|
-
*
|
|
517
|
+
* Valid values (only one value can be passed at a time):
|
|
513
518
|
*
|
|
514
|
-
* - **length**:
|
|
519
|
+
* - **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).
|
|
520
|
+
* - **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).
|
|
521
|
+
* - **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).
|
|
522
|
+
* - **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).
|
|
523
|
+
* - **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).
|
|
515
524
|
*
|
|
516
|
-
*
|
|
525
|
+
* If not specified, intelligent chunking is used by default.
|
|
517
526
|
*
|
|
518
|
-
* - **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).
|
|
519
|
-
*
|
|
520
|
-
* - **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).
|
|
521
|
-
*
|
|
522
|
-
* - **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).
|
|
523
|
-
*
|
|
524
|
-
* If you do not specify this parameter, smart chunking is used by default.
|
|
525
527
|
*
|
|
526
528
|
*
|
|
527
529
|
*
|
|
528
530
|
* <props="intl">
|
|
529
531
|
*
|
|
530
|
-
* > This parameter is not
|
|
532
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
531
533
|
*
|
|
532
534
|
* @example
|
|
533
535
|
* regex
|
|
@@ -542,17 +544,17 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
542
544
|
datasourceCode?: string;
|
|
543
545
|
/**
|
|
544
546
|
* @remarks
|
|
545
|
-
* Specifies whether to treat the first row of all
|
|
547
|
+
* 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.
|
|
546
548
|
*
|
|
547
|
-
* > 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.
|
|
548
549
|
*
|
|
549
|
-
*
|
|
550
|
+
* > Enable this feature only when all imported files are in .xlsx or .xls format and contain headers. Otherwise, do not enable it.
|
|
551
|
+
* >
|
|
550
552
|
*
|
|
553
|
+
* Valid values:
|
|
551
554
|
* - true: Enabled.
|
|
552
|
-
*
|
|
553
555
|
* - false: Disabled.
|
|
554
556
|
*
|
|
555
|
-
* If
|
|
557
|
+
* If not specified, this feature is disabled by default.
|
|
556
558
|
*
|
|
557
559
|
* @example
|
|
558
560
|
* false
|
|
@@ -561,15 +563,22 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
561
563
|
knowledgeScene?: string;
|
|
562
564
|
/**
|
|
563
565
|
* @remarks
|
|
564
|
-
* The data source code. This parameter is required when creating a data query knowledge base and is used with \\`table\\` and \\`database\\`.
|
|
565
|
-
*
|
|
566
566
|
* <props="china">
|
|
567
|
+
* The specific knowledge type, which further specifies the type of data processed by the knowledge base.
|
|
568
|
+
* <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.
|
|
569
|
+
*
|
|
570
|
+
* **Settings constraint**: The value of this parameter must match the selected structureType and determines the active values for knowledgeScene.
|
|
571
|
+
*
|
|
572
|
+
* **Valid values**:
|
|
573
|
+
* - document: Document search. Must be used with structureType: unstructured.
|
|
574
|
+
* - table: Data query. Must be used with structureType: structured.
|
|
575
|
+
* - image: Image-based Q&A. Must be used with structureType: structured.
|
|
576
|
+
* - multimedia: Audio/video search. Must be used with structureType: unstructured.
|
|
567
577
|
*
|
|
568
|
-
* 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.
|
|
569
578
|
*
|
|
570
579
|
*
|
|
571
580
|
*
|
|
572
|
-
* >
|
|
581
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
573
582
|
*
|
|
574
583
|
* @example
|
|
575
584
|
* document
|
|
@@ -577,20 +586,18 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
577
586
|
knowledgeType?: string;
|
|
578
587
|
/**
|
|
579
588
|
* @remarks
|
|
580
|
-
* The metadata extraction configuration. Metadata is a
|
|
589
|
+
* 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).
|
|
581
590
|
*/
|
|
582
591
|
metaExtractColumns?: CreateIndexRequestMetaExtractColumns[];
|
|
583
592
|
/**
|
|
584
593
|
* @remarks
|
|
585
|
-
* <props="china">
|
|
586
|
-
*
|
|
587
|
-
* 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.
|
|
588
|
-
*
|
|
594
|
+
* <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Value range: [1-200].
|
|
589
595
|
*
|
|
590
596
|
*
|
|
591
597
|
* <props="intl">
|
|
592
598
|
*
|
|
593
|
-
* > This parameter is not
|
|
599
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
600
|
+
* >
|
|
594
601
|
*
|
|
595
602
|
* @example
|
|
596
603
|
* 1
|
|
@@ -600,17 +607,16 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
600
607
|
* @remarks
|
|
601
608
|
* <props="china">
|
|
602
609
|
*
|
|
603
|
-
* The [
|
|
604
|
-
*
|
|
605
|
-
* -
|
|
606
|
-
*
|
|
607
|
-
* - enterprise: Ultimate Edition
|
|
610
|
+
* The [specification type](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
|
|
611
|
+
* - standard: Standard Edition.
|
|
612
|
+
* - enterprise: Ultimate Edition.
|
|
608
613
|
*
|
|
609
614
|
*
|
|
610
615
|
*
|
|
611
616
|
* <props="intl">
|
|
612
617
|
*
|
|
613
|
-
* > This parameter is not
|
|
618
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
619
|
+
* >
|
|
614
620
|
*
|
|
615
621
|
* @example
|
|
616
622
|
* standard
|
|
@@ -618,18 +624,16 @@ export declare class CreateIndexRequest extends $dara.Model {
|
|
|
618
624
|
pipelineCommercialType?: string;
|
|
619
625
|
/**
|
|
620
626
|
* @remarks
|
|
621
|
-
* <props="china">
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
* downgrade: Degrades the service (switches to using a lightweight retrieval chain).
|
|
626
|
-
* If you do not specify this parameter, the default value \\`downgrade\\` is used.
|
|
627
|
-
*
|
|
627
|
+
* <props="china">The rate limiting strategy for knowledge base dependent links (required only when pipelineCommercialType is set to enterprise).
|
|
628
|
+
* Valid values:
|
|
629
|
+
* downgrade: Downgrade processing (switch to lightweight link retrieval).
|
|
630
|
+
* If not specified, the default value is downgrade.
|
|
628
631
|
*
|
|
629
632
|
*
|
|
630
633
|
* <props="intl">
|
|
631
634
|
*
|
|
632
|
-
* > This parameter is not
|
|
635
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
636
|
+
* >
|
|
633
637
|
*
|
|
634
638
|
* @example
|
|
635
639
|
* downgrade
|