@openfilz-sdk/typescript-ee 1.9.7 → 1.9.8

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.
Files changed (37) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +6 -2
  4. package/api/aichat-api.ts +73 -0
  5. package/api/document-insights-api.ts +82 -0
  6. package/dist/api/aichat-api.d.ts +33 -0
  7. package/dist/api/aichat-api.js +68 -0
  8. package/dist/api/document-insights-api.d.ts +37 -0
  9. package/dist/api/document-insights-api.js +77 -0
  10. package/dist/esm/api/aichat-api.d.ts +33 -0
  11. package/dist/esm/api/aichat-api.js +68 -0
  12. package/dist/esm/api/document-insights-api.d.ts +37 -0
  13. package/dist/esm/api/document-insights-api.js +77 -0
  14. package/dist/esm/models/index.d.ts +2 -0
  15. package/dist/esm/models/index.js +2 -0
  16. package/dist/esm/models/insight-category-update.d.ts +14 -0
  17. package/dist/esm/models/insight-category-update.js +14 -0
  18. package/dist/esm/models/reorganization-by-kind-request.d.ts +14 -0
  19. package/dist/esm/models/reorganization-by-kind-request.js +14 -0
  20. package/dist/esm/models/settings.d.ts +1 -0
  21. package/dist/models/index.d.ts +2 -0
  22. package/dist/models/index.js +2 -0
  23. package/dist/models/insight-category-update.d.ts +14 -0
  24. package/dist/models/insight-category-update.js +15 -0
  25. package/dist/models/reorganization-by-kind-request.d.ts +14 -0
  26. package/dist/models/reorganization-by-kind-request.js +15 -0
  27. package/dist/models/settings.d.ts +1 -0
  28. package/docs/AIChatApi.md +53 -0
  29. package/docs/DocumentInsightsApi.md +56 -0
  30. package/docs/InsightCategoryUpdate.md +20 -0
  31. package/docs/ReorganizationByKindRequest.md +20 -0
  32. package/docs/Settings.md +2 -0
  33. package/models/index.ts +2 -0
  34. package/models/insight-category-update.ts +20 -0
  35. package/models/reorganization-by-kind-request.ts +20 -0
  36. package/models/settings.ts +1 -0
  37. package/package.json +1 -1
@@ -17,6 +17,7 @@ import type { AiChatRequest } from '../models';
17
17
  import type { AiChatResponse } from '../models';
18
18
  import type { ReorganizationApplyRequest } from '../models';
19
19
  import type { ReorganizationApplyResult } from '../models';
20
+ import type { ReorganizationByKindRequest } from '../models';
20
21
  import type { ReorganizationPlanView } from '../models';
21
22
  /**
22
23
  * AIChatApi - axios parameter creator
@@ -78,6 +79,14 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
78
79
  * @throws {RequiredError}
79
80
  */
80
81
  listConversations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
84
+ * @summary Propose a reorganisation by kind of document — no model involved
85
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ proposeByKind: (reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
81
90
  };
82
91
  /**
83
92
  * AIChatApi - functional programming interface
@@ -139,6 +148,14 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
139
148
  * @throws {RequiredError}
140
149
  */
141
150
  listConversations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatConversation>>>;
151
+ /**
152
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
153
+ * @summary Propose a reorganisation by kind of document — no model involved
154
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
142
159
  };
143
160
  /**
144
161
  * AIChatApi - factory interface
@@ -200,6 +217,14 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
200
217
  * @throws {RequiredError}
201
218
  */
202
219
  listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>>;
220
+ /**
221
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
222
+ * @summary Propose a reorganisation by kind of document — no model involved
223
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
203
228
  };
204
229
  /**
205
230
  * AIChatApi - object-oriented interface
@@ -261,4 +286,12 @@ export declare class AIChatApi extends BaseAPI {
261
286
  * @throws {RequiredError}
262
287
  */
263
288
  listConversations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiChatConversation[], any, {}, any>>;
