@openfilz-sdk/typescript-ee 1.9.7 → 1.9.9

package/dist/esm/models/index.d.ts

@@ -45,6 +45,8 @@ export * from './document-position';
 export * from './document-version-info';
 export * from './element-info';
 export * from './embed-url-response';
+export * from './embedding-backfill-request';
+export * from './embedding-backfill-status';
 export * from './enriched-audit-log';
 export * from './enriched-audit-log-details';
 export * from './feature-entitlement';
@@ -56,6 +58,7 @@ export * from './folder-response';
 export * from './ingestion-status-dto';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
+export * from './insight-category-update';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
@@ -84,6 +87,7 @@ export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
 export * from './reorganization-apply-result';
+export * from './reorganization-by-kind-request';
 export * from './reorganization-plan-view';
 export * from './replace-audit';
 export * from './response';

package/dist/esm/models/index.js

@@ -45,6 +45,8 @@ export * from './document-position';
 export * from './document-version-info';
 export * from './element-info';
 export * from './embed-url-response';
+export * from './embedding-backfill-request';
+export * from './embedding-backfill-status';
 export * from './enriched-audit-log';
 export * from './enriched-audit-log-details';
 export * from './feature-entitlement';
@@ -56,6 +58,7 @@ export * from './folder-response';
 export * from './ingestion-status-dto';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
+export * from './insight-category-update';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
@@ -84,6 +87,7 @@ export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
 export * from './reorganization-apply-result';
+export * from './reorganization-by-kind-request';
 export * from './reorganization-plan-view';
 export * from './replace-audit';
 export * from './response';

package/dist/esm/models/insight-category-update.d.ts

@@ -0,0 +1,14 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface InsightCategoryUpdate {
+    'category'?: string;
+}

package/dist/esm/models/insight-category-update.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/reorganization-by-kind-request.d.ts

@@ -0,0 +1,14 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ReorganizationByKindRequest {
+    'rootFolderId'?: string;
+}

package/dist/esm/models/reorganization-by-kind-request.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/settings.d.ts

