@smythos/sre 1.5.1 → 1.5.4

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 (193) hide show
  1. package/LICENSE +18 -0
  2. package/dist/index.js +22329 -4
  3. package/dist/index.js.map +1 -1
  4. package/dist/types/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.d.ts +2 -2
  5. package/dist/types/subsystems/IO/VectorDB.service/embed/BaseEmbedding.d.ts +11 -7
  6. package/dist/types/types/VectorDB.types.d.ts +13 -11
  7. package/package.json +102 -127
  8. package/src/Components/APICall/APICall.class.ts +155 -0
  9. package/src/Components/APICall/AccessTokenManager.ts +130 -0
  10. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -0
  11. package/src/Components/APICall/OAuth.helper.ts +294 -0
  12. package/src/Components/APICall/mimeTypeCategories.ts +46 -0
  13. package/src/Components/APICall/parseData.ts +167 -0
  14. package/src/Components/APICall/parseHeaders.ts +41 -0
  15. package/src/Components/APICall/parseProxy.ts +68 -0
  16. package/src/Components/APICall/parseUrl.ts +91 -0
  17. package/src/Components/APIEndpoint.class.ts +234 -0
  18. package/src/Components/APIOutput.class.ts +58 -0
  19. package/src/Components/AgentPlugin.class.ts +102 -0
  20. package/src/Components/Async.class.ts +155 -0
  21. package/src/Components/Await.class.ts +90 -0
  22. package/src/Components/Classifier.class.ts +158 -0
  23. package/src/Components/Component.class.ts +94 -0
  24. package/src/Components/ComponentHost.class.ts +38 -0
  25. package/src/Components/DataSourceCleaner.class.ts +92 -0
  26. package/src/Components/DataSourceIndexer.class.ts +181 -0
  27. package/src/Components/DataSourceLookup.class.ts +141 -0
  28. package/src/Components/FEncDec.class.ts +29 -0
  29. package/src/Components/FHash.class.ts +33 -0
  30. package/src/Components/FSign.class.ts +80 -0
  31. package/src/Components/FSleep.class.ts +25 -0
  32. package/src/Components/FTimestamp.class.ts +25 -0
  33. package/src/Components/FileStore.class.ts +75 -0
  34. package/src/Components/ForEach.class.ts +97 -0
  35. package/src/Components/GPTPlugin.class.ts +70 -0
  36. package/src/Components/GenAILLM.class.ts +395 -0
  37. package/src/Components/HuggingFace.class.ts +314 -0
  38. package/src/Components/Image/imageSettings.config.ts +70 -0
  39. package/src/Components/ImageGenerator.class.ts +407 -0
  40. package/src/Components/JSONFilter.class.ts +54 -0
  41. package/src/Components/LLMAssistant.class.ts +213 -0
  42. package/src/Components/LogicAND.class.ts +28 -0
  43. package/src/Components/LogicAtLeast.class.ts +85 -0
  44. package/src/Components/LogicAtMost.class.ts +86 -0
  45. package/src/Components/LogicOR.class.ts +29 -0
  46. package/src/Components/LogicXOR.class.ts +34 -0
  47. package/src/Components/MCPClient.class.ts +112 -0
  48. package/src/Components/PromptGenerator.class.ts +122 -0
  49. package/src/Components/ScrapflyWebScrape.class.ts +159 -0
  50. package/src/Components/TavilyWebSearch.class.ts +98 -0
  51. package/src/Components/index.ts +77 -0
  52. package/src/Core/AgentProcess.helper.ts +240 -0
  53. package/src/Core/Connector.class.ts +123 -0
  54. package/src/Core/ConnectorsService.ts +192 -0
  55. package/src/Core/DummyConnector.ts +49 -0
  56. package/src/Core/HookService.ts +105 -0
  57. package/src/Core/SmythRuntime.class.ts +292 -0
  58. package/src/Core/SystemEvents.ts +15 -0
  59. package/src/Core/boot.ts +55 -0
  60. package/src/config.ts +15 -0
  61. package/src/constants.ts +125 -0
  62. package/src/data/hugging-face.params.json +580 -0
  63. package/src/helpers/BinaryInput.helper.ts +324 -0
  64. package/src/helpers/Conversation.helper.ts +1094 -0
  65. package/src/helpers/JsonContent.helper.ts +97 -0
  66. package/src/helpers/LocalCache.helper.ts +97 -0
  67. package/src/helpers/Log.helper.ts +234 -0
  68. package/src/helpers/OpenApiParser.helper.ts +150 -0
  69. package/src/helpers/S3Cache.helper.ts +129 -0
  70. package/src/helpers/SmythURI.helper.ts +5 -0
  71. package/src/helpers/TemplateString.helper.ts +243 -0
  72. package/src/helpers/TypeChecker.helper.ts +329 -0
  73. package/src/index.ts +179 -0
  74. package/src/index.ts.bak +179 -0
  75. package/src/subsystems/AgentManager/Agent.class.ts +1108 -0
  76. package/src/subsystems/AgentManager/Agent.helper.ts +3 -0
  77. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -0
  78. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -0
  79. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +142 -0
  80. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -0
  81. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -0
  82. package/src/subsystems/AgentManager/AgentLogger.class.ts +297 -0
  83. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -0
  84. package/src/subsystems/AgentManager/AgentRuntime.class.ts +559 -0
  85. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -0
  86. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -0
  87. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -0
  88. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +59 -0
  89. package/src/subsystems/AgentManager/Component.service/index.ts +11 -0
  90. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -0
  91. package/src/subsystems/AgentManager/ForkedAgent.class.ts +153 -0
  92. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -0
  93. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +99 -0
  94. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +63 -0
  95. package/src/subsystems/ComputeManager/Code.service/index.ts +11 -0
  96. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -0
  97. package/src/subsystems/IO/CLI.service/index.ts +9 -0
  98. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -0
  99. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -0
  100. package/src/subsystems/IO/Log.service/index.ts +13 -0
  101. package/src/subsystems/IO/NKV.service/NKVConnector.ts +41 -0
  102. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -0
  103. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -0
  104. package/src/subsystems/IO/NKV.service/index.ts +12 -0
  105. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -0
  106. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -0
  107. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -0
  108. package/src/subsystems/IO/Router.service/index.ts +11 -0
  109. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +472 -0
  110. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -0
  111. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +305 -0
  112. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +418 -0
  113. package/src/subsystems/IO/Storage.service/index.ts +13 -0
  114. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -0
  115. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +454 -0
  116. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +384 -0
  117. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +421 -0
  118. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -0
  119. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -0
  120. package/src/subsystems/IO/VectorDB.service/embed/index.ts +21 -0
  121. package/src/subsystems/IO/VectorDB.service/index.ts +14 -0
  122. package/src/subsystems/LLMManager/LLM.helper.ts +221 -0
  123. package/src/subsystems/LLMManager/LLM.inference.ts +335 -0
  124. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +375 -0
  125. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +145 -0
  126. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +632 -0
  127. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +405 -0
  128. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +81 -0
  129. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +689 -0
  130. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +257 -0
  131. package/src/subsystems/LLMManager/LLM.service/connectors/OpenAI.class.ts +848 -0
  132. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +255 -0
  133. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +193 -0
  134. package/src/subsystems/LLMManager/LLM.service/index.ts +43 -0
  135. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +281 -0
  136. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.ts +229 -0
  137. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -0
  138. package/src/subsystems/LLMManager/custom-models.ts +854 -0
  139. package/src/subsystems/LLMManager/models.ts +2539 -0
  140. package/src/subsystems/LLMManager/paramMappings.ts +69 -0
  141. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -0
  142. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -0
  143. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +201 -0
  144. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -0
  145. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -0
  146. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -0
  147. package/src/subsystems/MemoryManager/LLMCache.ts +72 -0
  148. package/src/subsystems/MemoryManager/LLMContext.ts +125 -0
  149. package/src/subsystems/MemoryManager/RuntimeContext.ts +249 -0
  150. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -0
  151. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +76 -0
  152. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -0
  153. package/src/subsystems/Security/Account.service/AccountConnector.ts +41 -0
  154. package/src/subsystems/Security/Account.service/connectors/AWSAccount.class.ts +76 -0
  155. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -0
  156. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +159 -0
  157. package/src/subsystems/Security/Account.service/index.ts +14 -0
  158. package/src/subsystems/Security/Credentials.helper.ts +62 -0
  159. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +34 -0
  160. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +57 -0
  161. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -0
  162. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -0
  163. package/src/subsystems/Security/SecureConnector.class.ts +110 -0
  164. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -0
  165. package/src/subsystems/Security/Vault.service/VaultConnector.ts +26 -0
  166. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -0
  167. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +166 -0
  168. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -0
  169. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -0
  170. package/src/subsystems/Security/Vault.service/index.ts +12 -0
  171. package/src/types/ACL.types.ts +104 -0
  172. package/src/types/AWS.types.ts +9 -0
  173. package/src/types/Agent.types.ts +61 -0
  174. package/src/types/AgentLogger.types.ts +17 -0
  175. package/src/types/Cache.types.ts +1 -0
  176. package/src/types/Common.types.ts +3 -0
  177. package/src/types/LLM.types.ts +419 -0
  178. package/src/types/Redis.types.ts +8 -0
  179. package/src/types/SRE.types.ts +64 -0
  180. package/src/types/Security.types.ts +18 -0
  181. package/src/types/Storage.types.ts +5 -0
  182. package/src/types/VectorDB.types.ts +86 -0
  183. package/src/utils/base64.utils.ts +275 -0
  184. package/src/utils/cli.utils.ts +68 -0
  185. package/src/utils/data.utils.ts +263 -0
  186. package/src/utils/date-time.utils.ts +22 -0
  187. package/src/utils/general.utils.ts +238 -0
  188. package/src/utils/index.ts +12 -0
  189. package/src/utils/numbers.utils.ts +13 -0
  190. package/src/utils/oauth.utils.ts +35 -0
  191. package/src/utils/string.utils.ts +414 -0
  192. package/src/utils/url.utils.ts +19 -0
  193. package/src/utils/validation.utils.ts +74 -0
