@breign/client 1.0.163 → 1.0.165

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 (31) hide show
  1. package/dist/apis/AgentApi.d.ts +15 -1
  2. package/dist/apis/AgentApi.js +34 -0
  3. package/dist/apis/KnowledgeApi.d.ts +43 -1
  4. package/dist/apis/KnowledgeApi.js +104 -0
  5. package/dist/models/AddKnowledgeSiteExclusionRequestUio.d.ts +32 -0
  6. package/dist/models/AddKnowledgeSiteExclusionRequestUio.js +50 -0
  7. package/dist/models/AddKnowledgeSiteExclusionResponseUio.d.ts +44 -0
  8. package/dist/models/AddKnowledgeSiteExclusionResponseUio.js +58 -0
  9. package/dist/models/AgentPromptInitGenerationRequestNotesUio.d.ts +45 -0
  10. package/dist/models/AgentPromptInitGenerationRequestNotesUio.js +52 -0
  11. package/dist/models/AgentPromptInitGenerationRequestUio.d.ts +110 -0
  12. package/dist/models/AgentPromptInitGenerationRequestUio.js +92 -0
  13. package/dist/models/AgentPromptInitGenerationResponseUio.d.ts +38 -0
  14. package/dist/models/AgentPromptInitGenerationResponseUio.js +52 -0
  15. package/dist/models/FileCreationResponseUio.d.ts +7 -0
  16. package/dist/models/FileCreationResponseUio.js +2 -0
  17. package/dist/models/FileUio.d.ts +7 -0
  18. package/dist/models/FileUio.js +2 -0
  19. package/dist/models/FileWithDownloadUrlUio.d.ts +7 -0
  20. package/dist/models/FileWithDownloadUrlUio.js +2 -0
  21. package/dist/models/KnowledgeFileUio.d.ts +7 -0
  22. package/dist/models/KnowledgeFileUio.js +2 -0
  23. package/dist/models/KnowledgeSiteExclusionsUio.d.ts +32 -0
  24. package/dist/models/KnowledgeSiteExclusionsUio.js +50 -0
  25. package/dist/models/KnowledgeSitePagesRemovalUio.d.ts +38 -0
  26. package/dist/models/KnowledgeSitePagesRemovalUio.js +54 -0
  27. package/dist/models/StartKnowledgeBaseScrappingRequestUio.d.ts +1 -0
  28. package/dist/models/index.d.ts +7 -0
  29. package/dist/models/index.js +7 -0
  30. package/dist/openapi.json +362 -0
  31. package/package.json +1 -1
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AddModuleRequestUio, AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentImportRequestUio, AgentImportResponseUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentToolAllowedMethodsRequestUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, ConversationMessageImagesUio, DeleteMessageAudio200ResponseUio, EphemeralInstancesMetricsResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, OrgUsageMetricsResponseUio, S3UploadBodyUio, STTResponseUio } from '../models/index';
13
+ import type { AddModuleRequestUio, AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentImportRequestUio, AgentImportResponseUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentPromptInitGenerationRequestUio, AgentPromptInitGenerationResponseUio, AgentRequestUio, AgentSubscriptionUio, AgentToolAllowedMethodsRequestUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, ConversationMessageImagesUio, DeleteMessageAudio200ResponseUio, EphemeralInstancesMetricsResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, OrgUsageMetricsResponseUio, S3UploadBodyUio, STTResponseUio } from '../models/index';
14
14
  export interface AddModuleRequest {
15
15
  agentId: string;
16
16
  addModuleRequestUio: AddModuleRequestUio;
@@ -52,6 +52,10 @@ export interface ExportAgentRequest {
52
52
  agentId: string;
53
53
  format?: ExportAgentFormatEnum;
54
54
  }
55
+ export interface GenerateAgentPromptInitRequest {
56
+ agentId: string;
57
+ agentPromptInitGenerationRequestUio: AgentPromptInitGenerationRequestUio;
58
+ }
55
59
  export interface GetAdvancedFlowEditorRequest {
56
60
  agentId: string;
57
61
  }
@@ -307,6 +311,16 @@ export declare class AgentApi extends runtime.BaseAPI {
307
311
  * Export an agent
308
312
  */
309
313
  exportAgent(agentId: string, format?: ExportAgentFormatEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
314
+ /**
315
+ * Writes a ready-to-use initialization prompt from a short brief, using the AI model configured on the agent (or, failing that, on its organisation). The result is returned only — it is never persisted on the agent, which is updated through PATCH /agents/{agentId}.
316
+ * Generate initialization instructions for an agent
317
+ */
318
+ generateAgentPromptInitRaw(requestParameters: GenerateAgentPromptInitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentPromptInitGenerationResponseUio>>;
319
+ /**
320
+ * Writes a ready-to-use initialization prompt from a short brief, using the AI model configured on the agent (or, failing that, on its organisation). The result is returned only — it is never persisted on the agent, which is updated through PATCH /agents/{agentId}.
321
+ * Generate initialization instructions for an agent
322
+ */
323
+ generateAgentPromptInit(agentId: string, agentPromptInitGenerationRequestUio: AgentPromptInitGenerationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentPromptInitGenerationResponseUio>;
310
324
  /**
311
325
  * Get the advanced flow editor state for an agent
312
326
  * Get advanced flow editor state
@@ -388,6 +388,40 @@ class AgentApi extends runtime.BaseAPI {
388
388
  const response = await this.exportAgentRaw({ agentId: agentId, format: format }, initOverrides);
389
389
  return await response.value();
390
390
  }
391
+ /**
392
+ * Writes a ready-to-use initialization prompt from a short brief, using the AI model configured on the agent (or, failing that, on its organisation). The result is returned only — it is never persisted on the agent, which is updated through PATCH /agents/{agentId}.
393
+ * Generate initialization instructions for an agent
394
+ */
395
+ async generateAgentPromptInitRaw(requestParameters, initOverrides) {
396
+ if (requestParameters['agentId'] == null) {
397
+ throw new runtime.RequiredError('agentId', 'Required parameter "agentId" was null or undefined when calling generateAgentPromptInit().');
398
+ }
399
+ if (requestParameters['agentPromptInitGenerationRequestUio'] == null) {
400
+ throw new runtime.RequiredError('agentPromptInitGenerationRequestUio', 'Required parameter "agentPromptInitGenerationRequestUio" was null or undefined when calling generateAgentPromptInit().');
401
+ }
402
+ const queryParameters = {};
403
+ const headerParameters = {};
404
+ headerParameters['Content-Type'] = 'application/json';
405
+ if (this.configuration && this.configuration.apiKey) {
406
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
407
+ }
408
+ const response = await this.request({
409
+ path: `/agents/{agentId}/prompt-init/generate`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters['agentId']))),
410
+ method: 'POST',
411
+ headers: headerParameters,
412
+ query: queryParameters,
413
+ body: (0, index_1.AgentPromptInitGenerationRequestUioToJSON)(requestParameters['agentPromptInitGenerationRequestUio']),
414
+ }, initOverrides);
415
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AgentPromptInitGenerationResponseUioFromJSON)(jsonValue));
416
+ }
417
+ /**
418
+ * Writes a ready-to-use initialization prompt from a short brief, using the AI model configured on the agent (or, failing that, on its organisation). The result is returned only — it is never persisted on the agent, which is updated through PATCH /agents/{agentId}.
419
+ * Generate initialization instructions for an agent
420
+ */
421
+ async generateAgentPromptInit(agentId, agentPromptInitGenerationRequestUio, initOverrides) {
422
+ const response = await this.generateAgentPromptInitRaw({ agentId: agentId, agentPromptInitGenerationRequestUio: agentPromptInitGenerationRequestUio }, initOverrides);
423
+ return await response.value();
424
+ }
391
425
  /**
392
426
  * Get the advanced flow editor state for an agent
393
427
  * Get advanced flow editor state
@@ -10,11 +10,15 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AgentModuleUio, BodyWithMessageUio, CreateKnowledgeBaseRequestUio, CreateKnowledgeBaseResponseUio, DeleteKnowledgeSitePage200ResponseUio, FileCreationResponseUio, FileWithDownloadUrlUio, ImageKnowledgeUio, KnowledgeBaseConfigurationUio, KnowledgeBaseConfigurationUpdateRequestUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFileCreationRequestUio, KnowledgeFileParsingCallbackRequestUio, KnowledgeFileSummaryUio, KnowledgeFileUio, KnowledgeFilesByIdsRequestUio, KnowledgeSitePageUio, PatchKnowledgeBaseRequestUio, PatchKnowledgeFileRequestUio, SearchKnowledgeBase200ResponseInnerUio, SearchKnowledgeBaseRequestUio, StartKnowledgeBaseScrappingRequestUio, SyncKnowledgeSiteScrapping200ResponseUio, SyncKnowledgeSiteScrappingRequestUio, UploadImageToKnowledgeBaseLibrary200ResponseUio, UploadImageToKnowledgeBaseLibraryRequestUio, UploadedStatusUpdateRequestUio } from '../models/index';
13
+ import type { AddKnowledgeSiteExclusionRequestUio, AddKnowledgeSiteExclusionResponseUio, AgentModuleUio, BodyWithMessageUio, CreateKnowledgeBaseRequestUio, CreateKnowledgeBaseResponseUio, DeleteKnowledgeSitePage200ResponseUio, FileCreationResponseUio, FileWithDownloadUrlUio, ImageKnowledgeUio, KnowledgeBaseConfigurationUio, KnowledgeBaseConfigurationUpdateRequestUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFileCreationRequestUio, KnowledgeFileParsingCallbackRequestUio, KnowledgeFileSummaryUio, KnowledgeFileUio, KnowledgeFilesByIdsRequestUio, KnowledgeSiteExclusionsUio, KnowledgeSitePageUio, KnowledgeSitePagesRemovalUio, PatchKnowledgeBaseRequestUio, PatchKnowledgeFileRequestUio, SearchKnowledgeBase200ResponseInnerUio, SearchKnowledgeBaseRequestUio, StartKnowledgeBaseScrappingRequestUio, SyncKnowledgeSiteScrapping200ResponseUio, SyncKnowledgeSiteScrappingRequestUio, UploadImageToKnowledgeBaseLibrary200ResponseUio, UploadImageToKnowledgeBaseLibraryRequestUio, UploadedStatusUpdateRequestUio } from '../models/index';
14
14
  export interface AddFileToKnowledgeBaseRequest {
15
15
  knowledgebaseId: string;
16
16
  knowledgeFileCreationRequestUio: KnowledgeFileCreationRequestUio;
17
17
  }
18
+ export interface AddKnowledgeSiteExclusionRequest {
19
+ fileId: string;
20
+ addKnowledgeSiteExclusionRequestUio: AddKnowledgeSiteExclusionRequestUio;
21
+ }
18
22
  export interface CreateKnowledgeBaseRequest {
19
23
  organizationId: string;
20
24
  createKnowledgeBaseRequestUio: CreateKnowledgeBaseRequestUio;
@@ -36,6 +40,10 @@ export interface DeleteKnowledgeFileRequest {
36
40
  export interface DeleteKnowledgeSitePageRequest {
37
41
  knowledgeSitePageId: string;
38
42
  }
43
+ export interface DeleteKnowledgeSitePagesUnderPathRequest {
44
+ fileId: string;
45
+ pathPrefix: string;
46
+ }
39
47
  export interface GetAgentKnowledgeFilesRequest {
40
48
  agentId: string;
41
49
  searchName?: string;
@@ -94,6 +102,10 @@ export interface PatchKnowledgeFileRequest {
94
102
  fileId: string;
95
103
  patchKnowledgeFileRequestUio: PatchKnowledgeFileRequestUio;
96
104
  }
105
+ export interface RemoveKnowledgeSiteExclusionRequest {
106
+ fileId: string;
107
+ url: string;
108
+ }
97
109
  export interface SearchKnowledgeBaseRequest {
98
110
  knowledgebaseId: string;
99
111
  searchKnowledgeBaseRequestUio: SearchKnowledgeBaseRequestUio;
@@ -141,6 +153,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
141
153
  * Add a file to the knowledge base
142
154
  */