289
+ /**
290
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
291
+ * @summary Propose a reorganisation by kind of document — no model involved
292
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
293
+ * @param {*} [options] Override http request option.
294
+ * @throws {RequiredError}
295
+ */
296
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
264
297
  }
@@ -261,6 +261,38 @@ export const AIChatApiAxiosParamCreator = function (configuration) {
261
261
  options: localVarRequestOptions,
262
262
  };
263
263
  }),
264
+ /**
265
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
266
+ * @summary Propose a reorganisation by kind of document — no model involved
267
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
268
+ * @param {*} [options] Override http request option.
269
+ * @throws {RequiredError}
270
+ */
271
+ proposeByKind: (reorganizationByKindRequest_1, ...args_1) => __awaiter(this, [reorganizationByKindRequest_1, ...args_1], void 0, function* (reorganizationByKindRequest, options = {}) {
272
+ const localVarPath = `/api/v1/ai/reorganization/by-kind`;
273
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
274
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
275
+ let baseOptions;
276
+ if (configuration) {
277
+ baseOptions = configuration.baseOptions;
278
+ }
279
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
280
+ const localVarHeaderParameter = {};
281
+ const localVarQueryParameter = {};
282
+ // authentication keycloak_auth required
283
+ // http bearer authentication required
284
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
285
+ localVarHeaderParameter['Content-Type'] = 'application/json';
286
+ localVarHeaderParameter['Accept'] = 'application/json';
287
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
288
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
289
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
290
+ localVarRequestOptions.data = serializeDataIfNeeded(reorganizationByKindRequest, localVarRequestOptions, configuration);
291
+ return {
292
+ url: toPathString(localVarUrlObj),
293
+ options: localVarRequestOptions,
294
+ };
295
+ }),
264
296
  };
265
297
  };
266
298
  /**
@@ -381,6 +413,22 @@ export const AIChatApiFp = function (configuration) {
381
413
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
382
414
  });
383
415
  },
416
+ /**
417
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
418
+ * @summary Propose a reorganisation by kind of document — no model involved
419
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
420
+ * @param {*} [options] Override http request option.
421
+ * @throws {RequiredError}
422
+ */
423
+ proposeByKind(reorganizationByKindRequest, options) {
424
+ return __awaiter(this, void 0, void 0, function* () {
425
+ var _a, _b, _c;
426
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.proposeByKind(reorganizationByKindRequest, options);
427
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
428
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIChatApi.proposeByKind']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
429
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
430
+ });
431
+ },
384
432
  };
385
433
  };
386
434
  /**
@@ -459,6 +507,16 @@ export const AIChatApiFactory = function (configuration, basePath, axios) {
459
507
  listConversations(options) {
460
508
  return localVarFp.listConversations(options).then((request) => request(axios, basePath));
461
509
  },
510
+ /**
511
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
512
+ * @summary Propose a reorganisation by kind of document — no model involved
513
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
514
+ * @param {*} [options] Override http request option.
515
+ * @throws {RequiredError}
516
+ */
517
+ proposeByKind(reorganizationByKindRequest, options) {
518
+ return localVarFp.proposeByKind(reorganizationByKindRequest, options).then((request) => request(axios, basePath));
519
+ },
462
520
  };
463
521
  };
464
522
  /**
@@ -535,4 +593,14 @@ export class AIChatApi extends BaseAPI {
535
593
  listConversations(options) {
536
594
  return AIChatApiFp(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
537
595
  }
596
+ /**
597
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
598
+ * @summary Propose a reorganisation by kind of document — no model involved
599
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
600
+ * @param {*} [options] Override http request option.
601
+ * @throws {RequiredError}
602
+ */
603
+ proposeByKind(reorganizationByKindRequest, options) {
604
+ return AIChatApiFp(this.configuration).proposeByKind(reorganizationByKindRequest, options).then((request) => request(this.axios, this.basePath));
605
+ }
538
606
  }
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { DocumentInsightView } from '../models';
16
16
  import type { InsightBackfillRequest } from '../models';
