@openfilz-sdk/typescript-ee 1.9.7 → 1.9.9

package/.openapi-generator/FILES

@@ -4,6 +4,7 @@
 README.md
 api.ts
 api/aichat-api.ts
+api/aiembeddings-api.ts
 api/aisettings-api.ts
 api/collaboration-audit-controller-api.ts
 api/collaboration-controller-api.ts
@@ -40,6 +41,7 @@ base.ts
 common.ts
 configuration.ts
 docs/AIChatApi.md
+docs/AIEmbeddingsApi.md
 docs/AISettingsApi.md
 docs/AiChatConversation.md
 docs/AiChatRequest.md
@@ -102,6 +104,8 @@ docs/ESignPublicApi.md
 docs/ESignTemplatesApi.md
 docs/ElementInfo.md
 docs/EmbedUrlResponse.md
+docs/EmbeddingBackfillRequest.md
+docs/EmbeddingBackfillStatus.md
 docs/EnrichedAuditLog.md
 docs/EnrichedAuditLogDetails.md
 docs/FavoritesApi.md
@@ -117,6 +121,7 @@ docs/FolderResponse.md
 docs/IngestionStatusDto.md
 docs/InsightBackfillRequest.md
 docs/InsightBackfillStatus.md
+docs/InsightCategoryUpdate.md
 docs/InstantiateTemplateRequest.md
 docs/Item.md
 docs/ItemResult.md
@@ -149,6 +154,7 @@ docs/RenameAudit.md
 docs/RenameRequest.md
 docs/ReorganizationApplyRequest.md
 docs/ReorganizationApplyResult.md
+docs/ReorganizationByKindRequest.md
 docs/ReorganizationPlanView.md
 docs/ReplaceAudit.md
 docs/Response.md
@@ -262,6 +268,8 @@ models/document-position.ts
 models/document-version-info.ts
 models/element-info.ts
 models/embed-url-response.ts
+models/embedding-backfill-request.ts
+models/embedding-backfill-status.ts
 models/enriched-audit-log-details.ts
 models/enriched-audit-log.ts
 models/feature-entitlement.ts
@@ -274,6 +282,7 @@ models/index.ts
 models/ingestion-status-dto.ts
 models/insight-backfill-request.ts
 models/insight-backfill-status.ts
+models/insight-category-update.ts
 models/instantiate-template-request.ts
 models/item-result.ts
 models/item.ts
@@ -302,6 +311,7 @@ models/rename-audit.ts
 models/rename-request.ts
 models/reorganization-apply-request.ts
 models/reorganization-apply-result.ts
+models/reorganization-by-kind-request.ts
 models/reorganization-plan-view.ts
 models/replace-audit.ts
 models/response.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-ae1ec3aaf97f1fdfd8b0b5700b9c87eabe9527c1c2aecfd12fa72d2c2c9586c7
