@alicloud/bailian20231229 2.14.2 → 2.14.4
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 +62 -58
- package/dist/client.js +62 -62
- package/dist/client.js.map +1 -1
- package/dist/models/AddFileRequest.d.ts +20 -20
- package/dist/models/AddFileResponseBody.d.ts +5 -5
- package/dist/models/AddFileShrinkRequest.d.ts +16 -16
- package/dist/models/BatchUpdateFileTagRequest.d.ts +6 -4
- package/dist/models/BatchUpdateFileTagRequest.js.map +1 -1
- package/dist/models/BatchUpdateFileTagResponseBody.d.ts +14 -18
- package/dist/models/BatchUpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateFileTagShrinkRequest.d.ts +4 -2
- package/dist/models/BatchUpdateFileTagShrinkRequest.js.map +1 -1
- package/dist/models/CreateIndexRequest.d.ts +60 -60
- package/dist/models/CreateIndexResponseBody.d.ts +3 -3
- package/dist/models/CreateIndexShrinkRequest.d.ts +52 -52
- package/dist/models/ListIndexFileDetailsRequest.d.ts +3 -3
- package/dist/models/ListIndexFileDetailsResponseBody.d.ts +14 -4
- package/dist/models/ListIndexFileDetailsResponseBody.js.map +1 -1
- package/dist/models/ListIndicesRequest.d.ts +2 -2
- package/dist/models/ListIndicesResponseBody.d.ts +98 -29
- package/dist/models/ListIndicesResponseBody.js +37 -1
- package/dist/models/ListIndicesResponseBody.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobRequest.d.ts +33 -44
- package/dist/models/SubmitIndexAddDocumentsJobRequest.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.d.ts +8 -9
- package/dist/models/SubmitIndexAddDocumentsJobResponseBody.js.map +1 -1
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.d.ts +33 -44
- package/dist/models/SubmitIndexAddDocumentsJobShrinkRequest.js.map +1 -1
- package/dist/models/UpdateFileTagRequest.d.ts +1 -1
- package/dist/models/UpdateFileTagResponseBody.d.ts +8 -9
- package/dist/models/UpdateFileTagResponseBody.js.map +1 -1
- package/dist/models/UpdateFileTagShrinkRequest.d.ts +1 -1
- package/dist/models/model.d.ts +1 -0
- package/dist/models/model.js +12 -10
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +62 -62
- package/src/models/AddFileRequest.ts +20 -20
- package/src/models/AddFileResponseBody.ts +5 -5
- package/src/models/AddFileShrinkRequest.ts +16 -16
- package/src/models/BatchUpdateFileTagRequest.ts +6 -4
- package/src/models/BatchUpdateFileTagResponseBody.ts +14 -18
- package/src/models/BatchUpdateFileTagShrinkRequest.ts +4 -2
- package/src/models/CreateIndexRequest.ts +60 -60
- package/src/models/CreateIndexResponseBody.ts +3 -3
- package/src/models/CreateIndexShrinkRequest.ts +52 -52
- package/src/models/ListIndexFileDetailsRequest.ts +3 -3
- package/src/models/ListIndexFileDetailsResponseBody.ts +14 -4
- package/src/models/ListIndicesRequest.ts +2 -2
- package/src/models/ListIndicesResponseBody.ts +125 -29
- package/src/models/SubmitIndexAddDocumentsJobRequest.ts +33 -44
- package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +8 -9
- package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +33 -44
- package/src/models/UpdateFileTagRequest.ts +1 -1
- package/src/models/UpdateFileTagResponseBody.ts +8 -9
- package/src/models/UpdateFileTagShrinkRequest.ts +1 -1
- package/src/models/model.ts +1 -0
|
@@ -9,21 +9,21 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
9
9
|
* @remarks
|
|
10
10
|
* <props="china">
|
|
11
11
|
*
|
|
12
|
-
* The chunk size, which
|
|
12
|
+
* The chunk size, which is the maximum number of characters per text chunk. When the text exceeds this length:
|
|
13
13
|
*
|
|
14
|
-
* - **Intelligent chunking** (
|
|
15
|
-
* - **Custom chunking** (
|
|
14
|
+
* - **Intelligent chunking** (`chunkMode` not specified): The text is likely to be truncated.
|
|
15
|
+
* - **Custom chunking** (`chunkMode` specified): The text is forcibly truncated.
|
|
16
16
|
*
|
|
17
17
|
*
|
|
18
18
|
*
|
|
19
19
|
* <props="intl">
|
|
20
|
-
* The chunk size, which
|
|
20
|
+
* The chunk size, which is the maximum number of characters per text chunk. When the text exceeds this length, it is likely to be truncated.
|
|
21
21
|
*
|
|
22
22
|
*
|
|
23
23
|
*
|
|
24
|
-
*
|
|
24
|
+
* Valid values: [1-6000]. If not specified, the default value is 500.
|
|
25
25
|
*
|
|
26
|
-
* > 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.
|
|
26
|
+
* > 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 the default values.
|
|
27
27
|
*
|
|
28
28
|
* @example
|
|
29
29
|
* 128
|
|
@@ -32,18 +32,18 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
32
32
|
/**
|
|
33
33
|
* @remarks
|
|
34
34
|
* <props="china">
|
|
35
|
-
* The structure of the data table (column names, types,
|
|
35
|
+
* The structure of the data table (column names, types, and so on).
|
|
36
36
|
*
|
|
37
37
|
*
|
|
38
38
|
* <props="intl">
|
|
39
39
|
*
|
|
40
|
-
* > This parameter is not available. Do not pass
|
|
40
|
+
* > This parameter is not available. Do not pass in a value.
|
|
41
41
|
* >
|
|
42
42
|
*/
|
|
43
43
|
columnsShrink?: string;
|
|
44
44
|
/**
|
|
45
45
|
* @remarks
|
|
46
|
-
* > This parameter is not available. Do not pass
|
|
46
|
+
* > This parameter is not available. Do not pass in a value.
|
|
47
47
|
* >
|
|
48
48
|
*
|
|
49
49
|
* @example
|
|
@@ -52,23 +52,23 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
52
52
|
createIndexType?: string;
|
|
53
53
|
/**
|
|
54
54
|
* @remarks
|
|
55
|
-
* The knowledge base description. The description can be up to
|
|
55
|
+
* The knowledge base description. The description can be up to 200 characters in length and can contain Chinese and English characters.
|
|
56
56
|
* Default value: empty.
|
|
57
57
|
*
|
|
58
58
|
* @example
|
|
59
|
-
* The enterprise help document library includes important materials such as company policies and product catalogs
|
|
59
|
+
* The enterprise help document library includes important materials such as company policies and product catalogs
|
|
60
60
|
*/
|
|
61
61
|
description?: string;
|
|
62
62
|
/**
|
|
63
63
|
* @remarks
|
|
64
|
-
* The list of files to import when creating the knowledge base. Specify file IDs
|
|
64
|
+
* The list of files to import when creating the knowledge base. Specify file IDs. We recommend importing no more than 10,000 files. For remaining files, call the **SubmitIndexAddDocumentsJob** operation to continue importing.
|
|
65
65
|
*/
|
|
66
66
|
documentIdsShrink?: string;
|
|
67
67
|
/**
|
|
68
68
|
* @remarks
|
|
69
69
|
* <props="china">
|
|
70
70
|
*
|
|
71
|
-
* The embedding model used by the knowledge base. The embedding model
|
|
71
|
+
* The embedding model used by the knowledge base. The embedding model is used to transform 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 dimension selection, and is suitable for most scenarios. For more information, see [Vectorization](https://help.aliyun.com/document_detail/2842587.html). Valid values:
|
|
72
72
|
* - text-embedding-v4
|
|
73
73
|
* - text-embedding-v3
|
|
74
74
|
*
|
|
@@ -79,7 +79,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
79
79
|
*
|
|
80
80
|
* <props="intl">
|
|
81
81
|
*
|
|
82
|
-
* The embedding model used by the knowledge base. The embedding model
|
|
82
|
+
* The embedding model used by the knowledge base. The embedding model is used to transform 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:
|
|
83
83
|
* - text-embedding-v2
|
|
84
84
|
*
|
|
85
85
|
* Default value: empty, which uses the text-embedding-v2 model.
|
|
@@ -108,12 +108,12 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
108
108
|
* This parameter is required.
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
|
-
* EnterpriseHelpDocLibrary
|
|
111
|
+
* EnterpriseHelpDocLibrary
|
|
112
112
|
*/
|
|
113
113
|
name?: string;
|
|
114
114
|
/**
|
|
115
115
|
* @remarks
|
|
116
|
-
* The chunk overlap size, which
|
|
116
|
+
* The chunk overlap size, which is the number of overlapping characters between the current text chunk and the previous text chunk. Valid values: [0-1024].
|
|
117
117
|
*
|
|
118
118
|
* If not specified, the default value is 100.
|
|
119
119
|
* >`OverlapSize` must be less than `ChunkSize`. Otherwise, chunking exceptions occur.
|
|
@@ -124,15 +124,15 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
124
124
|
overlapSize?: number;
|
|
125
125
|
/**
|
|
126
126
|
* @remarks
|
|
127
|
-
* <props="intl">This parameter is not available. Do not pass
|
|
127
|
+
* <props="intl">This parameter is not yet available. Do not pass in a value.
|
|
128
128
|
*
|
|
129
|
-
* <props="china">
|
|
129
|
+
* <props="china">Provides a natural language instruction to fine-tune the behavior of the reranking model.
|
|
130
130
|
* <notice>This parameter takes effect only when rerank_mode is set to "custom".
|
|
131
131
|
*/
|
|
132
132
|
rerankInstruct?: string;
|
|
133
133
|
/**
|
|
134
134
|
* @remarks
|
|
135
|
-
* 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.
|
|
135
|
+
* 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. Valid values: [0.01-1.00].
|
|
136
136
|
*
|
|
137
137
|
* If not specified, the default value is 0.01.
|
|
138
138
|
*
|
|
@@ -155,7 +155,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
155
155
|
*
|
|
156
156
|
*
|
|
157
157
|
*
|
|
158
|
-
* <props="intl">This parameter is not available. Do not pass
|
|
158
|
+
* <props="intl">This parameter is not available. Do not pass in a value.
|
|
159
159
|
* [_single.params.RerankMode.enum.similar: 相似模式。]similar: Similarity mode.
|
|
160
160
|
* [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Custom mode.
|
|
161
161
|
* [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
@@ -183,7 +183,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
183
183
|
*
|
|
184
184
|
* <props="intl">
|
|
185
185
|
*
|
|
186
|
-
* - gte-rerank-hybrid:
|
|
186
|
+
* - gte-rerank-hybrid: Official reranking.
|
|
187
187
|
* - gte-rerank: gte-rerank reranking.
|
|
188
188
|
*
|
|
189
189
|
*
|
|
@@ -211,7 +211,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
211
211
|
*
|
|
212
212
|
* <props="china">
|
|
213
213
|
*
|
|
214
|
-
* > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated
|
|
214
|
+
* > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated. We do not recommend using them.
|
|
215
215
|
* >
|
|
216
216
|
*
|
|
217
217
|
* @example
|
|
@@ -222,16 +222,16 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
222
222
|
* @remarks
|
|
223
223
|
* <props="china">
|
|
224
224
|
*
|
|
225
|
-
* The sentence separator
|
|
225
|
+
* The sentence separator. This parameter takes effect only when `chunkMode`=**regex** (it does not take effect in other modes even if specified). You can pass in a single regular expression (multiple expressions are not supported) to split files into small text chunks.
|
|
226
226
|
*
|
|
227
|
-
* When using intelligent chunking (
|
|
227
|
+
* When using intelligent chunking (`chunkMode` not specified), keep the default empty value.
|
|
228
228
|
*
|
|
229
229
|
*
|
|
230
230
|
*
|
|
231
231
|
*
|
|
232
232
|
* <props="intl">
|
|
233
233
|
*
|
|
234
|
-
* > This parameter is not available. Do not pass
|
|
234
|
+
* > This parameter is not available. Do not pass in a value.
|
|
235
235
|
*
|
|
236
236
|
* @example
|
|
237
237
|
* (?<=。)
|
|
@@ -258,7 +258,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
258
258
|
* The vector storage type of the knowledge base. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values:
|
|
259
259
|
* - BUILT_IN: Vector data is hosted on the Alibaba Cloud Model Studio platform.
|
|
260
260
|
* - ADB: AnalyticDB for PostgreSQL database. If you need advanced features such as database management, auditing, and monitoring, select ADB.
|
|
261
|
-
* > 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,
|
|
261
|
+
* > 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, set the vector storage type to ADB-PG, and complete the authorization as prompted. If you pass in ADB, you must specify the `SinkInstanceId` and `SinkRegion` parameters.
|
|
262
262
|
*
|
|
263
263
|
* This parameter is required.
|
|
264
264
|
*
|
|
@@ -268,16 +268,16 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
268
268
|
sinkType?: string;
|
|
269
269
|
/**
|
|
270
270
|
* @remarks
|
|
271
|
-
* >Notice: This parameter is required in the latest SDK. Otherwise, calling the SubmitIndexJob operation returns
|
|
271
|
+
* >Notice: This parameter is required in the latest SDK version. Otherwise, calling the SubmitIndexJob operation returns the error: Required parameter(data_sources) missing or invalid.
|
|
272
272
|
*
|
|
273
273
|
* The data source type. Valid values:
|
|
274
|
-
* - 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).
|
|
275
|
-
* - 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).
|
|
274
|
+
* - 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). You can import multiple categories at the same time.
|
|
275
|
+
* - 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). You can import multiple files at the same time.
|
|
276
276
|
*
|
|
277
277
|
* > 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.
|
|
278
278
|
* >
|
|
279
279
|
*
|
|
280
|
-
* > 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
|
|
280
|
+
* > 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 to `CategoryIds`.
|
|
281
281
|
* >
|
|
282
282
|
*
|
|
283
283
|
* @example
|
|
@@ -293,7 +293,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
293
293
|
*
|
|
294
294
|
* **Valid values:**
|
|
295
295
|
*
|
|
296
|
-
* - 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.
|
|
296
|
+
* - unstructured: A document search or audio/video knowledge base. The default scenario for the document search type is basic document Q&A. <props="china">To create other scenarios, you must also pass the knowledgeType and knowledgeScene parameters.
|
|
297
297
|
*
|
|
298
298
|
* <props="china">
|
|
299
299
|
*
|
|
@@ -314,14 +314,14 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
314
314
|
* @remarks
|
|
315
315
|
* <props="china">
|
|
316
316
|
*
|
|
317
|
-
* Obtained by clicking the ID icon next to the table name on the Tables tab of [Data
|
|
317
|
+
* Obtained by clicking the ID icon next to the table name on the Tables tab of [Data Connection](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.
|
|
318
318
|
*
|
|
319
319
|
*
|
|
320
320
|
*
|
|
321
321
|
*
|
|
322
322
|
* <props="intl">
|
|
323
323
|
*
|
|
324
|
-
* > This parameter is not available. Do not pass
|
|
324
|
+
* > This parameter is not available. Do not pass in a value.
|
|
325
325
|
* >
|
|
326
326
|
*/
|
|
327
327
|
tableIdsShrink?: string;
|
|
@@ -338,11 +338,11 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
338
338
|
*
|
|
339
339
|
* Valid values (only one value can be passed at a time):
|
|
340
340
|
*
|
|
341
|
-
* - **length**: Chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If these two parameters
|
|
342
|
-
* - **page**: Chunk by page. If `ChunkSize` is specified, it is also considered during chunking (if not
|
|
343
|
-
* - **h1**: Chunk by first-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not
|
|
344
|
-
* - **h2**: Chunk by second-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not
|
|
345
|
-
* - **regex**: Chunk by regular expression.
|
|
341
|
+
* - **length**: Chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If you do not pass in these two parameters, the system uses the default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (it does not take effect even if specified).
|
|
342
|
+
* - **page**: Chunk by page. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by page does not support `OverlapSize` or `Separator` (they do not take effect even if specified).
|
|
343
|
+
* - **h1**: Chunk by first-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not specified, 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).
|
|
344
|
+
* - **h2**: Chunk by second-level headings. If `ChunkSize` is specified, it is also considered during chunking (if not specified, 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).
|
|
345
|
+
* - **regex**: Chunk 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 of 500 is used). Chunking by regular expression does not support `OverlapSize` (it does not take effect even if specified).
|
|
346
346
|
*
|
|
347
347
|
* If not specified, intelligent chunking is used by default.
|
|
348
348
|
*
|
|
@@ -351,7 +351,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
351
351
|
*
|
|
352
352
|
* <props="intl">
|
|
353
353
|
*
|
|
354
|
-
* > This parameter is not available. Do not pass
|
|
354
|
+
* > This parameter is not available. Do not pass in a value.
|
|
355
355
|
*
|
|
356
356
|
* @example
|
|
357
357
|
* regex
|
|
@@ -366,7 +366,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
366
366
|
datasourceCode?: string;
|
|
367
367
|
/**
|
|
368
368
|
* @remarks
|
|
369
|
-
* Specifies whether to treat the first row of all xlsx and xls files as headers and
|
|
369
|
+
* Specifies whether to treat the first row of all xlsx and xls files as headers and append them to each text chunk, preventing the large language model from treating headers as regular data rows.
|
|
370
370
|
*
|
|
371
371
|
*
|
|
372
372
|
* > Enable this feature only when all imported files are in .xlsx or .xls format and contain headers. Otherwise, do not enable it.
|
|
@@ -386,12 +386,12 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
386
386
|
/**
|
|
387
387
|
* @remarks
|
|
388
388
|
* <props="china">
|
|
389
|
-
* The specific knowledge type
|
|
390
|
-
* <notice>This parameter and knowledgeScene must be provided together or omitted together. They cannot be set
|
|
389
|
+
* The specific knowledge type that further specifies the data type processed by the knowledge base.
|
|
390
|
+
* <notice>This parameter and knowledgeScene must be provided together or omitted together. They cannot be set individually. If both are omitted, the system uses the default configurations based on structureType.
|
|
391
391
|
*
|
|
392
392
|
* **Settings constraint**: The value of this parameter must match the selected structureType and determines the active values for knowledgeScene.
|
|
393
393
|
*
|
|
394
|
-
* **Valid values
|
|
394
|
+
* **Valid values:**
|
|
395
395
|
* - document: Document search. Must be used with structureType: unstructured.
|
|
396
396
|
* - table: Data query. Must be used with structureType: structured.
|
|
397
397
|
* - image: Image-based Q&A. Must be used with structureType: structured.
|
|
@@ -400,7 +400,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
400
400
|
*
|
|
401
401
|
*
|
|
402
402
|
*
|
|
403
|
-
* <props="intl">This parameter is not available. Do not pass
|
|
403
|
+
* <props="intl">This parameter is not available. Do not pass in a value.
|
|
404
404
|
*
|
|
405
405
|
* @example
|
|
406
406
|
* document
|
|
@@ -408,17 +408,17 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
408
408
|
knowledgeType?: string;
|
|
409
409
|
/**
|
|
410
410
|
* @remarks
|
|
411
|
-
* The metadata extraction configuration. Metadata
|
|
411
|
+
* The metadata extraction configuration. Metadata consists 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).
|
|
412
412
|
*/
|
|
413
413
|
metaExtractColumnsShrink?: string;
|
|
414
414
|
/**
|
|
415
415
|
* @remarks
|
|
416
|
-
* <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise).
|
|
416
|
+
* <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Valid values: [1-200].
|
|
417
417
|
*
|
|
418
418
|
*
|
|
419
419
|
* <props="intl">
|
|
420
420
|
*
|
|
421
|
-
* > This parameter is not available. Do not pass
|
|
421
|
+
* > This parameter is not available. Do not pass in a value.
|
|
422
422
|
* >
|
|
423
423
|
*
|
|
424
424
|
* @example
|
|
@@ -429,7 +429,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
429
429
|
* @remarks
|
|
430
430
|
* <props="china">
|
|
431
431
|
*
|
|
432
|
-
* The [
|
|
432
|
+
* The [edition](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
|
|
433
433
|
* - standard: Standard Edition.
|
|
434
434
|
* - enterprise: Ultimate Edition.
|
|
435
435
|
*
|
|
@@ -437,7 +437,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
437
437
|
*
|
|
438
438
|
* <props="intl">
|
|
439
439
|
*
|
|
440
|
-
* > This parameter is not available. Do not pass
|
|
440
|
+
* > This parameter is not available. Do not pass in a value.
|
|
441
441
|
* >
|
|
442
442
|
*
|
|
443
443
|
* @example
|
|
@@ -446,15 +446,15 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
446
446
|
pipelineCommercialType?: string;
|
|
447
447
|
/**
|
|
448
448
|
* @remarks
|
|
449
|
-
* <props="china">The rate limiting strategy for knowledge base
|
|
449
|
+
* <props="china">The rate limiting strategy for the knowledge base dependency chain (required only when pipelineCommercialType is set to enterprise).
|
|
450
450
|
* Valid values:
|
|
451
|
-
* downgrade: Downgrade processing (switch to lightweight
|
|
451
|
+
* downgrade: Downgrade processing (switch to lightweight chain retrieval).
|
|
452
452
|
* If not specified, the default value is downgrade.
|
|
453
453
|
*
|
|
454
454
|
*
|
|
455
455
|
* <props="intl">
|
|
456
456
|
*
|
|
457
|
-
* > This parameter is not available. Do not pass
|
|
457
|
+
* > This parameter is not available. Do not pass in a value.
|
|
458
458
|
* >
|
|
459
459
|
*
|
|
460
460
|
* @example
|
|
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class ListIndexFileDetailsRequest extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* Filters the returned file details list by file name. Default value: empty, which means
|
|
5
|
+
* Filters the returned file details list by file name. Default value: empty, which means no filtering by file name.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
8
|
* TranslationPlatformO&MDocument.
|
|
@@ -19,7 +19,7 @@ export declare class ListIndexFileDetailsRequest extends $dara.Model {
|
|
|
19
19
|
* - PARSE_FAILED: Parsing failed.
|
|
20
20
|
* - DOC_PARSING: Parsing in progress.
|
|
21
21
|
*
|
|
22
|
-
* Default value: empty, which means
|
|
22
|
+
* Default value: empty, which means no filtering by file import status.
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
25
|
* FINISH
|
|
@@ -56,7 +56,7 @@ export declare class ListIndexFileDetailsRequest extends $dara.Model {
|
|
|
56
56
|
pageNumber?: number;
|
|
57
57
|
/**
|
|
58
58
|
* @remarks
|
|
59
|
-
* The number of files to display per page in a
|
|
59
|
+
* The number of files to display per page in a paging query. Maximum value: 10.
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
62
|
* 10
|
|
@@ -42,7 +42,7 @@ export declare class ListIndexFileDetailsResponseBodyDataDocuments extends $dara
|
|
|
42
42
|
enableHeaders?: string;
|
|
43
43
|
/**
|
|
44
44
|
* @remarks
|
|
45
|
-
* The time when the file was imported to the knowledge base, in
|
|
45
|
+
* The time when the file was imported to the knowledge base, in UNIX timestamp format.
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* 1744856423000
|
|
@@ -64,6 +64,16 @@ export declare class ListIndexFileDetailsResponseBodyDataDocuments extends $dara
|
|
|
64
64
|
* check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
|
|
65
65
|
*/
|
|
66
66
|
message?: string;
|
|
67
|
+
/**
|
|
68
|
+
* @remarks
|
|
69
|
+
* The metadata extracted from the document.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* {
|
|
73
|
+
* "doc_summary": ["Example 1."],
|
|
74
|
+
* "health_rule": ["Example 2"]
|
|
75
|
+
* }
|
|
76
|
+
*/
|
|
67
77
|
metaExtractInfo?: string;
|
|
68
78
|
/**
|
|
69
79
|
* @remarks
|
|
@@ -132,7 +142,7 @@ export declare class ListIndexFileDetailsResponseBodyDataDocuments extends $dara
|
|
|
132
142
|
export declare class ListIndexFileDetailsResponseBodyData extends $dara.Model {
|
|
133
143
|
/**
|
|
134
144
|
* @remarks
|
|
135
|
-
* The list of files in the knowledge base, sorted by file import time
|
|
145
|
+
* The list of files in the knowledge base, sorted in descending order by file import time (consistent with the console).
|
|
136
146
|
*/
|
|
137
147
|
documents?: ListIndexFileDetailsResponseBodyDataDocuments[];
|
|
138
148
|
/**
|
|
@@ -145,7 +155,7 @@ export declare class ListIndexFileDetailsResponseBodyData extends $dara.Model {
|
|
|
145
155
|
indexId?: string;
|
|
146
156
|
/**
|
|
147
157
|
* @remarks
|
|
148
|
-
* The
|
|
158
|
+
* The returned page number.
|
|
149
159
|
*
|
|
150
160
|
* @example
|
|
151
161
|
* 1
|
|
@@ -153,7 +163,7 @@ export declare class ListIndexFileDetailsResponseBodyData extends $dara.Model {
|
|
|
153
163
|
pageNumber?: number;
|
|
154
164
|
/**
|
|
155
165
|
* @remarks
|
|
156
|
-
* The
|
|
166
|
+
* The returned number of items per page.
|
|
157
167
|
*
|
|
158
168
|
* @example
|
|
159
169
|
* 10
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ListIndexFileDetailsResponseBody.js","sourceRoot":"","sources":["../../src/models/ListIndexFileDetailsResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,6CAA8C,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"ListIndexFileDetailsResponseBody.js","sourceRoot":"","sources":["../../src/models/ListIndexFileDetailsResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,6CAA8C,SAAQ,KAAK,CAAC,KAAK;IAiI5E,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,cAAc;YAC5B,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,EAAE,EAAE,IAAI;YACR,OAAO,EAAE,SAAS;YAClB,eAAe,EAAE,iBAAiB;YAClC,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,aAAa;YAC1B,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,EAAE,EAAE,QAAQ;YACZ,OAAO,EAAE,QAAQ;YACjB,eAAe,EAAE,QAAQ;YACzB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,QAAQ;YACrB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAhLD,sGAgLC;AAED,MAAa,oCAAqC,SAAQ,KAAK,CAAC,KAAK;IAsCnE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,6CAA6C,EAAE;YACzF,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApED,oFAoEC;AAED,MAAa,gCAAiC,SAAQ,KAAK,CAAC,KAAK;IAiD/D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,oCAAoC;YAC1C,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,IAAI,IAAI,OAAQ,IAAI,CAAC,IAAY,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjE,IAAI,CAAC,IAAY,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjFD,4EAiFC"}
|
|
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class ListIndicesRequest extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The name of the knowledge base. You can use this parameter to search for a knowledge base by name. The name must be 1 to 20 characters in length and can contain characters
|
|
5
|
+
* The name of the knowledge base. You can use this parameter to search for a knowledge base by name. The name must be 1 to 20 characters in length and can contain characters in the Unicode letter category (including letters, Chinese characters, and digits). The name can also contain colons (:), underscores (_), periods (.), or hyphens (-).
|
|
6
6
|
*
|
|
7
7
|
* Default value: empty, which queries all knowledge bases in the specified workspace.
|
|
8
8
|
*
|
|
@@ -20,7 +20,7 @@ export declare class ListIndicesRequest extends $dara.Model {
|
|
|
20
20
|
pageNumber?: string;
|
|
21
21
|
/**
|
|
22
22
|
* @remarks
|
|
23
|
-
* The number of knowledge bases to display per page
|
|
23
|
+
* The number of knowledge bases to display per page. No maximum limit.
|
|
24
24
|
* Default value: 10.
|
|
25
25
|
*
|
|
26
26
|
* @example
|