143
155
  addFileToKnowledgeBase(knowledgebaseId: string, knowledgeFileCreationRequestUio: KnowledgeFileCreationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreationResponseUio>;
156
+ /**
157
+ * Saves the URL among the site exclusions, which every resync applies, and removes the site pages it covers right away. An exclusion covers the URL and everything below it (`/blog` covers `/blog/a` but not `/blog-news`); an exclusion without a path covers the whole host. Adding a URL already excluded is a no-op.
158
+ * Exclude a page or directory from a scrapped site
159
+ */
160
+ addKnowledgeSiteExclusionRaw(requestParameters: AddKnowledgeSiteExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddKnowledgeSiteExclusionResponseUio>>;
161
+ /**
162
+ * Saves the URL among the site exclusions, which every resync applies, and removes the site pages it covers right away. An exclusion covers the URL and everything below it (`/blog` covers `/blog/a` but not `/blog-news`); an exclusion without a path covers the whole host. Adding a URL already excluded is a no-op.
163
+ * Exclude a page or directory from a scrapped site
164
+ */
165
+ addKnowledgeSiteExclusion(fileId: string, addKnowledgeSiteExclusionRequestUio: AddKnowledgeSiteExclusionRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddKnowledgeSiteExclusionResponseUio>;
144
166
  /**
145
167
  * Creates a knowledge base and provisions its vector store collection. `embeddingConfig` est obligatoire lorsque `vectorStoreType` vaut `qdrant`.
146
168
  * Create a knowledge base
@@ -201,6 +223,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
201
223
  * Delete a knowledge site page
202
224
  */
203
225
  deleteKnowledgeSitePage(knowledgeSitePageId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteKnowledgeSitePage200ResponseUio>;
226
+ /**
227
+ * Removes every page located in `pathPrefix` or below it, along with its chunks and stored content. The pages are not excluded: the next resync brings them back.
228
+ * Delete the knowledge site pages of a directory
229
+ */
230
+ deleteKnowledgeSitePagesUnderPathRaw(requestParameters: DeleteKnowledgeSitePagesUnderPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeSitePagesRemovalUio>>;
231
+ /**
232
+ * Removes every page located in `pathPrefix` or below it, along with its chunks and stored content. The pages are not excluded: the next resync brings them back.
233
+ * Delete the knowledge site pages of a directory
234
+ */
235
+ deleteKnowledgeSitePagesUnderPath(fileId: string, pathPrefix: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeSitePagesRemovalUio>;
204
236
  /**
205
237
  * Returns all knowledge bases attached to the agent and their indexed files.
206
238
  * Get knowledge bases and files for an agent
@@ -379,6 +411,16 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
379
411
  * Update a knowledge file
380
412
  */
381
413
  patchKnowledgeFile(fileId: string, patchKnowledgeFileRequestUio: PatchKnowledgeFileRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithMessageUio>;
414
+ /**
415
+ * The pages it covered are not scrapped again here: they come back with the next resync.
416
+ * Remove an exclusion from a scrapped site
417
+ */
418
+ removeKnowledgeSiteExclusionRaw(requestParameters: RemoveKnowledgeSiteExclusionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeSiteExclusionsUio>>;
419
+ /**
420
+ * The pages it covered are not scrapped again here: they come back with the next resync.
421
+ * Remove an exclusion from a scrapped site
422
+ */
423
+ removeKnowledgeSiteExclusion(fileId: string, url: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeSiteExclusionsUio>;
382
424
  /**
383
425
  * Run a vector search on a knowledge base and return matching chunks with their source files
384
426
  * Search a knowledge base
@@ -87,6 +87,40 @@ class KnowledgeApi extends runtime.BaseAPI {
87
87
  const response = await this.addFileToKnowledgeBaseRaw({ knowledgebaseId: knowledgebaseId, knowledgeFileCreationRequestUio: knowledgeFileCreationRequestUio }, initOverrides);
88
88
  return await response.value();
89
89
  }
90
+ /**
91
+ * Saves the URL among the site exclusions, which every resync applies, and removes the site pages it covers right away. An exclusion covers the URL and everything below it (`/blog` covers `/blog/a` but not `/blog-news`); an exclusion without a path covers the whole host. Adding a URL already excluded is a no-op.
92
+ * Exclude a page or directory from a scrapped site
93
+ */
94
+ async addKnowledgeSiteExclusionRaw(requestParameters, initOverrides) {
95
+ if (requestParameters['fileId'] == null) {
96
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling addKnowledgeSiteExclusion().');
97
+ }
98
+ if (requestParameters['addKnowledgeSiteExclusionRequestUio'] == null) {
99
+ throw new runtime.RequiredError('addKnowledgeSiteExclusionRequestUio', 'Required parameter "addKnowledgeSiteExclusionRequestUio" was null or undefined when calling addKnowledgeSiteExclusion().');
100
+ }
101
+ const queryParameters = {};
102
+ const headerParameters = {};
103
+ headerParameters['Content-Type'] = 'application/json';
104
+ if (this.configuration && this.configuration.apiKey) {
105
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
106
+ }
107
+ const response = await this.request({
108
+ path: `/knowledge-files/{fileId}/scraping-exclusions`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
109
+ method: 'POST',
110
+ headers: headerParameters,
111
+ query: queryParameters,
112
+ body: (0, index_1.AddKnowledgeSiteExclusionRequestUioToJSON)(requestParameters['addKnowledgeSiteExclusionRequestUio']),
113
+ }, initOverrides);
114
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AddKnowledgeSiteExclusionResponseUioFromJSON)(jsonValue));
115
+ }
116
+ /**
117
+ * Saves the URL among the site exclusions, which every resync applies, and removes the site pages it covers right away. An exclusion covers the URL and everything below it (`/blog` covers `/blog/a` but not `/blog-news`); an exclusion without a path covers the whole host. Adding a URL already excluded is a no-op.
118
+ * Exclude a page or directory from a scrapped site
119
+ */
120
+ async addKnowledgeSiteExclusion(fileId, addKnowledgeSiteExclusionRequestUio, initOverrides) {
121
+ const response = await this.addKnowledgeSiteExclusionRaw({ fileId: fileId, addKnowledgeSiteExclusionRequestUio: addKnowledgeSiteExclusionRequestUio }, initOverrides);
122
+ return await response.value();
123
+ }
90
124
  /**
91
125
  * Creates a knowledge base and provisions its vector store collection. `embeddingConfig` est obligatoire lorsque `vectorStoreType` vaut `qdrant`.
92
126
  * Create a knowledge base
@@ -272,6 +306,41 @@ class KnowledgeApi extends runtime.BaseAPI {
272
306
  const response = await this.deleteKnowledgeSitePageRaw({ knowledgeSitePageId: knowledgeSitePageId }, initOverrides);
273
307
  return await response.value();
274
308
  }
309
+ /**
310
+ * Removes every page located in `pathPrefix` or below it, along with its chunks and stored content. The pages are not excluded: the next resync brings them back.
311
+ * Delete the knowledge site pages of a directory
312
+ */
313
+ async deleteKnowledgeSitePagesUnderPathRaw(requestParameters, initOverrides) {
314
+ if (requestParameters['fileId'] == null) {
315
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling deleteKnowledgeSitePagesUnderPath().');
316
+ }
317
+ if (requestParameters['pathPrefix'] == null) {
318
+ throw new runtime.RequiredError('pathPrefix', 'Required parameter "pathPrefix" was null or undefined when calling deleteKnowledgeSitePagesUnderPath().');
319
+ }
320
+ const queryParameters = {};
321
+ if (requestParameters['pathPrefix'] != null) {
322
+ queryParameters['pathPrefix'] = requestParameters['pathPrefix'];
323
+ }
324
+ const headerParameters = {};
325
+ if (this.configuration && this.configuration.apiKey) {
326
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
327
+ }
328
+ const response = await this.request({
329
+ path: `/knowledge-files/{fileId}/knowledge-site-pages`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
330
+ method: 'DELETE',
331
+ headers: headerParameters,
332
+ query: queryParameters,
333
+ }, initOverrides);
334
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeSitePagesRemovalUioFromJSON)(jsonValue));
335
+ }
336
+ /**
337
+ * Removes every page located in `pathPrefix` or below it, along with its chunks and stored content. The pages are not excluded: the next resync brings them back.
338
+ * Delete the knowledge site pages of a directory
339
+ */
340
+ async deleteKnowledgeSitePagesUnderPath(fileId, pathPrefix, initOverrides) {
341
+ const response = await this.deleteKnowledgeSitePagesUnderPathRaw({ fileId: fileId, pathPrefix: pathPrefix }, initOverrides);
342
+ return await response.value();
343
+ }
275
344
  /**
276
345
  * Returns all knowledge bases attached to the agent and their indexed files.
277
346
  * Get knowledge bases and files for an agent
@@ -800,6 +869,41 @@ class KnowledgeApi extends runtime.BaseAPI {
800
869
  const response = await this.patchKnowledgeFileRaw({ fileId: fileId, patchKnowledgeFileRequestUio: patchKnowledgeFileRequestUio }, initOverrides);
801
870
  return await response.value();
802
871
  }
872
+ /**
873
+ * The pages it covered are not scrapped again here: they come back with the next resync.
874
+ * Remove an exclusion from a scrapped site
875
+ */
876
+ async removeKnowledgeSiteExclusionRaw(requestParameters, initOverrides) {
877
+ if (requestParameters['fileId'] == null) {
878
+ throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling removeKnowledgeSiteExclusion().');
879
+ }
880
+ if (requestParameters['url'] == null) {
881
+ throw new runtime.RequiredError('url', 'Required parameter "url" was null or undefined when calling removeKnowledgeSiteExclusion().');
882
+ }
883
+ const queryParameters = {};
884
+ if (requestParameters['url'] != null) {
885
+ queryParameters['url'] = requestParameters['url'];
886
+ }
887
+ const headerParameters = {};
888
+ if (this.configuration && this.configuration.apiKey) {
889
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
890
+ }
891
+ const response = await this.request({
892
+ path: `/knowledge-files/{fileId}/scraping-exclusions`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
893
+ method: 'DELETE',
894
+ headers: headerParameters,
895
+ query: queryParameters,
896
+ }, initOverrides);
897
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeSiteExclusionsUioFromJSON)(jsonValue));
898
+ }
899
+ /**
900
+ * The pages it covered are not scrapped again here: they come back with the next resync.
901
+ * Remove an exclusion from a scrapped site
902
+ */
903
+ async removeKnowledgeSiteExclusion(fileId, url, initOverrides) {
904
+ const response = await this.removeKnowledgeSiteExclusionRaw({ fileId: fileId, url: url }, initOverrides);
905
+ return await response.value();
906
+ }
803
907
  /**
804
908
  * Run a vector search on a knowledge base and return matching chunks with their source files
805
909
  * Search a knowledge base
@@ -0,0 +1,32 @@
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 AddKnowledgeSiteExclusionRequestUio
16
+ */
17
+ export interface AddKnowledgeSiteExclusionRequestUio {
18
+ /**
19
+ * Page or directory of the site to exclude, e.g. `https://site.com/blog`
20
+ * @type {string}
21
+ * @memberof AddKnowledgeSiteExclusionRequestUio
22
+ */
23
+ url: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the AddKnowledgeSiteExclusionRequestUio interface.
27
+ */
28
+ export declare function instanceOfAddKnowledgeSiteExclusionRequestUio(value: object): value is AddKnowledgeSiteExclusionRequestUio;
29
+ export declare function AddKnowledgeSiteExclusionRequestUioFromJSON(json: any): AddKnowledgeSiteExclusionRequestUio;
30
+ export declare function AddKnowledgeSiteExclusionRequestUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddKnowledgeSiteExclusionRequestUio;
31
+ export declare function AddKnowledgeSiteExclusionRequestUioToJSON(json: any): AddKnowledgeSiteExclusionRequestUio;
32
+ export declare function AddKnowledgeSiteExclusionRequestUioToJSONTyped(value?: AddKnowledgeSiteExclusionRequestUio | 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.instanceOfAddKnowledgeSiteExclusionRequestUio = instanceOfAddKnowledgeSiteExclusionRequestUio;
17
+ exports.AddKnowledgeSiteExclusionRequestUioFromJSON = AddKnowledgeSiteExclusionRequestUioFromJSON;
18
+ exports.AddKnowledgeSiteExclusionRequestUioFromJSONTyped = AddKnowledgeSiteExclusionRequestUioFromJSONTyped;
19
+ exports.AddKnowledgeSiteExclusionRequestUioToJSON = AddKnowledgeSiteExclusionRequestUioToJSON;
20
+ exports.AddKnowledgeSiteExclusionRequestUioToJSONTyped = AddKnowledgeSiteExclusionRequestUioToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AddKnowledgeSiteExclusionRequestUio interface.
23
+ */
24
+ function instanceOfAddKnowledgeSiteExclusionRequestUio(value) {
25
+ if (!('url' in value) || value['url'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function AddKnowledgeSiteExclusionRequestUioFromJSON(json) {
30
+ return AddKnowledgeSiteExclusionRequestUioFromJSONTyped(json, false);
31
+ }
32
+ function AddKnowledgeSiteExclusionRequestUioFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'url': json['url'],
38
+ };
39
+ }
40
+ function AddKnowledgeSiteExclusionRequestUioToJSON(json) {
41
+ return AddKnowledgeSiteExclusionRequestUioToJSONTyped(json, false);
42
+ }
43
+ function AddKnowledgeSiteExclusionRequestUioToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'url': value['url'],
49
+ };
50
+ }
@@ -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 AddKnowledgeSiteExclusionResponseUio
16
+ */
17
+ export interface AddKnowledgeSiteExclusionResponseUio {
18
+ /**
19
+ *
20
+ * @type {Array<string>}
21
+ * @memberof AddKnowledgeSiteExclusionResponseUio
22
+ */
23
+ scrapingExclusions: Array<string>;
24
+ /**
25
+ * URLs of the removed pages
26
+ * @type {Array<string>}
27
+ * @memberof AddKnowledgeSiteExclusionResponseUio
28
+ */
29
+ removedPages: Array<string>;
30
+ /**
31
+ * URLs of the pages that could not be removed
32
+ * @type {Array<string>}
33
+ * @memberof AddKnowledgeSiteExclusionResponseUio
34
+ */
35
+ failedPages: Array<string>;
36
+ }
37
+ /**
38
+ * Check if a given object implements the AddKnowledgeSiteExclusionResponseUio interface.
39
+ */
40
+ export declare function instanceOfAddKnowledgeSiteExclusionResponseUio(value: object): value is AddKnowledgeSiteExclusionResponseUio;
41
+ export declare function AddKnowledgeSiteExclusionResponseUioFromJSON(json: any): AddKnowledgeSiteExclusionResponseUio;
42
+ export declare function AddKnowledgeSiteExclusionResponseUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddKnowledgeSiteExclusionResponseUio;
43
+ export declare function AddKnowledgeSiteExclusionResponseUioToJSON(json: any): AddKnowledgeSiteExclusionResponseUio;
44
+ export declare function AddKnowledgeSiteExclusionResponseUioToJSONTyped(value?: AddKnowledgeSiteExclusionResponseUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
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.instanceOfAddKnowledgeSiteExclusionResponseUio = instanceOfAddKnowledgeSiteExclusionResponseUio;
17
+ exports.AddKnowledgeSiteExclusionResponseUioFromJSON = AddKnowledgeSiteExclusionResponseUioFromJSON;
18
+ exports.AddKnowledgeSiteExclusionResponseUioFromJSONTyped = AddKnowledgeSiteExclusionResponseUioFromJSONTyped;
19
+ exports.AddKnowledgeSiteExclusionResponseUioToJSON = AddKnowledgeSiteExclusionResponseUioToJSON;
20
+ exports.AddKnowledgeSiteExclusionResponseUioToJSONTyped = AddKnowledgeSiteExclusionResponseUioToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AddKnowledgeSiteExclusionResponseUio interface.
23
+ */
24
+ function instanceOfAddKnowledgeSiteExclusionResponseUio(value) {
25
+ if (!('scrapingExclusions' in value) || value['scrapingExclusions'] === undefined)
26
+ return false;
27
+ if (!('removedPages' in value) || value['removedPages'] === undefined)
28
+ return false;
29
+ if (!('failedPages' in value) || value['failedPages'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function AddKnowledgeSiteExclusionResponseUioFromJSON(json) {
34
+ return AddKnowledgeSiteExclusionResponseUioFromJSONTyped(json, false);
35
+ }
36
+ function AddKnowledgeSiteExclusionResponseUioFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'scrapingExclusions': json['scrapingExclusions'],
42
+ 'removedPages': json['removedPages'],
43
+ 'failedPages': json['failedPages'],
44
+ };
45
+ }
46
+ function AddKnowledgeSiteExclusionResponseUioToJSON(json) {
47
+ return AddKnowledgeSiteExclusionResponseUioToJSONTyped(json, false);
48
+ }
49
+ function AddKnowledgeSiteExclusionResponseUioToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'scrapingExclusions': value['scrapingExclusions'],
55
+ 'removedPages': value['removedPages'],
56
+ 'failedPages': value['failedPages'],
57
+ };
58
+ }
@@ -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
+ * What the user wrote themselves when no preset fitted, per question. A note REPLACES the presets of its own question rather than adding to them.
14
+ *
15
+ * @export
16
+ * @interface AgentPromptInitGenerationRequestNotesUio
17
+ */
18
+ export interface AgentPromptInitGenerationRequestNotesUio {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof AgentPromptInitGenerationRequestNotesUio
23
+ */
24
+ audience?: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof AgentPromptInitGenerationRequestNotesUio
29
+ */
30
+ answerStyle?: string;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof AgentPromptInitGenerationRequestNotesUio
35
+ */
36
+ sourcePolicy?: string;
37
+ }
38
+ /**
39
+ * Check if a given object implements the AgentPromptInitGenerationRequestNotesUio interface.
40
+ */
41
+ export declare function instanceOfAgentPromptInitGenerationRequestNotesUio(value: object): value is AgentPromptInitGenerationRequestNotesUio;
42
+ export declare function AgentPromptInitGenerationRequestNotesUioFromJSON(json: any): AgentPromptInitGenerationRequestNotesUio;
43
+ export declare function AgentPromptInitGenerationRequestNotesUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentPromptInitGenerationRequestNotesUio;
44
+ export declare function AgentPromptInitGenerationRequestNotesUioToJSON(json: any): AgentPromptInitGenerationRequestNotesUio;
45
+ export declare function AgentPromptInitGenerationRequestNotesUioToJSONTyped(value?: AgentPromptInitGenerationRequestNotesUio | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
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.instanceOfAgentPromptInitGenerationRequestNotesUio = instanceOfAgentPromptInitGenerationRequestNotesUio;
17
+ exports.AgentPromptInitGenerationRequestNotesUioFromJSON = AgentPromptInitGenerationRequestNotesUioFromJSON;
18
+ exports.AgentPromptInitGenerationRequestNotesUioFromJSONTyped = AgentPromptInitGenerationRequestNotesUioFromJSONTyped;
19
+ exports.AgentPromptInitGenerationRequestNotesUioToJSON = AgentPromptInitGenerationRequestNotesUioToJSON;
20
+ exports.AgentPromptInitGenerationRequestNotesUioToJSONTyped = AgentPromptInitGenerationRequestNotesUioToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AgentPromptInitGenerationRequestNotesUio interface.
23
+ */
24
+ function instanceOfAgentPromptInitGenerationRequestNotesUio(value) {
25
+ return true;
26
+ }
27
+ function AgentPromptInitGenerationRequestNotesUioFromJSON(json) {
28
+ return AgentPromptInitGenerationRequestNotesUioFromJSONTyped(json, false);
29
+ }
30
+ function AgentPromptInitGenerationRequestNotesUioFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'audience': json['audience'] == null ? undefined : json['audience'],
36
+ 'answerStyle': json['answerStyle'] == null ? undefined : json['answerStyle'],
37
+ 'sourcePolicy': json['sourcePolicy'] == null ? undefined : json['sourcePolicy'],
38
+ };
39
+ }
40
+ function AgentPromptInitGenerationRequestNotesUioToJSON(json) {
41
+ return AgentPromptInitGenerationRequestNotesUioToJSONTyped(json, false);
42
+ }
43
+ function AgentPromptInitGenerationRequestNotesUioToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'audience': value['audience'],
49
+ 'answerStyle': value['answerStyle'],
50
+ 'sourcePolicy': value['sourcePolicy'],
51
+ };
52
+ }