@@ -19,6 +19,7 @@ export interface Settings {
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
+    'aiInsightsCategories'?: Array<string>;
     'aiAutoFileActive'?: boolean;
     'signatureActive'?: boolean;
     'pdfToolsActive'?: boolean;

package/dist/models/embedding-backfill-request.d.ts

@@ -0,0 +1,15 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface EmbeddingBackfillRequest {
+    'folderId'?: string;
+    'force'?: boolean;
+}

package/dist/models/embedding-backfill-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/embedding-backfill-status.d.ts

@@ -0,0 +1,23 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface EmbeddingBackfillStatus {
+    'jobId'?: string;
+    'folderId'?: string;
+    'force'?: boolean;
+    'status'?: string;
+    'total'?: number;
+    'done'?: number;
+    'failed'?: number;
+    'skipped'?: number;
+    'startedAt'?: string;
+    'finishedAt'?: string;
+}

package/dist/models/embedding-backfill-status.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/index.d.ts

@@ -45,6 +45,8 @@ export * from './document-position';
 export * from './document-version-info';
 export * from './element-info';
 export * from './embed-url-response';
+export * from './embedding-backfill-request';
+export * from './embedding-backfill-status';
 export * from './enriched-audit-log';
 export * from './enriched-audit-log-details';
 export * from './feature-entitlement';
@@ -56,6 +58,7 @@ export * from './folder-response';
 export * from './ingestion-status-dto';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
+export * from './insight-category-update';
 export * from './instantiate-template-request';
 export * from './item';
 export * from './item-result';
@@ -84,6 +87,7 @@ export * from './rename-audit';
 export * from './rename-request';
 export * from './reorganization-apply-request';
 export * from './reorganization-apply-result';
+export * from './reorganization-by-kind-request';
 export * from './reorganization-plan-view';
 export * from './replace-audit';
 export * from './response';

package/dist/models/index.js

@@ -61,6 +61,8 @@ __exportStar(require("./document-position"), exports);
 __exportStar(require("./document-version-info"), exports);
 __exportStar(require("./element-info"), exports);
 __exportStar(require("./embed-url-response"), exports);
+__exportStar(require("./embedding-backfill-request"), exports);
+__exportStar(require("./embedding-backfill-status"), exports);
 __exportStar(require("./enriched-audit-log"), exports);
 __exportStar(require("./enriched-audit-log-details"), exports);
 __exportStar(require("./feature-entitlement"), exports);
@@ -72,6 +74,7 @@ __exportStar(require("./folder-response"), exports);
 __exportStar(require("./ingestion-status-dto"), exports);
 __exportStar(require("./insight-backfill-request"), exports);
 __exportStar(require("./insight-backfill-status"), exports);
+__exportStar(require("./insight-category-update"), exports);
 __exportStar(require("./instantiate-template-request"), exports);
 __exportStar(require("./item"), exports);
 __exportStar(require("./item-result"), exports);
@@ -100,6 +103,7 @@ __exportStar(require("./rename-audit"), exports);
 __exportStar(require("./rename-request"), exports);
 __exportStar(require("./reorganization-apply-request"), exports);
 __exportStar(require("./reorganization-apply-result"), exports);
+__exportStar(require("./reorganization-by-kind-request"), exports);
 __exportStar(require("./reorganization-plan-view"), exports);
 __exportStar(require("./replace-audit"), exports);
 __exportStar(require("./response"), exports);

package/dist/models/insight-category-update.d.ts

@@ -0,0 +1,14 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface InsightCategoryUpdate {
+    'category'?: string;
+}

package/dist/models/insight-category-update.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/reorganization-by-kind-request.d.ts

@@ -0,0 +1,14 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ReorganizationByKindRequest {
+    'rootFolderId'?: string;
+}

package/dist/models/reorganization-by-kind-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/settings.d.ts

@@ -19,6 +19,7 @@ export interface Settings {
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
+    'aiInsightsCategories'?: Array<string>;
     'aiAutoFileActive'?: boolean;
     'signatureActive'?: boolean;
     'pdfToolsActive'?: boolean;

package/docs/AIChatApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:8081*
 |[**get4**](#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
 |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
 |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
+|[**proposeByKind**](#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved|
 
 # **apply**
 > ReorganizationApplyResult apply()
@@ -366,3 +367,55 @@ This endpoint does not have any parameters.
 
 [[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)
 
+# **proposeByKind**
+> ReorganizationPlanView proposeByKind()
+
+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.
+
+### Example
+
+```typescript
+import {
+    AIChatApi,
+    Configuration,
+    ReorganizationByKindRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIChatApi(configuration);
+
+let reorganizationByKindRequest: ReorganizationByKindRequest; // (optional)
+
+const { status, data } = await apiInstance.proposeByKind(
+    reorganizationByKindRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reorganizationByKindRequest** | **ReorganizationByKindRequest**|  | |
+
+
+### Return type
+
+**ReorganizationPlanView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/AIEmbeddingsApi.md

@@ -0,0 +1,111 @@
+# AIEmbeddingsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**backfill1**](#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents|
+|[**backfillStatus1**](#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job|
+
+# **backfill1**
+> EmbeddingBackfillStatus backfill1()
+
+Queues every FILE without a chunk in the vector store (or every FILE when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. Run it after wiping the vector store for an embedding-provider switch.
+
+### Example
+
+```typescript
+import {
+    AIEmbeddingsApi,
+    Configuration,
+    EmbeddingBackfillRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIEmbeddingsApi(configuration);
+
+let embeddingBackfillRequest: EmbeddingBackfillRequest; // (optional)
+
+const { status, data } = await apiInstance.backfill1(
+    embeddingBackfillRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **embeddingBackfillRequest** | **EmbeddingBackfillRequest**|  | |
+
+
+### Return type
+
+**EmbeddingBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **backfillStatus1**
+> EmbeddingBackfillStatus backfillStatus1()
+
+
+### Example
+
+```typescript
+import {
+    AIEmbeddingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIEmbeddingsApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.backfillStatus1(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**EmbeddingBackfillStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/DocumentInsightsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8081*
 |[**backfill**](#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents|
 |[**backfillStatus**](#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job|
 |[**getInsights**](#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document|
+|[**setCategory**](#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document|
 
 # **backfill**
 > InsightBackfillStatus backfill()
@@ -161,3 +162,58 @@ const { status, data } = await apiInstance.getInsights(
 
 [[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)
 
+# **setCategory**
+> DocumentInsightView setCategory(insightCategoryUpdate)
+
+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.
+
+### Example
+
+```typescript
+import {
+    DocumentInsightsApi,
+    Configuration,
+    InsightCategoryUpdate
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentInsightsApi(configuration);
+
+let documentId: string; // (default to undefined)
+let insightCategoryUpdate: InsightCategoryUpdate; //
+
+const { status, data } = await apiInstance.setCategory(
+    documentId,
+    insightCategoryUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **insightCategoryUpdate** | **InsightCategoryUpdate**|  | |
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DocumentInsightView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/EmbeddingBackfillRequest.md

@@ -0,0 +1,22 @@
+# EmbeddingBackfillRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folderId** | **string** |  | [optional] [default to undefined]
+**force** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmbeddingBackfillRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: EmbeddingBackfillRequest = {
+    folderId,
+    force,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EmbeddingBackfillStatus.md

@@ -0,0 +1,38 @@
+# EmbeddingBackfillStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**folderId** | **string** |  | [optional] [default to undefined]
+**force** | **boolean** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**done** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmbeddingBackfillStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: EmbeddingBackfillStatus = {
+    jobId,
+    folderId,
+    force,
+    status,
+    total,
+    done,
+    failed,
+    skipped,
+    startedAt,
+    finishedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InsightCategoryUpdate.md

@@ -0,0 +1,20 @@
+# InsightCategoryUpdate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InsightCategoryUpdate } from '@openfilz-sdk/typescript-ee';
+
+const instance: InsightCategoryUpdate = {
+    category,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReorganizationByKindRequest.md

@@ -0,0 +1,20 @@
+# ReorganizationByKindRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rootFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReorganizationByKindRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReorganizationByKindRequest = {
+    rootFolderId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)