17
17
  import type { InsightBackfillStatus } from '../models';
18
+ import type { InsightCategoryUpdate } from '../models';
18
19
  /**
19
20
  * DocumentInsightsApi - axios parameter creator
20
21
  */
@@ -43,6 +44,15 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
43
44
  * @throws {RequiredError}
44
45
  */
45
46
  getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47
+ /**
48
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
49
+ * @summary Correct the kind of a document
50
+ * @param {string} documentId
51
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ setCategory: (documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
56
  };
47
57
  /**
48
58
  * DocumentInsightsApi - functional programming interface
@@ -72,6 +82,15 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
72
82
  * @throws {RequiredError}
73
83
  */
74
84
  getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
85
+ /**
86
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
87
+ * @summary Correct the kind of a document
88
+ * @param {string} documentId
89
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
75
94
  };
76
95
  /**
77
96
  * DocumentInsightsApi - factory interface
@@ -101,6 +120,15 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
101
120
  * @throws {RequiredError}
102
121
  */
103
122
  getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
123
+ /**
124
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
125
+ * @summary Correct the kind of a document
126
+ * @param {string} documentId
127
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ */
131
+ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
104
132
  };
105
133
  /**
106
134
  * DocumentInsightsApi - object-oriented interface
@@ -130,4 +158,13 @@ export declare class DocumentInsightsApi extends BaseAPI {
130
158
  * @throws {RequiredError}
131
159
  */
132
160
  getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}, any>>;
161
+ /**
162
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
163
+ * @summary Correct the kind of a document
164
+ * @param {string} documentId
165
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}, any>>;
133
170
  }
@@ -129,6 +129,44 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration) {
129
129
  options: localVarRequestOptions,
130
130
  };
131
131
  }),
132
+ /**
133
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
134
+ * @summary Correct the kind of a document
135
+ * @param {string} documentId
136
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ setCategory: (documentId_1, insightCategoryUpdate_1, ...args_1) => __awaiter(this, [documentId_1, insightCategoryUpdate_1, ...args_1], void 0, function* (documentId, insightCategoryUpdate, options = {}) {
141
+ // verify required parameter 'documentId' is not null or undefined
142
+ assertParamExists('setCategory', 'documentId', documentId);
143
+ // verify required parameter 'insightCategoryUpdate' is not null or undefined
144
+ assertParamExists('setCategory', 'insightCategoryUpdate', insightCategoryUpdate);
145
+ const localVarPath = `/api/v1/documents/{documentId}/insights`
146
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
147
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
148
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
149
+ let baseOptions;
150
+ if (configuration) {
151
+ baseOptions = configuration.baseOptions;
152
+ }
153
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
154
+ const localVarHeaderParameter = {};
155
+ const localVarQueryParameter = {};
156
+ // authentication keycloak_auth required
157
+ // http bearer authentication required
158
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
159
+ localVarHeaderParameter['Content-Type'] = 'application/json';
160
+ localVarHeaderParameter['Accept'] = 'application/json';
161
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
162
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
163
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
164
+ localVarRequestOptions.data = serializeDataIfNeeded(insightCategoryUpdate, localVarRequestOptions, configuration);
165
+ return {
166
+ url: toPathString(localVarUrlObj),
167
+ options: localVarRequestOptions,
168
+ };
169
+ }),
132
170
  };
133
171
  };
134
172
  /**
@@ -185,6 +223,23 @@ export const DocumentInsightsApiFp = function (configuration) {
185
223
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
186
224
  });
187
225
  },
226
+ /**
227
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
228
+ * @summary Correct the kind of a document
229
+ * @param {string} documentId
230
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ setCategory(documentId, insightCategoryUpdate, options) {
235
+ return __awaiter(this, void 0, void 0, function* () {
236
+ var _a, _b, _c;
237
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.setCategory(documentId, insightCategoryUpdate, options);
238
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
239
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentInsightsApi.setCategory']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
240
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
241
+ });
242
+ },
188
243
  };
189
244
  };
190
245
  /**
@@ -223,6 +278,17 @@ export const DocumentInsightsApiFactory = function (configuration, basePath, axi
223
278
  getInsights(documentId, options) {
224
279
  return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
225
280
  },
281
+ /**
282
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
283
+ * @summary Correct the kind of a document
284
+ * @param {string} documentId
285
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ setCategory(documentId, insightCategoryUpdate, options) {
290
+ return localVarFp.setCategory(documentId, insightCategoryUpdate, options).then((request) => request(axios, basePath));
291
+ },
226
292
  };
227
293
  };
228
294
  /**
@@ -259,4 +325,15 @@ export class DocumentInsightsApi extends BaseAPI {
259
325
  getInsights(documentId, options) {
260
326
  return DocumentInsightsApiFp(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
261
327
  }
328
+ /**
329
+ * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
330
+ * @summary Correct the kind of a document
331
+ * @param {string} documentId
332
+ * @param {InsightCategoryUpdate} insightCategoryUpdate
333
+ * @param {*} [options] Override http request option.
334
+ * @throws {RequiredError}
335
+ */
336
+ setCategory(documentId, insightCategoryUpdate, options) {
337
+ return DocumentInsightsApiFp(this.configuration).setCategory(documentId, insightCategoryUpdate, options).then((request) => request(this.axios, this.basePath));
338
+ }
262
339
  }
