@openfilz-sdk/typescript 1.3.19 → 1.3.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +7 -2
- package/api/document-insights-api.ts +71 -4
- package/api/settings-api.ts +18 -11
- package/api/smart-filing-api.ts +73 -0
- package/dist/api/document-insights-api.d.ts +33 -4
- package/dist/api/document-insights-api.js +66 -4
- package/dist/api/settings-api.d.ts +12 -8
- package/dist/api/settings-api.js +18 -11
- package/dist/api/smart-filing-api.d.ts +33 -0
- package/dist/api/smart-filing-api.js +68 -0
- package/dist/esm/api/document-insights-api.d.ts +33 -4
- package/dist/esm/api/document-insights-api.js +66 -4
- package/dist/esm/api/settings-api.d.ts +12 -8
- package/dist/esm/api/settings-api.js +18 -11
- package/dist/esm/api/smart-filing-api.d.ts +33 -0
- package/dist/esm/api/smart-filing-api.js +68 -0
- package/dist/esm/models/ai-preferences-view.d.ts +3 -0
- package/dist/esm/models/auto-file-inbox-request.d.ts +14 -0
- package/dist/esm/models/auto-file-inbox-request.js +14 -0
- package/dist/esm/models/facet.d.ts +15 -0
- package/dist/esm/models/facet.js +14 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/models/insight-facets.d.ts +16 -0
- package/dist/esm/models/insight-facets.js +14 -0
- package/dist/esm/models/save-ai-preferences-request.d.ts +1 -0
- package/dist/esm/models/settings.d.ts +1 -0
- package/dist/models/ai-preferences-view.d.ts +3 -0
- package/dist/models/auto-file-inbox-request.d.ts +14 -0
- package/dist/models/auto-file-inbox-request.js +15 -0
- package/dist/models/facet.d.ts +15 -0
- package/dist/models/facet.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/insight-facets.d.ts +16 -0
- package/dist/models/insight-facets.js +15 -0
- package/dist/models/save-ai-preferences-request.d.ts +1 -0
- package/dist/models/settings.d.ts +1 -0
- package/docs/AiPreferencesView.md +6 -0
- package/docs/AutoFileInboxRequest.md +20 -0
- package/docs/DocumentInsightsApi.md +46 -1
- package/docs/Facet.md +22 -0
- package/docs/InsightFacets.md +22 -0
- package/docs/SaveAiPreferencesRequest.md +2 -0
- package/docs/Settings.md +2 -0
- package/docs/SettingsApi.md +5 -2
- package/docs/SmartFilingApi.md +53 -0
- package/graphql/document-search.graphqls +4 -0
- package/graphql/document.graphqls +4 -0
- package/models/ai-preferences-view.ts +3 -0
- package/models/auto-file-inbox-request.ts +20 -0
- package/models/facet.ts +21 -0
- package/models/index.ts +3 -0
- package/models/insight-facets.ts +24 -0
- package/models/save-ai-preferences-request.ts +1 -0
- package/models/settings.ts +1 -0
- package/package.json +1 -1
|
@@ -99,6 +99,35 @@ const DocumentInsightsApiAxiosParamCreator = function (configuration) {
|
|
|
99
99
|
options: localVarRequestOptions,
|
|
100
100
|
};
|
|
101
101
|
}),
|
|
102
|
+
/**
|
|
103
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
104
|
+
* @summary The category and language facets of the library
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
facets: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
109
|
+
const localVarPath = `/api/v1/ai/insights/facets`;
|
|
110
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
111
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
112
|
+
let baseOptions;
|
|
113
|
+
if (configuration) {
|
|
114
|
+
baseOptions = configuration.baseOptions;
|
|
115
|
+
}
|
|
116
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
117
|
+
const localVarHeaderParameter = {};
|
|
118
|
+
const localVarQueryParameter = {};
|
|
119
|
+
// authentication keycloak_auth required
|
|
120
|
+
// http bearer authentication required
|
|
121
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
122
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
123
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
124
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
125
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
126
|
+
return {
|
|
127
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
128
|
+
options: localVarRequestOptions,
|
|
129
|
+
};
|
|
130
|
+
}),
|
|
102
131
|
/**
|
|
103
132
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
104
133
|
* @summary Get the insights of a document
|
|
@@ -133,7 +162,7 @@ const DocumentInsightsApiAxiosParamCreator = function (configuration) {
|
|
|
133
162
|
};
|
|
134
163
|
}),
|
|
135
164
|
/**
|
|
136
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
165
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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.
|
|
137
166
|
* @summary Correct the kind of a document
|
|
138
167
|
* @param {string} documentId
|
|
139
168
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -211,6 +240,21 @@ const DocumentInsightsApiFp = function (configuration) {
|
|
|
211
240
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
212
241
|
});
|
|
213
242
|
},
|
|
243
|
+
/**
|
|
244
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
245
|
+
* @summary The category and language facets of the library
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
facets(options) {
|
|
250
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
251
|
+
var _a, _b, _c;
|
|
252
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.facets(options);
|
|
253
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
254
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentInsightsApi.facets']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
255
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
256
|
+
});
|
|
257
|
+
},
|
|
214
258
|
/**
|
|
215
259
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
216
260
|
* @summary Get the insights of a document
|
|
@@ -228,7 +272,7 @@ const DocumentInsightsApiFp = function (configuration) {
|
|
|
228
272
|
});
|
|
229
273
|
},
|
|
230
274
|
/**
|
|
231
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
275
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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.
|
|
232
276
|
* @summary Correct the kind of a document
|
|
233
277
|
* @param {string} documentId
|
|
234
278
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -273,6 +317,15 @@ const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
|
|
|
273
317
|
backfillStatus(jobId, options) {
|
|
274
318
|
return localVarFp.backfillStatus(jobId, options).then((request) => request(axios, basePath));
|
|
275
319
|
},
|
|
320
|
+
/**
|
|
321
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
322
|
+
* @summary The category and language facets of the library
|
|
323
|
+
* @param {*} [options] Override http request option.
|
|
324
|
+
* @throws {RequiredError}
|
|
325
|
+
*/
|
|
326
|
+
facets(options) {
|
|
327
|
+
return localVarFp.facets(options).then((request) => request(axios, basePath));
|
|
328
|
+
},
|
|
276
329
|
/**
|
|
277
330
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
278
331
|
* @summary Get the insights of a document
|
|
@@ -284,7 +337,7 @@ const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
|
|
|
284
337
|
return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
|
|
285
338
|
},
|
|
286
339
|
/**
|
|
287
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
340
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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.
|
|
288
341
|
* @summary Correct the kind of a document
|
|
289
342
|
* @param {string} documentId
|
|
290
343
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -321,6 +374,15 @@ class DocumentInsightsApi extends base_1.BaseAPI {
|
|
|
321
374
|
backfillStatus(jobId, options) {
|
|
322
375
|
return (0, exports.DocumentInsightsApiFp)(this.configuration).backfillStatus(jobId, options).then((request) => request(this.axios, this.basePath));
|
|
323
376
|
}
|
|
377
|
+
/**
|
|
378
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
379
|
+
* @summary The category and language facets of the library
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
*/
|
|
383
|
+
facets(options) {
|
|
384
|
+
return (0, exports.DocumentInsightsApiFp)(this.configuration).facets(options).then((request) => request(this.axios, this.basePath));
|
|
385
|
+
}
|
|
324
386
|
/**
|
|
325
387
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
326
388
|
* @summary Get the insights of a document
|
|
@@ -332,7 +394,7 @@ class DocumentInsightsApi extends base_1.BaseAPI {
|
|
|
332
394
|
return (0, exports.DocumentInsightsApiFp)(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
333
395
|
}
|
|
334
396
|
/**
|
|
335
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
397
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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.
|
|
336
398
|
* @summary Correct the kind of a document
|
|
337
399
|
* @param {string} documentId
|
|
338
400
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -34,13 +34,14 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34
34
|
*/
|
|
35
35
|
getSettings1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* A null field leaves the current value unchanged.
|
|
37
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
38
38
|
* @summary Save the caller\'s smart-filing preferences
|
|
39
39
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
40
|
+
* @param {string} [acceptLanguage]
|
|
40
41
|
* @param {*} [options] Override http request option.
|
|
41
42
|
* @throws {RequiredError}
|
|
42
43
|
*/
|
|
43
|
-
save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
45
|
};
|
|
45
46
|
/**
|
|
46
47
|
* SettingsApi - functional programming interface
|
|
@@ -61,13 +62,14 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
|
|
|
61
62
|
*/
|
|
62
63
|
getSettings1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
|
|
63
64
|
/**
|
|
64
|
-
* A null field leaves the current value unchanged.
|
|
65
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
65
66
|
* @summary Save the caller\'s smart-filing preferences
|
|
66
67
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
68
|
+
* @param {string} [acceptLanguage]
|
|
67
69
|
* @param {*} [options] Override http request option.
|
|
68
70
|
* @throws {RequiredError}
|
|
69
71
|
*/
|
|
70
|
-
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
|
|
72
|
+
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
|
|
71
73
|
};
|
|
72
74
|
/**
|
|
73
75
|
* SettingsApi - factory interface
|
|
@@ -88,13 +90,14 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
|
|
|
88
90
|
*/
|
|
89
91
|
getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
|
|
90
92
|
/**
|
|
91
|
-
* A null field leaves the current value unchanged.
|
|
93
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
92
94
|
* @summary Save the caller\'s smart-filing preferences
|
|
93
95
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
96
|
+
* @param {string} [acceptLanguage]
|
|
94
97
|
* @param {*} [options] Override http request option.
|
|
95
98
|
* @throws {RequiredError}
|
|
96
99
|
*/
|
|
97
|
-
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
|
|
100
|
+
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
|
|
98
101
|
};
|
|
99
102
|
/**
|
|
100
103
|
* SettingsApi - object-oriented interface
|
|
@@ -115,11 +118,12 @@ export declare class SettingsApi extends BaseAPI {
|
|
|
115
118
|
*/
|
|
116
119
|
getSettings1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
|
|
117
120
|
/**
|
|
118
|
-
* A null field leaves the current value unchanged.
|
|
121
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
119
122
|
* @summary Save the caller\'s smart-filing preferences
|
|
120
123
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
124
|
+
* @param {string} [acceptLanguage]
|
|
121
125
|
* @param {*} [options] Override http request option.
|
|
122
126
|
* @throws {RequiredError}
|
|
123
127
|
*/
|
|
124
|
-
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
|
|
128
|
+
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
|
|
125
129
|
}
|
package/dist/api/settings-api.js
CHANGED
|
@@ -93,13 +93,14 @@ const SettingsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
};
|
|
94
94
|
}),
|
|
95
95
|
/**
|
|
96
|
-
* A null field leaves the current value unchanged.
|
|
96
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
97
97
|
* @summary Save the caller\'s smart-filing preferences
|
|
98
98
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
99
|
+
* @param {string} [acceptLanguage]
|
|
99
100
|
* @param {*} [options] Override http request option.
|
|
100
101
|
* @throws {RequiredError}
|
|
101
102
|
*/
|
|
102
|
-
save: (saveAiPreferencesRequest_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, ...args_1], void 0, function* (saveAiPreferencesRequest, options = {}) {
|
|
103
|
+
save: (saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1], void 0, function* (saveAiPreferencesRequest, acceptLanguage, options = {}) {
|
|
103
104
|
// verify required parameter 'saveAiPreferencesRequest' is not null or undefined
|
|
104
105
|
(0, common_1.assertParamExists)('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest);
|
|
105
106
|
const localVarPath = `/api/v1/settings/ai/preferences`;
|
|
@@ -117,6 +118,9 @@ const SettingsApiAxiosParamCreator = function (configuration) {
|
|
|
117
118
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
118
119
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
119
120
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
121
|
+
if (acceptLanguage != null) {
|
|
122
|
+
localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
|
|
123
|
+
}
|
|
120
124
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
121
125
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
122
126
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -166,16 +170,17 @@ const SettingsApiFp = function (configuration) {
|
|
|
166
170
|
});
|
|
167
171
|
},
|
|
168
172
|
/**
|
|
169
|
-
* A null field leaves the current value unchanged.
|
|
173
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
170
174
|
* @summary Save the caller\'s smart-filing preferences
|
|
171
175
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
176
|
+
* @param {string} [acceptLanguage]
|
|
172
177
|
* @param {*} [options] Override http request option.
|
|
173
178
|
* @throws {RequiredError}
|
|
174
179
|
*/
|
|
175
|
-
save(saveAiPreferencesRequest, options) {
|
|
180
|
+
save(saveAiPreferencesRequest, acceptLanguage, options) {
|
|
176
181
|
return __awaiter(this, void 0, void 0, function* () {
|
|
177
182
|
var _a, _b, _c;
|
|
178
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
|
|
183
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, acceptLanguage, options);
|
|
179
184
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
180
185
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SettingsApi.save']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
181
186
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -209,14 +214,15 @@ const SettingsApiFactory = function (configuration, basePath, axios) {
|
|
|
209
214
|
return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
|
|
210
215
|
},
|
|
211
216
|
/**
|
|
212
|
-
* A null field leaves the current value unchanged.
|
|
217
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
213
218
|
* @summary Save the caller\'s smart-filing preferences
|
|
214
219
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
220
|
+
* @param {string} [acceptLanguage]
|
|
215
221
|
* @param {*} [options] Override http request option.
|
|
216
222
|
* @throws {RequiredError}
|
|
217
223
|
*/
|
|
218
|
-
save(saveAiPreferencesRequest, options) {
|
|
219
|
-
return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
|
|
224
|
+
save(saveAiPreferencesRequest, acceptLanguage, options) {
|
|
225
|
+
return localVarFp.save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(axios, basePath));
|
|
220
226
|
},
|
|
221
227
|
};
|
|
222
228
|
};
|
|
@@ -244,14 +250,15 @@ class SettingsApi extends base_1.BaseAPI {
|
|
|
244
250
|
return (0, exports.SettingsApiFp)(this.configuration).getSettings1(options).then((request) => request(this.axios, this.basePath));
|
|
245
251
|
}
|
|
246
252
|
/**
|
|
247
|
-
* A null field leaves the current value unchanged.
|
|
253
|
+
* A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
|
|
248
254
|
* @summary Save the caller\'s smart-filing preferences
|
|
249
255
|
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
256
|
+
* @param {string} [acceptLanguage]
|
|
250
257
|
* @param {*} [options] Override http request option.
|
|
251
258
|
* @throws {RequiredError}
|
|
252
259
|
*/
|
|
253
|
-
save(saveAiPreferencesRequest, options) {
|
|
254
|
-
return (0, exports.SettingsApiFp)(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
260
|
+
save(saveAiPreferencesRequest, acceptLanguage, options) {
|
|
261
|
+
return (0, exports.SettingsApiFp)(this.configuration).save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(this.axios, this.basePath));
|
|
255
262
|
}
|
|
256
263
|
}
|
|
257
264
|
exports.SettingsApi = SettingsApi;
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AutoFileInboxRequest } from '../models';
|
|
15
16
|
import type { AutoFileJobView } from '../models';
|
|
16
17
|
import type { AutoFileJobsRequest } from '../models';
|
|
17
18
|
import type { AutoFileRequest } from '../models';
|
|
@@ -28,6 +29,14 @@ export declare const SmartFilingApiAxiosParamCreator: (configuration?: Configura
|
|
|
28
29
|
* @throws {RequiredError}
|
|
29
30
|
*/
|
|
30
31
|
file: (autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
34
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
35
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
fileInbox: (autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
40
|
/**
|
|
32
41
|
*
|
|
33
42
|
* @summary Progress and outcome of a filing job
|
|
@@ -81,6 +90,14 @@ export declare const SmartFilingApiFp: (configuration?: Configuration) => {
|
|
|
81
90
|
* @throws {RequiredError}
|
|
82
91
|
*/
|
|
83
92
|
file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
|
|
93
|
+
/**
|
|
94
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
95
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
96
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
|
|
84
101
|
/**
|
|
85
102
|
*
|
|
86
103
|
* @summary Progress and outcome of a filing job
|
|
@@ -134,6 +151,14 @@ export declare const SmartFilingApiFactory: (configuration?: Configuration, base
|
|
|
134
151
|
* @throws {RequiredError}
|
|
135
152
|
*/
|
|
136
153
|
file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
|
|
154
|
+
/**
|
|
155
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
156
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
157
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
|
|
137
162
|
/**
|
|
138
163
|
*
|
|
139
164
|
* @summary Progress and outcome of a filing job
|
|
@@ -187,6 +212,14 @@ export declare class SmartFilingApi extends BaseAPI {
|
|
|
187
212
|
* @throws {RequiredError}
|
|
188
213
|
*/
|
|
189
214
|
file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
|
|
215
|
+
/**
|
|
216
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
217
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
218
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
|
|
190
223
|
/**
|
|
191
224
|
*
|
|
192
225
|
* @summary Progress and outcome of a filing job
|
|
@@ -68,6 +68,38 @@ const SmartFilingApiAxiosParamCreator = function (configuration) {
|
|
|
68
68
|
options: localVarRequestOptions,
|
|
69
69
|
};
|
|
70
70
|
}),
|
|
71
|
+
/**
|
|
72
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
73
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
74
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
fileInbox: (autoFileInboxRequest_1, ...args_1) => __awaiter(this, [autoFileInboxRequest_1, ...args_1], void 0, function* (autoFileInboxRequest, options = {}) {
|
|
79
|
+
const localVarPath = `/api/v1/ai/auto-file/inbox`;
|
|
80
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
81
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
82
|
+
let baseOptions;
|
|
83
|
+
if (configuration) {
|
|
84
|
+
baseOptions = configuration.baseOptions;
|
|
85
|
+
}
|
|
86
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
87
|
+
const localVarHeaderParameter = {};
|
|
88
|
+
const localVarQueryParameter = {};
|
|
89
|
+
// authentication keycloak_auth required
|
|
90
|
+
// http bearer authentication required
|
|
91
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
92
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
93
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
94
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
95
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
96
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
97
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(autoFileInboxRequest, localVarRequestOptions, configuration);
|
|
98
|
+
return {
|
|
99
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
100
|
+
options: localVarRequestOptions,
|
|
101
|
+
};
|
|
102
|
+
}),
|
|
71
103
|
/**
|
|
72
104
|
*
|
|
73
105
|
* @summary Progress and outcome of a filing job
|
|
@@ -259,6 +291,22 @@ const SmartFilingApiFp = function (configuration) {
|
|
|
259
291
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
260
292
|
});
|
|
261
293
|
},
|
|
294
|
+
/**
|
|
295
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
296
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
297
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
fileInbox(autoFileInboxRequest, options) {
|
|
302
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
303
|
+
var _a, _b, _c;
|
|
304
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.fileInbox(autoFileInboxRequest, options);
|
|
305
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
306
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SmartFilingApi.fileInbox']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
307
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
308
|
+
});
|
|
309
|
+
},
|
|
262
310
|
/**
|
|
263
311
|
*
|
|
264
312
|
* @summary Progress and outcome of a filing job
|
|
@@ -358,6 +406,16 @@ const SmartFilingApiFactory = function (configuration, basePath, axios) {
|
|
|
358
406
|
file(autoFileRequest, options) {
|
|
359
407
|
return localVarFp.file(autoFileRequest, options).then((request) => request(axios, basePath));
|
|
360
408
|
},
|
|
409
|
+
/**
|
|
410
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
411
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
412
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
413
|
+
* @param {*} [options] Override http request option.
|
|
414
|
+
* @throws {RequiredError}
|
|
415
|
+
*/
|
|
416
|
+
fileInbox(autoFileInboxRequest, options) {
|
|
417
|
+
return localVarFp.fileInbox(autoFileInboxRequest, options).then((request) => request(axios, basePath));
|
|
418
|
+
},
|
|
361
419
|
/**
|
|
362
420
|
*
|
|
363
421
|
* @summary Progress and outcome of a filing job
|
|
@@ -425,6 +483,16 @@ class SmartFilingApi extends base_1.BaseAPI {
|
|
|
425
483
|
file(autoFileRequest, options) {
|
|
426
484
|
return (0, exports.SmartFilingApiFp)(this.configuration).file(autoFileRequest, options).then((request) => request(this.axios, this.basePath));
|
|
427
485
|
}
|
|
486
|
+
/**
|
|
487
|
+
* Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
|
|
488
|
+
* @summary File everything lying loose in the caller\'s Inbox
|
|
489
|
+
* @param {AutoFileInboxRequest} [autoFileInboxRequest]
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
fileInbox(autoFileInboxRequest, options) {
|
|
494
|
+
return (0, exports.SmartFilingApiFp)(this.configuration).fileInbox(autoFileInboxRequest, options).then((request) => request(this.axios, this.basePath));
|
|
495
|
+
}
|
|
428
496
|
/**
|
|
429
497
|
*
|
|
430
498
|
* @summary Progress and outcome of a filing job
|
|
@@ -16,6 +16,7 @@ import type { DocumentInsightView } from '../models';
|
|
|
16
16
|
import type { InsightBackfillRequest } from '../models';
|
|
17
17
|
import type { InsightBackfillStatus } from '../models';
|
|
18
18
|
import type { InsightCategoryUpdate } from '../models';
|
|
19
|
+
import type { InsightFacets } from '../models';
|
|
19
20
|
/**
|
|
20
21
|
* DocumentInsightsApi - axios parameter creator
|
|
21
22
|
*/
|
|
@@ -36,6 +37,13 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
|
|
|
36
37
|
* @throws {RequiredError}
|
|
37
38
|
*/
|
|
38
39
|
backfillStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
42
|
+
* @summary The category and language facets of the library
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
facets: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
47
|
/**
|
|
40
48
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
41
49
|
* @summary Get the insights of a document
|
|
@@ -45,7 +53,7 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
|
|
|
45
53
|
*/
|
|
46
54
|
getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
55
|
/**
|
|
48
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
56
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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
57
|
* @summary Correct the kind of a document
|
|
50
58
|
* @param {string} documentId
|
|
51
59
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -74,6 +82,13 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
|
|
|
74
82
|
* @throws {RequiredError}
|
|
75
83
|
*/
|
|
76
84
|
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
|
|
85
|
+
/**
|
|
86
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
87
|
+
* @summary The category and language facets of the library
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
facets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightFacets>>;
|
|
77
92
|
/**
|
|
78
93
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
79
94
|
* @summary Get the insights of a document
|
|
@@ -83,7 +98,7 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
|
|
|
83
98
|
*/
|
|
84
99
|
getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
|
|
85
100
|
/**
|
|
86
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
101
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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
102
|
* @summary Correct the kind of a document
|
|
88
103
|
* @param {string} documentId
|
|
89
104
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -112,6 +127,13 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
|
|
|
112
127
|
* @throws {RequiredError}
|
|
113
128
|
*/
|
|
114
129
|
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
|
|
130
|
+
/**
|
|
131
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
132
|
+
* @summary The category and language facets of the library
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
facets(options?: RawAxiosRequestConfig): AxiosPromise<InsightFacets>;
|
|
115
137
|
/**
|
|
116
138
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
117
139
|
* @summary Get the insights of a document
|
|
@@ -121,7 +143,7 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
|
|
|
121
143
|
*/
|
|
122
144
|
getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
|
|
123
145
|
/**
|
|
124
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
146
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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
147
|
* @summary Correct the kind of a document
|
|
126
148
|
* @param {string} documentId
|
|
127
149
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|
|
@@ -150,6 +172,13 @@ export declare class DocumentInsightsApi extends BaseAPI {
|
|
|
150
172
|
* @throws {RequiredError}
|
|
151
173
|
*/
|
|
152
174
|
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}>>;
|
|
175
|
+
/**
|
|
176
|
+
* How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
|
|
177
|
+
* @summary The category and language facets of the library
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
facets(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightFacets, any, {}>>;
|
|
153
182
|
/**
|
|
154
183
|
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
155
184
|
* @summary Get the insights of a document
|
|
@@ -159,7 +188,7 @@ export declare class DocumentInsightsApi extends BaseAPI {
|
|
|
159
188
|
*/
|
|
160
189
|
getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}>>;
|
|
161
190
|
/**
|
|
162
|
-
* Sets the tier-2 category to one of the deployment\'s
|
|
191
|
+
* Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: 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
192
|
* @summary Correct the kind of a document
|
|
164
193
|
* @param {string} documentId
|
|
165
194
|
* @param {InsightCategoryUpdate} insightCategoryUpdate
|