@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
|
@@ -1,8 +1,24 @@
|
|
|
1
1
|
import * as $dara from '@darabonba/typescript';
|
|
2
|
+
export declare class ListIndicesResponseBodyDataIndicesStructuredIndexConfig extends $dara.Model {
|
|
3
|
+
isRecall?: boolean;
|
|
4
|
+
isSearch?: boolean;
|
|
5
|
+
name?: string;
|
|
6
|
+
type?: string;
|
|
7
|
+
static names(): {
|
|
8
|
+
[key: string]: string;
|
|
9
|
+
};
|
|
10
|
+
static types(): {
|
|
11
|
+
[key: string]: any;
|
|
12
|
+
};
|
|
13
|
+
validate(): void;
|
|
14
|
+
constructor(map?: {
|
|
15
|
+
[key: string]: any;
|
|
16
|
+
});
|
|
17
|
+
}
|
|
2
18
|
export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
3
19
|
/**
|
|
4
20
|
* @remarks
|
|
5
|
-
* The estimated chunk
|
|
21
|
+
* The estimated chunk size. Valid values: 1 to 2048.
|
|
6
22
|
*
|
|
7
23
|
* @example
|
|
8
24
|
* 5
|
|
@@ -20,10 +36,10 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
20
36
|
confgModel?: string;
|
|
21
37
|
/**
|
|
22
38
|
* @remarks
|
|
23
|
-
* The
|
|
39
|
+
* The knowledge base description.
|
|
24
40
|
*
|
|
25
41
|
* @example
|
|
26
|
-
*
|
|
42
|
+
* Products in this list are mainly for overseas customers
|
|
27
43
|
*/
|
|
28
44
|
description?: string;
|
|
29
45
|
/**
|
|
@@ -33,21 +49,19 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
33
49
|
documentIds?: string[];
|
|
34
50
|
/**
|
|
35
51
|
* @remarks
|
|
36
|
-
* The
|
|
52
|
+
* The embedding model name. Valid values:
|
|
37
53
|
*
|
|
38
54
|
* <props="china">
|
|
39
55
|
*
|
|
40
|
-
* - text-embedding-v4:
|
|
41
|
-
* - text-embedding-v3:
|
|
42
|
-
* - text-embedding-v2:
|
|
56
|
+
* - text-embedding-v4: text-embedding-v4 model.
|
|
57
|
+
* - text-embedding-v3: text-embedding-v3 model.
|
|
58
|
+
* - text-embedding-v2: text-embedding-v2 model.
|
|
43
59
|
*
|
|
44
60
|
*
|
|
45
61
|
*
|
|
46
62
|
* <props="intl">
|
|
47
63
|
*
|
|
48
|
-
* - text-embedding-v2:
|
|
49
|
-
*
|
|
50
|
-
* .
|
|
64
|
+
* - text-embedding-v2: text-embedding-v2 model.
|
|
51
65
|
*
|
|
52
66
|
* @example
|
|
53
67
|
* text-embedding-v2
|
|
@@ -73,15 +87,15 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
73
87
|
id?: string;
|
|
74
88
|
/**
|
|
75
89
|
* @remarks
|
|
76
|
-
* The
|
|
90
|
+
* The knowledge base name.
|
|
77
91
|
*
|
|
78
92
|
* @example
|
|
79
|
-
* XXXX
|
|
93
|
+
* XXXX Product List
|
|
80
94
|
*/
|
|
81
95
|
name?: string;
|
|
82
96
|
/**
|
|
83
97
|
* @remarks
|
|
84
|
-
* The chunk overlap
|
|
98
|
+
* The chunk overlap size. Valid values: 0 to 1024.
|
|
85
99
|
*
|
|
86
100
|
* @example
|
|
87
101
|
* 10
|
|
@@ -97,7 +111,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
97
111
|
rerankMinScore?: string;
|
|
98
112
|
/**
|
|
99
113
|
* @remarks
|
|
100
|
-
* The
|
|
114
|
+
* The rerank model name. Valid values:
|
|
101
115
|
*
|
|
102
116
|
* <props="china">
|
|
103
117
|
*
|
|
@@ -113,8 +127,6 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
113
127
|
* - gte-rerank-hybrid: official reranking.
|
|
114
128
|
* - gte-rerank: gte-rerank reranking.
|
|
115
129
|
*
|
|
116
|
-
* .
|
|
117
|
-
*
|
|
118
130
|
* @example
|
|
119
131
|
* gte-rerank-hybrid
|
|
120
132
|
*/
|
|
@@ -133,7 +145,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
133
145
|
* - ;: Chinese semicolon
|
|
134
146
|
* - ;: English semicolon
|
|
135
147
|
* - ?: Chinese question mark
|
|
136
|
-
* - ?: English question mark
|
|
148
|
+
* - ?: English question mark
|
|
137
149
|
*
|
|
138
150
|
* @example
|
|
139
151
|
* \\n
|
|
@@ -168,7 +180,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
168
180
|
sinkType?: string;
|
|
169
181
|
/**
|
|
170
182
|
* @remarks
|
|
171
|
-
* The data type
|
|
183
|
+
* 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).
|
|
172
184
|
*
|
|
173
185
|
*
|
|
174
186
|
* For document search<props="china">/audio and video search knowledge bases, valid values:
|
|
@@ -184,7 +196,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
184
196
|
sourceType?: string;
|
|
185
197
|
/**
|
|
186
198
|
* @remarks
|
|
187
|
-
* The
|
|
199
|
+
* The knowledge base type. Valid values:
|
|
188
200
|
*
|
|
189
201
|
* - UNSTRUCTURED: document search.
|
|
190
202
|
*
|
|
@@ -192,6 +204,7 @@ export declare class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
192
204
|
* UNSTRUCTURED
|
|
193
205
|
*/
|
|
194
206
|
structureType?: string;
|
|
207
|
+
structuredIndexConfig?: ListIndicesResponseBodyDataIndicesStructuredIndexConfig[];
|
|
195
208
|
static names(): {
|
|
196
209
|
[key: string]: string;
|
|
197
210
|
};
|
|
@@ -211,7 +224,7 @@ export declare class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
211
224
|
indices?: ListIndicesResponseBodyDataIndices[];
|
|
212
225
|
/**
|
|
213
226
|
* @remarks
|
|
214
|
-
* The page number
|
|
227
|
+
* The specified page number.
|
|
215
228
|
*
|
|
216
229
|
* @example
|
|
217
230
|
* 1
|
|
@@ -219,7 +232,7 @@ export declare class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
219
232
|
pageNumber?: number;
|
|
220
233
|
/**
|
|
221
234
|
* @remarks
|
|
222
|
-
* The number of entries per page
|
|
235
|
+
* The specified number of entries per page.
|
|
223
236
|
*
|
|
224
237
|
* @example
|
|
225
238
|
* 10
|
|
@@ -247,7 +260,7 @@ export declare class ListIndicesResponseBodyData extends $dara.Model {
|
|
|
247
260
|
export declare class ListIndicesResponseBody extends $dara.Model {
|
|
248
261
|
/**
|
|
249
262
|
* @remarks
|
|
250
|
-
* The error code.
|
|
263
|
+
* The error status code.
|
|
251
264
|
*
|
|
252
265
|
* @example
|
|
253
266
|
* Index.InvalidParameter
|
|
@@ -33,9 +33,34 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.ListIndicesResponseBody = exports.ListIndicesResponseBodyData = exports.ListIndicesResponseBodyDataIndices = void 0;
|
|
36
|
+
exports.ListIndicesResponseBody = exports.ListIndicesResponseBodyData = exports.ListIndicesResponseBodyDataIndices = exports.ListIndicesResponseBodyDataIndicesStructuredIndexConfig = void 0;
|
|
37
37
|
// This file is auto-generated, don't edit it
|
|
38
38
|
const $dara = __importStar(require("@darabonba/typescript"));
|
|
39
|
+
class ListIndicesResponseBodyDataIndicesStructuredIndexConfig extends $dara.Model {
|
|
40
|
+
static names() {
|
|
41
|
+
return {
|
|
42
|
+
isRecall: 'IsRecall',
|
|
43
|
+
isSearch: 'IsSearch',
|
|
44
|
+
name: 'Name',
|
|
45
|
+
type: 'Type',
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
static types() {
|
|
49
|
+
return {
|
|
50
|
+
isRecall: 'boolean',
|
|
51
|
+
isSearch: 'boolean',
|
|
52
|
+
name: 'string',
|
|
53
|
+
type: 'string',
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
validate() {
|
|
57
|
+
super.validate();
|
|
58
|
+
}
|
|
59
|
+
constructor(map) {
|
|
60
|
+
super(map);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.ListIndicesResponseBodyDataIndicesStructuredIndexConfig = ListIndicesResponseBodyDataIndicesStructuredIndexConfig;
|
|
39
64
|
class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
40
65
|
static names() {
|
|
41
66
|
return {
|
|
@@ -56,6 +81,7 @@ class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
56
81
|
sinkType: 'SinkType',
|
|
57
82
|
sourceType: 'SourceType',
|
|
58
83
|
structureType: 'StructureType',
|
|
84
|
+
structuredIndexConfig: 'StructuredIndexConfig',
|
|
59
85
|
};
|
|
60
86
|
}
|
|
61
87
|
static types() {
|
|
@@ -77,12 +103,16 @@ class ListIndicesResponseBodyDataIndices extends $dara.Model {
|
|
|
77
103
|
sinkType: 'string',
|
|
78
104
|
sourceType: 'string',
|
|
79
105
|
structureType: 'string',
|
|
106
|
+
structuredIndexConfig: { 'type': 'array', 'itemType': ListIndicesResponseBodyDataIndicesStructuredIndexConfig },
|
|
80
107
|
};
|
|
81
108
|
}
|
|
82
109
|
validate() {
|
|
83
110
|
if (Array.isArray(this.documentIds)) {
|
|
84
111
|
$dara.Model.validateArray(this.documentIds);
|
|
85
112
|
}
|
|
113
|
+
if (Array.isArray(this.structuredIndexConfig)) {
|
|
114
|
+
$dara.Model.validateArray(this.structuredIndexConfig);
|
|
115
|
+
}
|
|
86
116
|
super.validate();
|
|
87
117
|
}
|
|
88
118
|
constructor(map) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ListIndicesResponseBody.js","sourceRoot":"","sources":["../../src/models/ListIndicesResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,kCAAmC,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"ListIndicesResponseBody.js","sourceRoot":"","sources":["../../src/models/ListIndicesResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,uDAAwD,SAAQ,KAAK,CAAC,KAAK;IAKtF,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;SACb,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;SACf,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;AA9BD,0HA8BC;AAED,MAAa,kCAAmC,SAAQ,KAAK,CAAC,KAAK;IA8LjE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;YACtB,UAAU,EAAE,YAAY;YACxB,WAAW,EAAE,aAAa;YAC1B,WAAW,EAAE,aAAa;YAC1B,kBAAkB,EAAE,oBAAoB;YACxC,aAAa,EAAE,eAAe;YAC9B,EAAE,EAAE,IAAI;YACR,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,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,qBAAqB,EAAE,uBAAuB;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE,QAAQ;YACpB,WAAW,EAAE,QAAQ;YACrB,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtD,kBAAkB,EAAE,QAAQ;YAC5B,aAAa,EAAE,SAAS;YACxB,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,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,qBAAqB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,uDAAuD,EAAE;SAChH,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC;YAC7C,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACxD,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAzPD,gFAyPC;AAED,MAAa,2BAA4B,SAAQ,KAAK,CAAC,KAAK;IA8B1D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,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,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,kCAAkC,EAAE;YAC5E,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,OAAO,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA1DD,kEA0DC;AAED,MAAa,uBAAwB,SAAQ,KAAK,CAAC,KAAK;IAgDtD,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,2BAA2B;YACjC,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;AAhFD,0DAgFC"}
|
|
@@ -15,32 +15,27 @@ export declare class SubmitIndexAddDocumentsJobRequestExtra extends $dara.Model
|
|
|
15
15
|
export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
16
16
|
/**
|
|
17
17
|
* @remarks
|
|
18
|
-
*
|
|
18
|
+
* The list of category IDs.
|
|
19
19
|
*/
|
|
20
20
|
categoryIds?: string[];
|
|
21
21
|
/**
|
|
22
22
|
* @remarks
|
|
23
23
|
* <props="china">
|
|
24
|
+
* 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):
|
|
24
25
|
*
|
|
25
|
-
*
|
|
26
|
+
* - **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).
|
|
27
|
+
* - **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).
|
|
28
|
+
* - **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).
|
|
29
|
+
* - **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).
|
|
26
30
|
*
|
|
27
|
-
*
|
|
31
|
+
* Default value: empty, which uses intelligent chunking.
|
|
28
32
|
*
|
|
29
|
-
* - **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.
|
|
30
|
-
*
|
|
31
|
-
* - **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.
|
|
32
|
-
*
|
|
33
|
-
* - **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.
|
|
34
|
-
*
|
|
35
|
-
* - **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.
|
|
36
|
-
*
|
|
37
|
-
* If this parameter is not set, intelligent chunking is used by default.
|
|
38
33
|
*
|
|
39
34
|
*
|
|
40
35
|
*
|
|
41
36
|
* <props="intl">
|
|
42
37
|
*
|
|
43
|
-
* > This parameter is not available. Do not specify
|
|
38
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
44
39
|
*
|
|
45
40
|
* @example
|
|
46
41
|
* length
|
|
@@ -49,24 +44,22 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
49
44
|
/**
|
|
50
45
|
* @remarks
|
|
51
46
|
* <props="china">
|
|
47
|
+
* 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:
|
|
52
48
|
*
|
|
53
|
-
*
|
|
49
|
+
* - **Intelligent chunking** (without specifying `chunkMode`): the text is likely to be truncated.
|
|
50
|
+
* - **Custom chunking** (with `chunkMode` specified): the text is forcibly split.
|
|
54
51
|
*
|
|
55
|
-
*
|
|
52
|
+
* Valid values: 1 to 6000. If this parameter is not specified, the default value of 500 is used.
|
|
56
53
|
*
|
|
57
|
-
*
|
|
54
|
+
* For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
58
55
|
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
* For more information, see [knowledge base](https://help.aliyun.com/document_detail/2807740.html).
|
|
62
|
-
*
|
|
63
|
-
* > 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.
|
|
56
|
+
* > 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).
|
|
64
57
|
*
|
|
65
58
|
*
|
|
66
59
|
*
|
|
67
60
|
* <props="intl">
|
|
68
61
|
*
|
|
69
|
-
* > This parameter is not available. Do not specify
|
|
62
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
70
63
|
*
|
|
71
64
|
* @example
|
|
72
65
|
* 128
|
|
@@ -74,19 +67,19 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
74
67
|
chunkSize?: number;
|
|
75
68
|
/**
|
|
76
69
|
* @remarks
|
|
77
|
-
*
|
|
70
|
+
* The list of file IDs.
|
|
78
71
|
*/
|
|
79
72
|
documentIds?: string[];
|
|
80
73
|
/**
|
|
81
74
|
* @remarks
|
|
82
|
-
* Specifies whether to
|
|
75
|
+
* 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.
|
|
83
76
|
*
|
|
84
|
-
* > Enable this parameter only if all imported documents are Excel files that contain a header.
|
|
85
77
|
*
|
|
86
|
-
*
|
|
78
|
+
* > Enable this feature only when all imported files are in xlsx or xls format and contain headers. Otherwise, leave it disabled.
|
|
79
|
+
* >
|
|
87
80
|
*
|
|
81
|
+
* Valid values:
|
|
88
82
|
* - true: Enabled.
|
|
89
|
-
*
|
|
90
83
|
* - false: Disabled.
|
|
91
84
|
*
|
|
92
85
|
* Default value: false.
|
|
@@ -98,7 +91,7 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
98
91
|
extra?: SubmitIndexAddDocumentsJobRequestExtra;
|
|
99
92
|
/**
|
|
100
93
|
* @remarks
|
|
101
|
-
* The knowledge base ID
|
|
94
|
+
* The knowledge base ID, which is the `Data.Id` returned by the **CreateIndex** operation.
|
|
102
95
|
*
|
|
103
96
|
* This parameter is required.
|
|
104
97
|
*
|
|
@@ -109,18 +102,16 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
109
102
|
/**
|
|
110
103
|
* @remarks
|
|
111
104
|
* <props="china">
|
|
105
|
+
* 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.
|
|
112
106
|
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
* Defaults to 100 if not specified.
|
|
116
|
-
*
|
|
117
|
-
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, the chunking process may fail.
|
|
107
|
+
* If this parameter is not specified, the default value of 100 is used.
|
|
108
|
+
* > The value of `OverlapSize` must be less than the value of `ChunkSize`. Otherwise, chunking exceptions may occur.
|
|
118
109
|
*
|
|
119
110
|
*
|
|
120
111
|
*
|
|
121
112
|
* <props="intl">
|
|
122
113
|
*
|
|
123
|
-
* > This parameter is not available. Do not specify
|
|
114
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
124
115
|
*
|
|
125
116
|
* @example
|
|
126
117
|
* 16
|
|
@@ -129,16 +120,15 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
129
120
|
/**
|
|
130
121
|
* @remarks
|
|
131
122
|
* <props="china">
|
|
123
|
+
* 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).
|
|
132
124
|
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
* When you use intelligent chunking (when `ChunkMode` is not specified), leave this parameter empty.
|
|
125
|
+
* When using intelligent chunking (without specifying `chunkMode`), keep the default empty value.
|
|
136
126
|
*
|
|
137
127
|
*
|
|
138
128
|
*
|
|
139
129
|
* <props="intl">
|
|
140
130
|
*
|
|
141
|
-
* > This parameter is not available. Do not specify
|
|
131
|
+
* > This parameter is not yet available. Do not specify this parameter.
|
|
142
132
|
*
|
|
143
133
|
* @example
|
|
144
134
|
* (?<=。)
|
|
@@ -146,13 +136,12 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $dara.Model {
|
|
|
146
136
|
separator?: string;
|
|
147
137
|
/**
|
|
148
138
|
* @remarks
|
|
149
|
-
* The
|
|
150
|
-
*
|
|
151
|
-
* -
|
|
152
|
-
*
|
|
153
|
-
* - 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.
|
|
139
|
+
* The data source type. Valid values:
|
|
140
|
+
* - 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.
|
|
141
|
+
* - 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.
|
|
154
142
|
*
|
|
155
|
-
* > If
|
|
143
|
+
* > 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.
|
|
144
|
+
* >
|
|
156
145
|
*
|
|
157
146
|
* This parameter is required.
|
|
158
147
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SubmitIndexAddDocumentsJobRequest.js","sourceRoot":"","sources":["../../src/models/SubmitIndexAddDocumentsJobRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,sCAAuC,SAAQ,KAAK,CAAC,KAAK;IAErE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,QAAQ;SACnB,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;AArBD,wFAqBC;AAED,MAAa,iCAAkC,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"SubmitIndexAddDocumentsJobRequest.js","sourceRoot":"","sources":["../../src/models/SubmitIndexAddDocumentsJobRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,sCAAuC,SAAQ,KAAK,CAAC,KAAK;IAErE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,QAAQ,EAAE,QAAQ;SACnB,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;AArBD,wFAqBC;AAED,MAAa,iCAAkC,SAAQ,KAAK,CAAC,KAAK;IAyIhE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,aAAa;YAC1B,aAAa,EAAE,eAAe;YAC9B,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtD,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE;YACtD,aAAa,EAAE,SAAS;YACxB,KAAK,EAAE,sCAAsC;YAC7C,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;QACD,IAAG,IAAI,CAAC,KAAK,IAAI,OAAQ,IAAI,CAAC,KAAa,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnE,IAAI,CAAC,KAAa,CAAC,QAAQ,EAAE,CAAC;QACjC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAvLD,8EAuLC"}
|
|
@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
2
2
|
export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $dara.Model {
|
|
3
3
|
/**
|
|
4
4
|
* @remarks
|
|
5
|
-
* The
|
|
5
|
+
* The task ID, also known as `JobId`.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
8
|
* 42687eb254a34802bed398357f5498ae
|
|
@@ -22,7 +22,7 @@ export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $dara.Mo
|
|
|
22
22
|
export declare class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model {
|
|
23
23
|
/**
|
|
24
24
|
* @remarks
|
|
25
|
-
* The error code
|
|
25
|
+
* The error code.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* Index.InvalidParameter
|
|
@@ -30,12 +30,12 @@ export declare class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model
|
|
|
30
30
|
code?: string;
|
|
31
31
|
/**
|
|
32
32
|
* @remarks
|
|
33
|
-
* The business data.
|
|
33
|
+
* The business data returned by the operation.
|
|
34
34
|
*/
|
|
35
35
|
data?: SubmitIndexAddDocumentsJobResponseBodyData;
|
|
36
36
|
/**
|
|
37
37
|
* @remarks
|
|
38
|
-
* The error message
|
|
38
|
+
* The error message.
|
|
39
39
|
*
|
|
40
40
|
* @example
|
|
41
41
|
* Required parameter(%s) missing or invalid, please check the request parameters.
|
|
@@ -51,7 +51,7 @@ export declare class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model
|
|
|
51
51
|
requestId?: string;
|
|
52
52
|
/**
|
|
53
53
|
* @remarks
|
|
54
|
-
* The
|
|
54
|
+
* The status code returned by the operation.
|
|
55
55
|
*
|
|
56
56
|
* @example
|
|
57
57
|
* 200
|
|
@@ -59,11 +59,10 @@ export declare class SubmitIndexAddDocumentsJobResponseBody extends $dara.Model
|
|
|
59
59
|
status?: string;
|
|
60
60
|
/**
|
|
61
61
|
* @remarks
|
|
62
|
-
* Indicates whether the
|
|
62
|
+
* Indicates whether the operation was successful. Valid values:
|
|
63
63
|
*
|
|
64
|
-
* - true:
|
|
65
|
-
*
|
|
66
|
-
* - false: The request failed.
|
|
64
|
+
* - true: Successful.
|
|
65
|
+
* - false: Failed.
|
|
67
66
|
*
|
|
68
67
|
* @example
|
|
69
68
|
* true
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SubmitIndexAddDocumentsJobResponseBody.js","sourceRoot":"","sources":["../../src/models/SubmitIndexAddDocumentsJobResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,0CAA2C,SAAQ,KAAK,CAAC,KAAK;IASzE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,EAAE,EAAE,IAAI;SACT,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,EAAE,EAAE,QAAQ;SACb,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;AA5BD,gGA4BC;AAED,MAAa,sCAAuC,SAAQ,KAAK,CAAC,KAAK;
|
|
1
|
+
{"version":3,"file":"SubmitIndexAddDocumentsJobResponseBody.js","sourceRoot":"","sources":["../../src/models/SubmitIndexAddDocumentsJobResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,0CAA2C,SAAQ,KAAK,CAAC,KAAK;IASzE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,EAAE,EAAE,IAAI;SACT,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,EAAE,EAAE,QAAQ;SACb,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;AA5BD,gGA4BC;AAED,MAAa,sCAAuC,SAAQ,KAAK,CAAC,KAAK;IAiDrE,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,0CAA0C;YAChD,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,wFAiFC"}
|