@@ -0,0 +1,421 @@
1
+ //==[ SRE: RAMVectorDB ]======================
2
+
3
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
4
+ import { IAccessCandidate, IACL, TAccessLevel } from '@sre/types/ACL.types';
5
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
6
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
7
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
8
+ import { VectorDBConnector } from '../VectorDBConnector';
9
+ import {
10
+ DatasourceDto,
11
+ IStorageVectorDataSource,
12
+ IStorageVectorNamespace,
13
+ IVectorDataSourceDto,
14
+ QueryOptions,
15
+ VectorsResultData,
16
+ } from '@sre/types/VectorDB.types';
17
+ import { ConnectorService } from '@sre/Core/ConnectorsService';
18
+ import { Logger } from '@sre/helpers/Log.helper';
19
+ import { AccountConnector } from '@sre/Security/Account.service/AccountConnector';
20
+ import { OpenAIEmbeds } from '@sre/IO/VectorDB.service/embed/OpenAIEmbedding';
21
+ import crypto from 'crypto';
22
+ import { BaseEmbedding, TEmbeddings } from '../embed/BaseEmbedding';
23
+ import { EmbeddingsFactory } from '../embed';
24
+
25
+ const console = Logger('RAM VectorDB');
26
+
27
+ interface VectorData {
28
+ id: string;
29
+ values: number[];
30
+ datasource: string;
31
+ metadata?: { [key: string]: any };
32
+ }
33
+
34
+ export type RAMVectorDBConfig = {
35
+ embeddings: TEmbeddings;
36
+ };
37
+
38
+ /**
39
+ * RAM Vector Database - stores everything in memory
40
+ * Data structure:
41
+ * - vectors: namespace -> VectorData[]
42
+ * - namespaces: namespace -> IStorageVectorNamespace
43
+ * - datasources: namespace -> datasourceId -> IStorageVectorDataSource
44
+ * - acls: resourceId -> IACL
45
+ */
46
+
47
+ export class RAMVectorDB extends VectorDBConnector {
48
+ public name = 'RAMVec';
49
+ public id = 'ram';
50
+ //private openaiApiKey: string;
51
+ private accountConnector: AccountConnector;
52
+ //private embeddingsProvider: OpenAIEmbeds;
53
+
54
+ // In-memory storage
55
+ private vectors: Record<string, VectorData[]> = {};
56
+ private namespaces: Record<string, IStorageVectorNamespace> = {};
57
+ private datasources: Record<string, Record<string, IStorageVectorDataSource>> = {};
58
+ private acls: Record<string, IACL> = {};
59
+ public embedder: BaseEmbedding;
60
+
61
+ constructor(protected _settings: RAMVectorDBConfig) {
62
+ super(_settings);
63
+
64
+ this.accountConnector = ConnectorService.getAccountConnector();
65
+
66
+ if (!_settings.embeddings) {
67
+ _settings.embeddings = { provider: 'OpenAI', model: 'text-embedding-3-large', params: { dimensions: 1024 } };
68
+ }
69
+ if (!_settings.embeddings.params?.dimensions) _settings.embeddings.params.dimensions = 1024;
70
+
71
+ this.embedder = EmbeddingsFactory.create(_settings.embeddings.provider, _settings.embeddings);
72
+ }
73
+
74
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
75
+ //const teamId = await this.accountConnector.getCandidateTeam(AccessCandidate.clone(candidate));
76
+ const preparedNs = this.constructNsName(candidate as AccessCandidate, resourceId);
77
+ const acl = this.acls[preparedNs];
78
+ const exists = !!acl;
79
+
80
+ if (!exists) {
81
+ //the resource does not exist yet, we grant write access to the candidate in order to allow the resource creation
82
+ return new ACL().addAccess(candidate.role, candidate.id, TAccessLevel.Owner);
83
+ }
84
+ return ACL.from(acl);
85
+ }
86
+
87
+ @SecureConnector.AccessControl
88
+ protected async createNamespace(acRequest: AccessRequest, namespace: string, metadata?: { [key: string]: any }): Promise<void> {
89
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
90
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
91
+
92
+ if (!this.namespaces[preparedNs]) {
93
+ const nsData = {
94
+ namespace: preparedNs,
95
+ displayName: namespace,
96
+ candidateId: acRequest.candidate.id,
97
+ candidateRole: acRequest.candidate.role,
98
+ metadata: {
99
+ ...metadata,
100
+ storageType: 'RAM',
101
+ },
102
+ };
103
+
104
+ // Store namespace metadata in memory
105
+ this.namespaces[preparedNs] = nsData;
106
+
107
+ // Initialize namespace vectors storage
108
+ this.vectors[preparedNs] = [];
109
+
110
+ // Initialize datasources storage for this namespace
111
+ this.datasources[preparedNs] = {};
112
+ }
113
+
114
+ // Store ACL in memory
115
+ const acl = new ACL().addAccess(acRequest.candidate.role, acRequest.candidate.id, TAccessLevel.Owner).ACL;
116
+ this.acls[preparedNs] = acl;
117
+
118
+ return new Promise<void>((resolve) => resolve());
119
+ }
120
+
121
+ @SecureConnector.AccessControl
122
+ protected async namespaceExists(acRequest: AccessRequest, namespace: string): Promise<boolean> {
123
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
124
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
125
+ return !!this.namespaces[preparedNs];
126
+ }
127
+
128
+ @SecureConnector.AccessControl
129
+ protected async getNamespace(acRequest: AccessRequest, namespace: string): Promise<IStorageVectorNamespace> {
130
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
131
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
132
+ const nsData = this.namespaces[preparedNs];
133
+ if (!nsData) {
134
+ throw new Error(`Namespace ${namespace} not found`);
135
+ }
136
+ return nsData;
137
+ }
138
+
139
+ @SecureConnector.AccessControl
140
+ protected async listNamespaces(acRequest: AccessRequest): Promise<IStorageVectorNamespace[]> {
141
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
142
+
143
+ // Filter namespaces by team
144
+ return Object.values(this.namespaces).filter((ns) => ns.candidateId === acRequest.candidate.id);
145
+ }
146
+
147
+ @SecureConnector.AccessControl
148
+ protected async deleteNamespace(acRequest: AccessRequest, namespace: string): Promise<void> {
149
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
150
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
151
+
152
+ // Delete from memory
153
+ delete this.vectors[preparedNs];
154
+ delete this.namespaces[preparedNs];
155
+ delete this.datasources[preparedNs];
156
+ delete this.acls[preparedNs];
157
+ }
158
+
159
+ @SecureConnector.AccessControl
160
+ protected async search(
161
+ acRequest: AccessRequest,
162
+ namespace: string,
163
+ query: string | number[],
164
+ options: QueryOptions = {}
165
+ ): Promise<VectorsResultData> {
166
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
167
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
168
+
169
+ if (!this.namespaces[preparedNs]) {
170
+ throw new Error('Namespace does not exist');
171
+ }
172
+
173
+ // Get query vector
174
+ let queryVector = query;
175
+ if (typeof query === 'string') {
176
+ queryVector = await this.embedder.embedText(query, acRequest.candidate as AccessCandidate);
177
+ }
178
+
179
+ // Search in namespace data
180
+ const namespaceData = this.vectors[preparedNs] || [];
181
+ const results: Array<{ id: string; score: number; values: number[]; metadata?: any; text: string }> = [];
182
+
183
+ for (const vector of namespaceData) {
184
+ const similarity = this.cosineSimilarity(queryVector as number[], vector.values);
185
+ results.push({
186
+ id: vector.id,
187
+ score: similarity,
188
+ values: vector.values,
189
+ metadata: options.includeMetadata ? vector.metadata : undefined,
190
+ text: vector.metadata?.text,
191
+ });
192
+ }
193
+
194
+ // Sort by similarity (highest first) and limit results
195
+ const topK = options.topK || 10;
196
+ const sortedResults = results.sort((a, b) => b.score - a.score).slice(0, topK);
197
+
198
+ return sortedResults;
199
+ }
200
+
201
+ @SecureConnector.AccessControl
202
+ protected async insert(
203
+ acRequest: AccessRequest,
204
+ namespace: string,
205
+ sourceWrapper: IVectorDataSourceDto | IVectorDataSourceDto[]
206
+ ): Promise<string[]> {
207
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
208
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
209
+
210
+ const sources = Array.isArray(sourceWrapper) ? sourceWrapper : [sourceWrapper];
211
+ const insertedIds: string[] = [];
212
+
213
+ if (!this.vectors[preparedNs]) {
214
+ this.vectors[preparedNs] = [];
215
+ }
216
+
217
+ for (const source of sources) {
218
+ let vector: number[] = [];
219
+
220
+ if (typeof source.source === 'string') {
221
+ // Text embedding
222
+
223
+ vector = await this.embedder.embedText(source.source, acRequest.candidate as AccessCandidate);
224
+ } else {
225
+ // Direct vector
226
+ vector = source.source;
227
+ }
228
+
229
+ const vectorData: VectorData = {
230
+ id: source.id,
231
+ values: vector,
232
+ datasource: source.metadata?.datasourceId || 'unknown',
233
+ metadata: source.metadata,
234
+ };
235
+
236
+ // Check if vector with this ID already exists and update it
237
+ const existingIndex = this.vectors[preparedNs].findIndex((v) => v.id === source.id);
238
+ if (existingIndex >= 0) {
239
+ this.vectors[preparedNs][existingIndex] = vectorData;
240
+ } else {
241
+ this.vectors[preparedNs].push(vectorData);
242
+ }
243
+
244
+ insertedIds.push(source.id);
245
+ }
246
+
247
+ return insertedIds;
248
+ }
249
+
250
+ @SecureConnector.AccessControl
251
+ protected async delete(acRequest: AccessRequest, namespace: string, id: string | string[]): Promise<void> {
252
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
253
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
254
+
255
+ const ids = Array.isArray(id) ? id : [id];
256
+
257
+ if (this.vectors[preparedNs]) {
258
+ this.vectors[preparedNs] = this.vectors[preparedNs].filter((vector) => !ids.includes(vector.id));
259
+ }
260
+ }
261
+
262
+ @SecureConnector.AccessControl
263
+ protected async createDatasource(acRequest: AccessRequest, namespace: string, datasource: DatasourceDto): Promise<IStorageVectorDataSource> {
264
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
265
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
266
+ const datasourceId = datasource.id || crypto.randomUUID();
267
+
268
+ // Ensure namespace exists
269
+ if (!this.namespaces[preparedNs]) {
270
+ await this.createNamespace(acRequest, namespace);
271
+ }
272
+
273
+ // Process text and create vectors
274
+ const vectorIds: string[] = [];
275
+
276
+ // Split text into chunks if needed
277
+ const chunkSize = datasource.chunkSize || 1000;
278
+ const chunkOverlap = datasource.chunkOverlap || 200;
279
+ const chunks = this.splitTextIntoChunks(datasource.text, chunkSize, chunkOverlap);
280
+
281
+ // Initialize namespace vectors if not exists (should already exist if namespace was created properly)
282
+ if (!this.vectors[preparedNs]) {
283
+ this.vectors[preparedNs] = [];
284
+ }
285
+
286
+ for (let i = 0; i < chunks.length; i++) {
287
+ const chunkId = `${datasourceId}_chunk_${i}`;
288
+ const vector = await this.embedder.embedText(chunks[i], acRequest.candidate as AccessCandidate);
289
+
290
+ const vectorData: VectorData = {
291
+ id: chunkId,
292
+ values: vector,
293
+ datasource: datasourceId,
294
+ metadata: {
295
+ ...datasource.metadata,
296
+ text: chunks[i],
297
+ chunkIndex: i,
298
+ totalChunks: chunks.length,
299
+ },
300
+ };
301
+
302
+ this.vectors[preparedNs].push(vectorData);
303
+ vectorIds.push(chunkId);
304
+ }
305
+
306
+ const storageDataSource: IStorageVectorDataSource = {
307
+ namespaceId: preparedNs,
308
+ candidateId: acRequest.candidate.id,
309
+ candidateRole: acRequest.candidate.role,
310
+ name: datasource.label || `Datasource ${datasourceId}`,
311
+ metadata: JSON.stringify(datasource.metadata || {}),
312
+ text: datasource.text,
313
+ vectorIds,
314
+ id: datasourceId,
315
+ };
316
+
317
+ // Store datasource metadata in memory
318
+ if (!this.datasources[preparedNs]) {
319
+ this.datasources[preparedNs] = {};
320
+ }
321
+ if (!this.datasources[preparedNs][datasourceId]) {
322
+ this.datasources[preparedNs][datasourceId] = storageDataSource;
323
+ } else {
324
+ this.datasources[preparedNs][datasourceId].vectorIds.push(...vectorIds);
325
+ }
326
+
327
+ return storageDataSource;
328
+ }
329
+
330
+ @SecureConnector.AccessControl
331
+ protected async deleteDatasource(acRequest: AccessRequest, namespace: string, datasourceId: string): Promise<void> {
332
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
333
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
334
+
335
+ // Ensure namespace exists
336
+ if (!this.namespaces[preparedNs]) {
337
+ throw new Error('Namespace does not exist');
338
+ }
339
+
340
+ // Get datasource info
341
+ const datasource = this.datasources[preparedNs]?.[datasourceId];
342
+ if (datasource) {
343
+ // Delete all vectors belonging to this datasource
344
+ if (this.vectors[preparedNs]) {
345
+ this.vectors[preparedNs] = this.vectors[preparedNs].filter((vector) => vector.datasource !== datasourceId);
346
+ }
347
+ }
348
+
349
+ // Delete datasource metadata
350
+ if (this.datasources[preparedNs]) {
351
+ delete this.datasources[preparedNs][datasourceId];
352
+ }
353
+ }
354
+
355
+ @SecureConnector.AccessControl
356
+ protected async listDatasources(acRequest: AccessRequest, namespace: string): Promise<IStorageVectorDataSource[]> {
357
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
358
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
359
+
360
+ const namespaceDatasources = this.datasources[preparedNs] || {};
361
+ return Object.values(namespaceDatasources);
362
+ }
363
+
364
+ @SecureConnector.AccessControl
365
+ protected async getDatasource(acRequest: AccessRequest, namespace: string, datasourceId: string): Promise<IStorageVectorDataSource> {
366
+ //const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
367
+ const preparedNs = this.constructNsName(acRequest.candidate as AccessCandidate, namespace);
368
+
369
+ const datasource = this.datasources[preparedNs]?.[datasourceId];
370
+ if (!datasource) {
371
+ throw new Error(`Datasource ${datasourceId} not found`);
372
+ }
373
+ return datasource;
374
+ }
375
+
376
+ /**
377
+ * Calculate cosine similarity between two vectors
378
+ */
379
+ private cosineSimilarity(vecA: number[], vecB: number[]): number {
380
+ if (vecA.length !== vecB.length) {
381
+ throw new Error('Vectors must have the same length');
382
+ }
383
+
384
+ let dotProduct = 0;
385
+ let normA = 0;
386
+ let normB = 0;
387
+
388
+ for (let i = 0; i < vecA.length; i++) {
389
+ dotProduct += vecA[i] * vecB[i];
390
+ normA += vecA[i] * vecA[i];
391
+ normB += vecB[i] * vecB[i];
392
+ }
393
+
394
+ normA = Math.sqrt(normA);
395
+ normB = Math.sqrt(normB);
396
+
397
+ if (normA === 0 || normB === 0) {
398
+ return 0;
399
+ }
400
+
401
+ return dotProduct / (normA * normB);
402
+ }
403
+
404
+ /**
405
+ * Split text into chunks with overlap
406
+ */
407
+ private splitTextIntoChunks(text: string, chunkSize: number, overlap: number): string[] {
408
+ const chunks: string[] = [];
409
+ let start = 0;
410
+
411
+ while (start < text.length) {
412
+ const end = Math.min(start + chunkSize, text.length);
413
+ chunks.push(text.slice(start, end));
414
+
415
+ if (end === text.length) break;
416
+ start = end - overlap;
417
+ }
418
+
419
+ return chunks;
420
+ }
421
+ }
@@ -0,0 +1,107 @@
1
+ import { IVectorDataSourceDto, Source } from '@sre/types/VectorDB.types';
2
+ import { isUrl } from '@sre/utils/index';
3
+ import { SupportedProviders, SupportedModels } from './index';
4
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
5
+
6
+ export type TEmbeddings = {
7
+ provider: SupportedProviders;
8
+ model: SupportedModels[SupportedProviders];
9
+
10
+ credentials?: {
11
+ apiKey: string;
12
+ };
13
+ params?: {
14
+ dimensions?: number;
15
+ timeout?: number;
16
+ chunkSize?: number;
17
+ stripNewLines?: boolean;
18
+ };
19
+ };
20
+
21
+ type SupportedSources = 'text' | 'vector' | 'url';
22
+
23
+ export abstract class BaseEmbedding {
24
+ model: string;
25
+ modelName: string;
26
+ chunkSize = 512;
27
+ stripNewLines = true;
28
+ dimensions?: number;
29
+ timeout?: number;
30
+
31
+ constructor(fields?: Partial<TEmbeddings>) {
32
+ this.model = fields?.model ?? this.model;
33
+ this.chunkSize = fields?.params?.chunkSize ?? this.chunkSize;
34
+ this.stripNewLines = fields?.params?.stripNewLines ?? this.stripNewLines;
35
+ this.timeout = fields?.params?.timeout;
36
+ this.dimensions = fields?.params?.dimensions;
37
+ }
38
+
39
+ /**
40
+ * Embed multiple texts and return their vector representations
41
+ */
42
+ abstract embedTexts(texts: string[], candidate: AccessCandidate): Promise<number[][]>;
43
+
44
+ /**
45
+ * Embed a single text and return its vector representation
46
+ */
47
+ abstract embedText(text: string, candidate: AccessCandidate): Promise<number[]>;
48
+
49
+ /**
50
+ * Utility method to chunk arrays into smaller batches
51
+ */
52
+ protected chunkArr<T>(arr: T[], sizePerChunk: number): T[][] {
53
+ return arr.reduce((chunks, elem, index) => {
54
+ const chunkIndex = Math.floor(index / sizePerChunk);
55
+ const chunk = chunks[chunkIndex] || [];
56
+ chunks[chunkIndex] = chunk.concat([elem]);
57
+ return chunks;
58
+ }, [] as T[][]);
59
+ }
60
+
61
+ /**
62
+ * Utility method to process multiple texts based on stripNewLines setting
63
+ */
64
+ protected processTexts(texts: string[]): string[] {
65
+ return this.stripNewLines ? texts.map((t) => t.replace(/\n/g, ' ')) : texts;
66
+ }
67
+
68
+ public detectSourceType(source: Source): SupportedSources | 'unknown' {
69
+ if (typeof source === 'string') {
70
+ return isUrl(source) ? 'url' : 'text';
71
+ } else if (Array.isArray(source) && source.every((v) => typeof v === 'number')) {
72
+ return 'vector';
73
+ } else {
74
+ return 'unknown';
75
+ }
76
+ }
77
+
78
+ public transformSource(source: IVectorDataSourceDto[], sourceType: SupportedSources, candidate: AccessCandidate) {
79
+ //* as the accepted sources increases, you will need to implement the strategy pattern instead of a switch case
80
+ switch (sourceType) {
81
+ case 'text': {
82
+ const texts = source.map((s) => s.source as string);
83
+
84
+ return this.embedTexts(texts, candidate).then((vectors) => {
85
+ return source.map((s, i) => ({
86
+ ...s,
87
+ source: vectors[i],
88
+ metadata: { ...s.metadata, text: texts[i] },
89
+ }));
90
+ });
91
+ }
92
+ case 'vector': {
93
+ return source;
94
+ }
95
+ }
96
+ }
97
+
98
+ // this is a dummy vector used to maximize search distance
99
+ // we use it to create reserved vectors that store namespace data
100
+ public get dummyVector(): number[] {
101
+ //This is good for cosine similarity, but not for euclidean distance
102
+ //TODO: detect current similarity metric and use the appropriate vector (e.g for euclidean distance, use a vector with all large values like [1e6, 1e6, ..., 1e6])
103
+ return Array(this.dimensions - 1)
104
+ .fill(0)
105
+ .concat([1]);
106
+ }
107
+ }
@@ -0,0 +1,109 @@
1
+ import OpenAI, { type ClientOptions, OpenAI as OpenAIClient } from 'openai';
2
+ import { BaseEmbedding, TEmbeddings } from './BaseEmbedding';
3
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
4
+ import { getLLMCredentials } from '@sre/LLMManager/LLM.service/LLMCredentials.helper';
5
+ import { TLLMCredentials, TLLMModel } from '@sre/types/LLM.types';
6
+
7
+ // Helper function to create OpenAI API errors
8
+ const createOpenAIError = (statusCode: number, error: any) => {
9
+ return new OpenAI.APIError(
10
+ statusCode,
11
+ {
12
+ code: error?.errKey || error?.code,
13
+ message: error?.message,
14
+ type: error?.name,
15
+ },
16
+ error?.message,
17
+ null
18
+ );
19
+ };
20
+
21
+ const DEFAULT_MODEL = 'text-embedding-ada-002';
22
+
23
+ export class OpenAIEmbeds extends BaseEmbedding {
24
+ protected client: OpenAIClient;
25
+ protected clientConfig: ClientOptions;
26
+
27
+ public static models = ['text-embedding-ada-002', 'text-embedding-3-large'];
28
+ public canSpecifyDimensions = true;
29
+
30
+ constructor(private settings?: Partial<TEmbeddings>) {
31
+ super({ model: settings?.model ?? DEFAULT_MODEL, ...settings });
32
+
33
+ this.clientConfig = {
34
+ //apiKey: fields?.credentials?.apiKey || process.env.OPENAI_API_KEY || '',
35
+ dangerouslyAllowBrowser: true,
36
+ };
37
+
38
+ if (this.model === 'text-embedding-ada-002') {
39
+ this.canSpecifyDimensions = false; // special case for ada-002, it doesn't support dimensions passing
40
+ }
41
+ }
42
+
43
+ async embedTexts(texts: string[], candidate: AccessCandidate): Promise<number[][]> {
44
+ const batches = this.chunkArr(this.processTexts(texts), this.chunkSize);
45
+
46
+ const batchRequests = batches.map((batch) => {
47
+ const params: OpenAIClient.EmbeddingCreateParams = {
48
+ model: this.model,
49
+ input: batch,
50
+ };
51
+ if (this.dimensions && this.canSpecifyDimensions) {
52
+ params.dimensions = this.dimensions;
53
+ }
54
+ return this.embed(params, candidate);
55
+ });
56
+ const batchResponses = await Promise.all(batchRequests);
57
+
58
+ const embeddings: number[][] = [];
59
+ for (let i = 0; i < batchResponses.length; i += 1) {
60
+ const batch = batches[i];
61
+ const { data: batchResponse } = batchResponses[i];
62
+ for (let j = 0; j < batch.length; j += 1) {
63
+ embeddings.push(batchResponse[j].embedding);
64
+ }
65
+ }
66
+ return embeddings;
67
+ }
68
+
69
+ async embedText(text: string, candidate: AccessCandidate): Promise<number[]> {
70
+ const params: OpenAIClient.EmbeddingCreateParams = {
71
+ model: this.model,
72
+ input: this.processTexts([text])[0],
73
+ };
74
+ if (this.dimensions && this.canSpecifyDimensions) {
75
+ params.dimensions = this.dimensions;
76
+ }
77
+ const { data } = await this.embed(params, candidate);
78
+ return data[0].embedding;
79
+ }
80
+
81
+ protected async embed(request: OpenAIClient.EmbeddingCreateParams, candidate: AccessCandidate) {
82
+ const modelInfo: TLLMModel = {
83
+ provider: 'OpenAI',
84
+ modelId: this.model,
85
+ credentials: this.settings?.credentials as unknown as TLLMCredentials,
86
+ };
87
+ const credentials = await getLLMCredentials(candidate, modelInfo);
88
+
89
+ if (!this.client) {
90
+ const params: ClientOptions = {
91
+ ...this.clientConfig,
92
+ apiKey: credentials.apiKey,
93
+ timeout: this.timeout,
94
+ maxRetries: 0,
95
+ };
96
+
97
+ this.client = new OpenAIClient(params);
98
+ }
99
+ try {
100
+ const res = await this.client.embeddings.create(request);
101
+ return res;
102
+ } catch (e) {
103
+ // const error = wrapOpenAIClientError(e);
104
+ // import openapi error from openai and throw it
105
+ const error = createOpenAIError(e.statusCode, e);
106
+ throw error;
107
+ }
108
+ }
109
+ }
@@ -0,0 +1,21 @@
1
+ import { OpenAIEmbeds } from './OpenAIEmbedding';
2
+ import { TEmbeddings } from './BaseEmbedding';
3
+
4
+ // a factory to get the correct embedding provider based on the provider name
5
+ const supportedProviders = {
6
+ OpenAI: {
7
+ embedder: OpenAIEmbeds,
8
+ models: OpenAIEmbeds.models,
9
+ },
10
+ } as const;
11
+
12
+ export type SupportedProviders = keyof typeof supportedProviders;
13
+ export type SupportedModels = {
14
+ [K in SupportedProviders]: (typeof supportedProviders)[K]['models'][number];
15
+ };
16
+
17
+ export class EmbeddingsFactory {
18
+ public static create(provider: SupportedProviders, config: TEmbeddings) {
19
+ return new supportedProviders[provider].embedder(config);
20
+ }
21
+ }
@@ -0,0 +1,14 @@
1
+ //==[ SRE: Storage ]======================
2
+
3
+ import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
4
+ import { TConnectorService } from '@sre/types/SRE.types';
5
+ import { PineconeVectorDB } from './connectors/PineconeVectorDB.class';
6
+ import { MilvusVectorDB } from './connectors/MilvusVectorDB.class';
7
+ import { RAMVectorDB } from './connectors/RAMVecrtorDB.class';
8
+ export class VectorDBService extends ConnectorServiceProvider {
9
+ public register() {
10
+ ConnectorService.register(TConnectorService.VectorDB, 'Pinecone', PineconeVectorDB);
11
+ ConnectorService.register(TConnectorService.VectorDB, 'RAMVec', RAMVectorDB);
12
+ ConnectorService.register(TConnectorService.VectorDB, 'Milvus', MilvusVectorDB);
13
+ }
14
+ }