@breign/client 1.0.115 → 1.0.117

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.
@@ -81,6 +81,9 @@ export interface GetKnowledgeFilesByIdsRequest {
81
81
  export interface GetKnowledgeSitePagesForFileRequest {
82
82
  fileId: string;
83
83
  }
84
+ export interface GetScrappingJobStatusRequest {
85
+ jobId: string;
86
+ }
84
87
  export interface ImportFileToAgentKnowledgeRequest {
85
88
  agentId: string;
86
89
  file: Blob;
@@ -330,6 +333,20 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
330
333
  * Get knowledge site pages for a file
331
334
  */
332
335
  getKnowledgeSitePagesForFile(fileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<KnowledgeSitePageUio>>;
336
+ /**
337
+ * Returns the current status and logs of a scrapping job
338
+ * Get scrapping job status
339
+ */
340
+ getScrappingJobStatusRaw(requestParameters: GetScrappingJobStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
341
+ [key: string]: any;
342
+ }>>;
343
+ /**
344
+ * Returns the current status and logs of a scrapping job
345
+ * Get scrapping job status
346
+ */
347
+ getScrappingJobStatus(jobId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
348
+ [key: string]: any;
349
+ }>;
333
350
  /**
334
351
  * Processes documents like PDFs, CSVs, and text files, and adds them to the brain\'s knowledge base
335
352
  * Upload and import a file into the brain\'s knowledge base
@@ -653,6 +653,35 @@ class KnowledgeApi extends runtime.BaseAPI {
653
653
  const response = await this.getKnowledgeSitePagesForFileRaw({ fileId: fileId }, initOverrides);
654
654
  return await response.value();
655
655
  }
656
+ /**
657
+ * Returns the current status and logs of a scrapping job
658
+ * Get scrapping job status
659
+ */
660
+ async getScrappingJobStatusRaw(requestParameters, initOverrides) {
661
+ if (requestParameters['jobId'] == null) {
662
+ throw new runtime.RequiredError('jobId', 'Required parameter "jobId" was null or undefined when calling getScrappingJobStatus().');
663
+ }
664
+ const queryParameters = {};
665
+ const headerParameters = {};
666
+ if (this.configuration && this.configuration.apiKey) {
667
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
668
+ }
669
+ const response = await this.request({
670
+ path: `/scrapping-jobs/{jobId}/status`.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId']))),
671
+ method: 'GET',
672
+ headers: headerParameters,
673
+ query: queryParameters,
674
+ }, initOverrides);
675
+ return new runtime.JSONApiResponse(response);
676
+ }
677
+ /**
678
+ * Returns the current status and logs of a scrapping job
679
+ * Get scrapping job status
680
+ */
681
+ async getScrappingJobStatus(jobId, initOverrides) {
682
+ const response = await this.getScrappingJobStatusRaw({ jobId: jobId }, initOverrides);
683
+ return await response.value();
684
+ }
656
685
  /**
657
686
  * Processes documents like PDFs, CSVs, and text files, and adds them to the brain\'s knowledge base
658
687
  * Upload and import a file into the brain\'s knowledge base
@@ -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 AgentMemoryConfigurationUio
16
+ */
17
+ export interface AgentMemoryConfigurationUio {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof AgentMemoryConfigurationUio
22
+ */
23
+ userMemoryEnabled?: boolean;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof AgentMemoryConfigurationUio
28
+ */
29
+ agentMemoryEnabled?: boolean;
30
+ /**
31
+ *
32
+ * @type {boolean}
33
+ * @memberof AgentMemoryConfigurationUio
34
+ */
35
+ organizationMemoryEnabled?: boolean;
36
+ }
37
+ /**
38
+ * Check if a given object implements the AgentMemoryConfigurationUio interface.
39
+ */
40
+ export declare function instanceOfAgentMemoryConfigurationUio(value: object): value is AgentMemoryConfigurationUio;
41
+ export declare function AgentMemoryConfigurationUioFromJSON(json: any): AgentMemoryConfigurationUio;
42
+ export declare function AgentMemoryConfigurationUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentMemoryConfigurationUio;
43
+ export declare function AgentMemoryConfigurationUioToJSON(json: any): AgentMemoryConfigurationUio;
44
+ export declare function AgentMemoryConfigurationUioToJSONTyped(value?: AgentMemoryConfigurationUio | 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.instanceOfAgentMemoryConfigurationUio = instanceOfAgentMemoryConfigurationUio;
17
+ exports.AgentMemoryConfigurationUioFromJSON = AgentMemoryConfigurationUioFromJSON;
18
+ exports.AgentMemoryConfigurationUioFromJSONTyped = AgentMemoryConfigurationUioFromJSONTyped;
19
+ exports.AgentMemoryConfigurationUioToJSON = AgentMemoryConfigurationUioToJSON;
20
+ exports.AgentMemoryConfigurationUioToJSONTyped = AgentMemoryConfigurationUioToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AgentMemoryConfigurationUio interface.
23
+ */
24
+ function instanceOfAgentMemoryConfigurationUio(value) {
25
+ return true;
26
+ }
27
+ function AgentMemoryConfigurationUioFromJSON(json) {
28
+ return AgentMemoryConfigurationUioFromJSONTyped(json, false);
29
+ }
30
+ function AgentMemoryConfigurationUioFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'userMemoryEnabled': json['userMemoryEnabled'] == null ? undefined : json['userMemoryEnabled'],
36
+ 'agentMemoryEnabled': json['agentMemoryEnabled'] == null ? undefined : json['agentMemoryEnabled'],
37
+ 'organizationMemoryEnabled': json['organizationMemoryEnabled'] == null ? undefined : json['organizationMemoryEnabled'],
38
+ };
39
+ }
40
+ function AgentMemoryConfigurationUioToJSON(json) {
41
+ return AgentMemoryConfigurationUioToJSONTyped(json, false);
42
+ }
43
+ function AgentMemoryConfigurationUioToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'userMemoryEnabled': value['userMemoryEnabled'],
49
+ 'agentMemoryEnabled': value['agentMemoryEnabled'],
50
+ 'organizationMemoryEnabled': value['organizationMemoryEnabled'],
51
+ };
52
+ }
@@ -13,6 +13,7 @@ import type { AgentSubscriptionUio } from './AgentSubscriptionUio';
13
13
  import type { ContextualKnowledgeConversationUio } from './ContextualKnowledgeConversationUio';
