@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.
- package/.openapi-generator/FILES +6 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +6 -2
- package/api/aiembeddings-api.ts +201 -0
- package/api.ts +1 -0
- package/dist/api/aiembeddings-api.d.ts +100 -0
- package/dist/api/aiembeddings-api.js +200 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/aiembeddings-api.d.ts +100 -0
- package/dist/esm/api/aiembeddings-api.js +193 -0
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/embedding-backfill-request.d.ts +15 -0
- package/dist/esm/models/embedding-backfill-request.js +14 -0
- package/dist/esm/models/embedding-backfill-status.d.ts +23 -0
- package/dist/esm/models/embedding-backfill-status.js +14 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/embedding-backfill-request.d.ts +15 -0
- package/dist/models/embedding-backfill-request.js +15 -0
- package/dist/models/embedding-backfill-status.d.ts +23 -0
- package/dist/models/embedding-backfill-status.js +15 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/AIEmbeddingsApi.md +111 -0
- package/docs/EmbeddingBackfillRequest.md +22 -0
- package/docs/EmbeddingBackfillStatus.md +38 -0
- package/models/embedding-backfill-request.ts +21 -0
- package/models/embedding-backfill-status.ts +29 -0
- package/models/index.ts +2 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
6
|
api/aichat-api.ts
|
|
7
|
+
api/aiembeddings-api.ts
|
|
7
8
|
api/aisettings-api.ts
|
|
8
9
|
api/collaboration-audit-controller-api.ts
|
|
9
10
|
api/collaboration-controller-api.ts
|
|
@@ -40,6 +41,7 @@ base.ts
|
|
|
40
41
|
common.ts
|
|
41
42
|
configuration.ts
|
|
42
43
|
docs/AIChatApi.md
|
|
44
|
+
docs/AIEmbeddingsApi.md
|
|
43
45
|
docs/AISettingsApi.md
|
|
44
46
|
docs/AiChatConversation.md
|
|
45
47
|
docs/AiChatRequest.md
|
|
@@ -102,6 +104,8 @@ docs/ESignPublicApi.md
|
|
|
102
104
|
docs/ESignTemplatesApi.md
|
|
103
105
|
docs/ElementInfo.md
|
|
104
106
|
docs/EmbedUrlResponse.md
|
|
107
|
+
docs/EmbeddingBackfillRequest.md
|
|
108
|
+
docs/EmbeddingBackfillStatus.md
|
|
105
109
|
docs/EnrichedAuditLog.md
|
|
106
110
|
docs/EnrichedAuditLogDetails.md
|
|
107
111
|
docs/FavoritesApi.md
|
|
@@ -264,6 +268,8 @@ models/document-position.ts
|
|
|
264
268
|
models/document-version-info.ts
|
|
265
269
|
models/element-info.ts
|
|
266
270
|
models/embed-url-response.ts
|
|
271
|
+
models/embedding-backfill-request.ts
|
|
272
|
+
models/embedding-backfill-status.ts
|
|
267
273
|
models/enriched-audit-log-details.ts
|
|
268
274
|
models/enriched-audit-log.ts
|
|
269
275
|
models/feature-entitlement.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
b3121981b96de40beec62c83a14b52b401783a54fac29aa7877dcd3b90549102
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.9.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.9.9
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @openfilz-sdk/typescript-ee@1.9.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.9.9 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -59,6 +59,8 @@ Class | Method | HTTP request | Description
|
|
|
59
59
|
*AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
|
|
60
60
|
*AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
|
|
61
61
|
*AIChatApi* | [**proposeByKind**](docs/AIChatApi.md#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved
|
|
62
|
+
*AIEmbeddingsApi* | [**backfill1**](docs/AIEmbeddingsApi.md#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents
|
|
63
|
+
*AIEmbeddingsApi* | [**backfillStatus1**](docs/AIEmbeddingsApi.md#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job
|
|
62
64
|
*AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
|
|
63
65
|
*AISettingsApi* | [**getSettings1**](docs/AISettingsApi.md#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings
|
|
64
66
|
*AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
|
|
@@ -268,6 +270,8 @@ Class | Method | HTTP request | Description
|
|
|
268
270
|
- [DocumentVersionInfo](docs/DocumentVersionInfo.md)
|
|
269
271
|
- [ElementInfo](docs/ElementInfo.md)
|
|
270
272
|
- [EmbedUrlResponse](docs/EmbedUrlResponse.md)
|
|
273
|
+
- [EmbeddingBackfillRequest](docs/EmbeddingBackfillRequest.md)
|
|
274
|
+
- [EmbeddingBackfillStatus](docs/EmbeddingBackfillStatus.md)
|
|
271
275
|
- [EnrichedAuditLog](docs/EnrichedAuditLog.md)
|
|
272
276
|
- [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
|
|
273
277
|
- [FeatureEntitlement](docs/FeatureEntitlement.md)
|
|
@@ -0,0 +1,201 @@
|
|
|
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
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { EmbeddingBackfillRequest } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { EmbeddingBackfillStatus } from '../models';
|
|
28
|
+
/**
|
|
29
|
+
* AIEmbeddingsApi - axios parameter creator
|
|
30
|
+
*/
|
|
31
|
+
export const AIEmbeddingsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* 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.
|
|
35
|
+
* @summary Embed existing documents
|
|
36
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
backfill1: async (embeddingBackfillRequest?: EmbeddingBackfillRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41
|
+
const localVarPath = `/api/v1/ai/embeddings/backfill`;
|
|
42
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44
|
+
let baseOptions;
|
|
45
|
+
if (configuration) {
|
|
46
|
+
baseOptions = configuration.baseOptions;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50
|
+
const localVarHeaderParameter = {} as any;
|
|
51
|
+
const localVarQueryParameter = {} as any;
|
|
52
|
+
|
|
53
|
+
// authentication keycloak_auth required
|
|
54
|
+
// http bearer authentication required
|
|
55
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
56
|
+
|
|
57
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
58
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
59
|
+
|
|
60
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
61
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
63
|
+
localVarRequestOptions.data = serializeDataIfNeeded(embeddingBackfillRequest, localVarRequestOptions, configuration)
|
|
64
|
+
|
|
65
|
+
return {
|
|
66
|
+
url: toPathString(localVarUrlObj),
|
|
67
|
+
options: localVarRequestOptions,
|
|
68
|
+
};
|
|
69
|
+
},
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @summary Progress of an embedding backfill job
|
|
73
|
+
* @param {string} jobId
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
backfillStatus1: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
78
|
+
// verify required parameter 'jobId' is not null or undefined
|
|
79
|
+
assertParamExists('backfillStatus1', 'jobId', jobId)
|
|
80
|
+
const localVarPath = `/api/v1/ai/embeddings/backfill/{jobId}`
|
|
81
|
+
.replace('{jobId}', encodeURIComponent(String(jobId)));
|
|
82
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
83
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
84
|
+
let baseOptions;
|
|
85
|
+
if (configuration) {
|
|
86
|
+
baseOptions = configuration.baseOptions;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
90
|
+
const localVarHeaderParameter = {} as any;
|
|
91
|
+
const localVarQueryParameter = {} as any;
|
|
92
|
+
|
|
93
|
+
// authentication keycloak_auth required
|
|
94
|
+
// http bearer authentication required
|
|
95
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
96
|
+
|
|
97
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
98
|
+
|
|
99
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
100
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
101
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
102
|
+
|
|
103
|
+
return {
|
|
104
|
+
url: toPathString(localVarUrlObj),
|
|
105
|
+
options: localVarRequestOptions,
|
|
106
|
+
};
|
|
107
|
+
},
|
|
108
|
+
}
|
|
109
|
+
};
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* AIEmbeddingsApi - functional programming interface
|
|
113
|
+
*/
|
|
114
|
+
export const AIEmbeddingsApiFp = function(configuration?: Configuration) {
|
|
115
|
+
const localVarAxiosParamCreator = AIEmbeddingsApiAxiosParamCreator(configuration)
|
|
116
|
+
return {
|
|
117
|
+
/**
|
|
118
|
+
* 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.
|
|
119
|
+
* @summary Embed existing documents
|
|
120
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
async backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>> {
|
|
125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.backfill1(embeddingBackfillRequest, options);
|
|
126
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
127
|
+
const localVarOperationServerBasePath = operationServerMap['AIEmbeddingsApi.backfill1']?.[localVarOperationServerIndex]?.url;
|
|
128
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
129
|
+
},
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @summary Progress of an embedding backfill job
|
|
133
|
+
* @param {string} jobId
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
async backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbeddingBackfillStatus>> {
|
|
138
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.backfillStatus1(jobId, options);
|
|
139
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
140
|
+
const localVarOperationServerBasePath = operationServerMap['AIEmbeddingsApi.backfillStatus1']?.[localVarOperationServerIndex]?.url;
|
|
141
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
142
|
+
},
|
|
143
|
+
}
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* AIEmbeddingsApi - factory interface
|
|
148
|
+
*/
|
|
149
|
+
export const AIEmbeddingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
150
|
+
const localVarFp = AIEmbeddingsApiFp(configuration)
|
|
151
|
+
return {
|
|
152
|
+
/**
|
|
153
|
+
* 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.
|
|
154
|
+
* @summary Embed existing documents
|
|
155
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus> {
|
|
160
|
+
return localVarFp.backfill1(embeddingBackfillRequest, options).then((request) => request(axios, basePath));
|
|
161
|
+
},
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @summary Progress of an embedding backfill job
|
|
165
|
+
* @param {string} jobId
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
backfillStatus1(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<EmbeddingBackfillStatus> {
|
|
170
|
+
return localVarFp.backfillStatus1(jobId, options).then((request) => request(axios, basePath));
|
|
171
|
+
},
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* AIEmbeddingsApi - object-oriented interface
|
|
177
|
+
*/
|
|
178
|
+
export class AIEmbeddingsApi extends BaseAPI {
|
|
179
|
+
/**
|
|
180
|
+
* 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.
|
|
181
|
+
* @summary Embed existing documents
|
|
182
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
public backfill1(embeddingBackfillRequest?: EmbeddingBackfillRequest, options?: RawAxiosRequestConfig) {
|
|
187
|
+
return AIEmbeddingsApiFp(this.configuration).backfill1(embeddingBackfillRequest, options).then((request) => request(this.axios, this.basePath));
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @summary Progress of an embedding backfill job
|
|
193
|
+
* @param {string} jobId
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
*/
|
|
197
|
+
public backfillStatus1(jobId: string, options?: RawAxiosRequestConfig) {
|
|
198
|
+
return AIEmbeddingsApiFp(this.configuration).backfillStatus1(jobId, options).then((request) => request(this.axios, this.basePath));
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
|
package/api.ts
CHANGED
|
@@ -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,200 @@
|
|
|
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
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.AIEmbeddingsApi = exports.AIEmbeddingsApiFactory = exports.AIEmbeddingsApiFp = exports.AIEmbeddingsApiAxiosParamCreator = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("../common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("../base");
|
|
32
|
+
/**
|
|
33
|
+
* AIEmbeddingsApi - axios parameter creator
|
|
34
|
+
*/
|
|
35
|
+
const AIEmbeddingsApiAxiosParamCreator = function (configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
* 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.
|
|
39
|
+
* @summary Embed existing documents
|
|
40
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
backfill1: (embeddingBackfillRequest_1, ...args_1) => __awaiter(this, [embeddingBackfillRequest_1, ...args_1], void 0, function* (embeddingBackfillRequest, options = {}) {
|
|
45
|
+
const localVarPath = `/api/v1/ai/embeddings/backfill`;
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
if (configuration) {
|
|
50
|
+
baseOptions = configuration.baseOptions;
|
|
51
|
+
}
|
|
52
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
53
|
+
const localVarHeaderParameter = {};
|
|
54
|
+
const localVarQueryParameter = {};
|
|
55
|
+
// authentication keycloak_auth required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
58
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
60
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
61
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
63
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(embeddingBackfillRequest, localVarRequestOptions, configuration);
|
|
64
|
+
return {
|
|
65
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
66
|
+
options: localVarRequestOptions,
|
|
67
|
+
};
|
|
68
|
+
}),
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @summary Progress of an embedding backfill job
|
|
72
|
+
* @param {string} jobId
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
backfillStatus1: (jobId_1, ...args_1) => __awaiter(this, [jobId_1, ...args_1], void 0, function* (jobId, options = {}) {
|
|
77
|
+
// verify required parameter 'jobId' is not null or undefined
|
|
78
|
+
(0, common_1.assertParamExists)('backfillStatus1', 'jobId', jobId);
|
|
79
|
+
const localVarPath = `/api/v1/ai/embeddings/backfill/{jobId}`
|
|
80
|
+
.replace('{jobId}', encodeURIComponent(String(jobId)));
|
|
81
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
83
|
+
let baseOptions;
|
|
84
|
+
if (configuration) {
|
|
85
|
+
baseOptions = configuration.baseOptions;
|
|
86
|
+
}
|
|
87
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
88
|
+
const localVarHeaderParameter = {};
|
|
89
|
+
const localVarQueryParameter = {};
|
|
90
|
+
// authentication keycloak_auth required
|
|
91
|
+
// http bearer authentication required
|
|
92
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
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
|
+
return {
|
|
98
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
99
|
+
options: localVarRequestOptions,
|
|
100
|
+
};
|
|
101
|
+
}),
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
exports.AIEmbeddingsApiAxiosParamCreator = AIEmbeddingsApiAxiosParamCreator;
|
|
105
|
+
/**
|
|
106
|
+
* AIEmbeddingsApi - functional programming interface
|
|
107
|
+
*/
|
|
108
|
+
const AIEmbeddingsApiFp = function (configuration) {
|
|
109
|
+
const localVarAxiosParamCreator = (0, exports.AIEmbeddingsApiAxiosParamCreator)(configuration);
|
|
110
|
+
return {
|
|
111
|
+
/**
|
|
112
|
+
* 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.
|
|
113
|
+
* @summary Embed existing documents
|
|
114
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
backfill1(embeddingBackfillRequest, options) {
|
|
119
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
120
|
+
var _a, _b, _c;
|
|
121
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.backfill1(embeddingBackfillRequest, options);
|
|
122
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
123
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIEmbeddingsApi.backfill1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
124
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
125
|
+
});
|
|
126
|
+
},
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @summary Progress of an embedding backfill job
|
|
130
|
+
* @param {string} jobId
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
backfillStatus1(jobId, options) {
|
|
135
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
136
|
+
var _a, _b, _c;
|
|
137
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.backfillStatus1(jobId, options);
|
|
138
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
139
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIEmbeddingsApi.backfillStatus1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
140
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
141
|
+
});
|
|
142
|
+
},
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
exports.AIEmbeddingsApiFp = AIEmbeddingsApiFp;
|
|
146
|
+
/**
|
|
147
|
+
* AIEmbeddingsApi - factory interface
|
|
148
|
+
*/
|
|
149
|
+
const AIEmbeddingsApiFactory = function (configuration, basePath, axios) {
|
|
150
|
+
const localVarFp = (0, exports.AIEmbeddingsApiFp)(configuration);
|
|
151
|
+
return {
|
|
152
|
+
/**
|
|
153
|
+
* 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.
|
|
154
|
+
* @summary Embed existing documents
|
|
155
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
backfill1(embeddingBackfillRequest, options) {
|
|
160
|
+
return localVarFp.backfill1(embeddingBackfillRequest, options).then((request) => request(axios, basePath));
|
|
161
|
+
},
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @summary Progress of an embedding backfill job
|
|
165
|
+
* @param {string} jobId
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
backfillStatus1(jobId, options) {
|
|
170
|
+
return localVarFp.backfillStatus1(jobId, options).then((request) => request(axios, basePath));
|
|
171
|
+
},
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
exports.AIEmbeddingsApiFactory = AIEmbeddingsApiFactory;
|
|
175
|
+
/**
|
|
176
|
+
* AIEmbeddingsApi - object-oriented interface
|
|
177
|
+
*/
|
|
178
|
+
class AIEmbeddingsApi extends base_1.BaseAPI {
|
|
179
|
+
/**
|
|
180
|
+
* 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.
|
|
181
|
+
* @summary Embed existing documents
|
|
182
|
+
* @param {EmbeddingBackfillRequest} [embeddingBackfillRequest]
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
backfill1(embeddingBackfillRequest, options) {
|
|
187
|
+
return (0, exports.AIEmbeddingsApiFp)(this.configuration).backfill1(embeddingBackfillRequest, options).then((request) => request(this.axios, this.basePath));
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @summary Progress of an embedding backfill job
|
|
192
|
+
* @param {string} jobId
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
backfillStatus1(jobId, options) {
|
|
197
|
+
return (0, exports.AIEmbeddingsApiFp)(this.configuration).backfillStatus1(jobId, options).then((request) => request(this.axios, this.basePath));
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
exports.AIEmbeddingsApi = AIEmbeddingsApi;
|
package/dist/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/api.js
CHANGED
|
@@ -28,6 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
30
|
__exportStar(require("./api/aichat-api"), exports);
|
|
31
|
+
__exportStar(require("./api/aiembeddings-api"), exports);
|
|
31
32
|
__exportStar(require("./api/aisettings-api"), exports);
|
|
32
33
|
__exportStar(require("./api/collaboration-audit-controller-api"), exports);
|
|
33
34
|
__exportStar(require("./api/collaboration-controller-api"), exports);
|