+b3121981b96de40beec62c83a14b52b401783a54fac29aa7877dcd3b90549102

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript-ee@1.9.7
+## @openfilz-sdk/typescript-ee@1.9.9
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript-ee@1.9.7 --save
+npm install @openfilz-sdk/typescript-ee@1.9.9 --save
 ```
 
 _unPublished (not recommended):_
@@ -58,6 +58,9 @@ Class | Method | HTTP request | Description
 *AIChatApi* | [**get4**](docs/AIChatApi.md#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant
 *AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
 *AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
+*AIChatApi* | [**proposeByKind**](docs/AIChatApi.md#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved
+*AIEmbeddingsApi* | [**backfill1**](docs/AIEmbeddingsApi.md#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents
+*AIEmbeddingsApi* | [**backfillStatus1**](docs/AIEmbeddingsApi.md#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job
 *AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
 *AISettingsApi* | [**getSettings1**](docs/AISettingsApi.md#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings
 *AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
@@ -113,6 +116,7 @@ Class | Method | HTTP request | Description
 *DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
 *DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
 *DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
+*DocumentInsightsApi* | [**setCategory**](docs/DocumentInsightsApi.md#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document
 *DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions | 
 *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
 *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
@@ -266,6 +270,8 @@ Class | Method | HTTP request | Description
  - [DocumentVersionInfo](docs/DocumentVersionInfo.md)
  - [ElementInfo](docs/ElementInfo.md)
  - [EmbedUrlResponse](docs/EmbedUrlResponse.md)
+ - [EmbeddingBackfillRequest](docs/EmbeddingBackfillRequest.md)
+ - [EmbeddingBackfillStatus](docs/EmbeddingBackfillStatus.md)
  - [EnrichedAuditLog](docs/EnrichedAuditLog.md)
  - [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
  - [FeatureEntitlement](docs/FeatureEntitlement.md)
@@ -277,6 +283,7 @@ Class | Method | HTTP request | Description
  - [IngestionStatusDto](docs/IngestionStatusDto.md)
  - [InsightBackfillRequest](docs/InsightBackfillRequest.md)
  - [InsightBackfillStatus](docs/InsightBackfillStatus.md)
+ - [InsightCategoryUpdate](docs/InsightCategoryUpdate.md)
  - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
  - [Item](docs/Item.md)
  - [ItemResult](docs/ItemResult.md)
@@ -305,6 +312,7 @@ Class | Method | HTTP request | Description
  - [RenameRequest](docs/RenameRequest.md)
  - [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
  - [ReorganizationApplyResult](docs/ReorganizationApplyResult.md)
+ - [ReorganizationByKindRequest](docs/ReorganizationByKindRequest.md)
  - [ReorganizationPlanView](docs/ReorganizationPlanView.md)
  - [ReplaceAudit](docs/ReplaceAudit.md)
  - [Response](docs/Response.md)

package/api/aichat-api.ts

@@ -32,6 +32,8 @@ import type { ReorganizationApplyRequest } from '../models';
 // @ts-ignore
 import type { ReorganizationApplyResult } from '../models';
 // @ts-ignore
+import type { ReorganizationByKindRequest } from '../models';
+// @ts-ignore
 import type { ReorganizationPlanView } from '../models';
 /**
  * AIChatApi - axios parameter creator
@@ -298,6 +300,43 @@ export const AIChatApiAxiosParamCreator = function (configuration?: Configuratio
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind: async (reorganizationByKindRequest?: ReorganizationByKindRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/reorganization/by-kind`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(reorganizationByKindRequest, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -403,6 +442,19 @@ export const AIChatApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AIChatApi.listConversations']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.proposeByKind(reorganizationByKindRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIChatApi.proposeByKind']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -482,6 +534,16 @@ export const AIChatApiFactory = function (configuration?: Configuration, basePat
         listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>> {
             return localVarFp.listConversations(options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Propose a reorganisation by kind of document — no model involved
+         * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView> {
+            return localVarFp.proposeByKind(reorganizationByKindRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -565,5 +627,16 @@ export class AIChatApi extends BaseAPI {
     public listConversations(options?: RawAxiosRequestConfig) {
         return AIChatApiFp(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 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.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) {
+        return AIChatApiFp(this.configuration).proposeByKind(reorganizationByKindRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/api/aiembeddings-api.ts

@@ -0,0 +1,201 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { EmbeddingBackfillRequest } from '../models';
+// @ts-ignore
+import type { EmbeddingBackfillStatus } from '../models';
+/**
+ * AIEmbeddingsApi - axios parameter creator
+ */
+export const AIEmbeddingsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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.
+         * @summary Embed existing documents
+         * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfill1: async (embeddingBackfillRequest?: EmbeddingBackfillRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/ai/embeddings/backfill`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(embeddingBackfillRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Progress of an embedding backfill job
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfillStatus1: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'jobId' is not null or undefined
+            assertParamExists('backfillStatus1', 'jobId', jobId)
+            const localVarPath = `/api/v1/ai/embeddings/backfill/{jobId}`
+                .replace('{jobId}', encodeURIComponent(String(jobId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AIEmbeddingsApi - functional programming interface
+ */
+export const AIEmbeddingsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AIEmbeddingsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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.
+         * @summary Embed existing documents
+         * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.backfill1(embeddingBackfillRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIEmbeddingsApi.backfill1']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Progress of an embedding backfill job
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.backfillStatus1(jobId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AIEmbeddingsApi.backfillStatus1']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * AIEmbeddingsApi - factory interface
+ */
+export const AIEmbeddingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AIEmbeddingsApiFp(configuration)
+    return {
+        /**
+         * 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.
+         * @summary Embed existing documents
+         * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus> {
+            return localVarFp.backfill1(embeddingBackfillRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Progress of an embedding backfill job
+         * @param {string} jobId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus> {
+            return localVarFp.backfillStatus1(jobId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * AIEmbeddingsApi - object-oriented interface
+ */
+export class AIEmbeddingsApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Embed existing documents
+     * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig) {
+        return AIEmbeddingsApiFp(this.configuration).backfill1(embeddingBackfillRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Progress of an embedding backfill job
+     * @param {string} jobId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public backfillStatus1(jobId: string, options?: RawAxiosRequestConfig) {
+        return AIEmbeddingsApiFp(this.configuration).backfillStatus1(jobId, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api/document-insights-api.ts

@@ -27,6 +27,8 @@ import type { DocumentInsightView } from '../models';
 import type { InsightBackfillRequest } from '../models';
 // @ts-ignore
 import type { InsightBackfillStatus } from '../models';
+// @ts-ignore
+import type { InsightCategoryUpdate } from '../models';
 /**
  * DocumentInsightsApi - axios parameter creator
  */
@@ -140,6 +142,49 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration?: Co
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId 
+         * @param {InsightCategoryUpdate} insightCategoryUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCategory: async (documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'documentId' is not null or undefined
+            assertParamExists('setCategory', 'documentId', documentId)
+            // verify required parameter 'insightCategoryUpdate' is not null or undefined
+            assertParamExists('setCategory', 'insightCategoryUpdate', insightCategoryUpdate)
+            const localVarPath = `/api/v1/documents/{documentId}/insights`
+                .replace('{documentId}', encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(insightCategoryUpdate, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -193,6 +238,20 @@ export const DocumentInsightsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.getInsights']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId 
+         * @param {InsightCategoryUpdate} insightCategoryUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setCategory(documentId, insightCategoryUpdate, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.setCategory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -232,6 +291,17 @@ export const DocumentInsightsApiFactory = function (configuration?: Configuratio
         getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView> {
             return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Correct the kind of a document
+         * @param {string} documentId 
+         * @param {InsightCategoryUpdate} insightCategoryUpdate 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView> {
+            return localVarFp.setCategory(documentId, insightCategoryUpdate, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -271,5 +341,17 @@ export class DocumentInsightsApi extends BaseAPI {
     public getInsights(documentId: string, options?: RawAxiosRequestConfig) {
         return DocumentInsightsApiFp(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 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.
+     * @summary Correct the kind of a document
+     * @param {string} documentId 
+     * @param {InsightCategoryUpdate} insightCategoryUpdate 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public setCategory(documentId: string, insightCategoryUpdate: InsightCategoryUpdate, options?: RawAxiosRequestConfig) {
+        return DocumentInsightsApiFp(this.configuration).setCategory(documentId, insightCategoryUpdate, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/api.ts

@@ -15,6 +15,7 @@
 
 
 export * from './api/aichat-api';
+export * from './api/aiembeddings-api';
 export * from './api/aisettings-api';
 export * from './api/collaboration-audit-controller-api';
 export * from './api/collaboration-controller-api';

package/dist/api/aichat-api.d.ts

@@ -17,6 +17,7 @@ import type { AiChatRequest } from '../models';
 import type { AiChatResponse } from '../models';
 import type { ReorganizationApplyRequest } from '../models';
 import type { ReorganizationApplyResult } from '../models';
+import type { ReorganizationByKindRequest } from '../models';
 import type { ReorganizationPlanView } from '../models';
 /**
  * AIChatApi - axios parameter creator
@@ -78,6 +79,14 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     listConversations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind: (reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AIChatApi - functional programming interface
@@ -139,6 +148,14 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatConversation>>>;
+    /**
+     * 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.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
 };
 /**
  * AIChatApi - factory interface
@@ -200,6 +217,14 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>>;
+    /**
+     * 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.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
 };
 /**
  * AIChatApi - object-oriented interface
@@ -261,4 +286,12 @@ export declare class AIChatApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listConversations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiChatConversation[], any, {}, any>>;
+    /**
+     * 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.
+     * @summary Propose a reorganisation by kind of document — no model involved
+     * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
 }