14
14
  import type { PersonaUio } from './PersonaUio';
15
15
  import type { PromptInitUio } from './PromptInitUio';
16
+ import type { AgentMemoryConfigurationUio } from './AgentMemoryConfigurationUio';
16
17
  import type { AgentPatchEngineUio } from './AgentPatchEngineUio';
17
18
  import type { AgentTypeUio } from './AgentTypeUio';
18
19
  /**
@@ -181,6 +182,12 @@ export interface AgentPatchUio {
181
182
  * @memberof AgentPatchUio
182
183
  */
183
184
  maxToolSteps?: number;
185
+ /**
186
+ *
187
+ * @type {AgentMemoryConfigurationUio}
188
+ * @memberof AgentPatchUio
189
+ */
190
+ memoryConfiguration?: AgentMemoryConfigurationUio | null;
184
191
  /**
185
192
  *
186
193
  * @type {ContextualKnowledgeConversationUio}
@@ -22,6 +22,7 @@ const AgentSubscriptionUio_1 = require("./AgentSubscriptionUio");
22
22
  const ContextualKnowledgeConversationUio_1 = require("./ContextualKnowledgeConversationUio");
23
23
  const PersonaUio_1 = require("./PersonaUio");
24
24
  const PromptInitUio_1 = require("./PromptInitUio");
25
+ const AgentMemoryConfigurationUio_1 = require("./AgentMemoryConfigurationUio");
25
26
  const AgentPatchEngineUio_1 = require("./AgentPatchEngineUio");
26
27
  const AgentTypeUio_1 = require("./AgentTypeUio");
27
28
  /**
@@ -64,6 +65,7 @@ function AgentPatchUioFromJSONTyped(json, ignoreDiscriminator) {
64
65
  'personal': json['personal'] == null ? undefined : json['personal'],
65
66
  'hideConversationsInHistory': json['hideConversationsInHistory'] == null ? undefined : json['hideConversationsInHistory'],
66
67
  'maxToolSteps': json['maxToolSteps'] == null ? undefined : json['maxToolSteps'],
68
+ 'memoryConfiguration': json['memoryConfiguration'] == null ? undefined : (0, AgentMemoryConfigurationUio_1.AgentMemoryConfigurationUioFromJSON)(json['memoryConfiguration']),
67
69
  'contextualKnowledgeConversation': json['contextualKnowledgeConversation'] == null ? undefined : (0, ContextualKnowledgeConversationUio_1.ContextualKnowledgeConversationUioFromJSON)(json['contextualKnowledgeConversation']),
68
70
  };
69
71
  }
@@ -101,6 +103,7 @@ function AgentPatchUioToJSONTyped(value, ignoreDiscriminator = false) {
101
103
  'personal': value['personal'],
102
104
  'hideConversationsInHistory': value['hideConversationsInHistory'],
103
105
  'maxToolSteps': value['maxToolSteps'],
106
+ 'memoryConfiguration': (0, AgentMemoryConfigurationUio_1.AgentMemoryConfigurationUioToJSON)(value['memoryConfiguration']),
104
107
  'contextualKnowledgeConversation': (0, ContextualKnowledgeConversationUio_1.ContextualKnowledgeConversationUioToJSON)(value['contextualKnowledgeConversation']),
105
108
  };
106
109
  }
@@ -17,6 +17,7 @@ import type { PersonaUio } from './PersonaUio';
17
17
  import type { AgentCreatorUio } from './AgentCreatorUio';
18
18
  import type { EngineUio } from './EngineUio';
19
19
  import type { PromptInitUio } from './PromptInitUio';
20
+ import type { AgentMemoryConfigurationUio } from './AgentMemoryConfigurationUio';
20
21
  import type { AgentTypeUio } from './AgentTypeUio';
21
22
  /**
22
23
  *
@@ -216,6 +217,12 @@ export interface AgentUio {
216
217
  * @memberof AgentUio
217
218
  */
