@openfilz-sdk/typescript-ee 1.9.8 → 1.9.9

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.
@@ -0,0 +1,100 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { EmbeddingBackfillRequest } from '../models';
16
+ import type { EmbeddingBackfillStatus } from '../models';
17
+ /**
18
+ * AIEmbeddingsApi - axios parameter creator
19
+ */
20
+ export declare const AIEmbeddingsApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * 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.
23
+ * @summary Embed existing documents
24
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
25
+ * @param {*} [options] Override http request option.
26
+ * @throws {RequiredError}
27
+ */
28
+ backfill1: (embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
+ /**
30
+ *
31
+ * @summary Progress of an embedding backfill job
32
+ * @param {string} jobId
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ backfillStatus1: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ };
38
+ /**
39
+ * AIEmbeddingsApi - functional programming interface
40
+ */
41
+ export declare const AIEmbeddingsApiFp: (configuration?: Configuration) => {
42
+ /**
43
+ * 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.
44
+ * @summary Embed existing documents
45
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>>;
50
+ /**
51
+ *
52
+ * @summary Progress of an embedding backfill job
53
+ * @param {string} jobId
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>>;
58
+ };
59
+ /**
60
+ * AIEmbeddingsApi - factory interface
61
+ */
62
+ export declare const AIEmbeddingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63
+ /**
64
+ * 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.
65
+ * @summary Embed existing documents
66
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
67
+ * @param {*} [options] Override http request option.
68
+ * @throws {RequiredError}
69
+ */
70
+ backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus>;
71
+ /**
72
+ *
73
+ * @summary Progress of an embedding backfill job
74
+ * @param {string} jobId
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus>;
79
+ };
80
+ /**
81
+ * AIEmbeddingsApi - object-oriented interface
82
+ */
83
+ export declare class AIEmbeddingsApi extends BaseAPI {
84
+ /**
85
+ * 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.
86
+ * @summary Embed existing documents
87
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmbeddingBackfillStatus, any, {}, any>>;
92
+ /**
93
+ *
94
+ * @summary Progress of an embedding backfill job
95
+ * @param {string} jobId
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmbeddingBackfillStatus, any, {}, any>>;
100
+ }
@@ -0,0 +1,193 @@
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
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import globalAxios from 'axios';
24
+ // Some imports not used depending on template conditions
25
+ // @ts-ignore
26
+ import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
27
+ // @ts-ignore
28
+ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
29
+ /**
30
+ * AIEmbeddingsApi - axios parameter creator
31
+ */
32
+ export const AIEmbeddingsApiAxiosParamCreator = function (configuration) {
33
+ return {
34
+ /**
35
+ * 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.
36
+ * @summary Embed existing documents
37
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ backfill1: (embeddingBackfillRequest_1, ...args_1) => __awaiter(this, [embeddingBackfillRequest_1, ...args_1], void 0, function* (embeddingBackfillRequest, options = {}) {
42
+ const localVarPath = `/api/v1/ai/embeddings/backfill`;
43
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
44
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
45
+ let baseOptions;
46
+ if (configuration) {
47
+ baseOptions = configuration.baseOptions;
48
+ }
49
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
50
+ const localVarHeaderParameter = {};
51
+ const localVarQueryParameter = {};
52
+ // authentication keycloak_auth required
53
+ // http bearer authentication required
54
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
55
+ localVarHeaderParameter['Content-Type'] = 'application/json';
56
+ localVarHeaderParameter['Accept'] = 'application/json';
57
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
58
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
59
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
60
+ localVarRequestOptions.data = serializeDataIfNeeded(embeddingBackfillRequest, localVarRequestOptions, configuration);
61
+ return {
62
+ url: toPathString(localVarUrlObj),
63
+ options: localVarRequestOptions,
64
+ };
65
+ }),
66
+ /**
67
+ *
68
+ * @summary Progress of an embedding backfill job
69
+ * @param {string} jobId
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ backfillStatus1: (jobId_1, ...args_1) => __awaiter(this, [jobId_1, ...args_1], void 0, function* (jobId, options = {}) {
74
+ // verify required parameter 'jobId' is not null or undefined
75
+ assertParamExists('backfillStatus1', 'jobId', jobId);
76
+ const localVarPath = `/api/v1/ai/embeddings/backfill/{jobId}`
77
+ .replace('{jobId}', encodeURIComponent(String(jobId)));
78
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
79
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
80
+ let baseOptions;
81
+ if (configuration) {
82
+ baseOptions = configuration.baseOptions;
83
+ }
84
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
85
+ const localVarHeaderParameter = {};
86
+ const localVarQueryParameter = {};
87
+ // authentication keycloak_auth required
88
+ // http bearer authentication required
89
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
90
+ localVarHeaderParameter['Accept'] = 'application/json';
91
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
92
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
93
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
94
+ return {
95
+ url: toPathString(localVarUrlObj),
96
+ options: localVarRequestOptions,
97
+ };
98
+ }),
99
+ };
100
+ };
101
+ /**
102
+ * AIEmbeddingsApi - functional programming interface
103
+ */
104
+ export const AIEmbeddingsApiFp = function (configuration) {
105
+ const localVarAxiosParamCreator = AIEmbeddingsApiAxiosParamCreator(configuration);
106
+ return {
107
+ /**
108
+ * 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.
109
+ * @summary Embed existing documents
110
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
111
+ * @param {*} [options] Override http request option.
112
+ * @throws {RequiredError}
113
+ */
114
+ backfill1(embeddingBackfillRequest, options) {
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ var _a, _b, _c;
117
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.backfill1(embeddingBackfillRequest, options);
118
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
119
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIEmbeddingsApi.backfill1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
120
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
121
+ });
122
+ },
123
+ /**
124
+ *
125
+ * @summary Progress of an embedding backfill job
126
+ * @param {string} jobId
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ backfillStatus1(jobId, options) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
+ var _a, _b, _c;
133
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.backfillStatus1(jobId, options);
134
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
135
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIEmbeddingsApi.backfillStatus1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
136
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
137
+ });
138
+ },
139
+ };
140
+ };
141
+ /**
142
+ * AIEmbeddingsApi - factory interface
143
+ */
144
+ export const AIEmbeddingsApiFactory = function (configuration, basePath, axios) {
145
+ const localVarFp = AIEmbeddingsApiFp(configuration);
146
+ return {
147
+ /**
148
+ * 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.
149
+ * @summary Embed existing documents
150
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ backfill1(embeddingBackfillRequest, options) {
155
+ return localVarFp.backfill1(embeddingBackfillRequest, options).then((request) => request(axios, basePath));
156
+ },
157
+ /**
158
+ *
159
+ * @summary Progress of an embedding backfill job
160
+ * @param {string} jobId
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ backfillStatus1(jobId, options) {
165
+ return localVarFp.backfillStatus1(jobId, options).then((request) => request(axios, basePath));
166
+ },
167
+ };
168
+ };
169
+ /**
170
+ * AIEmbeddingsApi - object-oriented interface
171
+ */
172
+ export class AIEmbeddingsApi extends BaseAPI {
173
+ /**
174
+ * 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.
175
+ * @summary Embed existing documents
176
+ * @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ */
180
+ backfill1(embeddingBackfillRequest, options) {
181
+ return AIEmbeddingsApiFp(this.configuration).backfill1(embeddingBackfillRequest, options).then((request) => request(this.axios, this.basePath));
182
+ }
183
+ /**
184
+ *
185
+ * @summary Progress of an embedding backfill job
186
+ * @param {string} jobId
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ backfillStatus1(jobId, options) {
191
+ return AIEmbeddingsApiFp(this.configuration).backfillStatus1(jobId, options).then((request) => request(this.axios, this.basePath));
192
+ }
193
+ }
package/dist/esm/api.d.ts CHANGED
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  export * from './api/aichat-api';
13
+ export * from './api/aiembeddings-api';
13
14
  export * from './api/aisettings-api';
14
15
  export * from './api/collaboration-audit-controller-api';
15
16
  export * from './api/collaboration-controller-api';
package/dist/esm/api.js CHANGED
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  export * from './api/aichat-api';
15
+ export * from './api/aiembeddings-api';
15
16
  export * from './api/aisettings-api';
16
17
  export * from './api/collaboration-audit-controller-api';
17
18
  export * from './api/collaboration-controller-api';
@@ -0,0 +1,15 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface EmbeddingBackfillRequest {
13
+ 'folderId'?: string;
14
+ 'force'?: boolean;
15
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,23 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface EmbeddingBackfillStatus {
13
+ 'jobId'?: string;
14
+ 'folderId'?: string;
15
+ 'force'?: boolean;
16
+ 'status'?: string;
17
+ 'total'?: number;
18
+ 'done'?: number;
19
+ 'failed'?: number;
20
+ 'skipped'?: number;
21
+ 'startedAt'?: string;
22
+ 'finishedAt'?: string;
23
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -45,6 +45,8 @@ export * from './document-position';
45
45
  export * from './document-version-info';
46
46
  export * from './element-info';
47
47
  export * from './embed-url-response';
48
+ export * from './embedding-backfill-request';
49
+ export * from './embedding-backfill-status';
48
50
  export * from './enriched-audit-log';
49
51
  export * from './enriched-audit-log-details';
50
52
  export * from './feature-entitlement';
@@ -45,6 +45,8 @@ export * from './document-position';
45
45
  export * from './document-version-info';
46
46
  export * from './element-info';
47
47
  export * from './embed-url-response';
48
+ export * from './embedding-backfill-request';
49
+ export * from './embedding-backfill-status';
48
50
  export * from './enriched-audit-log';
49
51
  export * from './enriched-audit-log-details';
50
52
  export * from './feature-entitlement';
@@ -0,0 +1,15 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface EmbeddingBackfillRequest {
13
+ 'folderId'?: string;
14
+ 'force'?: boolean;
15
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface EmbeddingBackfillStatus {
13
+ 'jobId'?: string;
14
+ 'folderId'?: string;
15
+ 'force'?: boolean;
16
+ 'status'?: string;
17
+ 'total'?: number;
18
+ 'done'?: number;
19
+ 'failed'?: number;
20
+ 'skipped'?: number;
21
+ 'startedAt'?: string;
22
+ 'finishedAt'?: string;
23
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -45,6 +45,8 @@ export * from './document-position';
45
45
  export * from './document-version-info';
46
46
  export * from './element-info';
47
47
  export * from './embed-url-response';
48
+ export * from './embedding-backfill-request';
49
+ export * from './embedding-backfill-status';
48
50
  export * from './enriched-audit-log';
49
51
  export * from './enriched-audit-log-details';
50
52
  export * from './feature-entitlement';
@@ -61,6 +61,8 @@ __exportStar(require("./document-position"), exports);
61
61
  __exportStar(require("./document-version-info"), exports);
62
62
  __exportStar(require("./element-info"), exports);
63
63
  __exportStar(require("./embed-url-response"), exports);
64
+ __exportStar(require("./embedding-backfill-request"), exports);
65
+ __exportStar(require("./embedding-backfill-status"), exports);
64
66
  __exportStar(require("./enriched-audit-log"), exports);
65
67
  __exportStar(require("./enriched-audit-log-details"), exports);
66
68
  __exportStar(require("./feature-entitlement"), exports);
@@ -0,0 +1,111 @@
1
+ # AIEmbeddingsApi
2
+
3
+ All URIs are relative to *http://localhost:8081*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**backfill1**](#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents|
8
+ |[**backfillStatus1**](#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job|
9
+
10
+ # **backfill1**
11
+ > EmbeddingBackfillStatus backfill1()
12
+
13
+ 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.
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ AIEmbeddingsApi,
20
+ Configuration,
21
+ EmbeddingBackfillRequest
22
+ } from '@openfilz-sdk/typescript-ee';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new AIEmbeddingsApi(configuration);
26
+
27
+ let embeddingBackfillRequest: EmbeddingBackfillRequest; // (optional)
28
+
29
+ const { status, data } = await apiInstance.backfill1(
30
+ embeddingBackfillRequest
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **embeddingBackfillRequest** | **EmbeddingBackfillRequest**| | |
39
+
40
+
41
+ ### Return type
42
+
43
+ **EmbeddingBackfillStatus**
44
+
45
+ ### Authorization
46
+
47
+ [keycloak_auth](../README.md#keycloak_auth)
48
+
49
+ ### HTTP request headers
50
+
51
+ - **Content-Type**: application/json
52
+ - **Accept**: application/json
53
+
54
+
55
+ ### HTTP response details
56
+ | Status code | Description | Response headers |
57
+ |-------------|-------------|------------------|
58
+ |**200** | OK | - |
59
+
60
+ [[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)
61
+
62
+ # **backfillStatus1**
63
+ > EmbeddingBackfillStatus backfillStatus1()
64
+
65
+
66
+ ### Example
67
+
68
+ ```typescript
69
+ import {
70
+ AIEmbeddingsApi,
71
+ Configuration
72
+ } from '@openfilz-sdk/typescript-ee';
73
+
74
+ const configuration = new Configuration();
75
+ const apiInstance = new AIEmbeddingsApi(configuration);
76
+
77
+ let jobId: string; // (default to undefined)
78
+
79
+ const { status, data } = await apiInstance.backfillStatus1(
80
+ jobId
81
+ );
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+ |Name | Type | Description | Notes|
87
+ |------------- | ------------- | ------------- | -------------|
88
+ | **jobId** | [**string**] | | defaults to undefined|
89
+
90
+
91
+ ### Return type
92
+
93
+ **EmbeddingBackfillStatus**
94
+
95
+ ### Authorization
96
+
97
+ [keycloak_auth](../README.md#keycloak_auth)
98
+
99
+ ### HTTP request headers
100
+
101
+ - **Content-Type**: Not defined
102
+ - **Accept**: application/json
103
+
104
+
105
+ ### HTTP response details
106
+ | Status code | Description | Response headers |
107
+ |-------------|-------------|------------------|
108
+ |**200** | OK | - |
109
+
110
+ [[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)
111
+
@@ -0,0 +1,22 @@
1
+ # EmbeddingBackfillRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **folderId** | **string** | | [optional] [default to undefined]
9
+ **force** | **boolean** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { EmbeddingBackfillRequest } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: EmbeddingBackfillRequest = {
17
+ folderId,
18
+ force,
19
+ };
20
+ ```
21
+
22
+ [[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,38 @@
1
+ # EmbeddingBackfillStatus
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **jobId** | **string** | | [optional] [default to undefined]
9
+ **folderId** | **string** | | [optional] [default to undefined]
10
+ **force** | **boolean** | | [optional] [default to undefined]
11
+ **status** | **string** | | [optional] [default to undefined]
12
+ **total** | **number** | | [optional] [default to undefined]
13
+ **done** | **number** | | [optional] [default to undefined]
14
+ **failed** | **number** | | [optional] [default to undefined]
15
+ **skipped** | **number** | | [optional] [default to undefined]
16
+ **startedAt** | **string** | | [optional] [default to undefined]
17
+ **finishedAt** | **string** | | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { EmbeddingBackfillStatus } from '@openfilz-sdk/typescript-ee';
23
+
24
+ const instance: EmbeddingBackfillStatus = {
25
+ jobId,
26
+ folderId,
27
+ force,
28
+ status,
29
+ total,
30
+ done,
31
+ failed,
32
+ skipped,
33
+ startedAt,
34
+ finishedAt,
35
+ };
36
+ ```
37
+
38
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)