@breign/client 1.0.83 → 1.0.84

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.
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AgentModuleUio, BodyWithMessageUio, DocumentAddRequestUio, FileCreationRequestUio, FileCreationResponseUio, FileStatusUio, FileStatusUpdateRequestUio, FileWithDownloadUrlUio, ImageKnowledgeUio, ImportFileToAgentKnowledge200ResponseUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFileSummaryUio, KnowledgeFilesByIdsRequestUio, S3UploadBodyUio } from '../models/index';
13
+ import type { AgentModuleUio, BodyWithMessageUio, DocumentAddRequestUio, FileCreationRequestUio, FileCreationResponseUio, FileStatusUio, FileStatusUpdateRequestUio, FileWithDownloadUrlUio, ImageKnowledgeUio, ImportFileToAgentKnowledge200ResponseUio, KnowledgeBaseConfigurationUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFilePagePreviewUio, KnowledgeFileSummaryUio, KnowledgeFilesByIdsRequestUio, S3UploadBodyUio } from '../models/index';
14
14
  export interface AddDocumentToKnowledgeBaseRequest {
15
15
  agentId: string;
16
16
  documentAddRequestUio: DocumentAddRequestUio;
@@ -56,6 +56,16 @@ export interface GetImagesFromKnowledgeBaseLibraryRequest {
56
56
  export interface GetInactiveKnowledgeFileIdsRequest {
57
57
  knowledgebaseId: string;
58
58
  }
59
+ export interface GetKnowledgeBaseConfigurationRequest {
60
+ knowledgebaseId: string;
61
+ }
62
+ export interface GetKnowledgeFileRequest {
63
+ fileId: string;
64
+ }
65
+ export interface GetKnowledgeFilePagePreviewRequest {
66
+ fileId: string;
67
+ pageIndex: number;
68
+ }
59
69
  export interface GetKnowledgeFilesByIdsRequest {
60
70
  knowledgeFilesByIdsRequestUio: KnowledgeFilesByIdsRequestUio;
61
71
  }
@@ -86,6 +96,14 @@ export interface UpdateImageStatusInKnowledgeBaseLibraryRequest {
86
96
  imageId: string;
87
97
  fileStatusUpdateRequestUio: FileStatusUpdateRequestUio;
88
98
  }
99
+ export interface UpdateKnowledgeBaseConfigurationRequest {
100
+ knowledgebaseId: string;
101
+ knowledgeBaseConfigurationUio: KnowledgeBaseConfigurationUio;
102
+ }
103
+ export interface UpdateKnowledgeFileStatusRequest {
104
+ fileId: string;
105
+ fileStatusUpdateRequestUio: FileStatusUpdateRequestUio;
106
+ }
89
107
  export interface UploadImageToKnowledgeBaseLibraryRequest {
90
108
  knowledgebaseId: string;
91
109
  image: Blob;
@@ -204,6 +222,36 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
204
222
  * Get inactive knowledge file IDs for a knowledge base
205
223
  */
206
224
  getInactiveKnowledgeFileIds(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
225
+ /**
226
+ * Returns the current configuration for a knowledge base
227
+ * Get knowledge base configuration
228
+ */
229
+ getKnowledgeBaseConfigurationRaw(requestParameters: GetKnowledgeBaseConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeBaseConfigurationUio>>;
230
+ /**
231
+ * Returns the current configuration for a knowledge base
232
+ * Get knowledge base configuration
233
+ */
234
+ getKnowledgeBaseConfiguration(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeBaseConfigurationUio>;
235
+ /**
236
+ * Retrieves metadata for a specific knowledge file by file ID
237
+ * Get a specific knowledge file
238
+ */
239
+ getKnowledgeFileRaw(requestParameters: GetKnowledgeFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWithDownloadUrlUio>>;
240
+ /**
241
+ * Retrieves metadata for a specific knowledge file by file ID
242
+ * Get a specific knowledge file
243
+ */
244
+ getKnowledgeFile(fileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWithDownloadUrlUio>;
245
+ /**
246
+ * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
247
+ * Get a presigned preview URL for a knowledge file page
248
+ */
249
+ getKnowledgeFilePagePreviewRaw(requestParameters: GetKnowledgeFilePagePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeFilePagePreviewUio>>;
250
+ /**
251
+ * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
252
+ * Get a presigned preview URL for a knowledge file page
253
+ */
254
+ getKnowledgeFilePagePreview(fileId: string, pageIndex: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeFilePagePreviewUio>;
207
255
  /**
208
256
  * Returns knowledge file summaries (id and name) for the given file IDs.
209
257
  * Get knowledge files by IDs
@@ -284,6 +332,30 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
284
332
  * Update the status of a specific knowledge image in a library image in knowledge base
285
333
  */
286
334
  updateImageStatusInKnowledgeBaseLibrary(knowledgebaseId: string, imageId: string, fileStatusUpdateRequestUio: FileStatusUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileStatusUio>;
335
+ /**
336
+ * Updates the module configuration for a knowledge base
337
+ * Update knowledge base configuration
338
+ */
339
+ updateKnowledgeBaseConfigurationRaw(requestParameters: UpdateKnowledgeBaseConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
340
+ [key: string]: any;
341
+ }>>;
342
+ /**
343
+ * Updates the module configuration for a knowledge base
344
+ * Update knowledge base configuration
345
+ */
346
+ updateKnowledgeBaseConfiguration(knowledgebaseId: string, knowledgeBaseConfigurationUio: KnowledgeBaseConfigurationUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
347
+ [key: string]: any;
348
+ }>;
349
+ /**
350
+ * Updates the status of a knowledge file and triggers indexing when uploaded
351
+ * Update knowledge file status
352
+ */
353
+ updateKnowledgeFileStatusRaw(requestParameters: UpdateKnowledgeFileStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
354
+ /**
355
+ * Updates the status of a knowledge file and triggers indexing when uploaded
356
+ * Update knowledge file status
357
+ */
358
+ updateKnowledgeFileStatus(fileId: string, fileStatusUpdateRequestUio: FileStatusUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
287
359
  /**
288
360
  * Upload a new image to a library image in knowledge base and return the upload URL
289
361
  * Upload a new image to a library image in knowledge base
@@ -410,6 +410,99 @@ class KnowledgeApi extends runtime.BaseAPI {
410
410
  const response = await this.getInactiveKnowledgeFileIdsRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
411
411
  return await response.value();
412
412
  }
413
+ /**
414
+ * Returns the current configuration for a knowledge base
415
+ * Get knowledge base configuration
416
+ */
417
+ async getKnowledgeBaseConfigurationRaw(requestParameters, initOverrides) {
418
+ if (requestParameters['knowledgebaseId'] == null) {
419
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling getKnowledgeBaseConfiguration().');
420
+ }
421
+ const queryParameters = {};
422
+ const headerParameters = {};
423
+ if (this.configuration && this.configuration.apiKey) {
424
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
425
+ }
426
+ const response = await this.request({
427
+ path: `/knowledge-bases/{knowledgebaseId}/configuration`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
428
+ method: 'GET',
429
+ headers: headerParameters,
430
+ query: queryParameters,
431
+ }, initOverrides);
432
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeBaseConfigurationUioFromJSON)(jsonValue));
433
+ }
434
+ /**
435
+ * Returns the current configuration for a knowledge base
436
+ * Get knowledge base configuration
437
+ */
438
+ async getKnowledgeBaseConfiguration(knowledgebaseId, initOverrides) {
439
+ const response = await this.getKnowledgeBaseConfigurationRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
440
+ return await response.value();
441
+ }
442
+ /**
443
+ * Retrieves metadata for a specific knowledge file by file ID
444
+ * Get a specific knowledge file
445
+ */
446
+ async getKnowledgeFileRaw(requestParameters, initOverrides) {
447
+ if (requestParameters['fileId'] == null) {
448
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling getKnowledgeFile().');
449
+ }
450
+ const queryParameters = {};
451
+ const headerParameters = {};
452
+ if (this.configuration && this.configuration.apiKey) {
453
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
454
+ }
455
+ const response = await this.request({
456
+ path: `/knowledge-files/{fileId}`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
457
+ method: 'GET',
458
+ headers: headerParameters,
459
+ query: queryParameters,
460
+ }, initOverrides);
461
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FileWithDownloadUrlUioFromJSON)(jsonValue));
462
+ }
463
+ /**
464
+ * Retrieves metadata for a specific knowledge file by file ID
465
+ * Get a specific knowledge file
466
+ */
467
+ async getKnowledgeFile(fileId, initOverrides) {
468
+ const response = await this.getKnowledgeFileRaw({ fileId: fileId }, initOverrides);
469
+ return await response.value();
470
+ }
471
+ /**
472
+ * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
473
+ * Get a presigned preview URL for a knowledge file page
474
+ */
475
+ async getKnowledgeFilePagePreviewRaw(requestParameters, initOverrides) {
476
+ if (requestParameters['fileId'] == null) {
477
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling getKnowledgeFilePagePreview().');
478
+ }
479
+ if (requestParameters['pageIndex'] == null) {
480
+ throw new runtime.RequiredError('pageIndex', 'Required parameter "pageIndex" was null or undefined when calling getKnowledgeFilePagePreview().');
481
+ }
482
+ const queryParameters = {};
483
+ if (requestParameters['pageIndex'] != null) {
484
+ queryParameters['pageIndex'] = requestParameters['pageIndex'];
485
+ }
486
+ const headerParameters = {};
487
+ if (this.configuration && this.configuration.apiKey) {
488
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
489
+ }
490
+ const response = await this.request({
491
+ path: `/knowledge-files/{fileId}/page-preview`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
492
+ method: 'GET',
493
+ headers: headerParameters,
494
+ query: queryParameters,
495
+ }, initOverrides);
496
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeFilePagePreviewUioFromJSON)(jsonValue));
497
+ }
498
+ /**
499
+ * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
500
+ * Get a presigned preview URL for a knowledge file page
501
+ */
502
+ async getKnowledgeFilePagePreview(fileId, pageIndex, initOverrides) {
503
+ const response = await this.getKnowledgeFilePagePreviewRaw({ fileId: fileId, pageIndex: pageIndex }, initOverrides);
504
+ return await response.value();
505
+ }
413
506
  /**
414
507
  * Returns knowledge file summaries (id and name) for the given file IDs.
415
508
  * Get knowledge files by IDs
@@ -690,6 +783,79 @@ class KnowledgeApi extends runtime.BaseAPI {
690
783
  const response = await this.updateImageStatusInKnowledgeBaseLibraryRaw({ knowledgebaseId: knowledgebaseId, imageId: imageId, fileStatusUpdateRequestUio: fileStatusUpdateRequestUio }, initOverrides);
691
784
  return await response.value();
692
785
  }
786
+ /**
787
+ * Updates the module configuration for a knowledge base
788
+ * Update knowledge base configuration
789
+ */
790
+ async updateKnowledgeBaseConfigurationRaw(requestParameters, initOverrides) {
791
+ if (requestParameters['knowledgebaseId'] == null) {
792
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling updateKnowledgeBaseConfiguration().');
793
+ }
794
+ if (requestParameters['knowledgeBaseConfigurationUio'] == null) {
795
+ throw new runtime.RequiredError('knowledgeBaseConfigurationUio', 'Required parameter "knowledgeBaseConfigurationUio" was null or undefined when calling updateKnowledgeBaseConfiguration().');
796
+ }
797
+ const queryParameters = {};
798
+ const headerParameters = {};
799
+ headerParameters['Content-Type'] = 'application/json';
800
+ if (this.configuration && this.configuration.apiKey) {
801
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
802
+ }
803
+ const response = await this.request({
804
+ path: `/knowledge-bases/{knowledgebaseId}/configuration`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
805
+ method: 'PUT',
806
+ headers: headerParameters,
807
+ query: queryParameters,
808
+ body: (0, index_1.KnowledgeBaseConfigurationUioToJSON)(requestParameters['knowledgeBaseConfigurationUio']),
809
+ }, initOverrides);
810
+ return new runtime.JSONApiResponse(response);
811
+ }
812
+ /**
813
+ * Updates the module configuration for a knowledge base
814
+ * Update knowledge base configuration
815
+ */
816
+ async updateKnowledgeBaseConfiguration(knowledgebaseId, knowledgeBaseConfigurationUio, initOverrides) {
817
+ const response = await this.updateKnowledgeBaseConfigurationRaw({ knowledgebaseId: knowledgebaseId, knowledgeBaseConfigurationUio: knowledgeBaseConfigurationUio }, initOverrides);
818
+ return await response.value();
819
+ }
820
+ /**
821
+ * Updates the status of a knowledge file and triggers indexing when uploaded
822
+ * Update knowledge file status
823
+ */
824
+ async updateKnowledgeFileStatusRaw(requestParameters, initOverrides) {
825
+ if (requestParameters['fileId'] == null) {
826
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling updateKnowledgeFileStatus().');
827
+ }
828
+ if (requestParameters['fileStatusUpdateRequestUio'] == null) {
829
+ throw new runtime.RequiredError('fileStatusUpdateRequestUio', 'Required parameter "fileStatusUpdateRequestUio" was null or undefined when calling updateKnowledgeFileStatus().');
830
+ }
831
+ const queryParameters = {};
832
+ const headerParameters = {};
833
+ headerParameters['Content-Type'] = 'application/json';
834
+ if (this.configuration && this.configuration.apiKey) {
835
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
836
+ }
837
+ const response = await this.request({
838
+ path: `/knowledge-files/{fileId}/status`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
839
+ method: 'POST',
840
+ headers: headerParameters,
841
+ query: queryParameters,
842
+ body: (0, index_1.FileStatusUpdateRequestUioToJSON)(requestParameters['fileStatusUpdateRequestUio']),
843
+ }, initOverrides);
844
+ if (this.isJsonMime(response.headers.get('content-type'))) {
845
+ return new runtime.JSONApiResponse(response);
846
+ }
847
+ else {
848
+ return new runtime.TextApiResponse(response);
849
+ }
850
+ }
851
+ /**
852
+ * Updates the status of a knowledge file and triggers indexing when uploaded
853
+ * Update knowledge file status
854
+ */
855
+ async updateKnowledgeFileStatus(fileId, fileStatusUpdateRequestUio, initOverrides) {
856
+ const response = await this.updateKnowledgeFileStatusRaw({ fileId: fileId, fileStatusUpdateRequestUio: fileStatusUpdateRequestUio }, initOverrides);
857
+ return await response.value();
858
+ }
693
859
  /**
694
860
  * Upload a new image to a library image in knowledge base and return the upload URL
695
861
  * Upload a new image to a library image in knowledge base
@@ -0,0 +1,45 @@
1
+ /**
2
+ * brain-client
3
+ * Api ands models for brain-app and brain-app
4
+ *
5
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface KnowledgeBaseConfigurationAuthenticationOneOfUio
16
+ */
17
+ export interface KnowledgeBaseConfigurationAuthenticationOneOfUio {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof KnowledgeBaseConfigurationAuthenticationOneOfUio
22
+ */
23
+ apiKey?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof KnowledgeBaseConfigurationAuthenticationOneOfUio
28
+ */
29
+ type?: KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum: {
35
+ readonly ApiKey: "API_KEY";
36
+ };
37
+ export type KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum = typeof KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum[keyof typeof KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum];
38
+ /**
39
+ * Check if a given object implements the KnowledgeBaseConfigurationAuthenticationOneOfUio interface.
40
+ */
41
+ export declare function instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio(value: object): value is KnowledgeBaseConfigurationAuthenticationOneOfUio;
42
+ export declare function KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSON(json: any): KnowledgeBaseConfigurationAuthenticationOneOfUio;
43
+ export declare function KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeBaseConfigurationAuthenticationOneOfUio;
44
+ export declare function KnowledgeBaseConfigurationAuthenticationOneOfUioToJSON(json: any): KnowledgeBaseConfigurationAuthenticationOneOfUio;
45
+ export declare function KnowledgeBaseConfigurationAuthenticationOneOfUioToJSONTyped(value?: KnowledgeBaseConfigurationAuthenticationOneOfUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * brain-client
6
+ * Api ands models for brain-app and brain-app
7
+ *
8
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 });
16
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum = void 0;
17
+ exports.instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio = instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio;
18
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSON = KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSON;
19
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped = KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped;
20
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioToJSON = KnowledgeBaseConfigurationAuthenticationOneOfUioToJSON;
21
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioToJSONTyped = KnowledgeBaseConfigurationAuthenticationOneOfUioToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.KnowledgeBaseConfigurationAuthenticationOneOfUioTypeEnum = {
26
+ ApiKey: 'API_KEY'
27
+ };
28
+ /**
29
+ * Check if a given object implements the KnowledgeBaseConfigurationAuthenticationOneOfUio interface.
30
+ */
31
+ function instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio(value) {
32
+ return true;
33
+ }
34
+ function KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSON(json) {
35
+ return KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped(json, false);
36
+ }
37
+ function KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'apiKey': json['apiKey'] == null ? undefined : json['apiKey'],
43
+ 'type': json['type'] == null ? undefined : json['type'],
44
+ };
45
+ }
46
+ function KnowledgeBaseConfigurationAuthenticationOneOfUioToJSON(json) {
47
+ return KnowledgeBaseConfigurationAuthenticationOneOfUioToJSONTyped(json, false);
48
+ }
49
+ function KnowledgeBaseConfigurationAuthenticationOneOfUioToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'apiKey': value['apiKey'],
55
+ 'type': value['type'],
56
+ };
57
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * brain-client
3
+ * Api ands models for brain-app and brain-app
4
+ *
5
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 { KnowledgeBaseConfigurationAuthenticationOneOfUio } from './KnowledgeBaseConfigurationAuthenticationOneOfUio';
13
+ /**
14
+ * @type KnowledgeBaseConfigurationAuthenticationUio
15
+ *
16
+ * @export
17
+ */
18
+ export type KnowledgeBaseConfigurationAuthenticationUio = KnowledgeBaseConfigurationAuthenticationOneOfUio | string;
19
+ export declare function KnowledgeBaseConfigurationAuthenticationUioFromJSON(json: any): KnowledgeBaseConfigurationAuthenticationUio;
20
+ export declare function KnowledgeBaseConfigurationAuthenticationUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeBaseConfigurationAuthenticationUio;
21
+ export declare function KnowledgeBaseConfigurationAuthenticationUioToJSON(json: any): any;
22
+ export declare function KnowledgeBaseConfigurationAuthenticationUioToJSONTyped(value?: KnowledgeBaseConfigurationAuthenticationUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * brain-client
6
+ * Api ands models for brain-app and brain-app
7
+ *
8
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 });
16
+ exports.KnowledgeBaseConfigurationAuthenticationUioFromJSON = KnowledgeBaseConfigurationAuthenticationUioFromJSON;
17
+ exports.KnowledgeBaseConfigurationAuthenticationUioFromJSONTyped = KnowledgeBaseConfigurationAuthenticationUioFromJSONTyped;
18
+ exports.KnowledgeBaseConfigurationAuthenticationUioToJSON = KnowledgeBaseConfigurationAuthenticationUioToJSON;
19
+ exports.KnowledgeBaseConfigurationAuthenticationUioToJSONTyped = KnowledgeBaseConfigurationAuthenticationUioToJSONTyped;
20
+ const KnowledgeBaseConfigurationAuthenticationOneOfUio_1 = require("./KnowledgeBaseConfigurationAuthenticationOneOfUio");
21
+ function KnowledgeBaseConfigurationAuthenticationUioFromJSON(json) {
22
+ return KnowledgeBaseConfigurationAuthenticationUioFromJSONTyped(json, false);
23
+ }
24
+ function KnowledgeBaseConfigurationAuthenticationUioFromJSONTyped(json, ignoreDiscriminator) {
25
+ if (json == null) {
26
+ return json;
27
+ }
28
+ if (typeof json !== 'object') {
29
+ return json;
30
+ }
31
+ if ((0, KnowledgeBaseConfigurationAuthenticationOneOfUio_1.instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio)(json)) {
32
+ return (0, KnowledgeBaseConfigurationAuthenticationOneOfUio_1.KnowledgeBaseConfigurationAuthenticationOneOfUioFromJSONTyped)(json, true);
33
+ }
34
+ return {};
35
+ }
36
+ function KnowledgeBaseConfigurationAuthenticationUioToJSON(json) {
37
+ return KnowledgeBaseConfigurationAuthenticationUioToJSONTyped(json, false);
38
+ }
39
+ function KnowledgeBaseConfigurationAuthenticationUioToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ if (typeof value !== 'object') {
44
+ return value;
45
+ }
46
+ if ((0, KnowledgeBaseConfigurationAuthenticationOneOfUio_1.instanceOfKnowledgeBaseConfigurationAuthenticationOneOfUio)(value)) {
47
+ return (0, KnowledgeBaseConfigurationAuthenticationOneOfUio_1.KnowledgeBaseConfigurationAuthenticationOneOfUioToJSON)(value);
48
+ }
49
+ return {};
50
+ }
@@ -0,0 +1,151 @@
1
+ /**
2
+ * brain-client
3
+ * Api ands models for brain-app and brain-app
4
+ *
5
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 { KnowledgeBaseConfigurationAuthenticationUio } from './KnowledgeBaseConfigurationAuthenticationUio';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface KnowledgeBaseConfigurationUio
17
+ */
18
+ export interface KnowledgeBaseConfigurationUio {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof KnowledgeBaseConfigurationUio
23
+ */
24
+ host?: string | null;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof KnowledgeBaseConfigurationUio
29
+ */
30
+ scheme?: KnowledgeBaseConfigurationUioSchemeEnum | null;
31
+ /**
32
+ *
33
+ * @type {KnowledgeBaseConfigurationAuthenticationUio}
34
+ * @memberof KnowledgeBaseConfigurationUio
35
+ */
36
+ authentication?: KnowledgeBaseConfigurationAuthenticationUio;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof KnowledgeBaseConfigurationUio
41
+ */
42
+ indexName?: string | null;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof KnowledgeBaseConfigurationUio
47
+ */
48
+ colpaliKnowledgeBaseId?: string | null;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof KnowledgeBaseConfigurationUio
53
+ */
54
+ emptyKnowledgeResult?: string | null;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof KnowledgeBaseConfigurationUio
59
+ */
60
+ additionalInstructions?: string | null;
61
+ /**
62
+ *
63
+ * @type {string}
64
+ * @memberof KnowledgeBaseConfigurationUio
65
+ */
66
+ fusionType?: KnowledgeBaseConfigurationUioFusionTypeEnum | null;
67
+ /**
68
+ *
69
+ * @type {string}
70
+ * @memberof KnowledgeBaseConfigurationUio
71
+ */
72
+ toolDescription?: string | null;
73
+ /**
74
+ *
75
+ * @type {string}
76
+ * @memberof KnowledgeBaseConfigurationUio
77
+ */
78
+ toolParametersQueryDescription?: string | null;
79
+ /**
80
+ *
81
+ * @type {number}
82
+ * @memberof KnowledgeBaseConfigurationUio
83
+ */
84
+ scoreThreshold?: number | null;
85
+ /**
86
+ *
87
+ * @type {number}
88
+ * @memberof KnowledgeBaseConfigurationUio
89
+ */
90
+ maxDocuments?: number | null;
91
+ /**
92
+ *
93
+ * @type {number}
94
+ * @memberof KnowledgeBaseConfigurationUio
95
+ */
96
+ maxRetrievalLength?: number | null;
97
+ /**
98
+ *
99
+ * @type {string}
100
+ * @memberof KnowledgeBaseConfigurationUio
101
+ */
102
+ vectorizerModel?: string | null;
103
+ /**
104
+ *
105
+ * @type {number}
106
+ * @memberof KnowledgeBaseConfigurationUio
107
+ */
108
+ vectorizerModelDimensions?: number | null;
109
+ /**
110
+ *
111
+ * @type {string}
112
+ * @memberof KnowledgeBaseConfigurationUio
113
+ */
114
+ embeddingProviderId?: string | null;
115
+ /**
116
+ *
117
+ * @type {string}
118
+ * @memberof KnowledgeBaseConfigurationUio
119
+ */
120
+ embeddingModelId?: string | null;
121
+ /**
122
+ *
123
+ * @type {number}
124
+ * @memberof KnowledgeBaseConfigurationUio
125
+ */
126
+ embeddingDimensions?: number | null;
127
+ }
128
+ /**
129
+ * @export
130
+ */
131
+ export declare const KnowledgeBaseConfigurationUioSchemeEnum: {
132
+ readonly Http: "http";
133
+ readonly Https: "https";
134
+ };
135
+ export type KnowledgeBaseConfigurationUioSchemeEnum = typeof KnowledgeBaseConfigurationUioSchemeEnum[keyof typeof KnowledgeBaseConfigurationUioSchemeEnum];
136
+ /**
137
+ * @export
138
+ */
139
+ export declare const KnowledgeBaseConfigurationUioFusionTypeEnum: {
140
+ readonly RankedFusion: "rankedFusion";
141
+ readonly RelativeScoreFusion: "relativeScoreFusion";
142
+ };
143
+ export type KnowledgeBaseConfigurationUioFusionTypeEnum = typeof KnowledgeBaseConfigurationUioFusionTypeEnum[keyof typeof KnowledgeBaseConfigurationUioFusionTypeEnum];
144
+ /**
145
+ * Check if a given object implements the KnowledgeBaseConfigurationUio interface.
146
+ */
147
+ export declare function instanceOfKnowledgeBaseConfigurationUio(value: object): value is KnowledgeBaseConfigurationUio;
148
+ export declare function KnowledgeBaseConfigurationUioFromJSON(json: any): KnowledgeBaseConfigurationUio;
149
+ export declare function KnowledgeBaseConfigurationUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeBaseConfigurationUio;
150
+ export declare function KnowledgeBaseConfigurationUioToJSON(json: any): KnowledgeBaseConfigurationUio;
151
+ export declare function KnowledgeBaseConfigurationUioToJSONTyped(value?: KnowledgeBaseConfigurationUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,98 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * brain-client
6
+ * Api ands models for brain-app and brain-app
7
+ *
8
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 });
16
+ exports.KnowledgeBaseConfigurationUioFusionTypeEnum = exports.KnowledgeBaseConfigurationUioSchemeEnum = void 0;
17
+ exports.instanceOfKnowledgeBaseConfigurationUio = instanceOfKnowledgeBaseConfigurationUio;
18
+ exports.KnowledgeBaseConfigurationUioFromJSON = KnowledgeBaseConfigurationUioFromJSON;
19
+ exports.KnowledgeBaseConfigurationUioFromJSONTyped = KnowledgeBaseConfigurationUioFromJSONTyped;
20
+ exports.KnowledgeBaseConfigurationUioToJSON = KnowledgeBaseConfigurationUioToJSON;
21
+ exports.KnowledgeBaseConfigurationUioToJSONTyped = KnowledgeBaseConfigurationUioToJSONTyped;
22
+ const KnowledgeBaseConfigurationAuthenticationUio_1 = require("./KnowledgeBaseConfigurationAuthenticationUio");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.KnowledgeBaseConfigurationUioSchemeEnum = {
27
+ Http: 'http',
28
+ Https: 'https'
29
+ };
30
+ /**
31
+ * @export
32
+ */
33
+ exports.KnowledgeBaseConfigurationUioFusionTypeEnum = {
34
+ RankedFusion: 'rankedFusion',
35
+ RelativeScoreFusion: 'relativeScoreFusion'
36
+ };
37
+ /**
38
+ * Check if a given object implements the KnowledgeBaseConfigurationUio interface.
39
+ */
40
+ function instanceOfKnowledgeBaseConfigurationUio(value) {
41
+ return true;
42
+ }
43
+ function KnowledgeBaseConfigurationUioFromJSON(json) {
44
+ return KnowledgeBaseConfigurationUioFromJSONTyped(json, false);
45
+ }
46
+ function KnowledgeBaseConfigurationUioFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'host': json['host'] == null ? undefined : json['host'],
52
+ 'scheme': json['scheme'] == null ? undefined : json['scheme'],
53
+ 'authentication': json['authentication'] == null ? undefined : (0, KnowledgeBaseConfigurationAuthenticationUio_1.KnowledgeBaseConfigurationAuthenticationUioFromJSON)(json['authentication']),
54
+ 'indexName': json['indexName'] == null ? undefined : json['indexName'],
55
+ 'colpaliKnowledgeBaseId': json['colpaliKnowledgeBaseId'] == null ? undefined : json['colpaliKnowledgeBaseId'],
56
+ 'emptyKnowledgeResult': json['emptyKnowledgeResult'] == null ? undefined : json['emptyKnowledgeResult'],
57
+ 'additionalInstructions': json['additionalInstructions'] == null ? undefined : json['additionalInstructions'],
58
+ 'fusionType': json['fusionType'] == null ? undefined : json['fusionType'],
59
+ 'toolDescription': json['toolDescription'] == null ? undefined : json['toolDescription'],
60
+ 'toolParametersQueryDescription': json['toolParametersQueryDescription'] == null ? undefined : json['toolParametersQueryDescription'],
61
+ 'scoreThreshold': json['scoreThreshold'] == null ? undefined : json['scoreThreshold'],
62
+ 'maxDocuments': json['maxDocuments'] == null ? undefined : json['maxDocuments'],
63
+ 'maxRetrievalLength': json['maxRetrievalLength'] == null ? undefined : json['maxRetrievalLength'],
64
+ 'vectorizerModel': json['vectorizerModel'] == null ? undefined : json['vectorizerModel'],
65
+ 'vectorizerModelDimensions': json['vectorizerModelDimensions'] == null ? undefined : json['vectorizerModelDimensions'],
66
+ 'embeddingProviderId': json['embeddingProviderId'] == null ? undefined : json['embeddingProviderId'],
67
+ 'embeddingModelId': json['embeddingModelId'] == null ? undefined : json['embeddingModelId'],
68
+ 'embeddingDimensions': json['embeddingDimensions'] == null ? undefined : json['embeddingDimensions'],
69
+ };
70
+ }
71
+ function KnowledgeBaseConfigurationUioToJSON(json) {
72
+ return KnowledgeBaseConfigurationUioToJSONTyped(json, false);
73
+ }
74
+ function KnowledgeBaseConfigurationUioToJSONTyped(value, ignoreDiscriminator = false) {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+ return {
79
+ 'host': value['host'],
80
+ 'scheme': value['scheme'],
81
+ 'authentication': (0, KnowledgeBaseConfigurationAuthenticationUio_1.KnowledgeBaseConfigurationAuthenticationUioToJSON)(value['authentication']),
82
+ 'indexName': value['indexName'],
83
+ 'colpaliKnowledgeBaseId': value['colpaliKnowledgeBaseId'],
84
+ 'emptyKnowledgeResult': value['emptyKnowledgeResult'],
85
+ 'additionalInstructions': value['additionalInstructions'],
86
+ 'fusionType': value['fusionType'],
87
+ 'toolDescription': value['toolDescription'],
88
+ 'toolParametersQueryDescription': value['toolParametersQueryDescription'],
89
+ 'scoreThreshold': value['scoreThreshold'],
90
+ 'maxDocuments': value['maxDocuments'],
91
+ 'maxRetrievalLength': value['maxRetrievalLength'],
92
+ 'vectorizerModel': value['vectorizerModel'],
93
+ 'vectorizerModelDimensions': value['vectorizerModelDimensions'],
94
+ 'embeddingProviderId': value['embeddingProviderId'],
95
+ 'embeddingModelId': value['embeddingModelId'],
96
+ 'embeddingDimensions': value['embeddingDimensions'],
97
+ };
98
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * brain-client
3
+ * Api ands models for brain-app and brain-app
4
+ *
5
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface KnowledgeFilePagePreviewUio
16
+ */
17
+ export interface KnowledgeFilePagePreviewUio {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof KnowledgeFilePagePreviewUio
22
+ */
23
+ url: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof KnowledgeFilePagePreviewUio
28
+ */
29
+ key?: string;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof KnowledgeFilePagePreviewUio
34
+ */
35
+ pageIndex: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the KnowledgeFilePagePreviewUio interface.
39
+ */
40
+ export declare function instanceOfKnowledgeFilePagePreviewUio(value: object): value is KnowledgeFilePagePreviewUio;
41
+ export declare function KnowledgeFilePagePreviewUioFromJSON(json: any): KnowledgeFilePagePreviewUio;
42
+ export declare function KnowledgeFilePagePreviewUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeFilePagePreviewUio;
43
+ export declare function KnowledgeFilePagePreviewUioToJSON(json: any): KnowledgeFilePagePreviewUio;
44
+ export declare function KnowledgeFilePagePreviewUioToJSONTyped(value?: KnowledgeFilePagePreviewUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * brain-client
6
+ * Api ands models for brain-app and brain-app
7
+ *
8
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
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 });
16
+ exports.instanceOfKnowledgeFilePagePreviewUio = instanceOfKnowledgeFilePagePreviewUio;
17
+ exports.KnowledgeFilePagePreviewUioFromJSON = KnowledgeFilePagePreviewUioFromJSON;
18
+ exports.KnowledgeFilePagePreviewUioFromJSONTyped = KnowledgeFilePagePreviewUioFromJSONTyped;
19
+ exports.KnowledgeFilePagePreviewUioToJSON = KnowledgeFilePagePreviewUioToJSON;
20
+ exports.KnowledgeFilePagePreviewUioToJSONTyped = KnowledgeFilePagePreviewUioToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the KnowledgeFilePagePreviewUio interface.
23
+ */
24
+ function instanceOfKnowledgeFilePagePreviewUio(value) {
25
+ if (!('url' in value) || value['url'] === undefined)
26
+ return false;
27
+ if (!('pageIndex' in value) || value['pageIndex'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function KnowledgeFilePagePreviewUioFromJSON(json) {
32
+ return KnowledgeFilePagePreviewUioFromJSONTyped(json, false);
33
+ }
34
+ function KnowledgeFilePagePreviewUioFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'url': json['url'],
40
+ 'key': json['key'] == null ? undefined : json['key'],
41
+ 'pageIndex': json['pageIndex'],
42
+ };
43
+ }
44
+ function KnowledgeFilePagePreviewUioToJSON(json) {
45
+ return KnowledgeFilePagePreviewUioToJSONTyped(json, false);
46
+ }
47
+ function KnowledgeFilePagePreviewUioToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'url': value['url'],
53
+ 'key': value['key'],
54
+ 'pageIndex': value['pageIndex'],
55
+ };
56
+ }
@@ -159,10 +159,14 @@ export * from './ImageKnowledgeUio';
159
159
  export * from './ImportFileToAgentKnowledge200ResponseUio';
160
160
  export * from './InputUio';
161
161
  export * from './InstanceUio';
162
+ export * from './KnowledgeBaseConfigurationAuthenticationOneOfUio';
163
+ export * from './KnowledgeBaseConfigurationAuthenticationUio';
164
+ export * from './KnowledgeBaseConfigurationUio';
162
165
  export * from './KnowledgeBaseFilesInnerUio';
163
166
  export * from './KnowledgeBasePrivacyUio';
164
167
  export * from './KnowledgeBaseUio';
165
168
  export * from './KnowledgeBaseWithFilesUio';
169
+ export * from './KnowledgeFilePagePreviewUio';
166
170
  export * from './KnowledgeFileSummaryKnowledgeBaseIdUio';
167
171
  export * from './KnowledgeFileSummaryUio';
168
172
  export * from './KnowledgeFilesByIdsRequestUio';
@@ -177,10 +177,14 @@ __exportStar(require("./ImageKnowledgeUio"), exports);
177
177
  __exportStar(require("./ImportFileToAgentKnowledge200ResponseUio"), exports);
178
178
  __exportStar(require("./InputUio"), exports);
179
179
  __exportStar(require("./InstanceUio"), exports);
180
+ __exportStar(require("./KnowledgeBaseConfigurationAuthenticationOneOfUio"), exports);
181
+ __exportStar(require("./KnowledgeBaseConfigurationAuthenticationUio"), exports);
182
+ __exportStar(require("./KnowledgeBaseConfigurationUio"), exports);
180
183
  __exportStar(require("./KnowledgeBaseFilesInnerUio"), exports);
181
184
  __exportStar(require("./KnowledgeBasePrivacyUio"), exports);
182
185
  __exportStar(require("./KnowledgeBaseUio"), exports);
183
186
  __exportStar(require("./KnowledgeBaseWithFilesUio"), exports);
187
+ __exportStar(require("./KnowledgeFilePagePreviewUio"), exports);
184
188
  __exportStar(require("./KnowledgeFileSummaryKnowledgeBaseIdUio"), exports);
185
189
  __exportStar(require("./KnowledgeFileSummaryUio"), exports);
186
190
  __exportStar(require("./KnowledgeFilesByIdsRequestUio"), exports);
package/dist/openapi.json CHANGED
@@ -6084,6 +6084,185 @@
6084
6084
  "tags" : [ "knowledge" ]
6085
6085
  }
6086
6086
  },
6087
+ "/knowledge-bases/{knowledgebaseId}/configuration" : {
6088
+ "get" : {
6089
+ "description" : "Returns the current configuration for a knowledge base",
6090
+ "operationId" : "getKnowledgeBaseConfiguration",
6091
+ "parameters" : [ {
6092
+ "description" : "ID of the knowledge base to retrieve",
6093
+ "in" : "path",
6094
+ "name" : "knowledgebaseId",
6095
+ "required" : true,
6096
+ "schema" : {
6097
+ "format" : "uuid",
6098
+ "type" : "string"
6099
+ }
6100
+ } ],
6101
+ "responses" : {
6102
+ "200" : {
6103
+ "content" : {
6104
+ "application/json" : {
6105
+ "schema" : {
6106
+ "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
6107
+ }
6108
+ }
6109
+ },
6110
+ "description" : "Configuration retrieved successfully"
6111
+ },
6112
+ "401" : {
6113
+ "description" : "Unauthorized"
6114
+ },
6115
+ "404" : {
6116
+ "description" : "Knowledge base not found"
6117
+ },
6118
+ "500" : {
6119
+ "description" : "Server error"
6120
+ }
6121
+ },
6122
+ "summary" : "Get knowledge base configuration",
6123
+ "tags" : [ "knowledge" ]
6124
+ },
6125
+ "put" : {
6126
+ "description" : "Updates the module configuration for a knowledge base",
6127
+ "operationId" : "updateKnowledgeBaseConfiguration",
6128
+ "parameters" : [ {
6129
+ "description" : "ID of the knowledge base to retrieve",
6130
+ "in" : "path",
6131
+ "name" : "knowledgebaseId",
6132
+ "required" : true,
6133
+ "schema" : {
6134
+ "format" : "uuid",
6135
+ "type" : "string"
6136
+ }
6137
+ } ],
6138
+ "requestBody" : {
6139
+ "content" : {
6140
+ "application/json" : {
6141
+ "schema" : {
6142
+ "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
6143
+ }
6144
+ }
6145
+ },
6146
+ "required" : true
6147
+ },
6148
+ "responses" : {
6149
+ "200" : {
6150
+ "content" : {
6151
+ "application/json" : {
6152
+ "schema" : {
6153
+ "additionalProperties" : true,
6154
+ "type" : "object"
6155
+ }
6156
+ }
6157
+ },
6158
+ "description" : "Configuration updated successfully"
6159
+ },
6160
+ "400" : {
6161
+ "description" : "Invalid configuration payload"
6162
+ },
6163
+ "401" : {
6164
+ "description" : "Unauthorized"
6165
+ },
6166
+ "404" : {
6167
+ "description" : "Knowledge base not found"
6168
+ },
6169
+ "500" : {
6170
+ "description" : "Server error"
6171
+ }
6172
+ },
6173
+ "summary" : "Update knowledge base configuration",
6174
+ "tags" : [ "knowledge" ]
6175
+ }
6176
+ },
6177
+ "/knowledge-files/{fileId}" : {
6178
+ "get" : {
6179
+ "description" : "Retrieves metadata for a specific knowledge file by file ID",
6180
+ "operationId" : "getKnowledgeFile",
6181
+ "parameters" : [ {
6182
+ "description" : "The ID of the file",
6183
+ "in" : "path",
6184
+ "name" : "fileId",
6185
+ "required" : true,
6186
+ "schema" : {
6187
+ "type" : "string"
6188
+ }
6189
+ } ],
6190
+ "responses" : {
6191
+ "200" : {
6192
+ "content" : {
6193
+ "application/json" : {
6194
+ "schema" : {
6195
+ "$ref" : "#/components/schemas/FileWithDownloadUrl"
6196
+ }
6197
+ }
6198
+ },
6199
+ "description" : "File details retrieved successfully"
6200
+ },
6201
+ "401" : {
6202
+ "description" : "Unauthorized"
6203
+ },
6204
+ "404" : {
6205
+ "description" : "File not found"
6206
+ },
6207
+ "500" : {
6208
+ "description" : "Server error"
6209
+ }
6210
+ },
6211
+ "summary" : "Get a specific knowledge file",
6212
+ "tags" : [ "knowledge" ]
6213
+ }
6214
+ },
6215
+ "/knowledge-files/{fileId}/status" : {
6216
+ "post" : {
6217
+ "description" : "Updates the status of a knowledge file and triggers indexing when uploaded",
6218
+ "operationId" : "updateKnowledgeFileStatus",
6219
+ "parameters" : [ {
6220
+ "description" : "The ID of the file",
6221
+ "in" : "path",
6222
+ "name" : "fileId",
6223
+ "required" : true,
6224
+ "schema" : {
6225
+ "type" : "string"
6226
+ }
6227
+ } ],
6228
+ "requestBody" : {
6229
+ "content" : {
6230
+ "application/json" : {
6231
+ "schema" : {
6232
+ "$ref" : "#/components/schemas/FileStatusUpdateRequest"
6233
+ }
6234
+ }
6235
+ },
6236
+ "required" : true
6237
+ },
6238
+ "responses" : {
6239
+ "200" : {
6240
+ "content" : {
6241
+ "application/json" : {
6242
+ "schema" : {
6243
+ "$ref" : "#/components/schemas/File"
6244
+ }
6245
+ }
6246
+ },
6247
+ "description" : "File status updated successfully"
6248
+ },
6249
+ "400" : {
6250
+ "description" : "Invalid status update"
6251
+ },
6252
+ "401" : {
6253
+ "description" : "Unauthorized"
6254
+ },
6255
+ "404" : {
6256
+ "description" : "File not found"
6257
+ },
6258
+ "500" : {
6259
+ "description" : "Server error"
6260
+ }
6261
+ },
6262
+ "summary" : "Update knowledge file status",
6263
+ "tags" : [ "knowledge" ]
6264
+ }
6265
+ },
6087
6266
  "/knowledge-files/by-ids" : {
6088
6267
  "post" : {
6089
6268
  "description" : "Returns knowledge file summaries (id and name) for the given file IDs.",
@@ -6123,6 +6302,53 @@
6123
6302
  "tags" : [ "knowledge" ]
6124
6303
  }
6125
6304
  },
6305
+ "/knowledge-files/{fileId}/page-preview" : {
6306
+ "get" : {
6307
+ "description" : "Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).",
6308
+ "operationId" : "getKnowledgeFilePagePreview",
6309
+ "parameters" : [ {
6310
+ "description" : "The ID of the file",
6311
+ "in" : "path",
6312
+ "name" : "fileId",
6313
+ "required" : true,
6314
+ "schema" : {
6315
+ "type" : "string"
6316
+ }
6317
+ }, {
6318
+ "description" : "Zero-based page index.",
6319
+ "in" : "query",
6320
+ "name" : "pageIndex",
6321
+ "required" : true,
6322
+ "schema" : {
6323
+ "minimum" : 0,
6324
+ "type" : "integer"
6325
+ }
6326
+ } ],
6327
+ "responses" : {
6328
+ "200" : {
6329
+ "content" : {
6330
+ "application/json" : {
6331
+ "schema" : {
6332
+ "$ref" : "#/components/schemas/KnowledgeFilePagePreview"
6333
+ }
6334
+ }
6335
+ },
6336
+ "description" : "Presigned preview URL"
6337
+ },
6338
+ "400" : {
6339
+ "description" : "Invalid page index or unsupported knowledge base type"
6340
+ },
6341
+ "401" : {
6342
+ "description" : "Unauthorized"
6343
+ },
6344
+ "404" : {
6345
+ "description" : "File not found"
6346
+ }
6347
+ },
6348
+ "summary" : "Get a presigned preview URL for a knowledge file page",
6349
+ "tags" : [ "knowledge" ]
6350
+ }
6351
+ },
6126
6352
  "/tools" : {
6127
6353
  "get" : {
6128
6354
  "description" : "Returns tools matching optional search query, with pagination",
@@ -11175,6 +11401,84 @@
11175
11401
  "enum" : [ "SCRAPING", "PENDING", "UPLOADED", "PROCESSING", "INDEXED" ],
11176
11402
  "type" : "string"
11177
11403
  },
11404
+ "KnowledgeBaseConfiguration" : {
11405
+ "properties" : {
11406
+ "host" : {
11407
+ "nullable" : true,
11408
+ "type" : "string"
11409
+ },
11410
+ "scheme" : {
11411
+ "enum" : [ "http", "https" ],
11412
+ "nullable" : true,
11413
+ "type" : "string"
11414
+ },
11415
+ "authentication" : {
11416
+ "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication"
11417
+ },
11418
+ "indexName" : {
11419
+ "nullable" : true,
11420
+ "type" : "string"
11421
+ },
11422
+ "colpaliKnowledgeBaseId" : {
11423
+ "nullable" : true,
11424
+ "type" : "string"
11425
+ },
11426
+ "emptyKnowledgeResult" : {
11427
+ "nullable" : true,
11428
+ "type" : "string"
11429
+ },
11430
+ "additionalInstructions" : {
11431
+ "nullable" : true,
11432
+ "type" : "string"
11433
+ },
11434
+ "fusionType" : {
11435
+ "enum" : [ "rankedFusion", "relativeScoreFusion" ],
11436
+ "nullable" : true,
11437
+ "type" : "string"
11438
+ },
11439
+ "toolDescription" : {
11440
+ "nullable" : true,
11441
+ "type" : "string"
11442
+ },
11443
+ "toolParametersQueryDescription" : {
11444
+ "nullable" : true,
11445
+ "type" : "string"
11446
+ },
11447
+ "scoreThreshold" : {
11448
+ "nullable" : true,
11449
+ "type" : "number"
11450
+ },
11451
+ "maxDocuments" : {
11452
+ "nullable" : true,
11453
+ "type" : "number"
11454
+ },
11455
+ "maxRetrievalLength" : {
11456
+ "nullable" : true,
11457
+ "type" : "number"
11458
+ },
11459
+ "vectorizerModel" : {
11460
+ "nullable" : true,
11461
+ "type" : "string"
11462
+ },
11463
+ "vectorizerModelDimensions" : {
11464
+ "nullable" : true,
11465
+ "type" : "number"
11466
+ },
11467
+ "embeddingProviderId" : {
11468
+ "nullable" : true,
11469
+ "type" : "string"
11470
+ },
11471
+ "embeddingModelId" : {
11472
+ "nullable" : true,
11473
+ "type" : "string"
11474
+ },
11475
+ "embeddingDimensions" : {
11476
+ "nullable" : true,
11477
+ "type" : "number"
11478
+ }
11479
+ },
11480
+ "type" : "object"
11481
+ },
11178
11482
  "KnowledgeFilesByIdsRequest" : {
11179
11483
  "properties" : {
11180
11484
  "ids" : {
@@ -11188,6 +11492,21 @@
11188
11492
  "required" : [ "ids" ],
11189
11493
  "type" : "object"
11190
11494
  },
11495
+ "KnowledgeFilePagePreview" : {
11496
+ "properties" : {
11497
+ "url" : {
11498
+ "type" : "string"
11499
+ },
11500
+ "key" : {
11501
+ "type" : "string"
11502
+ },
11503
+ "pageIndex" : {
11504
+ "type" : "integer"
11505
+ }
11506
+ },
11507
+ "required" : [ "pageIndex", "url" ],
11508
+ "type" : "object"
11509
+ },
11191
11510
  "ToolCreateRequest" : {
11192
11511
  "additionalProperties" : false,
11193
11512
  "properties" : {
@@ -12594,6 +12913,28 @@
12594
12913
  "type" : "array"
12595
12914
  } ]
12596
12915
  },
12916
+ "KnowledgeBaseConfiguration_authentication_oneOf" : {
12917
+ "nullable" : true,
12918
+ "properties" : {
12919
+ "apiKey" : {
12920
+ "type" : "string"
12921
+ },
12922
+ "type" : {
12923
+ "enum" : [ "API_KEY" ],
12924
+ "type" : "string"
12925
+ }
12926
+ },
12927
+ "type" : "object"
12928
+ },
12929
+ "KnowledgeBaseConfiguration_authentication" : {
12930
+ "oneOf" : [ {
12931
+ "enum" : [ "NONE" ],
12932
+ "nullable" : true,
12933
+ "type" : "string"
12934
+ }, {
12935
+ "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication_oneOf"
12936
+ } ]
12937
+ },
12597
12938
  "ToolSecure_configuration" : {
12598
12939
  "additionalProperties" : true,
12599
12940
  "properties" : {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breign/client",
3
- "version": "1.0.83",
3
+ "version": "1.0.84",
4
4
  "main": "dist/index.js",
5
5
  "exports": {
6
6
  ".": "./dist/index.js",