218
219
  maxToolSteps?: number;
220
+ /**
221
+ *
222
+ * @type {AgentMemoryConfigurationUio}
223
+ * @memberof AgentUio
224
+ */
225
+ memoryConfiguration?: AgentMemoryConfigurationUio | null;
219
226
  /**
220
227
  *
221
228
  * @type {ContextualKnowledgeConversationUio}
@@ -27,6 +27,7 @@ const PersonaUio_1 = require("./PersonaUio");
27
27
  const AgentCreatorUio_1 = require("./AgentCreatorUio");
28
28
  const EngineUio_1 = require("./EngineUio");
29
29
  const PromptInitUio_1 = require("./PromptInitUio");
30
+ const AgentMemoryConfigurationUio_1 = require("./AgentMemoryConfigurationUio");
30
31
  const AgentTypeUio_1 = require("./AgentTypeUio");
31
32
  /**
32
33
  * @export
@@ -99,6 +100,7 @@ function AgentUioFromJSONTyped(json, ignoreDiscriminator) {
99
100
  'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
100
101
  'hideConversationsInHistory': json['hideConversationsInHistory'] == null ? undefined : json['hideConversationsInHistory'],
101
102
  'maxToolSteps': json['maxToolSteps'] == null ? undefined : json['maxToolSteps'],
103
+ 'memoryConfiguration': json['memoryConfiguration'] == null ? undefined : (0, AgentMemoryConfigurationUio_1.AgentMemoryConfigurationUioFromJSON)(json['memoryConfiguration']),
102
104
  'contextualKnowledgeConversation': json['contextualKnowledgeConversation'] == null ? undefined : (0, ContextualKnowledgeConversationUio_1.ContextualKnowledgeConversationUioFromJSON)(json['contextualKnowledgeConversation']),
103
105
  'creator': json['creator'] == null ? undefined : (0, AgentCreatorUio_1.AgentCreatorUioFromJSON)(json['creator']),
104
106
  'engineSource': json['engineSource'] == null ? undefined : json['engineSource'],
@@ -144,6 +146,7 @@ function AgentUioToJSONTyped(value, ignoreDiscriminator = false) {
144
146
  'createdBy': value['createdBy'],
145
147
  'hideConversationsInHistory': value['hideConversationsInHistory'],
146
148
  'maxToolSteps': value['maxToolSteps'],
149
+ 'memoryConfiguration': (0, AgentMemoryConfigurationUio_1.AgentMemoryConfigurationUioToJSON)(value['memoryConfiguration']),
147
150
  'contextualKnowledgeConversation': (0, ContextualKnowledgeConversationUio_1.ContextualKnowledgeConversationUioToJSON)(value['contextualKnowledgeConversation']),
148
151
  'creator': (0, AgentCreatorUio_1.AgentCreatorUioToJSON)(value['creator']),
149
152
  'engineSource': value['engineSource'],
@@ -17,6 +17,7 @@ export * from './AgentDuplicateRequestUio';
17
17
  export * from './AgentFeedbackMetricsUio';
18
18
  export * from './AgentFlowCreateUio';
19
19
  export * from './AgentFlowUio';
20
+ export * from './AgentMemoryConfigurationUio';
20
21
  export * from './AgentMetricsByAppUio';
21
22
  export * from './AgentMetricsEventUio';
22
23
  export * from './AgentMetricsOverviewUio';
@@ -35,6 +35,7 @@ __exportStar(require("./AgentDuplicateRequestUio"), exports);
35
35
  __exportStar(require("./AgentFeedbackMetricsUio"), exports);
36
36
  __exportStar(require("./AgentFlowCreateUio"), exports);
37
37
  __exportStar(require("./AgentFlowUio"), exports);
38
+ __exportStar(require("./AgentMemoryConfigurationUio"), exports);
38
39
  __exportStar(require("./AgentMetricsByAppUio"), exports);
39
40
  __exportStar(require("./AgentMetricsEventUio"), exports);
40
41
  __exportStar(require("./AgentMetricsOverviewUio"), exports);
package/dist/openapi.json CHANGED
@@ -8256,6 +8256,46 @@
8256
8256
  "tags" : [ "knowledge" ]
8257
8257
  }
8258
8258
  },
8259
+ "/scrapping-jobs/{jobId}/status" : {
8260
+ "get" : {
8261
+ "description" : "Returns the current status and logs of a scrapping job",
8262
+ "operationId" : "getScrappingJobStatus",
8263
+ "parameters" : [ {
8264
+ "description" : "ID of the scrapping job",
8265
+ "in" : "path",
8266
+ "name" : "jobId",
8267
+ "required" : true,
8268
+ "schema" : {
8269
+ "type" : "string"
8270
+ }
8271
+ } ],
8272
+ "responses" : {
8273
+ "200" : {
8274
+ "content" : {
8275
+ "application/json" : {
8276
+ "schema" : {
8277
+ "additionalProperties" : true,
8278
+ "description" : "Status payload returned by the scrapping service",
8279
+ "type" : "object"
8280
+ }
8281
+ }
8282
+ },
8283
+ "description" : "Scrapping job status retrieved successfully"
8284
+ },
8285
+ "401" : {
8286
+ "description" : "Unauthorized"
8287
+ },
8288
+ "404" : {
8289
+ "description" : "Scrapping job not found"
8290
+ },
8291
+ "500" : {
8292
+ "description" : "Error while fetching scrapping status"
8293
+ }
8294
+ },
8295
+ "summary" : "Get scrapping job status",
8296
+ "tags" : [ "knowledge" ]
8297
+ }
8298
+ },
8259
8299
  "/knowledge-bases/{knowledgebaseId}/chunks/{chunkIdKnowledge}" : {
8260
8300
  "delete" : {
8261
8301
  "description" : "Deletes a chunk from a knowledge file",
@@ -11794,6 +11834,15 @@
11794
11834
  "type" : "string"
11795
11835
  }
11796
11836
  },
11837
+ "scrappingJobIdPath" : {
11838
+ "description" : "ID of the scrapping job",
11839
+ "in" : "path",
11840
+ "name" : "jobId",
11841
+ "required" : true,
11842
+ "schema" : {
11843
+ "type" : "string"
11844
+ }
11845
+ },
11797
11846
  "chunkIdKnowledgePath" : {
11798
11847
  "description" : "ID of the chunk knowledge file",
11799
11848
  "in" : "path",
@@ -12212,6 +12261,12 @@
12212
12261
  "minimum" : 1,
12213
12262
  "type" : "integer"
12214
12263
  },
12264
+ "memoryConfiguration" : {
12265
+ "allOf" : [ {
12266
+ "$ref" : "#/components/schemas/AgentMemoryConfiguration"
12267
+ } ],
12268
+ "nullable" : true
12269
+ },
12215
12270
  "contextualKnowledgeConversation" : {
12216
12271
  "allOf" : [ {
12217
12272
  "$ref" : "#/components/schemas/ContextualKnowledgeConversation"
@@ -12347,6 +12402,20 @@
12347
12402
  "required" : [ "amountForPrice", "currency", "price" ],
12348
12403
  "type" : "object"
12349
12404
  },
12405
+ "AgentMemoryConfiguration" : {
12406
+ "properties" : {
12407
+ "userMemoryEnabled" : {
12408
+ "type" : "boolean"
12409
+ },
12410
+ "agentMemoryEnabled" : {
12411
+ "type" : "boolean"
12412
+ },
12413
+ "organizationMemoryEnabled" : {
12414
+ "type" : "boolean"
12415
+ }
12416
+ },
12417
+ "type" : "object"
12418
+ },
12350
12419
  "ContextualKnowledgeConversation" : {
12351
12420
  "properties" : {
12352
12421
  "enabled" : {
@@ -12535,6 +12604,12 @@
12535
12604
  "minimum" : 1,
12536
12605
  "type" : "integer"
12537
12606
  },
12607
+ "memoryConfiguration" : {
12608
+ "allOf" : [ {
12609
+ "$ref" : "#/components/schemas/AgentMemoryConfiguration"
12610
+ } ],
12611
+ "nullable" : true
12612
+ },
12538
12613
  "contextualKnowledgeConversation" : {
12539
12614
  "allOf" : [ {
12540
12615
  "$ref" : "#/components/schemas/ContextualKnowledgeConversation"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breign/client",
3
- "version": "1.0.115",
3
+ "version": "1.0.117",
4
4
  "main": "dist/index.js",
5
5
  "exports": {
6
6
  ".": "./dist/index.js",