@@ -56,6 +56,7 @@ export * from './folder-response';
56
56
  export * from './ingestion-status-dto';
57
57
  export * from './insight-backfill-request';
58
58
  export * from './insight-backfill-status';
59
+ export * from './insight-category-update';
59
60
  export * from './instantiate-template-request';
60
61
  export * from './item';
61
62
  export * from './item-result';
@@ -84,6 +85,7 @@ export * from './rename-audit';
84
85
  export * from './rename-request';
85
86
  export * from './reorganization-apply-request';
86
87
  export * from './reorganization-apply-result';
88
+ export * from './reorganization-by-kind-request';
87
89
  export * from './reorganization-plan-view';
88
90
  export * from './replace-audit';
89
91
  export * from './response';
@@ -56,6 +56,7 @@ export * from './folder-response';
56
56
  export * from './ingestion-status-dto';
57
57
  export * from './insight-backfill-request';
58
58
  export * from './insight-backfill-status';
59
+ export * from './insight-category-update';
59
60
  export * from './instantiate-template-request';
60
61
  export * from './item';
61
62
  export * from './item-result';
@@ -84,6 +85,7 @@ export * from './rename-audit';
84
85
  export * from './rename-request';
85
86
  export * from './reorganization-apply-request';
86
87
  export * from './reorganization-apply-result';
88
+ export * from './reorganization-by-kind-request';
87
89
  export * from './reorganization-plan-view';
88
90
  export * from './replace-audit';
89
91
  export * from './response';
