@alicloud/bailian20231229 2.14.2 → 2.14.3
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 +32 -30
- package/dist/client.js +32 -30
- package/dist/client.js.map +1 -1
- 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 +1 -1
- package/dist/models/ListIndicesResponseBody.d.ts +35 -22
- package/dist/models/ListIndicesResponseBody.js +31 -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/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 +32 -30
- package/src/models/ListIndexFileDetailsRequest.ts +3 -3
- package/src/models/ListIndexFileDetailsResponseBody.ts +14 -4
- package/src/models/ListIndicesRequest.ts +1 -1
- package/src/models/ListIndicesResponseBody.ts +56 -22
- package/src/models/SubmitIndexAddDocumentsJobRequest.ts +33 -44
- package/src/models/SubmitIndexAddDocumentsJobResponseBody.ts +8 -9
- package/src/models/SubmitIndexAddDocumentsJobShrinkRequest.ts +33 -44
- package/src/models/model.ts +1 -0
|
@@ -2,10 +2,42 @@
|
|
|
2
2
|
import * as $dara from '@darabonba/typescript';
|
|
3
3
|
|
|
4
4
|
|
|
5
|
+
export class ListIndicesResponseBodyDataIndicesStructuredIndexConfig extends $dara.Model {
|
|
6
|
+
isRecall?: boolean;
|
|
7
|
+
isSearch?: boolean;
|
|
8
|
+
name?: string;
|
|
9
|
+
type?: string;
|
|
10
|
+
static names(): { [key: string]: string } {
|
|
11
|
+
return {
|
|
12
|
+
isRecall: 'IsRecall',
|
|
13
|
+
isSearch: 'IsSearch',
|
|
14
|
+
name: 'Name',
|
|
15
|
+
type: 'Type',
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
static types(): { [key: string]: any } {
|
|
20
|
+
return {
|
|
21
|
+
isRecall: 'boolean',
|
|
22
|
+
isSearch: 'boolean',
|
|
23
|
+
name: 'string',
|
|
24
|
+
type: 'string',
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
validate() {
|
|
29
|
+
super.validate();
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
constructor(map?: { [key: string]: any }) {
|
|
33
|
+
super(map);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
5
37
|
export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
6
38
|
/**
|
|
7
39
|
* @remarks
|
|
8
|
-
* The estimated chunk
|
|
40
|
+
* The estimated chunk size. Valid values: 1 to 2048.
|
|
9
41
|
*
|
|
10
42
|
* @example
|
|
11
43
|
* 5
|
|
@@ -23,10 +55,10 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
23
55
|
confgModel?: string;
|
|
24
56
|
/**
|
|
25
57
|
* @remarks
|
|
26
|
-
* The
|
|
58
|
+
* The knowledge base description.
|
|
27
59
|
*
|
|
28
60
|
* @example
|
|
29
|
-
*
|
|
61
|
+
* Products in this list are mainly for overseas customers
|
|
30
62
|
*/
|
|
31
63
|
description?: string;
|
|
32
64
|
/**
|
|
@@ -36,21 +68,19 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
36
68
|
documentIds?: string[];
|
|
37
69
|
/**
|
|
38
70
|
* @remarks
|
|
39
|
-
* The
|
|
71
|
+
* The embedding model name. Valid values:
|
|
40
72
|
*
|
|
41
73
|
* <props="china">
|
|
42
74
|
*
|
|
43
|
-
* - text-embedding-v4:
|
|
44
|
-
* - text-embedding-v3:
|
|
45
|
-
* - text-embedding-v2:
|
|
75
|
+
* - text-embedding-v4: text-embedding-v4 model.
|
|
76
|
+
* - text-embedding-v3: text-embedding-v3 model.
|
|
77
|
+
* - text-embedding-v2: text-embedding-v2 model.
|
|
46
78
|
*
|
|
47
79
|
*
|
|
48
80
|
*
|
|
49
81
|
* <props="intl">
|
|
50
82
|
*
|
|
51
|
-
* - text-embedding-v2:
|
|
52
|
-
*
|
|
53
|
-
* .
|
|
83
|
+
* - text-embedding-v2: text-embedding-v2 model.
|
|
54
84
|
*
|
|
55
85
|
* @example
|
|
56
86
|
* text-embedding-v2
|
|
@@ -76,15 +106,15 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
76
106
|
id?: string;
|
|
77
107
|
/**
|
|
78
108
|
* @remarks
|
|
79
|
-
* The
|
|
109
|
+
* The knowledge base name.
|
|
80
110
|
*
|
|
81
111
|
* @example
|
|
82
|
-
* XXXX
|
|
112
|
+
* XXXX Product List
|
|
83
113
|
*/
|
|
84
114
|
name?: string;
|
|
85
115
|
/**
|
|
86
116
|
* @remarks
|
|
87
|
-
* The chunk overlap
|
|
117
|
+
* The chunk overlap size. Valid values: 0 to 1024.
|
|
88
118
|
*
|
|
89
119
|
* @example
|
|
90
120
|
* 10
|
|
@@ -100,7 +130,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
100
130
|
rerankMinScore?: string;
|
|
101
131
|
/**
|
|
102
132
|
* @remarks
|
|
103
|
-
* The
|
|
133
|
+
* The rerank model name. Valid values:
|
|
104
134
|
*
|
|
105
135
|
* <props="china">
|
|
106
136
|
*
|
|
@@ -116,8 +146,6 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
116
146
|
* - gte-rerank-hybrid: official reranking.
|
|
117
147
|
* - gte-rerank: gte-rerank reranking.
|
|
118
148
|
*
|
|
119
|
-
* .
|
|
120
|
-
*
|
|
121
149
|
* @example
|
|
122
150
|
* gte-rerank-hybrid
|
|
123
151
|
*/
|
|
@@ -136,7 +164,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
136
164
|
* - ;: Chinese semicolon
|
|
137
165
|
* - ;: English semicolon
|
|
138
166
|
* - ?: Chinese question mark
|
|
139
|
-
* - ?: English question mark
|
|
167
|
+
* - ?: English question mark
|
|
140
168
|
*
|
|
141
169
|
* @example
|
|
142
170
|
* \\n
|
|
@@ -171,7 +199,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
171
199
|
sinkType?: string;
|
|
172
200
|
/**
|
|
173
201
|
* @remarks
|
|
174
|
-
* The data type
|
|
202
|
+
* The data type in Alibaba Cloud Model Studio <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).
|
|
175
203
|
*
|
|
176
204
|
*
|
|
177
205
|
* For document search<props="china">/audio and video search knowledge bases, valid values:
|
|
@@ -187,7 +215,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
187
215
|
sourceType?: string;
|
|
188
216
|
/**
|
|
189
217
|
* @remarks
|
|
190
|
-
* The
|
|
218
|
+
* The knowledge base type. Valid values:
|
|
191
219
|
*
|
|
192
220
|
* - UNSTRUCTURED: document search.
|
|
193
221
|
*
|
|
@@ -195,6 +223,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
195
223
|
* UNSTRUCTURED
|
|
196
224
|
*/
|
|
197
225
|
structureType?: string;
|
|
226
|
+
structuredIndexConfig?: ListIndicesResponseBodyDataIndicesStructuredIndexConfig[];
|
|
198
227
|
static names(): { [key: string]: string } {
|
|
199
228
|
return {
|
|
200
229
|
chunkSize: 'ChunkSize',
|
|
@@ -214,6 +243,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
214
243
|
sinkType: 'SinkType',
|
|
215
244
|
sourceType: 'SourceType',
|
|
216
245
|
structureType: 'StructureType',
|
|
246
|
+
structuredIndexConfig: 'StructuredIndexConfig',
|
|
217
247
|
};
|
|
218
248
|
}
|
|
219
249
|
|
|
@@ -236,6 +266,7 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
236
266
|
sinkType: 'string',
|
|
237
267
|
sourceType: 'string',
|
|
238
268
|
structureType: 'string',
|
|
269
|
+
structuredIndexConfig: { 'type': 'array', 'itemType': ListIndicesResponseBodyDataIndicesStructuredIndexConfig },
|
|
239
270
|
};
|
|
240
271
|
}
|
|
241
272
|
|
|
@@ -243,6 +274,9 @@ export class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
243
274
|
if(Array.isArray(this.documentIds)) {
|
|
244
275
|
$dara.Model.validateArray(this.documentIds);
|
|
245
276
|
}
|
|
277
|
+
if(Array.isArray(this.structuredIndexConfig)) {
|
|
278
|
+
$dara.Model.validateArray(this.structuredIndexConfig);
|
|
279
|
+
}
|
|
246
280
|
super.validate();
|
|
247
281
|
}
|
|
248
282
|
|
|
@@ -259,7 +293,7 @@ export class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
259
293
|
indices?: ListIndicesResponseBodyDataIndices[];
|
|
260
294
|
/**
|
|
261
295
|
* @remarks
|
|
262
|
-
* The page number
|
|
296
|
+
* The specified page number.
|
|
263
297
|
*
|
|
264
298
|
* @example
|
|
265
299
|
* 1
|
|
@@ -267,7 +301,7 @@ export class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
267
301
|
pageNumber?: number;
|
|
268
302
|
/**
|
|
269
303
|
* @remarks
|
|
270
|
-
* The number of entries per page
|
|
304
|
+
* The specified number of entries per page.
|
|
271
305
|
*
|
|
272
306
|
* @example
|
|
273
307
|
* 10
|
|
@@ -314,7 +348,7 @@ export class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
314
348
|
export class ListIndicesResponseBody extends $dara.Model {
|
|
315
349
|
/**
|
|
316
350
|
* @remarks
|
|
317
|
-
* The error code.
|
|
351
|
+
* The error status code.
|
|
318
352
|
*
|
|
319
353
|
* @example
|
|
320
354
|
* Index.InvalidParameter
|
|
@@ -28,32 +28,27 @@ export class SubmitIndexAddDocumentsJobRequestExtra extends $dara.Model {
|
|
|
28
28
|
export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
29
29
|
/**
|
|
30
30
|
* @remarks
|
|
31
|
-
*
|
|
31
|
+
* The list of category IDs.
|
|
32
32
|
*/
|
|
33
33
|
categoryIds?: string[];
|
|
34
34
|
/**
|
|
35
35
|
* @remarks
|
|
36
36
|
* <props="china">
|
|
37
|
+
* Enables custom chunking (applies only to files appended in this request). For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values (only one value can be specified at a time):
|
|
37
38
|
*
|
|
38
|
-
*
|
|
39
|
+
* - **length**: chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If these two parameters are not specified, the system uses default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (even if specified, it does not take effect).
|
|
40
|
+
* - **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` (even if specified, they do not take effect).
|
|
41
|
+
* - **h1**~**h5**: chunk by headings at the corresponding level (`h1` is the first-level heading, and so on, with support up to `h5` fifth-level heading). If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by heading does not support `OverlapSize` or `Separator` (even if specified, they do not take effect).
|
|
42
|
+
* - **regex**: chunk by regular expression. The `Separator` parameter must be specified. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by regex does not support `OverlapSize` (even if specified, it does not take effect).
|
|
39
43
|
*
|
|
40
|
-
*
|
|
44
|
+
* Default value: empty, which uses intelligent chunking.
|
|
41
45
|
*
|
|
42
|
-
* - **page**: Splits the text by page. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
43
|
-
*
|
|
44
|
-
* - **h1**: Splits the text by level-1 headings. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
45
|
-
*
|
|
46
|
-
* - **h2**: Splits the text by level-2 headings. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
47
|
-
*
|
|
48
|
-
* - **regex**: Splits the text by using a regular expression. The `Separator` parameter is required for this mode. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` parameter.
|
|
49
|
-
*
|
|
50
|
-
* If this parameter is not set, intelligent chunking is used by default.
|
|
51
46
|
*
|
|
52
47
|
*
|
|
53
48
|
*
|
|
54
49
|
* <props="intl">
|
|
55
50
|
*
|
|
56
|
-
* > This parameter is not available. Do not specify
|
|
51
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
57
52
|
*
|
|
58
53
|
* @example
|
|
59
54
|
* length
|
|
@@ -62,24 +57,22 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
62
57
|
/**
|
|
63
58
|
* @remarks
|
|
64
59
|
* <props="china">
|
|
60
|
+
* The chunk length, which is the maximum number of characters per text chunk (applies only to files appended in this request). When this length is exceeded:
|
|
65
61
|
*
|
|
66
|
-
*
|
|
62
|
+
* - **Intelligent chunking** (without specifying `chunkMode`): the text is likely to be truncated.
|
|
63
|
+
* - **Custom chunking** (with `chunkMode` specified): the text is forcibly split.
|
|
67
64
|
*
|
|
68
|
-
*
|
|
65
|
+
* Valid values: 1 to 6000. If this parameter is not specified, the default value of 500 is used.
|
|
69
66
|
*
|
|
70
|
-
*
|
|
67
|
+
* For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
71
68
|
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* For more information, see [knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
75
|
-
*
|
|
76
|
-
* > If you specify a `ChunkSize` less than 100, you must also specify the `OverlapSize` parameter. You can also omit both parameters to use the system defaults.
|
|
69
|
+
* > If you specify `ChunkSize` with a value less than 100, you must also specify `OverlapSize`. You can also leave both parameters unspecified (the system uses default values).
|
|
77
70
|
*
|
|
78
71
|
*
|
|
79
72
|
*
|
|
80
73
|
* <props="intl">
|
|
81
74
|
*
|
|
82
|
-
* > This parameter is not available. Do not specify
|
|
75
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
83
76
|
*
|
|
84
77
|
* @example
|
|
85
78
|
* 128
|
|
@@ -87,19 +80,19 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
87
80
|
chunkSize?: number;
|
|
88
81
|
/**
|
|
89
82
|
* @remarks
|
|
90
|
-
*
|
|
83
|
+
* The list of file IDs.
|
|
91
84
|
*/
|
|
92
85
|
documentIds?: string[];
|
|
93
86
|
/**
|
|
94
87
|
* @remarks
|
|
95
|
-
* Specifies whether to
|
|
88
|
+
* Specifies whether to enable header assembly for Excel files. When enabled, the knowledge base treats the first row of all xlsx and xls files as headers and automatically appends them to each text chunk (data row), preventing the large language model from treating headers as regular data rows.
|
|
96
89
|
*
|
|
97
|
-
* > Enable this parameter only if all imported documents are Excel files that contain a header.
|
|
98
90
|
*
|
|
99
|
-
*
|
|
91
|
+
* > Enable this feature only when all imported files are in xlsx or xls format and contain headers. Otherwise, leave it disabled.
|
|
92
|
+
* >
|
|
100
93
|
*
|
|
94
|
+
* Valid values:
|
|
101
95
|
* - true: Enabled.
|
|
102
|
-
*
|
|
103
96
|
* - false: Disabled.
|
|
104
97
|
*
|
|
105
98
|
* Default value: false.
|
|
@@ -111,7 +104,7 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
111
104
|
extra?: SubmitIndexAddDocumentsJobRequestExtra;
|
|
112
105
|
/**
|
|
113
106
|
* @remarks
|
|
114
|
-
* The knowledge base ID
|
|
107
|
+
* The knowledge base ID, which is the `Data.Id` returned by the **CreateIndex** operation.
|
|
115
108
|
*
|
|
116
109
|
* This parameter is required.
|
|
117
110
|
*
|
|
@@ -122,18 +115,16 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
122
115
|
/**
|
|
123
116
|
* @remarks
|
|
124
117
|
* <props="china">
|
|
118
|
+
* The chunk overlap length (applies only to files appended in this request). It indicates the number of overlapping characters between the current text chunk and the previous text chunk. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values: 0 to 1024.
|
|
125
119
|
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
* Defaults to 100 if not specified.
|
|
129
|
-
*
|
|
130
|
-
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, the chunking process may fail.
|
|
120
|
+
* If this parameter is not specified, the default value of 100 is used.
|
|
121
|
+
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, chunking exceptions may occur.
|
|
131
122
|
*
|
|
132
123
|
*
|
|
133
124
|
*
|
|
134
125
|
* <props="intl">
|
|
135
126
|
*
|
|
136
|
-
* > This parameter is not available. Do not specify
|
|
127
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
137
128
|
*
|
|
138
129
|
* @example
|
|
139
130
|
* 16
|
|
@@ -142,16 +133,15 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
142
133
|
/**
|
|
143
134
|
* @remarks
|
|
144
135
|
* <props="china">
|
|
136
|
+
* The sentence separator, which takes effect only when `chunkMode` is set to **regex** (otherwise, it does not take effect even if specified). You can specify a regular expression (only one is supported) to split the file into small text chunks. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
145
137
|
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* When you use intelligent chunking (when `ChunkMode` is not specified), leave this parameter empty.
|
|
138
|
+
* When using intelligent chunking (without specifying `chunkMode`), keep the default empty value.
|
|
149
139
|
*
|
|
150
140
|
*
|
|
151
141
|
*
|
|
152
142
|
* <props="intl">
|
|
153
143
|
*
|
|
154
|
-
* > This parameter is not available. Do not specify
|
|
144
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
155
145
|
*
|
|
156
146
|
* @example
|
|
157
147
|
* (?<=。)
|
|
@@ -159,13 +149,12 @@ export class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
159
149
|
separator?: string;
|
|
160
150
|
/**
|
|
161
151
|
* @remarks
|
|
162
|
-
* The
|
|
163
|
-
*
|
|
164
|
-
* -
|
|
165
|
-
*
|
|
166
|
-
* - DATA_CENTER_FILE: 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.
|
|
152
|
+
* The data source type. Valid values:
|
|
153
|
+
* - DATA_CENTER_CATEGORY: category type. Imports all documents 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 are supported.
|
|
154
|
+
* - DATA_CENTER_FILE: document 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 are supported.
|
|
167
155
|
*
|
|
168
|
-
* > If
|
|
156
|
+
* > 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.
|
|
157
|
+
* >
|
|
169
158
|
*
|
|
170
159
|
* This parameter is required.
|
|
171
160
|
*
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class SubmitIndexAddDocumentsJobResponseBodyData extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The
|
|
8
|
+
* The task ID, also known as `JobId`.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* 42687eb254a34802bed398357f5498ae
|
|
@@ -35,7 +35,7 @@ export class SubmitIndexAddDocumentsJobResponseBodyData extends $dara.Model {
|
|
|
35
35
|
export class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model {
|
|
36
36
|
/**
|
|
37
37
|
* @remarks
|
|
38
|
-
* The error code
|
|
38
|
+
* The error code.
|
|
39
39
|
*
|
|
40
40
|
* @example
|
|
41
41
|
* Index.InvalidParameter
|
|
@@ -43,12 +43,12 @@ export class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model {
|
|
|
43
43
|
code?: string;
|
|
44
44
|
/**
|
|
45
45
|
* @remarks
|
|
46
|
-
* The business data.
|
|
46
|
+
* The business data returned by the operation.
|
|
47
47
|
*/
|
|
48
48
|
data?: SubmitIndexAddDocumentsJobResponseBodyData;
|
|
49
49
|
/**
|
|
50
50
|
* @remarks
|
|
51
|
-
* The error message
|
|
51
|
+
* The error message.
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
54
|
* Required parameter(%s) missing or invalid, please check the request parameters.
|
|
@@ -64,7 +64,7 @@ export class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model {
|
|
|
64
64
|
requestId?: string;
|
|
65
65
|
/**
|
|
66
66
|
* @remarks
|
|
67
|
-
* The
|
|
67
|
+
* The status code returned by the operation.
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
70
|
* 200
|
|
@@ -72,11 +72,10 @@ export class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model {
|
|
|
72
72
|
status?: string;
|
|
73
73
|
/**
|
|
74
74
|
* @remarks
|
|
75
|
-
* Indicates whether the
|
|
75
|
+
* Indicates whether the operation was successful. Valid values:
|
|
76
76
|
*
|
|
77
|
-
* - true:
|
|
78
|
-
*
|
|
79
|
-
* - false: The request failed.
|
|
77
|
+
* - true: Successful.
|
|
78
|
+
* - false: Failed.
|
|
80
79
|
*
|
|
81
80
|
* @example
|
|
82
81
|
* true
|
|
@@ -5,32 +5,27 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
*
|
|
8
|
+
* The list of category IDs.
|
|
9
9
|
*/
|
|
10
10
|
categoryIdsShrink?: string;
|
|
11
11
|
/**
|
|
12
12
|
* @remarks
|
|
13
13
|
* <props="china">
|
|
14
|
+
* Enables custom chunking (applies only to files appended in this request). For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values (only one value can be specified at a time):
|
|
14
15
|
*
|
|
15
|
-
*
|
|
16
|
+
* - **length**: chunk by length. Strictly chunks according to the specified `ChunkSize` and `OverlapSize`. If these two parameters are not specified, the system uses default values (`ChunkSize` of 500 and `OverlapSize` of 100). Chunking by length does not support `Separator` (even if specified, it does not take effect).
|
|
17
|
+
* - **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` (even if specified, they do not take effect).
|
|
18
|
+
* - **h1**~**h5**: chunk by headings at the corresponding level (`h1` is the first-level heading, and so on, with support up to `h5` fifth-level heading). If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by heading does not support `OverlapSize` or `Separator` (even if specified, they do not take effect).
|
|
19
|
+
* - **regex**: chunk by regular expression. The `Separator` parameter must be specified. If `ChunkSize` is specified, it is also considered during chunking (if not specified, the default value of 500 is used). Chunking by regex does not support `OverlapSize` (even if specified, it does not take effect).
|
|
16
20
|
*
|
|
17
|
-
*
|
|
21
|
+
* Default value: empty, which uses intelligent chunking.
|
|
18
22
|
*
|
|
19
|
-
* - **page**: Splits the text by page. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
20
|
-
*
|
|
21
|
-
* - **h1**: Splits the text by level-1 headings. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
22
|
-
*
|
|
23
|
-
* - **h2**: Splits the text by level-2 headings. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` and `Separator` parameters.
|
|
24
|
-
*
|
|
25
|
-
* - **regex**: Splits the text by using a regular expression. The `Separator` parameter is required for this mode. If `ChunkSize` is specified, its value is also applied during chunking. If `ChunkSize` is not set, a default value of 500 is used. This mode ignores the `OverlapSize` parameter.
|
|
26
|
-
*
|
|
27
|
-
* If this parameter is not set, intelligent chunking is used by default.
|
|
28
23
|
*
|
|
29
24
|
*
|
|
30
25
|
*
|
|
31
26
|
* <props="intl">
|
|
32
27
|
*
|
|
33
|
-
* > This parameter is not available. Do not specify
|
|
28
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
34
29
|
*
|
|
35
30
|
* @example
|
|
36
31
|
* length
|
|
@@ -39,24 +34,22 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
39
34
|
/**
|
|
40
35
|
* @remarks
|
|
41
36
|
* <props="china">
|
|
37
|
+
* The chunk length, which is the maximum number of characters per text chunk (applies only to files appended in this request). When this length is exceeded:
|
|
42
38
|
*
|
|
43
|
-
*
|
|
39
|
+
* - **Intelligent chunking** (without specifying `chunkMode`): the text is likely to be truncated.
|
|
40
|
+
* - **Custom chunking** (with `chunkMode` specified): the text is forcibly split.
|
|
44
41
|
*
|
|
45
|
-
*
|
|
42
|
+
* Valid values: 1 to 6000. If this parameter is not specified, the default value of 500 is used.
|
|
46
43
|
*
|
|
47
|
-
*
|
|
44
|
+
* For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
48
45
|
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* For more information, see [knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
52
|
-
*
|
|
53
|
-
* > If you specify a `ChunkSize` less than 100, you must also specify the `OverlapSize` parameter. You can also omit both parameters to use the system defaults.
|
|
46
|
+
* > If you specify `ChunkSize` with a value less than 100, you must also specify `OverlapSize`. You can also leave both parameters unspecified (the system uses default values).
|
|
54
47
|
*
|
|
55
48
|
*
|
|
56
49
|
*
|
|
57
50
|
* <props="intl">
|
|
58
51
|
*
|
|
59
|
-
* > This parameter is not available. Do not specify
|
|
52
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
60
53
|
*
|
|
61
54
|
* @example
|
|
62
55
|
* 128
|
|
@@ -64,19 +57,19 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
64
57
|
chunkSize?: number;
|
|
65
58
|
/**
|
|
66
59
|
* @remarks
|
|
67
|
-
*
|
|
60
|
+
* The list of file IDs.
|
|
68
61
|
*/
|
|
69
62
|
documentIdsShrink?: string;
|
|
70
63
|
/**
|
|
71
64
|
* @remarks
|
|
72
|
-
* Specifies whether to
|
|
65
|
+
* Specifies whether to enable header assembly for Excel files. When enabled, the knowledge base treats the first row of all xlsx and xls files as headers and automatically appends them to each text chunk (data row), preventing the large language model from treating headers as regular data rows.
|
|
73
66
|
*
|
|
74
|
-
* > Enable this parameter only if all imported documents are Excel files that contain a header.
|
|
75
67
|
*
|
|
76
|
-
*
|
|
68
|
+
* > Enable this feature only when all imported files are in xlsx or xls format and contain headers. Otherwise, leave it disabled.
|
|
69
|
+
* >
|
|
77
70
|
*
|
|
71
|
+
* Valid values:
|
|
78
72
|
* - true: Enabled.
|
|
79
|
-
*
|
|
80
73
|
* - false: Disabled.
|
|
81
74
|
*
|
|
82
75
|
* Default value: false.
|
|
@@ -88,7 +81,7 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
88
81
|
extraShrink?: string;
|
|
89
82
|
/**
|
|
90
83
|
* @remarks
|
|
91
|
-
* The knowledge base ID
|
|
84
|
+
* The knowledge base ID, which is the `Data.Id` returned by the **CreateIndex** operation.
|
|
92
85
|
*
|
|
93
86
|
* This parameter is required.
|
|
94
87
|
*
|
|
@@ -99,18 +92,16 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
99
92
|
/**
|
|
100
93
|
* @remarks
|
|
101
94
|
* <props="china">
|
|
95
|
+
* The chunk overlap length (applies only to files appended in this request). It indicates the number of overlapping characters between the current text chunk and the previous text chunk. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html). Valid values: 0 to 1024.
|
|
102
96
|
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* Defaults to 100 if not specified.
|
|
106
|
-
*
|
|
107
|
-
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, the chunking process may fail.
|
|
97
|
+
* If this parameter is not specified, the default value of 100 is used.
|
|
98
|
+
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, chunking exceptions may occur.
|
|
108
99
|
*
|
|
109
100
|
*
|
|
110
101
|
*
|
|
111
102
|
* <props="intl">
|
|
112
103
|
*
|
|
113
|
-
* > This parameter is not available. Do not specify
|
|
104
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
114
105
|
*
|
|
115
106
|
* @example
|
|
116
107
|
* 16
|
|
@@ -119,16 +110,15 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
119
110
|
/**
|
|
120
111
|
* @remarks
|
|
121
112
|
* <props="china">
|
|
113
|
+
* The sentence separator, which takes effect only when `chunkMode` is set to **regex** (otherwise, it does not take effect even if specified). You can specify a regular expression (only one is supported) to split the file into small text chunks. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
122
114
|
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* When you use intelligent chunking (when `ChunkMode` is not specified), leave this parameter empty.
|
|
115
|
+
* When using intelligent chunking (without specifying `chunkMode`), keep the default empty value.
|
|
126
116
|
*
|
|
127
117
|
*
|
|
128
118
|
*
|
|
129
119
|
* <props="intl">
|
|
130
120
|
*
|
|
131
|
-
* > This parameter is not available. Do not specify
|
|
121
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
132
122
|
*
|
|
133
123
|
* @example
|
|
134
124
|
* (?<=。)
|
|
@@ -136,13 +126,12 @@ export class SubmitIndexAddDocumentsJobShrinkRequest extends $dara.Model {
|
|
|
136
126
|
separator?: string;
|
|
137
127
|
/**
|
|
138
128
|
* @remarks
|
|
139
|
-
* The
|
|
140
|
-
*
|
|
141
|
-
* -
|
|
142
|
-
*
|
|
143
|
-
* - DATA_CENTER_FILE: 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.
|
|
129
|
+
* The data source type. Valid values:
|
|
130
|
+
* - DATA_CENTER_CATEGORY: category type. Imports all documents 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 are supported.
|
|
131
|
+
* - DATA_CENTER_FILE: document 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 are supported.
|
|
144
132
|
*
|
|
145
|
-
* > If
|
|
133
|
+
* > 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.
|
|
134
|
+
* >
|
|
146
135
|
*
|
|
147
136
|
* This parameter is required.
|
|
148
137
|
*
|
package/src/models/model.ts
CHANGED
|
@@ -65,6 +65,7 @@ export { ListIndexDocumentsResponseBodyDataDocuments } from './ListIndexDocument
|
|
|
65
65
|
export { ListIndexDocumentsResponseBodyData } from './ListIndexDocumentsResponseBody';
|
|
66
66
|
export { ListIndexFileDetailsResponseBodyDataDocuments } from './ListIndexFileDetailsResponseBody';
|
|
67
67
|
export { ListIndexFileDetailsResponseBodyData } from './ListIndexFileDetailsResponseBody';
|
|
68
|
+
export { ListIndicesResponseBodyDataIndicesStructuredIndexConfig } from './ListIndicesResponseBody';
|
|
68
69
|
export { ListIndicesResponseBodyDataIndices } from './ListIndicesResponseBody';
|
|
69
70
|
export { ListIndicesResponseBodyData } from './ListIndicesResponseBody';
|
|
70
71
|
export { ListMemoriesResponseBodyMemories } from './ListMemoriesResponseBody';
|