@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,30 +2,28 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
*
|
|
5
|
+
* 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.
|
|
6
6
|
*/
|
|
7
7
|
categoryIdsShrink?: string;
|
|
8
8
|
/**
|
|
9
9
|
* @remarks
|
|
10
10
|
* <props="china">
|
|
11
11
|
*
|
|
12
|
-
* The chunk size, which
|
|
12
|
+
* The chunk size, which specifies the maximum number of characters per text chunk. When this length is exceeded:
|
|
13
13
|
*
|
|
14
|
-
* - **
|
|
15
|
-
*
|
|
16
|
-
* - **Custom chunking** (the \\`chunkMode\\` parameter is specified): The text is forcibly truncated.
|
|
14
|
+
* - **Intelligent chunking** (when `chunkMode` is not specified): The text is likely to be truncated.
|
|
15
|
+
* - **Custom chunking** (when `chunkMode` is specified): The text is forcibly truncated.
|
|
17
16
|
*
|
|
18
17
|
*
|
|
19
18
|
*
|
|
20
19
|
* <props="intl">
|
|
21
|
-
*
|
|
22
|
-
* 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.
|
|
20
|
+
* 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.
|
|
23
21
|
*
|
|
24
22
|
*
|
|
25
23
|
*
|
|
26
|
-
*
|
|
24
|
+
* Value range: [1-6000]. If not specified, the default value is 500.
|
|
27
25
|
*
|
|
28
|
-
* > If
|
|
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.
|
|
29
27
|
*
|
|
30
28
|
* @example
|
|
31
29
|
* 128
|
|
@@ -34,19 +32,19 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
34
32
|
/**
|
|
35
33
|
* @remarks
|
|
36
34
|
* <props="china">
|
|
37
|
-
*
|
|
38
35
|
* The structure of the data table (column names, types, etc.).
|
|
39
36
|
*
|
|
40
37
|
*
|
|
41
|
-
*
|
|
42
38
|
* <props="intl">
|
|
43
39
|
*
|
|
44
|
-
* > This parameter is not
|
|
40
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
41
|
+
* >
|
|
45
42
|
*/
|
|
46
43
|
columnsShrink?: string;
|
|
47
44
|
/**
|
|
48
45
|
* @remarks
|
|
49
|
-
* > This parameter is not
|
|
46
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
47
|
+
* >
|
|
50
48
|
*
|
|
51
49
|
* @example
|
|
52
50
|
* standard
|
|
@@ -54,42 +52,40 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
54
52
|
createIndexType?: string;
|
|
55
53
|
/**
|
|
56
54
|
* @remarks
|
|
57
|
-
* The
|
|
58
|
-
*
|
|
55
|
+
* The knowledge base description. The description can be up to 1000 characters in length.
|
|
56
|
+
* Default value: empty.
|
|
59
57
|
*
|
|
60
58
|
* @example
|
|
61
|
-
*
|
|
59
|
+
* The enterprise help document library includes important materials such as company policies and product catalogs.
|
|
62
60
|
*/
|
|
63
61
|
description?: string;
|
|
64
62
|
/**
|
|
65
63
|
* @remarks
|
|
66
|
-
*
|
|
64
|
+
* 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.
|
|
67
65
|
*/
|
|
68
66
|
documentIdsShrink?: string;
|
|
69
67
|
/**
|
|
70
68
|
* @remarks
|
|
71
69
|
* <props="china">
|
|
72
70
|
*
|
|
73
|
-
* The
|
|
74
|
-
*
|
|
71
|
+
* 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:
|
|
75
72
|
* - text-embedding-v4
|
|
76
|
-
*
|
|
77
73
|
* - text-embedding-v3
|
|
78
74
|
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
75
|
+
* Default value: empty, which uses the text-embedding-v3 model.
|
|
82
76
|
*
|
|
83
|
-
* <props="intl">
|
|
84
|
-
*
|
|
85
|
-
* - 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:
|
|
86
77
|
*
|
|
87
78
|
*
|
|
88
79
|
*
|
|
80
|
+
* <props="intl">
|
|
89
81
|
*
|
|
82
|
+
* 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:
|
|
90
83
|
* - text-embedding-v2
|
|
91
84
|
*
|
|
92
|
-
*
|
|
85
|
+
* Default value: empty, which uses the text-embedding-v2 model.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* text-embedding-v4
|
|
93
89
|
*/
|
|
94
90
|
embeddingModelName?: string;
|
|
95
91
|
/**
|
|
@@ -97,10 +93,9 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
97
93
|
* Specifies whether to enable multi-turn conversation rewriting. Valid values:
|
|
98
94
|
*
|
|
99
95
|
* - true: Enabled.
|
|
100
|
-
*
|
|
101
96
|
* - false: Disabled.
|
|
102
97
|
*
|
|
103
|
-
* If
|
|
98
|
+
* If not specified, this feature is enabled by default.
|
|
104
99
|
*
|
|
105
100
|
* @example
|
|
106
101
|
* true
|
|
@@ -108,21 +103,20 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
108
103
|
enableRewrite?: boolean;
|
|
109
104
|
/**
|
|
110
105
|
* @remarks
|
|
111
|
-
* The
|
|
106
|
+
* 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 (:).
|
|
112
107
|
*
|
|
113
108
|
* This parameter is required.
|
|
114
109
|
*
|
|
115
110
|
* @example
|
|
116
|
-
*
|
|
111
|
+
* EnterpriseHelpDocLibrary.
|
|
117
112
|
*/
|
|
118
113
|
name?: string;
|
|
119
114
|
/**
|
|
120
115
|
* @remarks
|
|
121
|
-
* The overlap size, which
|
|
116
|
+
* 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].
|
|
122
117
|
*
|
|
123
|
-
* If
|
|
124
|
-
*
|
|
125
|
-
* > \\`OverlapSize\\` must be smaller than \\`ChunkSize\\`. Otherwise, chunking errors will occur.
|
|
118
|
+
* If not specified, the default value is 100.
|
|
119
|
+
* >`OverlapSize` must be less than `ChunkSize`. Otherwise, chunking exceptions occur.
|
|
126
120
|
*
|
|
127
121
|
* @example
|
|
128
122
|
* 16
|
|
@@ -130,16 +124,17 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
130
124
|
overlapSize?: number;
|
|
131
125
|
/**
|
|
132
126
|
* @remarks
|
|
133
|
-
*
|
|
127
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
134
128
|
*
|
|
135
|
-
*
|
|
129
|
+
* <props="china">A natural language instruction for fine-grained control of the reranking model\\"s behavior.
|
|
130
|
+
* <notice>This parameter takes effect only when rerank_mode is set to "custom".
|
|
136
131
|
*/
|
|
137
132
|
rerankInstruct?: string;
|
|
138
133
|
/**
|
|
139
134
|
* @remarks
|
|
140
|
-
* The similarity threshold. Only text chunks with
|
|
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. Value range: [0.01-1.00].
|
|
141
136
|
*
|
|
142
|
-
* If
|
|
137
|
+
* If not specified, the default value is 0.01.
|
|
143
138
|
*
|
|
144
139
|
* @example
|
|
145
140
|
* 0.20
|
|
@@ -147,9 +142,26 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
147
142
|
rerankMinScore?: number;
|
|
148
143
|
/**
|
|
149
144
|
* @remarks
|
|
150
|
-
*
|
|
145
|
+
* <props="china">
|
|
146
|
+
* Specifies the instruction intervention mode for the reranking model to determine its scoring preference.
|
|
151
147
|
*
|
|
152
|
-
*
|
|
148
|
+
* **Valid values:**
|
|
149
|
+
*
|
|
150
|
+
* - **qa**: (Default) Q&A mode. The model tends to assign higher scores to candidates that directly answer the query. Recommended for Q&A scenarios.
|
|
151
|
+
*
|
|
152
|
+
* - **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.
|
|
153
|
+
*
|
|
154
|
+
* - **custom**: Custom mode. The model\\"s ranking behavior is determined by the instruction in the rerank_instruct parameter.
|
|
155
|
+
*
|
|
156
|
+
*
|
|
157
|
+
*
|
|
158
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
159
|
+
* [_single.params.RerankMode.enum.similar: 相似模式。]similar: Similarity mode.
|
|
160
|
+
* [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Custom mode.
|
|
161
|
+
* [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
162
|
+
* [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Similarity mode.
|
|
163
|
+
* [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Custom mode.
|
|
164
|
+
* [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (Default) Q&A mode.
|
|
153
165
|
*
|
|
154
166
|
* @example
|
|
155
167
|
* qa
|
|
@@ -157,47 +169,50 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
157
169
|
rerankMode?: string;
|
|
158
170
|
/**
|
|
159
171
|
* @remarks
|
|
160
|
-
* The reranking model used by the knowledge base. The reranking model is an external scoring system that calculates
|
|
172
|
+
* 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:
|
|
161
173
|
*
|
|
162
|
-
* <props="china">
|
|
163
174
|
*
|
|
164
|
-
*
|
|
175
|
+
* <props="china">
|
|
165
176
|
*
|
|
177
|
+
* - qwen3-rerank-hybrid: qwen3-rerank(hybrid) reranking.
|
|
166
178
|
* - qwen3-rerank: qwen3-rerank reranking.
|
|
167
|
-
*
|
|
168
|
-
* - gte-rerank-hybrid: gte-rerank (hybrid) reranking.
|
|
169
|
-
*
|
|
179
|
+
* - gte-rerank-hybrid: gte-rerank(hybrid) reranking.
|
|
170
180
|
* - gte-rerank: gte-rerank reranking.
|
|
171
181
|
*
|
|
172
182
|
*
|
|
173
183
|
*
|
|
174
184
|
* <props="intl">
|
|
175
185
|
*
|
|
176
|
-
* - gte-rerank-hybrid:
|
|
177
|
-
*
|
|
186
|
+
* - gte-rerank-hybrid: official reranking.
|
|
178
187
|
* - gte-rerank: gte-rerank reranking.
|
|
179
188
|
*
|
|
180
189
|
*
|
|
181
190
|
*
|
|
191
|
+
*
|
|
192
|
+
*
|
|
182
193
|
* <props="china">
|
|
183
194
|
*
|
|
184
|
-
*
|
|
195
|
+
* Default value: empty, which uses qwen3-rerank.
|
|
196
|
+
* > 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`.
|
|
197
|
+
* >
|
|
185
198
|
*
|
|
186
|
-
* > 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.
|
|
187
199
|
*
|
|
188
200
|
*
|
|
189
201
|
*
|
|
190
202
|
* <props="intl">
|
|
191
203
|
*
|
|
192
|
-
*
|
|
204
|
+
* Default value: empty, which uses gte-rerank-hybrid.
|
|
205
|
+
* > 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`.
|
|
206
|
+
* >
|
|
207
|
+
*
|
|
193
208
|
*
|
|
194
|
-
* > 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.
|
|
195
209
|
*
|
|
196
210
|
*
|
|
197
211
|
*
|
|
198
212
|
* <props="china">
|
|
199
213
|
*
|
|
200
|
-
* >
|
|
214
|
+
* > `gte-rerank-hybrid` and `gte-rerank` will no longer be updated and are not recommended.
|
|
215
|
+
* >
|
|
201
216
|
*
|
|
202
217
|
* @example
|
|
203
218
|
* gte-rerank-hybrid
|
|
@@ -207,15 +222,16 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
207
222
|
* @remarks
|
|
208
223
|
* <props="china">
|
|
209
224
|
*
|
|
210
|
-
* The sentence separator
|
|
225
|
+
* 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.
|
|
226
|
+
*
|
|
227
|
+
* When using intelligent chunking (when `chunkMode` is not specified), keep the default empty value.
|
|
211
228
|
*
|
|
212
|
-
* For smart chunking (the \\`chunkMode\\` parameter is not specified), you can leave this parameter empty.
|
|
213
229
|
*
|
|
214
230
|
*
|
|
215
231
|
*
|
|
216
232
|
* <props="intl">
|
|
217
233
|
*
|
|
218
|
-
* > This parameter is not
|
|
234
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
219
235
|
*
|
|
220
236
|
* @example
|
|
221
237
|
* (?<=。)
|
|
@@ -223,7 +239,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
223
239
|
separator?: string;
|
|
224
240
|
/**
|
|
225
241
|
* @remarks
|
|
226
|
-
* The
|
|
242
|
+
* 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.
|
|
227
243
|
*
|
|
228
244
|
* @example
|
|
229
245
|
* gp-bp32109xxxx
|
|
@@ -231,7 +247,7 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
231
247
|
sinkInstanceId?: string;
|
|
232
248
|
/**
|
|
233
249
|
* @remarks
|
|
234
|
-
* The region
|
|
250
|
+
* 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.
|
|
235
251
|
*
|
|
236
252
|
* @example
|
|
237
253
|
* cn-hangzhou
|
|
@@ -239,13 +255,10 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
239
255
|
sinkRegion?: string;
|
|
240
256
|
/**
|
|
241
257
|
* @remarks
|
|
242
|
-
* The storage
|
|
243
|
-
*
|
|
244
|
-
* -
|
|
245
|
-
*
|
|
246
|
-
* - ADB: AnalyticDB for PostgreSQL. We recommend choosing ADB if you need advanced features such as database management, auditing, and monitoring.
|
|
247
|
-
*
|
|
248
|
-
* > 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.
|
|
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
|
+
* - BUILT_IN: Vector data is hosted on the Alibaba Cloud Model Studio platform.
|
|
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, 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.
|
|
249
262
|
*
|
|
250
263
|
* This parameter is required.
|
|
251
264
|
*
|
|
@@ -255,21 +268,17 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
255
268
|
sinkType?: string;
|
|
256
269
|
/**
|
|
257
270
|
* @remarks
|
|
258
|
-
* >Notice:
|
|
259
|
-
*
|
|
260
|
-
* 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.
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
* The source of the imported data. Valid values:
|
|
265
|
-
*
|
|
266
|
-
* - DATA_CENTER_CATEGORY: Category type. Imports all files under the specified categories in <props="intl">[Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center). You can import multiple categories at the same time.
|
|
271
|
+
* >Notice: This parameter is required in the latest SDK. Otherwise, calling the SubmitIndexJob operation returns an error: Required parameter(data_sources) missing or invalid.
|
|
267
272
|
*
|
|
268
|
-
*
|
|
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). Multiple categories can be imported simultaneously.
|
|
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). Multiple files can be imported simultaneously.
|
|
269
276
|
*
|
|
270
|
-
* > If
|
|
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
|
+
* >
|
|
271
279
|
*
|
|
272
|
-
* > To create an empty knowledge base, use an empty category that contains no files
|
|
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 in `CategoryIds`.
|
|
281
|
+
* >
|
|
273
282
|
*
|
|
274
283
|
* @example
|
|
275
284
|
* DATA_CENTER_FILE
|
|
@@ -280,20 +289,20 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
280
289
|
sourceType?: string;
|
|
281
290
|
/**
|
|
282
291
|
* @remarks
|
|
283
|
-
* The
|
|
292
|
+
* The knowledge base type.
|
|
284
293
|
*
|
|
285
|
-
* **Valid values
|
|
294
|
+
* **Valid values:**
|
|
286
295
|
*
|
|
287
|
-
* - unstructured: A
|
|
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.
|
|
288
297
|
*
|
|
289
298
|
* <props="china">
|
|
290
299
|
*
|
|
291
|
-
* - structured: A
|
|
292
|
-
*
|
|
300
|
+
* - structured: A data query or image-based Q&A knowledge base.
|
|
293
301
|
*
|
|
294
302
|
*
|
|
295
303
|
*
|
|
296
|
-
* > The
|
|
304
|
+
* > The knowledge base type cannot be changed after creation.
|
|
305
|
+
* >
|
|
297
306
|
*
|
|
298
307
|
* This parameter is required.
|
|
299
308
|
*
|
|
@@ -305,13 +314,15 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
305
314
|
* @remarks
|
|
306
315
|
* <props="china">
|
|
307
316
|
*
|
|
308
|
-
*
|
|
317
|
+
* 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.
|
|
318
|
+
*
|
|
309
319
|
*
|
|
310
320
|
*
|
|
311
321
|
*
|
|
312
322
|
* <props="intl">
|
|
313
323
|
*
|
|
314
|
-
* > This parameter is not
|
|
324
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
325
|
+
* >
|
|
315
326
|
*/
|
|
316
327
|
tableIdsShrink?: string;
|
|
317
328
|
/**
|
|
@@ -323,27 +334,24 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
323
334
|
* @remarks
|
|
324
335
|
* <props="china">
|
|
325
336
|
*
|
|
326
|
-
* Enables custom chunking and specifies the chunking
|
|
327
|
-
*
|
|
328
|
-
* Possible values (only one value can be specified at a time):
|
|
337
|
+
* Enables custom chunking and specifies the chunking strategy. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
329
338
|
*
|
|
330
|
-
*
|
|
339
|
+
* Valid values (only one value can be passed at a time):
|
|
331
340
|
*
|
|
332
|
-
* - **
|
|
341
|
+
* - **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).
|
|
342
|
+
* - **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).
|
|
343
|
+
* - **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).
|
|
344
|
+
* - **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).
|
|
345
|
+
* - **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).
|
|
333
346
|
*
|
|
334
|
-
*
|
|
347
|
+
* If not specified, intelligent chunking is used by default.
|
|
335
348
|
*
|
|
336
|
-
* - **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).
|
|
337
|
-
*
|
|
338
|
-
* - **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).
|
|
339
|
-
*
|
|
340
|
-
* If you do not specify this parameter, smart chunking is used by default.
|
|
341
349
|
*
|
|
342
350
|
*
|
|
343
351
|
*
|
|
344
352
|
* <props="intl">
|
|
345
353
|
*
|
|
346
|
-
* > This parameter is not
|
|
354
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
347
355
|
*
|
|
348
356
|
* @example
|
|
349
357
|
* regex
|
|
@@ -358,17 +366,17 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
358
366
|
datasourceCode?: string;
|
|
359
367
|
/**
|
|
360
368
|
* @remarks
|
|
361
|
-
* Specifies whether to treat the first row of all
|
|
369
|
+
* 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.
|
|
362
370
|
*
|
|
363
|
-
* > 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.
|
|
364
371
|
*
|
|
365
|
-
*
|
|
372
|
+
* > Enable this feature only when all imported files are in .xlsx or .xls format and contain headers. Otherwise, do not enable it.
|
|
373
|
+
* >
|
|
366
374
|
*
|
|
375
|
+
* Valid values:
|
|
367
376
|
* - true: Enabled.
|
|
368
|
-
*
|
|
369
377
|
* - false: Disabled.
|
|
370
378
|
*
|
|
371
|
-
* If
|
|
379
|
+
* If not specified, this feature is disabled by default.
|
|
372
380
|
*
|
|
373
381
|
* @example
|
|
374
382
|
* false
|
|
@@ -377,15 +385,22 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
377
385
|
knowledgeScene?: string;
|
|
378
386
|
/**
|
|
379
387
|
* @remarks
|
|
380
|
-
* The data source code. This parameter is required when creating a data query knowledge base and is used with \\`table\\` and \\`database\\`.
|
|
381
|
-
*
|
|
382
388
|
* <props="china">
|
|
389
|
+
* The specific knowledge type, which further specifies the type of data processed by the knowledge base.
|
|
390
|
+
* <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.
|
|
391
|
+
*
|
|
392
|
+
* **Settings constraint**: The value of this parameter must match the selected structureType and determines the active values for knowledgeScene.
|
|
393
|
+
*
|
|
394
|
+
* **Valid values**:
|
|
395
|
+
* - document: Document search. Must be used with structureType: unstructured.
|
|
396
|
+
* - table: Data query. Must be used with structureType: structured.
|
|
397
|
+
* - image: Image-based Q&A. Must be used with structureType: structured.
|
|
398
|
+
* - multimedia: Audio/video search. Must be used with structureType: unstructured.
|
|
383
399
|
*
|
|
384
|
-
* 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.
|
|
385
400
|
*
|
|
386
401
|
*
|
|
387
402
|
*
|
|
388
|
-
* >
|
|
403
|
+
* <props="intl">This parameter is not available. Do not pass this parameter.
|
|
389
404
|
*
|
|
390
405
|
* @example
|
|
391
406
|
* document
|
|
@@ -393,20 +408,18 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
393
408
|
knowledgeType?: string;
|
|
394
409
|
/**
|
|
395
410
|
* @remarks
|
|
396
|
-
* The metadata extraction configuration. Metadata is a
|
|
411
|
+
* 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).
|
|
397
412
|
*/
|
|
398
413
|
metaExtractColumnsShrink?: string;
|
|
399
414
|
/**
|
|
400
415
|
* @remarks
|
|
401
|
-
* <props="china">
|
|
402
|
-
*
|
|
403
|
-
* 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.
|
|
404
|
-
*
|
|
416
|
+
* <props="china">The number of RCUs for the knowledge base (required only when pipelineCommercialType is set to enterprise). Value range: [1-200].
|
|
405
417
|
*
|
|
406
418
|
*
|
|
407
419
|
* <props="intl">
|
|
408
420
|
*
|
|
409
|
-
* > This parameter is not
|
|
421
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
422
|
+
* >
|
|
410
423
|
*
|
|
411
424
|
* @example
|
|
412
425
|
* 1
|
|
@@ -416,17 +429,16 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
416
429
|
* @remarks
|
|
417
430
|
* <props="china">
|
|
418
431
|
*
|
|
419
|
-
* The [
|
|
420
|
-
*
|
|
421
|
-
* -
|
|
422
|
-
*
|
|
423
|
-
* - enterprise: Ultimate Edition
|
|
432
|
+
* The [specification type](https://help.aliyun.com/document_detail/2997110.html) of the knowledge base. Valid values:
|
|
433
|
+
* - standard: Standard Edition.
|
|
434
|
+
* - enterprise: Ultimate Edition.
|
|
424
435
|
*
|
|
425
436
|
*
|
|
426
437
|
*
|
|
427
438
|
* <props="intl">
|
|
428
439
|
*
|
|
429
|
-
* > This parameter is not
|
|
440
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
441
|
+
* >
|
|
430
442
|
*
|
|
431
443
|
* @example
|
|
432
444
|
* standard
|
|
@@ -434,18 +446,16 @@ export declare class CreateIndexShrinkRequest extends $dara.Model {
|
|
|
434
446
|
pipelineCommercialType?: string;
|
|
435
447
|
/**
|
|
436
448
|
* @remarks
|
|
437
|
-
* <props="china">
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
* downgrade: Degrades the service (switches to using a lightweight retrieval chain).
|
|
442
|
-
* If you do not specify this parameter, the default value \\`downgrade\\` is used.
|
|
443
|
-
*
|
|
449
|
+
* <props="china">The rate limiting strategy for knowledge base dependent links (required only when pipelineCommercialType is set to enterprise).
|
|
450
|
+
* Valid values:
|
|
451
|
+
* downgrade: Downgrade processing (switch to lightweight link retrieval).
|
|
452
|
+
* If not specified, the default value is downgrade.
|
|
444
453
|
*
|
|
445
454
|
*
|
|
446
455
|
* <props="intl">
|
|
447
456
|
*
|
|
448
|
-
* > This parameter is not
|
|
457
|
+
* > This parameter is not available. Do not pass this parameter.
|
|
458
|
+
* >
|
|
449
459
|
*
|
|
450
460
|
* @example
|
|
451
461
|
* downgrade
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateIndexShrinkRequest.js","sourceRoot":"","sources":["../../src/models/CreateIndexShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wBAAyB,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"CreateIndexShrinkRequest.js","sourceRoot":"","sources":["../../src/models/CreateIndexShrinkRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,wBAAyB,SAAQ,KAAK,CAAC,KAAK;IA+cvD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,iBAAiB,EAAE,aAAa;YAChC,SAAS,EAAE,WAAW;YACtB,aAAa,EAAE,SAAS;YACxB,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,iBAAiB,EAAE,aAAa;YAChC,kBAAkB,EAAE,oBAAoB;YACxC,aAAa,EAAE,eAAe;YAC9B,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,cAAc,EAAE,gBAAgB;YAChC,UAAU,EAAE,YAAY;YACxB,eAAe,EAAE,iBAAiB;YAClC,SAAS,EAAE,WAAW;YACtB,cAAc,EAAE,gBAAgB;YAChC,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,UAAU,EAAE,YAAY;YACxB,aAAa,EAAE,eAAe;YAC9B,cAAc,EAAE,UAAU;YAC1B,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,UAAU;YACpB,cAAc,EAAE,gBAAgB;YAChC,aAAa,EAAE,eAAe;YAC9B,cAAc,EAAE,gBAAgB;YAChC,aAAa,EAAE,eAAe;YAC9B,wBAAwB,EAAE,oBAAoB;YAC9C,oBAAoB,EAAE,sBAAsB;YAC5C,sBAAsB,EAAE,wBAAwB;YAChD,iCAAiC,EAAE,mCAAmC;YACtE,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,iBAAiB,EAAE,QAAQ;YAC3B,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,QAAQ;YACvB,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,iBAAiB,EAAE,QAAQ;YAC3B,kBAAkB,EAAE,QAAQ;YAC5B,aAAa,EAAE,SAAS;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,QAAQ;YACpB,eAAe,EAAE,QAAQ;YACzB,SAAS,EAAE,QAAQ;YACnB,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,UAAU,EAAE,QAAQ;YACpB,aAAa,EAAE,QAAQ;YACvB,cAAc,EAAE,QAAQ;YACxB,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,QAAQ;YAClB,cAAc,EAAE,QAAQ;YACxB,aAAa,EAAE,SAAS;YACxB,cAAc,EAAE,QAAQ;YACxB,aAAa,EAAE,QAAQ;YACvB,wBAAwB,EAAE,QAAQ;YAClC,oBAAoB,EAAE,QAAQ;YAC9B,sBAAsB,EAAE,QAAQ;YAChC,iCAAiC,EAAE,QAAQ;YAC3C,KAAK,EAAE,QAAQ;SAChB,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;AApiBD,4DAoiBC"}
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import * as $dara from '@darabonba/typescript';
|
|
2
2
|
export declare class DeleteConnectorResponseBodyData extends $dara.Model {
|
|
3
3
|
/**
|
|
4
|
+
* @remarks
|
|
5
|
+
* The connector ID.
|
|
6
|
+
*
|
|
4
7
|
* @example
|
|
5
8
|
* conn_file_e0c9db4030b2465a9478028f7d76cd92_1234
|
|
6
9
|
*/
|
|
@@ -18,27 +21,48 @@ export declare class DeleteConnectorResponseBodyData extends $dara.Model {
|
|
|
18
21
|
}
|
|
19
22
|
export declare class DeleteConnectorResponseBody extends $dara.Model {
|
|
20
23
|
/**
|
|
24
|
+
* @remarks
|
|
25
|
+
* The error status code.
|
|
26
|
+
*
|
|
21
27
|
* @example
|
|
22
28
|
* Index.InvalidParameter
|
|
23
29
|
*/
|
|
24
30
|
code?: string;
|
|
31
|
+
/**
|
|
32
|
+
* @remarks
|
|
33
|
+
* The business data field of the operation.
|
|
34
|
+
*/
|
|
25
35
|
data?: DeleteConnectorResponseBodyData;
|
|
26
36
|
/**
|
|
37
|
+
* @remarks
|
|
38
|
+
* The error message.
|
|
39
|
+
*
|
|
27
40
|
* @example
|
|
28
41
|
* User not authorized to operate on the specified resource
|
|
29
42
|
*/
|
|
30
43
|
message?: string;
|
|
31
44
|
/**
|
|
45
|
+
* @remarks
|
|
46
|
+
* Id of the request
|
|
47
|
+
*
|
|
32
48
|
* @example
|
|
33
49
|
* 1C139002-0EC5-584C-A755-4B8B9FA080BE
|
|
34
50
|
*/
|
|
35
51
|
requestId?: string;
|
|
36
52
|
/**
|
|
53
|
+
* @remarks
|
|
54
|
+
* The status code returned by the operation.
|
|
55
|
+
*
|
|
37
56
|
* @example
|
|
38
57
|
* 200
|
|
39
58
|
*/
|
|
40
59
|
status?: string;
|
|
41
60
|
/**
|
|
61
|
+
* @remarks
|
|
62
|
+
* Indicates whether the operation was successful. Valid values:
|
|
63
|
+
* - true: Succeeded.
|
|
64
|
+
* - false: Failed.
|
|
65
|
+
*
|
|
42
66
|
* @example
|
|
43
67
|
* true
|
|
44
68
|
*/
|