@@ -0,0 +1,14 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface InsightCategoryUpdate {
13
+ 'category'?: string;
14
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface ReorganizationByKindRequest {
13
+ 'rootFolderId'?: string;
14
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -19,6 +19,7 @@ export interface Settings {
19
19
  'aiActive'?: boolean;
20
20
  'aiUserSettingsEnabled'?: boolean;
21
21
  'aiInsightsActive'?: boolean;
22
+ 'aiInsightsCategories'?: Array<string>;
22
23
  'aiAutoFileActive'?: boolean;
23
24
  'signatureActive'?: boolean;
24
25
  'pdfToolsActive'?: boolean;
@@ -56,6 +56,7 @@ export * from './folder-response';
56
56
  export * from './ingestion-status-dto';
57
57
  export * from './insight-backfill-request';
58
58
  export * from './insight-backfill-status';
59
+ export * from './insight-category-update';
59
60
  export * from './instantiate-template-request';
60
61
  export * from './item';
61
62
  export * from './item-result';
@@ -84,6 +85,7 @@ export * from './rename-audit';
84
85
  export * from './rename-request';
85
86
  export * from './reorganization-apply-request';
86
87
  export * from './reorganization-apply-result';
88
+ export * from './reorganization-by-kind-request';
87
89
  export * from './reorganization-plan-view';
88
90
  export * from './replace-audit';
89
91
  export * from './response';
@@ -72,6 +72,7 @@ __exportStar(require("./folder-response"), exports);
72
72
  __exportStar(require("./ingestion-status-dto"), exports);
73
73
  __exportStar(require("./insight-backfill-request"), exports);
74
74
  __exportStar(require("./insight-backfill-status"), exports);
75
+ __exportStar(require("./insight-category-update"), exports);
75
76
  __exportStar(require("./instantiate-template-request"), exports);
76
77
  __exportStar(require("./item"), exports);
77
78
  __exportStar(require("./item-result"), exports);
@@ -100,6 +101,7 @@ __exportStar(require("./rename-audit"), exports);
100
101
  __exportStar(require("./rename-request"), exports);
101
102
  __exportStar(require("./reorganization-apply-request"), exports);
102
103
  __exportStar(require("./reorganization-apply-result"), exports);
104
+ __exportStar(require("./reorganization-by-kind-request"), exports);
103
105
  __exportStar(require("./reorganization-plan-view"), exports);
104
106
  __exportStar(require("./replace-audit"), exports);
105
107
  __exportStar(require("./response"), exports);
@@ -0,0 +1,14 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface InsightCategoryUpdate {
13
+ 'category'?: string;
14
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface ReorganizationByKindRequest {
13
+ 'rootFolderId'?: string;
14
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -19,6 +19,7 @@ export interface Settings {
19
19
  'aiActive'?: boolean;
20
20
  'aiUserSettingsEnabled'?: boolean;
21
21
  'aiInsightsActive'?: boolean;
22
+ 'aiInsightsCategories'?: Array<string>;
22
23
  'aiAutoFileActive'?: boolean;
23
24
  'signatureActive'?: boolean;
24
25
  'pdfToolsActive'?: boolean;
package/docs/AIChatApi.md CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:8081*
11
11
  |[**get4**](#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
12
12
  |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
13
13
  |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
14
+ |[**proposeByKind**](#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved|
14
15
 
15
16
  # **apply**
16
17
  > ReorganizationApplyResult apply()
@@ -366,3 +367,55 @@ This endpoint does not have any parameters.
366
367
 
367
368
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
368
369
 
370
+ # **proposeByKind**
371
+ > ReorganizationPlanView proposeByKind()
372
+
373
+ Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
374
+
375
+ ### Example
376
+
377
+ ```typescript
378
+ import {
379
+ AIChatApi,
380
+ Configuration,
381
+ ReorganizationByKindRequest
382
+ } from '@openfilz-sdk/typescript-ee';
383
+
384
+ const configuration = new Configuration();
385
+ const apiInstance = new AIChatApi(configuration);
386
+
387
+ let reorganizationByKindRequest: ReorganizationByKindRequest; // (optional)
388
+
389
+ const { status, data } = await apiInstance.proposeByKind(
390
+ reorganizationByKindRequest
391
+ );
392
+ ```
393
+
394
+ ### Parameters
395
+
396
+ |Name | Type | Description | Notes|
397
+ |------------- | ------------- | ------------- | -------------|
398
+ | **reorganizationByKindRequest** | **ReorganizationByKindRequest**| | |
399
+
400
+
401
+ ### Return type
402
+
403
+ **ReorganizationPlanView**
404
+
405
+ ### Authorization
406
+
407
+ [keycloak_auth](../README.md#keycloak_auth)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: application/json
412
+ - **Accept**: application/json
413
+
414
+
415
+ ### HTTP response details
416
+ | Status code | Description | Response headers |
417
+ |-------------|-------------|------------------|
418
+ |**200** | OK | - |
419
+
420
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
421
+