@nestbox-ai/doc-processing-api 1.0.67 → 1.0.69
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/.openapi-generator/VERSION +1 -1
- package/README.md +2 -2
- package/api.ts +68 -28
- package/common.ts +2 -1
- package/dist/api.d.ts +40 -16
- package/dist/api.js +56 -28
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- package/dist/esm/api.d.ts +40 -16
- package/dist/esm/api.js +57 -29
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -0
- package/docs/DocumentDto.md +2 -0
- package/docs/DocumentsApi.md +8 -2
- package/docs/ProfileDto.md +2 -0
- package/docs/ProfilesApi.md +8 -2
- package/package.json +2 -2
package/dist/esm/api.js
CHANGED
|
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
28
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from './base';
|
|
29
29
|
export const BatchQueryDtoStatusEnum = {
|
|
30
30
|
Queued: 'queued',
|
|
31
31
|
Running: 'running',
|
|
@@ -191,10 +191,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
191
191
|
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
192
192
|
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
193
193
|
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
194
|
+
* @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]).
|
|
194
195
|
* @param {*} [options] Override http request option.
|
|
195
196
|
* @throws {RequiredError}
|
|
196
197
|
*/
|
|
197
|
-
documentsControllerCreateDocument: (profileId_1, file_1, stages_1, priority_1, visualize_1, ...args_1) => __awaiter(this, [profileId_1, file_1, stages_1, priority_1, visualize_1, ...args_1], void 0, function* (profileId, file, stages, priority, visualize, options = {}) {
|
|
198
|
+
documentsControllerCreateDocument: (profileId_1, file_1, stages_1, priority_1, visualize_1, tags_1, ...args_1) => __awaiter(this, [profileId_1, file_1, stages_1, priority_1, visualize_1, tags_1, ...args_1], void 0, function* (profileId, file, stages, priority, visualize, tags, options = {}) {
|
|
198
199
|
// verify required parameter 'profileId' is not null or undefined
|
|
199
200
|
assertParamExists('documentsControllerCreateDocument', 'profileId', profileId);
|
|
200
201
|
// verify required parameter 'file' is not null or undefined
|
|
@@ -225,6 +226,9 @@ export const DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
225
226
|
if (visualize !== undefined) {
|
|
226
227
|
localVarFormParams.append('visualize', String(visualize));
|
|
227
228
|
}
|
|
229
|
+
if (tags) {
|
|
230
|
+
localVarFormParams.append('tags', tags.join(COLLECTION_FORMATS.csv));
|
|
231
|
+
}
|
|
228
232
|
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
229
233
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
230
234
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -272,10 +276,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
272
276
|
* @param {number} [page] 1-based page number.
|
|
273
277
|
* @param {number} [limit] Page size.
|
|
274
278
|
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
279
|
+
* @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
|
|
275
280
|
* @param {*} [options] Override http request option.
|
|
276
281
|
* @throws {RequiredError}
|
|
277
282
|
*/
|
|
278
|
-
documentsControllerListDocuments: (page_1, limit_1, profileId_1, ...args_1) => __awaiter(this, [page_1, limit_1, profileId_1, ...args_1], void 0, function* (page, limit, profileId, options = {}) {
|
|
283
|
+
documentsControllerListDocuments: (page_1, limit_1, profileId_1, tags_1, ...args_1) => __awaiter(this, [page_1, limit_1, profileId_1, tags_1, ...args_1], void 0, function* (page, limit, profileId, tags, options = {}) {
|
|
279
284
|
const localVarPath = `/documents`;
|
|
280
285
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
281
286
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -295,6 +300,9 @@ export const DocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
295
300
|
if (profileId !== undefined) {
|
|
296
301
|
localVarQueryParameter['profileId'] = profileId;
|
|
297
302
|
}
|
|
303
|
+
if (tags) {
|
|
304
|
+
localVarQueryParameter['tags'] = tags;
|
|
305
|
+
}
|
|
298
306
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
299
307
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
300
308
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -320,13 +328,14 @@ export const DocumentsApiFp = function (configuration) {
|
|
|
320
328
|
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
321
329
|
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
322
330
|
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
331
|
+
* @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]).
|
|
323
332
|
* @param {*} [options] Override http request option.
|
|
324
333
|
* @throws {RequiredError}
|
|
325
334
|
*/
|
|
326
|
-
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
|
|
335
|
+
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
|
|
327
336
|
return __awaiter(this, void 0, void 0, function* () {
|
|
328
337
|
var _a, _b, _c;
|
|
329
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options);
|
|
338
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options);
|
|
330
339
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
331
340
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentsApi.documentsControllerCreateDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
332
341
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -354,13 +363,14 @@ export const DocumentsApiFp = function (configuration) {
|
|
|
354
363
|
* @param {number} [page] 1-based page number.
|
|
355
364
|
* @param {number} [limit] Page size.
|
|
356
365
|
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
366
|
+
* @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
|
|
357
367
|
* @param {*} [options] Override http request option.
|
|
358
368
|
* @throws {RequiredError}
|
|
359
369
|
*/
|
|
360
|
-
documentsControllerListDocuments(page, limit, profileId, options) {
|
|
370
|
+
documentsControllerListDocuments(page, limit, profileId, tags, options) {
|
|
361
371
|
return __awaiter(this, void 0, void 0, function* () {
|
|
362
372
|
var _a, _b, _c;
|
|
363
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, options);
|
|
373
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, tags, options);
|
|
364
374
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
365
375
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentsApi.documentsControllerListDocuments']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
366
376
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -382,11 +392,12 @@ export const DocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
382
392
|
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
383
393
|
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
384
394
|
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
395
|
+
* @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]).
|
|
385
396
|
* @param {*} [options] Override http request option.
|
|
386
397
|
* @throws {RequiredError}
|
|
387
398
|
*/
|
|
388
|
-
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
|
|
389
|
-
return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(axios, basePath));
|
|
399
|
+
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
|
|
400
|
+
return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(axios, basePath));
|
|
390
401
|
},
|
|
391
402
|
/**
|
|
392
403
|
*
|
|
@@ -404,11 +415,12 @@ export const DocumentsApiFactory = function (configuration, basePath, axios) {
|
|
|
404
415
|
* @param {number} [page] 1-based page number.
|
|
405
416
|
* @param {number} [limit] Page size.
|
|
406
417
|
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
418
|
+
* @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
|
|
407
419
|
* @param {*} [options] Override http request option.
|
|
408
420
|
* @throws {RequiredError}
|
|
409
421
|
*/
|
|
410
|
-
documentsControllerListDocuments(page, limit, profileId, options) {
|
|
411
|
-
return localVarFp.documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(axios, basePath));
|
|
422
|
+
documentsControllerListDocuments(page, limit, profileId, tags, options) {
|
|
423
|
+
return localVarFp.documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(axios, basePath));
|
|
412
424
|
},
|
|
413
425
|
};
|
|
414
426
|
};
|
|
@@ -424,11 +436,12 @@ export class DocumentsApi extends BaseAPI {
|
|
|
424
436
|
* @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
|
|
425
437
|
* @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
|
|
426
438
|
* @param {boolean} [visualize] Whether to generate graph visualization artifacts.
|
|
439
|
+
* @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]).
|
|
427
440
|
* @param {*} [options] Override http request option.
|
|
428
441
|
* @throws {RequiredError}
|
|
429
442
|
*/
|
|
430
|
-
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
|
|
431
|
-
return DocumentsApiFp(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(this.axios, this.basePath));
|
|
443
|
+
documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
|
|
444
|
+
return DocumentsApiFp(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(this.axios, this.basePath));
|
|
432
445
|
}
|
|
433
446
|
/**
|
|
434
447
|
*
|
|
@@ -446,11 +459,12 @@ export class DocumentsApi extends BaseAPI {
|
|
|
446
459
|
* @param {number} [page] 1-based page number.
|
|
447
460
|
* @param {number} [limit] Page size.
|
|
448
461
|
* @param {string} [profileId] Filter documents by profile/config ID.
|
|
462
|
+
* @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
|
|
449
463
|
* @param {*} [options] Override http request option.
|
|
450
464
|
* @throws {RequiredError}
|
|
451
465
|
*/
|
|
452
|
-
documentsControllerListDocuments(page, limit, profileId, options) {
|
|
453
|
-
return DocumentsApiFp(this.configuration).documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(this.axios, this.basePath));
|
|
466
|
+
documentsControllerListDocuments(page, limit, profileId, tags, options) {
|
|
467
|
+
return DocumentsApiFp(this.configuration).documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(this.axios, this.basePath));
|
|
454
468
|
}
|
|
455
469
|
}
|
|
456
470
|
export const DocumentsControllerCreateDocumentPriorityEnum = {
|
|
@@ -1136,10 +1150,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1136
1150
|
* @summary Create profile from YAML
|
|
1137
1151
|
* @param {File} yaml YAML file containing the profile/config.
|
|
1138
1152
|
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1153
|
+
* @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]).
|
|
1139
1154
|
* @param {*} [options] Override http request option.
|
|
1140
1155
|
* @throws {RequiredError}
|
|
1141
1156
|
*/
|
|
1142
|
-
profilesControllerCreateProfile: (yaml_1, name_1, ...args_1) => __awaiter(this, [yaml_1, name_1, ...args_1], void 0, function* (yaml, name, options = {}) {
|
|
1157
|
+
profilesControllerCreateProfile: (yaml_1, name_1, tags_1, ...args_1) => __awaiter(this, [yaml_1, name_1, tags_1, ...args_1], void 0, function* (yaml, name, tags, options = {}) {
|
|
1143
1158
|
// verify required parameter 'yaml' is not null or undefined
|
|
1144
1159
|
assertParamExists('profilesControllerCreateProfile', 'yaml', yaml);
|
|
1145
1160
|
const localVarPath = `/profiles`;
|
|
@@ -1159,6 +1174,9 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1159
1174
|
if (name !== undefined) {
|
|
1160
1175
|
localVarFormParams.append('name', name);
|
|
1161
1176
|
}
|
|
1177
|
+
if (tags) {
|
|
1178
|
+
localVarFormParams.append('tags', tags.join(COLLECTION_FORMATS.csv));
|
|
1179
|
+
}
|
|
1162
1180
|
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
1163
1181
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1164
1182
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1231,10 +1249,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1231
1249
|
* @summary List profiles
|
|
1232
1250
|
* @param {number} [page] 1-based page number.
|
|
1233
1251
|
* @param {number} [limit] Page size.
|
|
1252
|
+
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1234
1253
|
* @param {*} [options] Override http request option.
|
|
1235
1254
|
* @throws {RequiredError}
|
|
1236
1255
|
*/
|
|
1237
|
-
profilesControllerListProfiles: (page_1, limit_1, ...args_1) => __awaiter(this, [page_1, limit_1, ...args_1], void 0, function* (page, limit, options = {}) {
|
|
1256
|
+
profilesControllerListProfiles: (page_1, limit_1, tags_1, ...args_1) => __awaiter(this, [page_1, limit_1, tags_1, ...args_1], void 0, function* (page, limit, tags, options = {}) {
|
|
1238
1257
|
const localVarPath = `/profiles`;
|
|
1239
1258
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1240
1259
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1251,6 +1270,9 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1251
1270
|
if (limit !== undefined) {
|
|
1252
1271
|
localVarQueryParameter['limit'] = limit;
|
|
1253
1272
|
}
|
|
1273
|
+
if (tags) {
|
|
1274
|
+
localVarQueryParameter['tags'] = tags;
|
|
1275
|
+
}
|
|
1254
1276
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1255
1277
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1256
1278
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1273,13 +1295,14 @@ export const ProfilesApiFp = function (configuration) {
|
|
|
1273
1295
|
* @summary Create profile from YAML
|
|
1274
1296
|
* @param {File} yaml YAML file containing the profile/config.
|
|
1275
1297
|
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1298
|
+
* @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]).
|
|
1276
1299
|
* @param {*} [options] Override http request option.
|
|
1277
1300
|
* @throws {RequiredError}
|
|
1278
1301
|
*/
|
|
1279
|
-
profilesControllerCreateProfile(yaml, name, options) {
|
|
1302
|
+
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1280
1303
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1281
1304
|
var _a, _b, _c;
|
|
1282
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, options);
|
|
1305
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, tags, options);
|
|
1283
1306
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1284
1307
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerCreateProfile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1285
1308
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1321,13 +1344,14 @@ export const ProfilesApiFp = function (configuration) {
|
|
|
1321
1344
|
* @summary List profiles
|
|
1322
1345
|
* @param {number} [page] 1-based page number.
|
|
1323
1346
|
* @param {number} [limit] Page size.
|
|
1347
|
+
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1324
1348
|
* @param {*} [options] Override http request option.
|
|
1325
1349
|
* @throws {RequiredError}
|
|
1326
1350
|
*/
|
|
1327
|
-
profilesControllerListProfiles(page, limit, options) {
|
|
1351
|
+
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1328
1352
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1329
1353
|
var _a, _b, _c;
|
|
1330
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, options);
|
|
1354
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
|
|
1331
1355
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1332
1356
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerListProfiles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1333
1357
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1346,11 +1370,12 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1346
1370
|
* @summary Create profile from YAML
|
|
1347
1371
|
* @param {File} yaml YAML file containing the profile/config.
|
|
1348
1372
|
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1373
|
+
* @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]).
|
|
1349
1374
|
* @param {*} [options] Override http request option.
|
|
1350
1375
|
* @throws {RequiredError}
|
|
1351
1376
|
*/
|
|
1352
|
-
profilesControllerCreateProfile(yaml, name, options) {
|
|
1353
|
-
return localVarFp.profilesControllerCreateProfile(yaml, name, options).then((request) => request(axios, basePath));
|
|
1377
|
+
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1378
|
+
return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
|
|
1354
1379
|
},
|
|
1355
1380
|
/**
|
|
1356
1381
|
*
|
|
@@ -1376,11 +1401,12 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1376
1401
|
* @summary List profiles
|
|
1377
1402
|
* @param {number} [page] 1-based page number.
|
|
1378
1403
|
* @param {number} [limit] Page size.
|
|
1404
|
+
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1379
1405
|
* @param {*} [options] Override http request option.
|
|
1380
1406
|
* @throws {RequiredError}
|
|
1381
1407
|
*/
|
|
1382
|
-
profilesControllerListProfiles(page, limit, options) {
|
|
1383
|
-
return localVarFp.profilesControllerListProfiles(page, limit, options).then((request) => request(axios, basePath));
|
|
1408
|
+
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1409
|
+
return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
|
|
1384
1410
|
},
|
|
1385
1411
|
};
|
|
1386
1412
|
};
|
|
@@ -1393,11 +1419,12 @@ export class ProfilesApi extends BaseAPI {
|
|
|
1393
1419
|
* @summary Create profile from YAML
|
|
1394
1420
|
* @param {File} yaml YAML file containing the profile/config.
|
|
1395
1421
|
* @param {string} [name] Optional override for profile name (otherwise derived from YAML).
|
|
1422
|
+
* @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]).
|
|
1396
1423
|
* @param {*} [options] Override http request option.
|
|
1397
1424
|
* @throws {RequiredError}
|
|
1398
1425
|
*/
|
|
1399
|
-
profilesControllerCreateProfile(yaml, name, options) {
|
|
1400
|
-
return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, options).then((request) => request(this.axios, this.basePath));
|
|
1426
|
+
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1427
|
+
return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1401
1428
|
}
|
|
1402
1429
|
/**
|
|
1403
1430
|
*
|
|
@@ -1423,11 +1450,12 @@ export class ProfilesApi extends BaseAPI {
|
|
|
1423
1450
|
* @summary List profiles
|
|
1424
1451
|
* @param {number} [page] 1-based page number.
|
|
1425
1452
|
* @param {number} [limit] Page size.
|
|
1453
|
+
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1426
1454
|
* @param {*} [options] Override http request option.
|
|
1427
1455
|
* @throws {RequiredError}
|
|
1428
1456
|
*/
|
|
1429
|
-
profilesControllerListProfiles(page, limit, options) {
|
|
1430
|
-
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1457
|
+
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1458
|
+
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1431
1459
|
}
|
|
1432
1460
|
}
|
|
1433
1461
|
/**
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -28,7 +28,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
|
28
28
|
* This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
|
|
29
29
|
* Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
|
|
30
30
|
*/
|
|
31
|
-
export declare const replaceWithSerializableTypeIfNeeded: (key:
|
|
31
|
+
export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
|
|
32
32
|
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
33
33
|
export declare const toPathString: (url: URL) => string;
|
|
34
34
|
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/esm/common.js
CHANGED
|
@@ -96,6 +96,7 @@ export const setSearchParams = function (url, ...objects) {
|
|
|
96
96
|
* This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
|
|
97
97
|
* Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
|
|
98
98
|
*/
|
|
99
|
+
// @ts-ignore
|
|
99
100
|
export const replaceWithSerializableTypeIfNeeded = function (key, value) {
|
|
100
101
|
if (value instanceof Set) {
|
|
101
102
|
return Array.from(value);
|
package/docs/DocumentDto.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**updatedAt** | **string** | Document last update timestamp | [optional] [default to undefined]
|
|
16
16
|
**latestJobId** | **string** | Latest job ID associated with this document | [optional] [default to undefined]
|
|
17
17
|
**metrics** | **{ [key: string]: any; }** | Optional processing metrics (pages, chunks, entities, etc.) | [optional] [default to undefined]
|
|
18
|
+
**tags** | **Array<string>** | Tags associated with the document | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
@@ -32,6 +33,7 @@ const instance: DocumentDto = {
|
|
|
32
33
|
updatedAt,
|
|
33
34
|
latestJobId,
|
|
34
35
|
metrics,
|
|
36
|
+
tags,
|
|
35
37
|
};
|
|
36
38
|
```
|
|
37
39
|
|
package/docs/DocumentsApi.md
CHANGED
|
@@ -29,13 +29,15 @@ let file: File; //Document file to process (pdf/md/html/docx/etc). (default to u
|
|
|
29
29
|
let stages: string; //Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server. (optional) (default to undefined)
|
|
30
30
|
let priority: string; // (optional) (default to 'normal')
|
|
31
31
|
let visualize: boolean; //Whether to generate graph visualization artifacts. (optional) (default to false)
|
|
32
|
+
let tags: Array<string>; //Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]). (optional) (default to undefined)
|
|
32
33
|
|
|
33
34
|
const { status, data } = await apiInstance.documentsControllerCreateDocument(
|
|
34
35
|
profileId,
|
|
35
36
|
file,
|
|
36
37
|
stages,
|
|
37
38
|
priority,
|
|
38
|
-
visualize
|
|
39
|
+
visualize,
|
|
40
|
+
tags
|
|
39
41
|
);
|
|
40
42
|
```
|
|
41
43
|
|
|
@@ -48,6 +50,7 @@ const { status, data } = await apiInstance.documentsControllerCreateDocument(
|
|
|
48
50
|
| **stages** | [**string**] | Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server. | (optional) defaults to undefined|
|
|
49
51
|
| **priority** | [**string**]**Array<'low' | 'normal' | 'high'>** | | (optional) defaults to 'normal'|
|
|
50
52
|
| **visualize** | [**boolean**] | Whether to generate graph visualization artifacts. | (optional) defaults to false|
|
|
53
|
+
| **tags** | **Array<string>** | Optional tags to associate with the document (e.g., [\\\"invoice\\\", \\\"2024\\\"]). | (optional) defaults to undefined|
|
|
51
54
|
|
|
52
55
|
|
|
53
56
|
### Return type
|
|
@@ -145,11 +148,13 @@ const apiInstance = new DocumentsApi(configuration);
|
|
|
145
148
|
let page: number; //1-based page number. (optional) (default to 1)
|
|
146
149
|
let limit: number; //Page size. (optional) (default to 10)
|
|
147
150
|
let profileId: string; //Filter documents by profile/config ID. (optional) (default to undefined)
|
|
151
|
+
let tags: Array<string>; //Filter documents by tags (any match). Pass multiple times or comma-separated. (optional) (default to undefined)
|
|
148
152
|
|
|
149
153
|
const { status, data } = await apiInstance.documentsControllerListDocuments(
|
|
150
154
|
page,
|
|
151
155
|
limit,
|
|
152
|
-
profileId
|
|
156
|
+
profileId,
|
|
157
|
+
tags
|
|
153
158
|
);
|
|
154
159
|
```
|
|
155
160
|
|
|
@@ -160,6 +165,7 @@ const { status, data } = await apiInstance.documentsControllerListDocuments(
|
|
|
160
165
|
| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
|
|
161
166
|
| **limit** | [**number**] | Page size. | (optional) defaults to 10|
|
|
162
167
|
| **profileId** | [**string**] | Filter documents by profile/config ID. | (optional) defaults to undefined|
|
|
168
|
+
| **tags** | **Array<string>** | Filter documents by tags (any match). Pass multiple times or comma-separated. | (optional) defaults to undefined|
|
|
163
169
|
|
|
164
170
|
|
|
165
171
|
### Return type
|
package/docs/ProfileDto.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**yamlFileName** | **string** | YAML file name | [optional] [default to undefined]
|
|
14
14
|
**yamlSha256** | **string** | Optional checksum of the uploaded YAML file | [optional] [default to undefined]
|
|
15
15
|
**yamlFileContent** | **string** | Content of the YAML file | [optional] [default to undefined]
|
|
16
|
+
**tags** | **Array<string>** | Tags associated with the profile | [optional] [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,6 +29,7 @@ const instance: ProfileDto = {
|
|
|
28
29
|
yamlFileName,
|
|
29
30
|
yamlSha256,
|
|
30
31
|
yamlFileContent,
|
|
32
|
+
tags,
|
|
31
33
|
};
|
|
32
34
|
```
|
|
33
35
|
|
package/docs/ProfilesApi.md
CHANGED
|
@@ -27,10 +27,12 @@ const apiInstance = new ProfilesApi(configuration);
|
|
|
27
27
|
|
|
28
28
|
let yaml: File; //YAML file containing the profile/config. (default to undefined)
|
|
29
29
|
let name: string; //Optional override for profile name (otherwise derived from YAML). (optional) (default to undefined)
|
|
30
|
+
let tags: Array<string>; //Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]). (optional) (default to undefined)
|
|
30
31
|
|
|
31
32
|
const { status, data } = await apiInstance.profilesControllerCreateProfile(
|
|
32
33
|
yaml,
|
|
33
|
-
name
|
|
34
|
+
name,
|
|
35
|
+
tags
|
|
34
36
|
);
|
|
35
37
|
```
|
|
36
38
|
|
|
@@ -40,6 +42,7 @@ const { status, data } = await apiInstance.profilesControllerCreateProfile(
|
|
|
40
42
|
|------------- | ------------- | ------------- | -------------|
|
|
41
43
|
| **yaml** | [**File**] | YAML file containing the profile/config. | defaults to undefined|
|
|
42
44
|
| **name** | [**string**] | Optional override for profile name (otherwise derived from YAML). | (optional) defaults to undefined|
|
|
45
|
+
| **tags** | **Array<string>** | Optional tags to associate with the profile (e.g., [\\\"production\\\", \\\"finance\\\"]). | (optional) defaults to undefined|
|
|
43
46
|
|
|
44
47
|
|
|
45
48
|
### Return type
|
|
@@ -181,10 +184,12 @@ const apiInstance = new ProfilesApi(configuration);
|
|
|
181
184
|
|
|
182
185
|
let page: number; //1-based page number. (optional) (default to 1)
|
|
183
186
|
let limit: number; //Page size. (optional) (default to 10)
|
|
187
|
+
let tags: Array<string>; //Filter profiles by tags (any match). Pass multiple times or comma-separated. (optional) (default to undefined)
|
|
184
188
|
|
|
185
189
|
const { status, data } = await apiInstance.profilesControllerListProfiles(
|
|
186
190
|
page,
|
|
187
|
-
limit
|
|
191
|
+
limit,
|
|
192
|
+
tags
|
|
188
193
|
);
|
|
189
194
|
```
|
|
190
195
|
|
|
@@ -194,6 +199,7 @@ const { status, data } = await apiInstance.profilesControllerListProfiles(
|
|
|
194
199
|
|------------- | ------------- | ------------- | -------------|
|
|
195
200
|
| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
|
|
196
201
|
| **limit** | [**number**] | Page size. | (optional) defaults to 10|
|
|
202
|
+
| **tags** | **Array<string>** | Filter profiles by tags (any match). Pass multiple times or comma-separated. | (optional) defaults to undefined|
|
|
197
203
|
|
|
198
204
|
|
|
199
205
|
### Return type
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nestbox-ai/doc-processing-api",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.69",
|
|
4
4
|
"description": "OpenAPI client for @nestbox-ai/doc-processing-api",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"prepare": "npm run build"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"axios": "^1.
|
|
27
|
+
"axios": "^1.13.5"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@types/node": "12.11.5 - 12.20.42",
|