@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
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8081*
7
7
  |[**backfill**](#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents|
8
8
  |[**backfillStatus**](#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job|
9
9
  |[**getInsights**](#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document|
10
+ |[**setCategory**](#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document|
10
11
 
11
12
  # **backfill**
12
13
  > InsightBackfillStatus backfill()
@@ -161,3 +162,58 @@ const { status, data } = await apiInstance.getInsights(
161
162
 
162
163
  [[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)
163
164
 
165
+ # **setCategory**
166
+ > DocumentInsightView setCategory(insightCategoryUpdate)
167
+
168
+ 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.
169
+
170
+ ### Example
171
+
172
+ ```typescript
173
+ import {
174
+ DocumentInsightsApi,
175
+ Configuration,
176
+ InsightCategoryUpdate
177
+ } from '@openfilz-sdk/typescript-ee';
178
+
179
+ const configuration = new Configuration();
180
+ const apiInstance = new DocumentInsightsApi(configuration);
181
+
182
+ let documentId: string; // (default to undefined)
183
+ let insightCategoryUpdate: InsightCategoryUpdate; //
184
+
185
+ const { status, data } = await apiInstance.setCategory(
186
+ documentId,
187
+ insightCategoryUpdate
188
+ );
189
+ ```
190
+
191
+ ### Parameters
192
+
193
+ |Name | Type | Description | Notes|
194
+ |------------- | ------------- | ------------- | -------------|
195
+ | **insightCategoryUpdate** | **InsightCategoryUpdate**| | |
196
+ | **documentId** | [**string**] | | defaults to undefined|
197
+
198
+
199
+ ### Return type
200
+
201
+ **DocumentInsightView**
202
+
203
+ ### Authorization
204
+
205
+ [keycloak_auth](../README.md#keycloak_auth)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
213
+ ### HTTP response details
214
+ | Status code | Description | Response headers |
215
+ |-------------|-------------|------------------|
216
+ |**200** | OK | - |
217
+
218
+ [[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)
219
+
@@ -0,0 +1,20 @@
1
+ # InsightCategoryUpdate
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **category** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { InsightCategoryUpdate } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: InsightCategoryUpdate = {
16
+ category,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ReorganizationByKindRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **rootFolderId** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorganizationByKindRequest } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: ReorganizationByKindRequest = {
16
+ rootFolderId,
17
+ };
18
+ ```
19
+
20
+ [[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/Settings.md CHANGED
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **aiActive** | **boolean** | | [optional] [default to undefined]
15
15
  **aiUserSettingsEnabled** | **boolean** | | [optional] [default to undefined]
16
16
  **aiInsightsActive** | **boolean** | | [optional] [default to undefined]
17
+ **aiInsightsCategories** | **Array<string>** | | [optional] [default to undefined]
17
18
  **aiAutoFileActive** | **boolean** | | [optional] [default to undefined]
18
19
  **signatureActive** | **boolean** | | [optional] [default to undefined]
19
20
  **pdfToolsActive** | **boolean** | | [optional] [default to undefined]
@@ -44,6 +45,7 @@ const instance: Settings = {
44
45
  aiActive,
45
46
  aiUserSettingsEnabled,
46
47
  aiInsightsActive,
48
+ aiInsightsCategories,
47
49
  aiAutoFileActive,
48
50
  signatureActive,
49
51
  pdfToolsActive,
package/models/index.ts CHANGED
@@ -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,20 @@
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
+
15
+
16
+
17
+ export interface InsightCategoryUpdate {
18
+ 'category'?: string;
19
+ }
20
+
@@ -0,0 +1,20 @@
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
+
15
+
16
+
17
+ export interface ReorganizationByKindRequest {
18
+ 'rootFolderId'?: string;
19
+ }
20
+
@@ -24,6 +24,7 @@ export interface Settings {
24
24
  'aiActive'?: boolean;
25
25
  'aiUserSettingsEnabled'?: boolean;
26
26
  'aiInsightsActive'?: boolean;
27
+ 'aiInsightsCategories'?: Array<string>;
27
28
  'aiAutoFileActive'?: boolean;
28
29
  'signatureActive'?: boolean;
29
30
  'pdfToolsActive'?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfilz-sdk/typescript-ee",
3
- "version": "1.9.7",
3
+ "version": "1.9.8",
4
4
  "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {