@breign/client 1.0.109 → 1.0.110

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/dist/apis/AppApi.d.ts +92 -18
  2. package/dist/apis/AppApi.js +196 -32
  3. package/dist/apis/KnowledgeApi.d.ts +120 -8
  4. package/dist/apis/KnowledgeApi.js +268 -30
  5. package/dist/apis/PromptsApi.d.ts +3 -3
  6. package/dist/apis/PromptsApi.js +3 -2
  7. package/dist/apis/ToolsApi.d.ts +42 -1
  8. package/dist/apis/ToolsApi.js +87 -0
  9. package/dist/models/AddCustomFiller201ResponseFillerUio.d.ts +50 -0
  10. package/dist/models/AddCustomFiller201ResponseFillerUio.js +62 -0
  11. package/dist/models/AddCustomFiller201ResponseUio.d.ts +39 -0
  12. package/dist/models/AddCustomFiller201ResponseUio.js +55 -0
  13. package/dist/models/AddCustomFillerRequestUio.d.ts +32 -0
  14. package/dist/models/AddCustomFillerRequestUio.js +50 -0
  15. package/dist/models/AgentPatchUio.d.ts +1 -1
  16. package/dist/models/AgentUio.d.ts +1 -1
  17. package/dist/models/FileCreationRequestUio.d.ts +6 -0
  18. package/dist/models/FileCreationRequestUio.js +2 -0
  19. package/dist/models/FileCreationResponseUio.d.ts +38 -0
  20. package/dist/models/FileCreationResponseUio.js +18 -0
  21. package/dist/models/FileUio.d.ts +38 -0
  22. package/dist/models/FileUio.js +18 -0
  23. package/dist/models/FileWithDownloadUrlUio.d.ts +38 -0
  24. package/dist/models/FileWithDownloadUrlUio.js +18 -0
  25. package/dist/models/KnowledgeSitePageUio.d.ts +129 -0
  26. package/dist/models/KnowledgeSitePageUio.js +101 -0
  27. package/dist/models/MessageStatusErrorUio.d.ts +38 -0
  28. package/dist/models/MessageStatusErrorUio.js +50 -0
  29. package/dist/models/MessageStatusToolCallUio.d.ts +38 -0
  30. package/dist/models/MessageStatusToolCallUio.js +54 -0
  31. package/dist/models/MessageStatusUio.d.ts +79 -0
  32. package/dist/models/MessageStatusUio.js +73 -0
  33. package/dist/models/PatchKnowledgeBaseRequestUio.d.ts +38 -0
  34. package/dist/models/PatchKnowledgeBaseRequestUio.js +54 -0
  35. package/dist/models/PatchKnowledgeFileRequestUio.d.ts +32 -0
  36. package/dist/models/PatchKnowledgeFileRequestUio.js +50 -0
  37. package/dist/models/SearchKnowledgeBase200ResponseInnerUio.d.ts +52 -0
  38. package/dist/models/SearchKnowledgeBase200ResponseInnerUio.js +60 -0
  39. package/dist/models/SearchKnowledgeBaseRequestUio.d.ts +38 -0
  40. package/dist/models/SearchKnowledgeBaseRequestUio.js +52 -0
  41. package/dist/models/StartKnowledgeBaseScrappingRequestUio.d.ts +88 -0
  42. package/dist/models/StartKnowledgeBaseScrappingRequestUio.js +74 -0
  43. package/dist/models/UpdateSelectedFillers200ResponseUio.d.ts +39 -0
  44. package/dist/models/UpdateSelectedFillers200ResponseUio.js +55 -0
  45. package/dist/models/UpdateSelectedFillersRequestDataInnerUio.d.ts +38 -0
  46. package/dist/models/UpdateSelectedFillersRequestDataInnerUio.js +54 -0
  47. package/dist/models/UpdateSelectedFillersRequestUio.d.ts +33 -0
  48. package/dist/models/UpdateSelectedFillersRequestUio.js +51 -0
  49. package/dist/models/UpdateToolStaticCredentialsRequestUio.d.ts +38 -0
  50. package/dist/models/UpdateToolStaticCredentialsRequestUio.js +50 -0
  51. package/dist/models/UploadImageToKnowledgeBaseLibrary200ResponseUio.d.ts +41 -0
  52. package/dist/models/UploadImageToKnowledgeBaseLibrary200ResponseUio.js +55 -0
  53. package/dist/models/UploadImageToKnowledgeBaseLibraryRequestUio.d.ts +50 -0
  54. package/dist/models/UploadImageToKnowledgeBaseLibraryRequestUio.js +62 -0
  55. package/dist/models/index.d.ts +18 -1
  56. package/dist/models/index.js +18 -1
  57. package/dist/openapi.json +1365 -282
  58. package/package.json +1 -1
  59. package/dist/models/AudioFillerExistsResponseUio.d.ts +0 -32
  60. package/dist/models/AudioFillerExistsResponseUio.js +0 -50
@@ -10,14 +10,14 @@
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, KnowledgeBaseConfigurationUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFilePagePreviewUio, 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, KnowledgeSitePageUio, PatchKnowledgeBaseRequestUio, PatchKnowledgeFileRequestUio, SearchKnowledgeBase200ResponseInnerUio, SearchKnowledgeBaseRequestUio, StartKnowledgeBaseScrappingRequestUio, UploadImageToKnowledgeBaseLibrary200ResponseUio, UploadImageToKnowledgeBaseLibraryRequestUio } from '../models/index';
14
14
  export interface AddDocumentToKnowledgeBaseRequest {
15
15
  agentId: string;
16
16
  documentAddRequestUio: DocumentAddRequestUio;
17
17
  noSplit?: boolean;
18
18
  }
19
19
  export interface AddFileToKnowledgeBaseRequest {
20
- organizationId: string;
20
+ knowledgebaseId: string;
21
21
  fileCreationRequestUio: FileCreationRequestUio;
22
22
  }
23
23
  export interface CreateModuleForOrganizationRequest {
@@ -36,6 +36,9 @@ export interface DeleteImageFromKnowledgeBaseLibraryRequest {
36
36
  knowledgebaseId: string;
37
37
  imageId: string;
38
38
  }
39
+ export interface DeleteKnowledgeBaseRequest {
40
+ knowledgebaseId: string;
41
+ }
39
42
  export interface GetAgentKnowledgeFilesRequest {
40
43
  agentId: string;
41
44
  searchName?: string;
@@ -56,6 +59,9 @@ export interface GetImagesFromKnowledgeBaseLibraryRequest {
56
59
  export interface GetInactiveKnowledgeFileIdsRequest {
57
60
  knowledgebaseId: string;
58
61
  }
62
+ export interface GetKnowledgeBaseRequest {
63
+ knowledgebaseId: string;
64
+ }
59
65
  export interface GetKnowledgeBaseConfigurationRequest {
60
66
  knowledgebaseId: string;
61
67
  }
@@ -66,9 +72,15 @@ export interface GetKnowledgeFilePagePreviewRequest {
66
72
  fileId: string;
67
73
  pageIndex: number;
68
74
  }
75
+ export interface GetKnowledgeFilesRequest {
76
+ knowledgeBaseIds: Array<string>;
77
+ }
69
78
  export interface GetKnowledgeFilesByIdsRequest {
70
79
  knowledgeFilesByIdsRequestUio: KnowledgeFilesByIdsRequestUio;
71
80
  }
81
+ export interface GetKnowledgeSitePagesForFileRequest {
82
+ fileId: string;
83
+ }
72
84
  export interface ImportFileToAgentKnowledgeRequest {
73
85
  agentId: string;
74
86
  file: Blob;
@@ -76,6 +88,14 @@ export interface ImportFileToAgentKnowledgeRequest {
76
88
  export interface ImportProjectsToAgentKnowledgeRequest {
77
89
  agentId: string;
78
90
  }
91
+ export interface PatchKnowledgeBaseRequest {
92
+ knowledgebaseId: string;
93
+ patchKnowledgeBaseRequestUio: PatchKnowledgeBaseRequestUio;
94
+ }
95
+ export interface PatchKnowledgeFileRequest {
96
+ fileId: string;
97
+ patchKnowledgeFileRequestUio: PatchKnowledgeFileRequestUio;
98
+ }
79
99
  export interface PrepareFileUploadRequest {
80
100
  agentId: string;
81
101
  fileCreationRequestUio: FileCreationRequestUio;
@@ -86,6 +106,14 @@ export interface ResetAgentKnowledgeRequest {
86
106
  export interface ResetKnowledgeBaseRequest {
87
107
  organizationId: string;
88
108
  }
109
+ export interface SearchKnowledgeBaseRequest {
110
+ knowledgebaseId: string;
111
+ searchKnowledgeBaseRequestUio: SearchKnowledgeBaseRequestUio;
112
+ }
113
+ export interface StartKnowledgeBaseScrappingRequest {
114
+ knowledgebaseId: string;
115
+ startKnowledgeBaseScrappingRequestUio: StartKnowledgeBaseScrappingRequestUio;
116
+ }
89
117
  export interface UpdateFileStatusRequest {
90
118
  agentId: string;
91
119
  fileId: string;
@@ -106,7 +134,7 @@ export interface UpdateKnowledgeFileStatusRequest {
106
134
  }
107
135
  export interface UploadImageToKnowledgeBaseLibraryRequest {
108
136
  knowledgebaseId: string;
109
- image: Blob;
137
+ uploadImageToKnowledgeBaseLibraryRequestUio: UploadImageToKnowledgeBaseLibraryRequestUio;
110
138
  }
111
139
  /**
112
140
  *
@@ -131,7 +159,7 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
131
159
  * Add a file to the knowledge base
132
160
  * Add a file to the knowledge base
133
161
  */
134
- addFileToKnowledgeBase(organizationId: string, fileCreationRequestUio: FileCreationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreationResponseUio>;
162
+ addFileToKnowledgeBase(knowledgebaseId: string, fileCreationRequestUio: FileCreationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreationResponseUio>;
135
163
  /**
136
164
  * Create a new module for an organization
137
165
  * Create a new module for an organization
@@ -172,6 +200,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
172
200
  * Delete a specific knowledge image from a library image in knowledge base
173
201
  */
174
202
  deleteImageFromKnowledgeBaseLibrary(knowledgebaseId: string, imageId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
203
+ /**
204
+ * Delete a knowledge base, its vector store collection and its stored files
205
+ * Delete a knowledge base
206
+ */
207
+ deleteKnowledgeBaseRaw(requestParameters: DeleteKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BodyWithMessageUio>>;
208
+ /**
209
+ * Delete a knowledge base, its vector store collection and its stored files
210
+ * Delete a knowledge base
211
+ */
212
+ deleteKnowledgeBase(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithMessageUio>;
175
213
  /**
176
214
  * Returns all knowledge bases attached to the agent and their indexed files.
177
215
  * Get knowledge bases and files for an agent
@@ -206,12 +244,12 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
206
244
  * Get all images from a library image in knowledge base
207
245
  * Get all knowledge images from a knowledge base
208
246
  */
209
- getImagesFromKnowledgeBaseLibraryRaw(requestParameters: GetImagesFromKnowledgeBaseLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageKnowledgeUio>>;
247
+ getImagesFromKnowledgeBaseLibraryRaw(requestParameters: GetImagesFromKnowledgeBaseLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ImageKnowledgeUio>>>;
210
248
  /**
211
249
  * Get all images from a library image in knowledge base
212
250
  * Get all knowledge images from a knowledge base
213
251
  */
214
- getImagesFromKnowledgeBaseLibrary(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageKnowledgeUio>;
252
+ getImagesFromKnowledgeBaseLibrary(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ImageKnowledgeUio>>;
215
253
  /**
216
254
  * Returns an array of file IDs that are marked as inactive in the given knowledge base.
217
255
  * Get inactive knowledge file IDs for a knowledge base
@@ -222,6 +260,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
222
260
  * Get inactive knowledge file IDs for a knowledge base
223
261
  */
224
262
  getInactiveKnowledgeFileIds(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
263
+ /**
264
+ * Get a knowledge base by its ID
265
+ * Get a knowledge base
266
+ */
267
+ getKnowledgeBaseRaw(requestParameters: GetKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeBaseUio>>;
268
+ /**
269
+ * Get a knowledge base by its ID
270
+ * Get a knowledge base
271
+ */
272
+ getKnowledgeBase(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeBaseUio>;
225
273
  /**
226
274
  * Returns the current configuration for a knowledge base
227
275
  * Get knowledge base configuration
@@ -252,6 +300,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
252
300
  * Get a presigned preview URL for a knowledge file page
253
301
  */
254
302
  getKnowledgeFilePagePreview(fileId: string, pageIndex: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeFilePagePreviewUio>;
303
+ /**
304
+ * Get all knowledge files belonging to the given knowledge bases
305
+ * Get knowledge files for knowledge bases
306
+ */
307
+ getKnowledgeFilesRaw(requestParameters: GetKnowledgeFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<any>>>;
308
+ /**
309
+ * Get all knowledge files belonging to the given knowledge bases
310
+ * Get knowledge files for knowledge bases
311
+ */
312
+ getKnowledgeFiles(knowledgeBaseIds: Array<string>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<any>>;
255
313
  /**
256
314
  * Returns knowledge file summaries (id and name) for the given file IDs.
257
315
  * Get knowledge files by IDs
@@ -262,6 +320,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
262
320
  * Get knowledge files by IDs
263
321
  */
264
322
  getKnowledgeFilesByIds(knowledgeFilesByIdsRequestUio: KnowledgeFilesByIdsRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<KnowledgeFileSummaryUio>>;
323
+ /**
324
+ * Get the scraped site pages attached to a knowledge file of type website
325
+ * Get knowledge site pages for a file
326
+ */
327
+ getKnowledgeSitePagesForFileRaw(requestParameters: GetKnowledgeSitePagesForFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<KnowledgeSitePageUio>>>;
328
+ /**
329
+ * Get the scraped site pages attached to a knowledge file of type website
330
+ * Get knowledge site pages for a file
331
+ */
332
+ getKnowledgeSitePagesForFile(fileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<KnowledgeSitePageUio>>;
265
333
  /**
266
334
  * Processes documents like PDFs, CSVs, and text files, and adds them to the brain\'s knowledge base
267
335
  * Upload and import a file into the brain\'s knowledge base
@@ -282,6 +350,26 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
282
350
  * Import projects into agent knowledge
283
351
  */
284
352
  importProjectsToAgentKnowledge(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
353
+ /**
354
+ * Update the name and authorized agents of a knowledge base
355
+ * Update a knowledge base
356
+ */
357
+ patchKnowledgeBaseRaw(requestParameters: PatchKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BodyWithMessageUio>>;
358
+ /**
359
+ * Update the name and authorized agents of a knowledge base
360
+ * Update a knowledge base
361
+ */
362
+ patchKnowledgeBase(knowledgebaseId: string, patchKnowledgeBaseRequestUio: PatchKnowledgeBaseRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithMessageUio>;
363
+ /**
364
+ * Update the active state of a knowledge file
365
+ * Update a knowledge file
366
+ */
367
+ patchKnowledgeFileRaw(requestParameters: PatchKnowledgeFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BodyWithMessageUio>>;
368
+ /**
369
+ * Update the active state of a knowledge file
370
+ * Update a knowledge file
371
+ */
372
+ patchKnowledgeFile(fileId: string, patchKnowledgeFileRequestUio: PatchKnowledgeFileRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithMessageUio>;
285
373
  /**
286
374
  * Registers a file for upload to the brain\'s knowledge base and returns an upload URL
287
375
  * Prepare file upload for knowledge base
@@ -312,6 +400,30 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
312
400
  * Reset knowledge base
313
401
  */
314
402
  resetKnowledgeBase(organizationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithMessageUio>;
403
+ /**
404
+ * Run a vector search on a knowledge base and return matching chunks with their source files
405
+ * Search a knowledge base
406
+ */
407
+ searchKnowledgeBaseRaw(requestParameters: SearchKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SearchKnowledgeBase200ResponseInnerUio>>>;
408
+ /**
409
+ * Run a vector search on a knowledge base and return matching chunks with their source files
410
+ * Search a knowledge base
411
+ */
412
+ searchKnowledgeBase(knowledgebaseId: string, searchKnowledgeBaseRequestUio: SearchKnowledgeBaseRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SearchKnowledgeBase200ResponseInnerUio>>;
413
+ /**
414
+ * Trigger the scrapping service to crawl the given URLs and index the result into the knowledge base
415
+ * Start a knowledge base scrapping job
416
+ */
417
+ startKnowledgeBaseScrappingRaw(requestParameters: StartKnowledgeBaseScrappingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
418
+ [key: string]: any;
419
+ }>>;
420
+ /**
421
+ * Trigger the scrapping service to crawl the given URLs and index the result into the knowledge base
422
+ * Start a knowledge base scrapping job
423
+ */
424
+ startKnowledgeBaseScrapping(knowledgebaseId: string, startKnowledgeBaseScrappingRequestUio: StartKnowledgeBaseScrappingRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
425
+ [key: string]: any;
426
+ }>;
315
427
  /**
316
428
  * Updates the status of a knowledge file and triggers the indexing process if the file is uploaded
317
429
  * Update file status and trigger indexing
@@ -360,10 +472,10 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
360
472
  * Upload a new image to a library image in knowledge base and return the upload URL
361
473
  * Upload a new image to a library image in knowledge base
362
474
  */
363
- uploadImageToKnowledgeBaseLibraryRaw(requestParameters: UploadImageToKnowledgeBaseLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<S3UploadBodyUio>>;
475
+ uploadImageToKnowledgeBaseLibraryRaw(requestParameters: UploadImageToKnowledgeBaseLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadImageToKnowledgeBaseLibrary200ResponseUio>>;
364
476
  /**
365
477
  * Upload a new image to a library image in knowledge base and return the upload URL
366
478
  * Upload a new image to a library image in knowledge base
367
479
  */
368
- uploadImageToKnowledgeBaseLibrary(knowledgebaseId: string, image: Blob, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<S3UploadBodyUio>;
480
+ uploadImageToKnowledgeBaseLibrary(knowledgebaseId: string, uploadImageToKnowledgeBaseLibraryRequestUio: UploadImageToKnowledgeBaseLibraryRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadImageToKnowledgeBaseLibrary200ResponseUio>;
369
481
  }
@@ -94,8 +94,8 @@ class KnowledgeApi extends runtime.BaseAPI {
94
94
  * Add a file to the knowledge base
95
95
  */
96
96
  async addFileToKnowledgeBaseRaw(requestParameters, initOverrides) {
97
- if (requestParameters['organizationId'] == null) {
98
- throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling addFileToKnowledgeBase().');
97
+ if (requestParameters['knowledgebaseId'] == null) {
98
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling addFileToKnowledgeBase().');
99
99
  }
100
100
  if (requestParameters['fileCreationRequestUio'] == null) {
101
101
  throw new runtime.RequiredError('fileCreationRequestUio', 'Required parameter "fileCreationRequestUio" was null or undefined when calling addFileToKnowledgeBase().');
@@ -107,7 +107,7 @@ class KnowledgeApi extends runtime.BaseAPI {
107
107
  headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
108
108
  }
109
109
  const response = await this.request({
110
- path: `/organizations/{organizationId}/knowledge/files`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
110
+ path: `/knowledge-bases/{knowledgebaseId}/files`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
111
111
  method: 'POST',
112
112
  headers: headerParameters,
113
113
  query: queryParameters,
@@ -119,8 +119,8 @@ class KnowledgeApi extends runtime.BaseAPI {
119
119
  * Add a file to the knowledge base
120
120
  * Add a file to the knowledge base
121
121
  */
122
- async addFileToKnowledgeBase(organizationId, fileCreationRequestUio, initOverrides) {
123
- const response = await this.addFileToKnowledgeBaseRaw({ organizationId: organizationId, fileCreationRequestUio: fileCreationRequestUio }, initOverrides);
122
+ async addFileToKnowledgeBase(knowledgebaseId, fileCreationRequestUio, initOverrides) {
123
+ const response = await this.addFileToKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId, fileCreationRequestUio: fileCreationRequestUio }, initOverrides);
124
124
  return await response.value();
125
125
  }
126
126
  /**
@@ -250,6 +250,35 @@ class KnowledgeApi extends runtime.BaseAPI {
250
250
  async deleteImageFromKnowledgeBaseLibrary(knowledgebaseId, imageId, initOverrides) {
251
251
  await this.deleteImageFromKnowledgeBaseLibraryRaw({ knowledgebaseId: knowledgebaseId, imageId: imageId }, initOverrides);
252
252
  }
253
+ /**
254
+ * Delete a knowledge base, its vector store collection and its stored files
255
+ * Delete a knowledge base
256
+ */
257
+ async deleteKnowledgeBaseRaw(requestParameters, initOverrides) {
258
+ if (requestParameters['knowledgebaseId'] == null) {
259
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling deleteKnowledgeBase().');
260
+ }
261
+ const queryParameters = {};
262
+ const headerParameters = {};
263
+ if (this.configuration && this.configuration.apiKey) {
264
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
265
+ }
266
+ const response = await this.request({
267
+ path: `/knowledge-bases/{knowledgebaseId}`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
268
+ method: 'DELETE',
269
+ headers: headerParameters,
270
+ query: queryParameters,
271
+ }, initOverrides);
272
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BodyWithMessageUioFromJSON)(jsonValue));
273
+ }
274
+ /**
275
+ * Delete a knowledge base, its vector store collection and its stored files
276
+ * Delete a knowledge base
277
+ */
278
+ async deleteKnowledgeBase(knowledgebaseId, initOverrides) {
279
+ const response = await this.deleteKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
280
+ return await response.value();
281
+ }
253
282
  /**
254
283
  * Returns all knowledge bases attached to the agent and their indexed files.
255
284
  * Get knowledge bases and files for an agent
@@ -371,7 +400,7 @@ class KnowledgeApi extends runtime.BaseAPI {
371
400
  headers: headerParameters,
372
401
  query: queryParameters,
373
402
  }, initOverrides);
374
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ImageKnowledgeUioFromJSON)(jsonValue));
403
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ImageKnowledgeUioFromJSON));
375
404
  }
376
405
  /**
377
406
  * Get all images from a library image in knowledge base
@@ -410,6 +439,35 @@ class KnowledgeApi extends runtime.BaseAPI {
410
439
  const response = await this.getInactiveKnowledgeFileIdsRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
411
440
  return await response.value();
412
441
  }
442
+ /**
443
+ * Get a knowledge base by its ID
444
+ * Get a knowledge base
445
+ */
446
+ async getKnowledgeBaseRaw(requestParameters, initOverrides) {
447
+ if (requestParameters['knowledgebaseId'] == null) {
448
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling getKnowledgeBase().');
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-bases/{knowledgebaseId}`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
457
+ method: 'GET',
458
+ headers: headerParameters,
459
+ query: queryParameters,
460
+ }, initOverrides);
461
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeBaseUioFromJSON)(jsonValue));
462
+ }
463
+ /**
464
+ * Get a knowledge base by its ID
465
+ * Get a knowledge base
466
+ */
467
+ async getKnowledgeBase(knowledgebaseId, initOverrides) {
468
+ const response = await this.getKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
469
+ return await response.value();
470
+ }
413
471
  /**
414
472
  * Returns the current configuration for a knowledge base
415
473
  * Get knowledge base configuration
@@ -503,6 +561,38 @@ class KnowledgeApi extends runtime.BaseAPI {
503
561
  const response = await this.getKnowledgeFilePagePreviewRaw({ fileId: fileId, pageIndex: pageIndex }, initOverrides);
504
562
  return await response.value();
505
563
  }
564
+ /**
565
+ * Get all knowledge files belonging to the given knowledge bases
566
+ * Get knowledge files for knowledge bases
567
+ */
568
+ async getKnowledgeFilesRaw(requestParameters, initOverrides) {
569
+ if (requestParameters['knowledgeBaseIds'] == null) {
570
+ throw new runtime.RequiredError('knowledgeBaseIds', 'Required parameter "knowledgeBaseIds" was null or undefined when calling getKnowledgeFiles().');
571
+ }
572
+ const queryParameters = {};
573
+ if (requestParameters['knowledgeBaseIds'] != null) {
574
+ queryParameters['knowledgeBaseIds'] = requestParameters['knowledgeBaseIds'];
575
+ }
576
+ const headerParameters = {};
577
+ if (this.configuration && this.configuration.apiKey) {
578
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
579
+ }
580
+ const response = await this.request({
581
+ path: `/knowledge-files`,
582
+ method: 'GET',
583
+ headers: headerParameters,
584
+ query: queryParameters,
585
+ }, initOverrides);
586
+ return new runtime.JSONApiResponse(response);
587
+ }
588
+ /**
589
+ * Get all knowledge files belonging to the given knowledge bases
590
+ * Get knowledge files for knowledge bases
591
+ */
592
+ async getKnowledgeFiles(knowledgeBaseIds, initOverrides) {
593
+ const response = await this.getKnowledgeFilesRaw({ knowledgeBaseIds: knowledgeBaseIds }, initOverrides);
594
+ return await response.value();
595
+ }
506
596
  /**
507
597
  * Returns knowledge file summaries (id and name) for the given file IDs.
508
598
  * Get knowledge files by IDs
@@ -534,6 +624,35 @@ class KnowledgeApi extends runtime.BaseAPI {
534
624
  const response = await this.getKnowledgeFilesByIdsRaw({ knowledgeFilesByIdsRequestUio: knowledgeFilesByIdsRequestUio }, initOverrides);
535
625
  return await response.value();
536
626
  }
627
+ /**
628
+ * Get the scraped site pages attached to a knowledge file of type website
629
+ * Get knowledge site pages for a file
630
+ */
631
+ async getKnowledgeSitePagesForFileRaw(requestParameters, initOverrides) {
632
+ if (requestParameters['fileId'] == null) {
633
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling getKnowledgeSitePagesForFile().');
634
+ }
635
+ const queryParameters = {};
636
+ const headerParameters = {};
637
+ if (this.configuration && this.configuration.apiKey) {
638
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
639
+ }
640
+ const response = await this.request({
641
+ path: `/knowledge-files/{fileId}/kowledge-site-pages`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
642
+ method: 'GET',
643
+ headers: headerParameters,
644
+ query: queryParameters,
645
+ }, initOverrides);
646
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.KnowledgeSitePageUioFromJSON));
647
+ }
648
+ /**
649
+ * Get the scraped site pages attached to a knowledge file of type website
650
+ * Get knowledge site pages for a file
651
+ */
652
+ async getKnowledgeSitePagesForFile(fileId, initOverrides) {
653
+ const response = await this.getKnowledgeSitePagesForFileRaw({ fileId: fileId }, initOverrides);
654
+ return await response.value();
655
+ }
537
656
  /**
538
657
  * Processes documents like PDFs, CSVs, and text files, and adds them to the brain\'s knowledge base
539
658
  * Upload and import a file into the brain\'s knowledge base
@@ -613,6 +732,74 @@ class KnowledgeApi extends runtime.BaseAPI {
613
732
  async importProjectsToAgentKnowledge(agentId, initOverrides) {
614
733
  await this.importProjectsToAgentKnowledgeRaw({ agentId: agentId }, initOverrides);
615
734
  }
735
+ /**
736
+ * Update the name and authorized agents of a knowledge base
737
+ * Update a knowledge base
738
+ */
739
+ async patchKnowledgeBaseRaw(requestParameters, initOverrides) {
740
+ if (requestParameters['knowledgebaseId'] == null) {
741
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling patchKnowledgeBase().');
742
+ }
743
+ if (requestParameters['patchKnowledgeBaseRequestUio'] == null) {
744
+ throw new runtime.RequiredError('patchKnowledgeBaseRequestUio', 'Required parameter "patchKnowledgeBaseRequestUio" was null or undefined when calling patchKnowledgeBase().');
745
+ }
746
+ const queryParameters = {};
747
+ const headerParameters = {};
748
+ headerParameters['Content-Type'] = 'application/json';
749
+ if (this.configuration && this.configuration.apiKey) {
750
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
751
+ }
752
+ const response = await this.request({
753
+ path: `/knowledge-bases/{knowledgebaseId}`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
754
+ method: 'PATCH',
755
+ headers: headerParameters,
756
+ query: queryParameters,
757
+ body: (0, index_1.PatchKnowledgeBaseRequestUioToJSON)(requestParameters['patchKnowledgeBaseRequestUio']),
758
+ }, initOverrides);
759
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BodyWithMessageUioFromJSON)(jsonValue));
760
+ }
761
+ /**
762
+ * Update the name and authorized agents of a knowledge base
763
+ * Update a knowledge base
764
+ */
765
+ async patchKnowledgeBase(knowledgebaseId, patchKnowledgeBaseRequestUio, initOverrides) {
766
+ const response = await this.patchKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId, patchKnowledgeBaseRequestUio: patchKnowledgeBaseRequestUio }, initOverrides);
767
+ return await response.value();
768
+ }
769
+ /**
770
+ * Update the active state of a knowledge file
771
+ * Update a knowledge file
772
+ */
773
+ async patchKnowledgeFileRaw(requestParameters, initOverrides) {
774
+ if (requestParameters['fileId'] == null) {
775
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling patchKnowledgeFile().');
776
+ }
777
+ if (requestParameters['patchKnowledgeFileRequestUio'] == null) {
778
+ throw new runtime.RequiredError('patchKnowledgeFileRequestUio', 'Required parameter "patchKnowledgeFileRequestUio" was null or undefined when calling patchKnowledgeFile().');
779
+ }
780
+ const queryParameters = {};
781
+ const headerParameters = {};
782
+ headerParameters['Content-Type'] = 'application/json';
783
+ if (this.configuration && this.configuration.apiKey) {
784
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
785
+ }
786
+ const response = await this.request({
787
+ path: `/knowledge-files/{fileId}`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
788
+ method: 'PATCH',
789
+ headers: headerParameters,
790
+ query: queryParameters,
791
+ body: (0, index_1.PatchKnowledgeFileRequestUioToJSON)(requestParameters['patchKnowledgeFileRequestUio']),
792
+ }, initOverrides);
793
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BodyWithMessageUioFromJSON)(jsonValue));
794
+ }
795
+ /**
796
+ * Update the active state of a knowledge file
797
+ * Update a knowledge file
798
+ */
799
+ async patchKnowledgeFile(fileId, patchKnowledgeFileRequestUio, initOverrides) {
800
+ const response = await this.patchKnowledgeFileRaw({ fileId: fileId, patchKnowledgeFileRequestUio: patchKnowledgeFileRequestUio }, initOverrides);
801
+ return await response.value();
802
+ }
616
803
  /**
617
804
  * Registers a file for upload to the brain\'s knowledge base and returns an upload URL
618
805
  * Prepare file upload for knowledge base
@@ -704,6 +891,74 @@ class KnowledgeApi extends runtime.BaseAPI {
704
891
  const response = await this.resetKnowledgeBaseRaw({ organizationId: organizationId }, initOverrides);
705
892
  return await response.value();
706
893
  }
894
+ /**
895
+ * Run a vector search on a knowledge base and return matching chunks with their source files
896
+ * Search a knowledge base
897
+ */
898
+ async searchKnowledgeBaseRaw(requestParameters, initOverrides) {
899
+ if (requestParameters['knowledgebaseId'] == null) {
900
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling searchKnowledgeBase().');
901
+ }
902
+ if (requestParameters['searchKnowledgeBaseRequestUio'] == null) {
903
+ throw new runtime.RequiredError('searchKnowledgeBaseRequestUio', 'Required parameter "searchKnowledgeBaseRequestUio" was null or undefined when calling searchKnowledgeBase().');
904
+ }
905
+ const queryParameters = {};
906
+ const headerParameters = {};
907
+ headerParameters['Content-Type'] = 'application/json';
908
+ if (this.configuration && this.configuration.apiKey) {
909
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
910
+ }
911
+ const response = await this.request({
912
+ path: `/knowledge-bases/{knowledgebaseId}/search`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
913
+ method: 'POST',
914
+ headers: headerParameters,
915
+ query: queryParameters,
916
+ body: (0, index_1.SearchKnowledgeBaseRequestUioToJSON)(requestParameters['searchKnowledgeBaseRequestUio']),
917
+ }, initOverrides);
918
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SearchKnowledgeBase200ResponseInnerUioFromJSON));
919
+ }
920
+ /**
921
+ * Run a vector search on a knowledge base and return matching chunks with their source files
922
+ * Search a knowledge base
923
+ */
924
+ async searchKnowledgeBase(knowledgebaseId, searchKnowledgeBaseRequestUio, initOverrides) {
925
+ const response = await this.searchKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId, searchKnowledgeBaseRequestUio: searchKnowledgeBaseRequestUio }, initOverrides);
926
+ return await response.value();
927
+ }
928
+ /**
929
+ * Trigger the scrapping service to crawl the given URLs and index the result into the knowledge base
930
+ * Start a knowledge base scrapping job
931
+ */
932
+ async startKnowledgeBaseScrappingRaw(requestParameters, initOverrides) {
933
+ if (requestParameters['knowledgebaseId'] == null) {
934
+ throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling startKnowledgeBaseScrapping().');
935
+ }
936
+ if (requestParameters['startKnowledgeBaseScrappingRequestUio'] == null) {
937
+ throw new runtime.RequiredError('startKnowledgeBaseScrappingRequestUio', 'Required parameter "startKnowledgeBaseScrappingRequestUio" was null or undefined when calling startKnowledgeBaseScrapping().');
938
+ }
939
+ const queryParameters = {};
940
+ const headerParameters = {};
941
+ headerParameters['Content-Type'] = 'application/json';
942
+ if (this.configuration && this.configuration.apiKey) {
943
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
944
+ }
945
+ const response = await this.request({
946
+ path: `/knowledge-bases/{knowledgebaseId}/scrapping`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
947
+ method: 'POST',
948
+ headers: headerParameters,
949
+ query: queryParameters,
950
+ body: (0, index_1.StartKnowledgeBaseScrappingRequestUioToJSON)(requestParameters['startKnowledgeBaseScrappingRequestUio']),
951
+ }, initOverrides);
952
+ return new runtime.JSONApiResponse(response);
953
+ }
954
+ /**
955
+ * Trigger the scrapping service to crawl the given URLs and index the result into the knowledge base
956
+ * Start a knowledge base scrapping job
957
+ */
958
+ async startKnowledgeBaseScrapping(knowledgebaseId, startKnowledgeBaseScrappingRequestUio, initOverrides) {
959
+ const response = await this.startKnowledgeBaseScrappingRaw({ knowledgebaseId: knowledgebaseId, startKnowledgeBaseScrappingRequestUio: startKnowledgeBaseScrappingRequestUio }, initOverrides);
960
+ return await response.value();
961
+ }
707
962
  /**
708
963
  * Updates the status of a knowledge file and triggers the indexing process if the file is uploaded
709
964
  * Update file status and trigger indexing
@@ -864,47 +1119,30 @@ class KnowledgeApi extends runtime.BaseAPI {
864
1119
  if (requestParameters['knowledgebaseId'] == null) {
865
1120
  throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling uploadImageToKnowledgeBaseLibrary().');
866
1121
  }
867
- if (requestParameters['image'] == null) {
868
- throw new runtime.RequiredError('image', 'Required parameter "image" was null or undefined when calling uploadImageToKnowledgeBaseLibrary().');
1122
+ if (requestParameters['uploadImageToKnowledgeBaseLibraryRequestUio'] == null) {
1123
+ throw new runtime.RequiredError('uploadImageToKnowledgeBaseLibraryRequestUio', 'Required parameter "uploadImageToKnowledgeBaseLibraryRequestUio" was null or undefined when calling uploadImageToKnowledgeBaseLibrary().');
869
1124
  }
870
1125
  const queryParameters = {};
871
1126
  const headerParameters = {};
1127
+ headerParameters['Content-Type'] = 'application/json';
872
1128
  if (this.configuration && this.configuration.apiKey) {
873
1129
  headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
874
1130
  }
875
- const consumes = [
876
- { contentType: 'multipart/form-data' },
877
- ];
878
- // @ts-ignore: canConsumeForm may be unused
879
- const canConsumeForm = runtime.canConsumeForm(consumes);
880
- let formParams;
881
- let useForm = false;
882
- // use FormData to transmit files using content-type "multipart/form-data"
883
- useForm = canConsumeForm;
884
- if (useForm) {
885
- formParams = new FormData();
886
- }
887
- else {
888
- formParams = new URLSearchParams();
889
- }
890
- if (requestParameters['image'] != null) {
891
- formParams.append('image', requestParameters['image']);
892
- }
893
1131
  const response = await this.request({
894
1132
  path: `/knowledge-bases/{knowledgebaseId}/images`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
895
1133
  method: 'POST',
896
1134
  headers: headerParameters,
897
1135
  query: queryParameters,
898
- body: formParams,
1136
+ body: (0, index_1.UploadImageToKnowledgeBaseLibraryRequestUioToJSON)(requestParameters['uploadImageToKnowledgeBaseLibraryRequestUio']),
899
1137
  }, initOverrides);
900
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.S3UploadBodyUioFromJSON)(jsonValue));
1138
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UploadImageToKnowledgeBaseLibrary200ResponseUioFromJSON)(jsonValue));
901
1139
  }
902
1140
  /**
903
1141
  * Upload a new image to a library image in knowledge base and return the upload URL
904
1142
  * Upload a new image to a library image in knowledge base
905
1143
  */
906
- async uploadImageToKnowledgeBaseLibrary(knowledgebaseId, image, initOverrides) {
907
- const response = await this.uploadImageToKnowledgeBaseLibraryRaw({ knowledgebaseId: knowledgebaseId, image: image }, initOverrides);
1144
+ async uploadImageToKnowledgeBaseLibrary(knowledgebaseId, uploadImageToKnowledgeBaseLibraryRequestUio, initOverrides) {
1145
+ const response = await this.uploadImageToKnowledgeBaseLibraryRaw({ knowledgebaseId: knowledgebaseId, uploadImageToKnowledgeBaseLibraryRequestUio: uploadImageToKnowledgeBaseLibraryRequestUio }, initOverrides);
908
1146
  return await response.value();
909
1147
  }
910
1148
  }