@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/dist/api.js CHANGED
@@ -198,10 +198,11 @@ const DocumentsApiAxiosParamCreator = function (configuration) {
198
198
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
199
199
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
200
200
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
201
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
201
202
  * @param {*} [options] Override http request option.
202
203
  * @throws {RequiredError}
203
204
  */
204
- 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 = {}) {
205
+ 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 = {}) {
205
206
  // verify required parameter 'profileId' is not null or undefined
206
207
  (0, common_1.assertParamExists)('documentsControllerCreateDocument', 'profileId', profileId);
207
208
  // verify required parameter 'file' is not null or undefined
@@ -232,6 +233,9 @@ const DocumentsApiAxiosParamCreator = function (configuration) {
232
233
  if (visualize !== undefined) {
233
234
  localVarFormParams.append('visualize', String(visualize));
234
235
  }
236
+ if (tags) {
237
+ localVarFormParams.append('tags', tags.join(base_1.COLLECTION_FORMATS.csv));
238
+ }
235
239
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
236
240
  localVarHeaderParameter['Accept'] = 'application/json';
237
241
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -279,10 +283,11 @@ const DocumentsApiAxiosParamCreator = function (configuration) {
279
283
  * @param {number} [page] 1-based page number.
280
284
  * @param {number} [limit] Page size.
281
285
  * @param {string} [profileId] Filter documents by profile/config ID.
286
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
282
287
  * @param {*} [options] Override http request option.
283
288
  * @throws {RequiredError}
284
289
  */
285
- 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 = {}) {
290
+ 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 = {}) {
286
291
  const localVarPath = `/documents`;
287
292
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
288
293
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -302,6 +307,9 @@ const DocumentsApiAxiosParamCreator = function (configuration) {
302
307
  if (profileId !== undefined) {
303
308
  localVarQueryParameter['profileId'] = profileId;
304
309
  }
310
+ if (tags) {
311
+ localVarQueryParameter['tags'] = tags;
312
+ }
305
313
  localVarHeaderParameter['Accept'] = 'application/json';
306
314
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
307
315
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -328,13 +336,14 @@ const DocumentsApiFp = function (configuration) {
328
336
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
329
337
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
330
338
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
339
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
331
340
  * @param {*} [options] Override http request option.
332
341
  * @throws {RequiredError}
333
342
  */
334
- documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
343
+ documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
335
344
  return __awaiter(this, void 0, void 0, function* () {
336
345
  var _a, _b, _c;
337
- const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options);
346
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options);
338
347
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
339
348
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentsApi.documentsControllerCreateDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
340
349
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -362,13 +371,14 @@ const DocumentsApiFp = function (configuration) {
362
371
  * @param {number} [page] 1-based page number.
363
372
  * @param {number} [limit] Page size.
364
373
  * @param {string} [profileId] Filter documents by profile/config ID.
374
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
365
375
  * @param {*} [options] Override http request option.
366
376
  * @throws {RequiredError}
367
377
  */
368
- documentsControllerListDocuments(page, limit, profileId, options) {
378
+ documentsControllerListDocuments(page, limit, profileId, tags, options) {
369
379
  return __awaiter(this, void 0, void 0, function* () {
370
380
  var _a, _b, _c;
371
- const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, options);
381
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.documentsControllerListDocuments(page, limit, profileId, tags, options);
372
382
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
373
383
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentsApi.documentsControllerListDocuments']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
374
384
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -391,11 +401,12 @@ const DocumentsApiFactory = function (configuration, basePath, axios) {
391
401
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
392
402
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
393
403
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
404
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
394
405
  * @param {*} [options] Override http request option.
395
406
  * @throws {RequiredError}
396
407
  */
397
- documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
398
- return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(axios, basePath));
408
+ documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
409
+ return localVarFp.documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(axios, basePath));
399
410
  },
400
411
  /**
401
412
  *
@@ -413,11 +424,12 @@ const DocumentsApiFactory = function (configuration, basePath, axios) {
413
424
  * @param {number} [page] 1-based page number.
414
425
  * @param {number} [limit] Page size.
415
426
  * @param {string} [profileId] Filter documents by profile/config ID.
427
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
416
428
  * @param {*} [options] Override http request option.
417
429
  * @throws {RequiredError}
418
430
  */
419
- documentsControllerListDocuments(page, limit, profileId, options) {
420
- return localVarFp.documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(axios, basePath));
431
+ documentsControllerListDocuments(page, limit, profileId, tags, options) {
432
+ return localVarFp.documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(axios, basePath));
421
433
  },
422
434
  };
423
435
  };
@@ -434,11 +446,12 @@ class DocumentsApi extends base_1.BaseAPI {
434
446
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
435
447
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
436
448
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
449
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
437
450
  * @param {*} [options] Override http request option.
438
451
  * @throws {RequiredError}
439
452
  */
440
- documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options) {
441
- return (0, exports.DocumentsApiFp)(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, options).then((request) => request(this.axios, this.basePath));
453
+ documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options) {
454
+ return (0, exports.DocumentsApiFp)(this.configuration).documentsControllerCreateDocument(profileId, file, stages, priority, visualize, tags, options).then((request) => request(this.axios, this.basePath));
442
455
  }
443
456
  /**
444
457
  *
@@ -456,11 +469,12 @@ class DocumentsApi extends base_1.BaseAPI {
456
469
  * @param {number} [page] 1-based page number.
457
470
  * @param {number} [limit] Page size.
458
471
  * @param {string} [profileId] Filter documents by profile/config ID.
472
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
459
473
  * @param {*} [options] Override http request option.
460
474
  * @throws {RequiredError}
461
475
  */
462
- documentsControllerListDocuments(page, limit, profileId, options) {
463
- return (0, exports.DocumentsApiFp)(this.configuration).documentsControllerListDocuments(page, limit, profileId, options).then((request) => request(this.axios, this.basePath));
476
+ documentsControllerListDocuments(page, limit, profileId, tags, options) {
477
+ return (0, exports.DocumentsApiFp)(this.configuration).documentsControllerListDocuments(page, limit, profileId, tags, options).then((request) => request(this.axios, this.basePath));
464
478
  }
465
479
  }
466
480
  exports.DocumentsApi = DocumentsApi;
@@ -1159,10 +1173,11 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
1159
1173
  * @summary Create profile from YAML
1160
1174
  * @param {File} yaml YAML file containing the profile/config.
1161
1175
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1176
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1162
1177
  * @param {*} [options] Override http request option.
1163
1178
  * @throws {RequiredError}
1164
1179
  */
1165
- profilesControllerCreateProfile: (yaml_1, name_1, ...args_1) => __awaiter(this, [yaml_1, name_1, ...args_1], void 0, function* (yaml, name, options = {}) {
1180
+ 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 = {}) {
1166
1181
  // verify required parameter 'yaml' is not null or undefined
1167
1182
  (0, common_1.assertParamExists)('profilesControllerCreateProfile', 'yaml', yaml);
1168
1183
  const localVarPath = `/profiles`;
@@ -1182,6 +1197,9 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
1182
1197
  if (name !== undefined) {
1183
1198
  localVarFormParams.append('name', name);
1184
1199
  }
1200
+ if (tags) {
1201
+ localVarFormParams.append('tags', tags.join(base_1.COLLECTION_FORMATS.csv));
1202
+ }
1185
1203
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
1186
1204
  localVarHeaderParameter['Accept'] = 'application/json';
1187
1205
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -1254,10 +1272,11 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
1254
1272
  * @summary List profiles
1255
1273
  * @param {number} [page] 1-based page number.
1256
1274
  * @param {number} [limit] Page size.
1275
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1257
1276
  * @param {*} [options] Override http request option.
1258
1277
  * @throws {RequiredError}
1259
1278
  */
1260
- profilesControllerListProfiles: (page_1, limit_1, ...args_1) => __awaiter(this, [page_1, limit_1, ...args_1], void 0, function* (page, limit, options = {}) {
1279
+ 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 = {}) {
1261
1280
  const localVarPath = `/profiles`;
1262
1281
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1263
1282
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1274,6 +1293,9 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
1274
1293
  if (limit !== undefined) {
1275
1294
  localVarQueryParameter['limit'] = limit;
1276
1295
  }
1296
+ if (tags) {
1297
+ localVarQueryParameter['tags'] = tags;
1298
+ }
1277
1299
  localVarHeaderParameter['Accept'] = 'application/json';
1278
1300
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1279
1301
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1297,13 +1319,14 @@ const ProfilesApiFp = function (configuration) {
1297
1319
  * @summary Create profile from YAML
1298
1320
  * @param {File} yaml YAML file containing the profile/config.
1299
1321
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1322
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1300
1323
  * @param {*} [options] Override http request option.
1301
1324
  * @throws {RequiredError}
1302
1325
  */
1303
- profilesControllerCreateProfile(yaml, name, options) {
1326
+ profilesControllerCreateProfile(yaml, name, tags, options) {
1304
1327
  return __awaiter(this, void 0, void 0, function* () {
1305
1328
  var _a, _b, _c;
1306
- const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, options);
1329
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerCreateProfile(yaml, name, tags, options);
1307
1330
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1308
1331
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProfilesApi.profilesControllerCreateProfile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1309
1332
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1345,13 +1368,14 @@ const ProfilesApiFp = function (configuration) {
1345
1368
  * @summary List profiles
1346
1369
  * @param {number} [page] 1-based page number.
1347
1370
  * @param {number} [limit] Page size.
1371
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1348
1372
  * @param {*} [options] Override http request option.
1349
1373
  * @throws {RequiredError}
1350
1374
  */
1351
- profilesControllerListProfiles(page, limit, options) {
1375
+ profilesControllerListProfiles(page, limit, tags, options) {
1352
1376
  return __awaiter(this, void 0, void 0, function* () {
1353
1377
  var _a, _b, _c;
1354
- const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, options);
1378
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
1355
1379
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1356
1380
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProfilesApi.profilesControllerListProfiles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1357
1381
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1371,11 +1395,12 @@ const ProfilesApiFactory = function (configuration, basePath, axios) {
1371
1395
  * @summary Create profile from YAML
1372
1396
  * @param {File} yaml YAML file containing the profile/config.
1373
1397
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1398
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1374
1399
  * @param {*} [options] Override http request option.
1375
1400
  * @throws {RequiredError}
1376
1401
  */
1377
- profilesControllerCreateProfile(yaml, name, options) {
1378
- return localVarFp.profilesControllerCreateProfile(yaml, name, options).then((request) => request(axios, basePath));
1402
+ profilesControllerCreateProfile(yaml, name, tags, options) {
1403
+ return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
1379
1404
  },
1380
1405
  /**
1381
1406
  *
@@ -1401,11 +1426,12 @@ const ProfilesApiFactory = function (configuration, basePath, axios) {
1401
1426
  * @summary List profiles
1402
1427
  * @param {number} [page] 1-based page number.
1403
1428
  * @param {number} [limit] Page size.
1429
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1404
1430
  * @param {*} [options] Override http request option.
1405
1431
  * @throws {RequiredError}
1406
1432
  */
1407
- profilesControllerListProfiles(page, limit, options) {
1408
- return localVarFp.profilesControllerListProfiles(page, limit, options).then((request) => request(axios, basePath));
1433
+ profilesControllerListProfiles(page, limit, tags, options) {
1434
+ return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
1409
1435
  },
1410
1436
  };
1411
1437
  };
@@ -1419,11 +1445,12 @@ class ProfilesApi extends base_1.BaseAPI {
1419
1445
  * @summary Create profile from YAML
1420
1446
  * @param {File} yaml YAML file containing the profile/config.
1421
1447
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1448
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1422
1449
  * @param {*} [options] Override http request option.
1423
1450
  * @throws {RequiredError}
1424
1451
  */
1425
- profilesControllerCreateProfile(yaml, name, options) {
1426
- return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerCreateProfile(yaml, name, options).then((request) => request(this.axios, this.basePath));
1452
+ profilesControllerCreateProfile(yaml, name, tags, options) {
1453
+ return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
1427
1454
  }
1428
1455
  /**
1429
1456
  *
@@ -1449,11 +1476,12 @@ class ProfilesApi extends base_1.BaseAPI {
1449
1476
  * @summary List profiles
1450
1477
  * @param {number} [page] 1-based page number.
1451
1478
  * @param {number} [limit] Page size.
1479
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1452
1480
  * @param {*} [options] Override http request option.
1453
1481
  * @throws {RequiredError}
1454
1482
  */
1455
- profilesControllerListProfiles(page, limit, options) {
1456
- return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerListProfiles(page, limit, options).then((request) => request(this.axios, this.basePath));
1483
+ profilesControllerListProfiles(page, limit, tags, options) {
1484
+ return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
1457
1485
  }
1458
1486
  }
1459
1487
  exports.ProfilesApi = ProfilesApi;
package/dist/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: any, value: any) => any;
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/common.js CHANGED
@@ -105,6 +105,7 @@ exports.setSearchParams = setSearchParams;
105
105
  * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
106
106
  * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
107
107
  */
108
+ // @ts-ignore
108
109
  const replaceWithSerializableTypeIfNeeded = function (key, value) {
109
110
  if (value instanceof Set) {
110
111
  return Array.from(value);
package/dist/esm/api.d.ts CHANGED
@@ -115,6 +115,10 @@ export interface DocumentDto {
115
115
  'metrics'?: {
116
116
  [key: string]: any;
117
117
  };
118
+ /**
119
+ * Tags associated with the document
120
+ */
121
+ 'tags'?: Array<string>;
118
122
  }
119
123
  export declare const DocumentDtoStatusEnum: {
120
124
  readonly Queued: "queued";
@@ -549,6 +553,10 @@ export interface ProfileDto {
549
553
  * Content of the YAML file
550
554
  */
551
555
  'yamlFileContent'?: string;
556
+ /**
557
+ * Tags associated with the profile
558
+ */
559
+ 'tags'?: Array<string>;
552
560
  }
553
561
  export interface QueryCreateResponseDto {
554
562
  /**
@@ -733,10 +741,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
733
741
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
734
742
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
735
743
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
744
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
736
745
  * @param {*} [options] Override http request option.
737
746
  * @throws {RequiredError}
738
747
  */
739
- documentsControllerCreateDocument: (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
748
+ documentsControllerCreateDocument: (profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
740
749
  /**
741
750
  *
742
751
  * @summary Read document
@@ -751,10 +760,11 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
751
760
  * @param {number} [page] 1-based page number.
752
761
  * @param {number} [limit] Page size.
753
762
  * @param {string} [profileId] Filter documents by profile/config ID.
763
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
754
764
  * @param {*} [options] Override http request option.
755
765
  * @throws {RequiredError}
756
766
  */
757
- documentsControllerListDocuments: (page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
767
+ documentsControllerListDocuments: (page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
758
768
  };
759
769
  /**
760
770
  * DocumentsApi - functional programming interface
@@ -768,10 +778,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
768
778
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
769
779
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
770
780
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
781
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
771
782
  * @param {*} [options] Override http request option.
772
783
  * @throws {RequiredError}
773
784
  */
774
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>>;
785
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentCreateResponseDto>>;
775
786
  /**
776
787
  *
777
788
  * @summary Read document
@@ -786,10 +797,11 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
786
797
  * @param {number} [page] 1-based page number.
787
798
  * @param {number} [limit] Page size.
788
799
  * @param {string} [profileId] Filter documents by profile/config ID.
800
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
789
801
  * @param {*} [options] Override http request option.
790
802
  * @throws {RequiredError}
791
803
  */
792
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>>;
804
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedDocumentsDto>>;
793
805
  };
794
806
  /**
795
807
  * DocumentsApi - factory interface
@@ -803,10 +815,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
803
815
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
804
816
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
805
817
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
818
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
806
819
  * @param {*} [options] Override http request option.
807
820
  * @throws {RequiredError}
808
821
  */
809
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto>;
822
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<DocumentCreateResponseDto>;
810
823
  /**
811
824
  *
812
825
  * @summary Read document
@@ -821,10 +834,11 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
821
834
  * @param {number} [page] 1-based page number.
822
835
  * @param {number} [limit] Page size.
823
836
  * @param {string} [profileId] Filter documents by profile/config ID.
837
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
824
838
  * @param {*} [options] Override http request option.
825
839
  * @throws {RequiredError}
826
840
  */
827
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto>;
841
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedDocumentsDto>;
828
842
  };
829
843
  /**
830
844
  * DocumentsApi - object-oriented interface
@@ -838,10 +852,11 @@ export declare class DocumentsApi extends BaseAPI {
838
852
  * @param {string} [stages] Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server.
839
853
  * @param {DocumentsControllerCreateDocumentPriorityEnum} [priority]
840
854
  * @param {boolean} [visualize] Whether to generate graph visualization artifacts.
855
+ * @param {Array<string>} [tags] Optional tags to associate with the document (e.g., [\\\&quot;invoice\\\&quot;, \\\&quot;2024\\\&quot;]).
841
856
  * @param {*} [options] Override http request option.
842
857
  * @throws {RequiredError}
843
858
  */
844
- documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentCreateResponseDto, any, {}>>;
859
+ documentsControllerCreateDocument(profileId: string, file: File, stages?: string, priority?: DocumentsControllerCreateDocumentPriorityEnum, visualize?: boolean, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentCreateResponseDto, any, {}>>;
845
860
  /**
846
861
  *
847
862
  * @summary Read document
@@ -856,10 +871,11 @@ export declare class DocumentsApi extends BaseAPI {
856
871
  * @param {number} [page] 1-based page number.
857
872
  * @param {number} [limit] Page size.
858
873
  * @param {string} [profileId] Filter documents by profile/config ID.
874
+ * @param {Array<string>} [tags] Filter documents by tags (any match). Pass multiple times or comma-separated.
859
875
  * @param {*} [options] Override http request option.
860
876
  * @throws {RequiredError}
861
877
  */
862
- documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedDocumentsDto, any, {}>>;
878
+ documentsControllerListDocuments(page?: number, limit?: number, profileId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedDocumentsDto, any, {}>>;
863
879
  }
864
880
  export declare const DocumentsControllerCreateDocumentPriorityEnum: {
865
881
  readonly Low: "low";
@@ -1216,10 +1232,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
1216
1232
  * @summary Create profile from YAML
1217
1233
  * @param {File} yaml YAML file containing the profile/config.
1218
1234
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1235
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1219
1236
  * @param {*} [options] Override http request option.
1220
1237
  * @throws {RequiredError}
1221
1238
  */
1222
- profilesControllerCreateProfile: (yaml: File, name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1239
+ profilesControllerCreateProfile: (yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1223
1240
  /**
1224
1241
  *
1225
1242
  * @summary Read profile
@@ -1240,10 +1257,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
1240
1257
  * @summary List profiles
1241
1258
  * @param {number} [page] 1-based page number.
1242
1259
  * @param {number} [limit] Page size.
1260
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1243
1261
  * @param {*} [options] Override http request option.
1244
1262
  * @throws {RequiredError}
1245
1263
  */
1246
- profilesControllerListProfiles: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1264
+ profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1247
1265
  };
1248
1266
  /**
1249
1267
  * ProfilesApi - functional programming interface
@@ -1254,10 +1272,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
1254
1272
  * @summary Create profile from YAML
1255
1273
  * @param {File} yaml YAML file containing the profile/config.
1256
1274
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1275
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1257
1276
  * @param {*} [options] Override http request option.
1258
1277
  * @throws {RequiredError}
1259
1278
  */
1260
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
1279
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
1261
1280
  /**
1262
1281
  *
1263
1282
  * @summary Read profile
@@ -1280,10 +1299,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
1280
1299
  * @summary List profiles
1281
1300
  * @param {number} [page] 1-based page number.
1282
1301
  * @param {number} [limit] Page size.
1302
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1283
1303
  * @param {*} [options] Override http request option.
1284
1304
  * @throws {RequiredError}
1285
1305
  */
1286
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
1306
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
1287
1307
  };
1288
1308
  /**
1289
1309
  * ProfilesApi - factory interface
@@ -1294,10 +1314,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
1294
1314
  * @summary Create profile from YAML
1295
1315
  * @param {File} yaml YAML file containing the profile/config.
1296
1316
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1317
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1297
1318
  * @param {*} [options] Override http request option.
1298
1319
  * @throws {RequiredError}
1299
1320
  */
1300
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
1321
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
1301
1322
  /**
1302
1323
  *
1303
1324
  * @summary Read profile
@@ -1320,10 +1341,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
1320
1341
  * @summary List profiles
1321
1342
  * @param {number} [page] 1-based page number.
1322
1343
  * @param {number} [limit] Page size.
1344
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1323
1345
  * @param {*} [options] Override http request option.
1324
1346
  * @throws {RequiredError}
1325
1347
  */
1326
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
1348
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
1327
1349
  };
1328
1350
  /**
1329
1351
  * ProfilesApi - object-oriented interface
@@ -1334,10 +1356,11 @@ export declare class ProfilesApi extends BaseAPI {
1334
1356
  * @summary Create profile from YAML
1335
1357
  * @param {File} yaml YAML file containing the profile/config.
1336
1358
  * @param {string} [name] Optional override for profile name (otherwise derived from YAML).
1359
+ * @param {Array<string>} [tags] Optional tags to associate with the profile (e.g., [\\\&quot;production\\\&quot;, \\\&quot;finance\\\&quot;]).
1337
1360
  * @param {*} [options] Override http request option.
1338
1361
  * @throws {RequiredError}
1339
1362
  */
1340
- profilesControllerCreateProfile(yaml: File, name?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
1363
+ profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
1341
1364
  /**
1342
1365
  *
1343
1366
  * @summary Read profile
@@ -1360,10 +1383,11 @@ export declare class ProfilesApi extends BaseAPI {
1360
1383
  * @summary List profiles
1361
1384
  * @param {number} [page] 1-based page number.
1362
1385
  * @param {number} [limit] Page size.
1386
+ * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
1363
1387
  * @param {*} [options] Override http request option.
1364
1388
  * @throws {RequiredError}
1365
1389
  */
1366
- profilesControllerListProfiles(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
1390
+ profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
1367
1391
  }
1368
1392
  /**
1369
1393
  * QueriesApi - axios parameter creator