@futdevpro/nts-dynamo 1.10.25 → 1.10.27

package/src/_modules/open-ai/_services/embedding.control-service.ts

@@ -1,26 +1,16 @@
-import OpenAI from 'openai';
 
-import { DyNTS_SingletonService } from '../../../_services/base/singleton.service';
-import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
+import { DyFM_OpenAIModel } from '@futdevpro/fsm-dynamo/open-ai';
+import { DyFM_Error } from '@futdevpro/fsm-dynamo';
+
 import { DyNTS_OpenAI_ServiceBase } from './open-ai.service-base';
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
 
-/**
- * Service for handling OpenAI text embeddings
- * @class Embedding_ControlService
- * @extends DyNTS_OpenAI_ServiceBase
- */
 export class Embedding_ControlService extends DyNTS_OpenAI_ServiceBase {
 
-  /**
-   * Creates embeddings for the given text using the specified model
-   * @param {string} text - The text to create embeddings for
-   * @param {DyNTS_OpenAIModel} [model=DyNTS_GPTModel.textEmbedding_3Large] - The embedding model to use
-   * @returns {Promise<number[]>} The embedding vector
-   * @throws {Error} If the embedding creation fails
-   */
   async createEmbedding(
     text: string,
-    model: DyNTS_OpenAIModel = DyNTS_OpenAIModel.textEmbedding_3Large
+    model: DyFM_OpenAIModel | string = DyFM_OpenAIModel.textEmbedding_3Large,
+    issuer: string
   ): Promise<number[]> {
     try {
       const response = await this.openai.embeddings.create({
@@ -30,21 +20,18 @@ export class Embedding_ControlService extends DyNTS_OpenAI_ServiceBase {
 
       return response.data[0].embedding;
     } catch (error) {
-      console.error('Error creating embedding:', error);
-      throw new Error('Failed to create embedding');
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('createEmbedding', error, issuer),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ECS-CE0`,
+      });
     }
   }
 
-  /**
-   * Creates embeddings for multiple texts using the specified model
-   * @param {string[]} texts - Array of texts to create embeddings for
-   * @param {DyNTS_OpenAIModel} [model=DyNTS_GPTModel.textEmbedding_3Large] - The embedding model to use
-   * @returns {Promise<number[][]>} Array of embedding vectors
-   * @throws {Error} If the embedding creation fails
-   */
   async createEmbeddings(
     texts: string[],
-    model: DyNTS_OpenAIModel = DyNTS_OpenAIModel.textEmbedding_3Large
+    model: DyFM_OpenAIModel | string = DyFM_OpenAIModel.textEmbedding_3Large,
+    issuer: string
   ): Promise<number[][]> {
     try {
       const response = await this.openai.embeddings.create({
@@ -54,8 +41,11 @@ export class Embedding_ControlService extends DyNTS_OpenAI_ServiceBase {
 
       return response.data.map(item => item.embedding);
     } catch (error) {
-      console.error('Error creating embeddings:', error);
-      throw new Error('Failed to create embeddings');
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('createEmbeddings', error, issuer),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ECS-CES0`,
+      });
     }
   }
 }

package/src/_modules/open-ai/_services/gpt.service-base.ts

@@ -3,11 +3,10 @@ import { OpenAI, ClientOptions } from 'openai';
 import { ChatCompletion, ChatCompletionMessageParam } from 'openai/resources';
 
 import { DyFM_AnyError, DyFM_Error, DyFM_Error_Settings, DyFM_Log } from '@futdevpro/fsm-dynamo';
+import { DyFM_GPTCall_Settings } from '@futdevpro/fsm-dynamo/open-ai';
 
-import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
 import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
 import { DyNTS_OpenAI_ServiceBase } from './open-ai.service-base';
-import { DyNTS_GPTCall_Settings } from '../_models/gpt-call-settings.interface';
 import { RequestOptions } from 'openai/core';
 import { ChatCompletionCreateParamsBase } from 'openai/resources/chat/completions';
 
@@ -258,7 +257,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
   async getQuestionAnswer(
     question: string, 
     issuer: string,
-    messageSettings: DyNTS_GPTCall_Settings = this.defaultSettings
+    messageSettings: DyFM_GPTCall_Settings = this.defaultSettings
   ): Promise<string> {
     const answer = await this.resolveSimpleUserMessage(question, issuer, messageSettings);
 
@@ -287,7 +286,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
   async getAnswer(
     question: string, 
     issuer: string,
-    settings?: DyNTS_GPTCall_Settings
+    settings?: DyFM_GPTCall_Settings
   ): Promise<string> {
     if (this.debugLog) {
       console.log('\n - ', question);
@@ -305,7 +304,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
   async resolveSimpleUserMessage(
     message: string,
     issuer: string,
-    settings?: DyNTS_GPTCall_Settings
+    settings?: DyFM_GPTCall_Settings
   ): Promise<string> {
     return this.resolveConversation(
       [{ role: 'user', content: message }], 
@@ -318,7 +317,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
   async resolveConversation(
     conversation: DyNTS_GPT_Message[],
     issuer: string,
-    settings?: DyNTS_GPTCall_Settings,
+    settings?: DyFM_GPTCall_Settings,
     getFullResponse?: boolean
   ): Promise<string | ChatCompletion> {
     try {
@@ -346,7 +345,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
   private getMessageCreateInput(
     messages: DyNTS_GPT_Message[],
     issuer: string,
-    settings: DyNTS_GPTCall_Settings = this.defaultSettings
+    settings: DyFM_GPTCall_Settings = this.defaultSettings
   ): ChatCompletionCreateParamsBase {
     try {
       messages.unshift(this.getDefaultSystemMessage(settings));
@@ -386,7 +385,7 @@ export class DyNTS_GPT_ServiceBase extends DyNTS_OpenAI_ServiceBase {
     }
   }
 
-  private getDefaultSystemMessage(settings: DyNTS_GPTCall_Settings): DyNTS_GPT_Message {
+  private getDefaultSystemMessage(settings: DyFM_GPTCall_Settings): DyNTS_GPT_Message {
     return {
       role: DyNTS_GPT_Message_Role.system,
       content: settings.systemPrompt || this.defaultSystemPrompt,

package/src/_modules/open-ai/_services/open-ai.service-base.ts

@@ -1,13 +1,10 @@
-
 import { OpenAI, ClientOptions } from 'openai';
 import { ChatCompletion, ChatCompletionMessageParam } from 'openai/resources';
 
+import { DyFM_OpenAI_Settings, DyFM_OpenAIModel, DyFM_GPTCall_Settings } from '@futdevpro/fsm-dynamo/open-ai';
 import { DyFM_AnyError, DyFM_Error, DyFM_Error_Settings, DyFM_Log } from '@futdevpro/fsm-dynamo';
 
-import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
 import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
-import { DyNTS_OpenAI_Settings } from '../_models/open-ai-settings.interface';
-import { DyNTS_GPTCall_Settings } from '../_models/gpt-call-settings.interface';
 
 
 /**
@@ -29,8 +26,8 @@ export class DyNTS_OpenAI_ServiceBase {
   readonly openai: OpenAI;
 
   /* readonly defaultSystemPrompt: string;
-  readonly defaultModel: DyNTS_OpenAIModel | string; */
-  readonly defaultSettings: DyNTS_GPTCall_Settings;
+  readonly defaultModel: DyFM_OpenAIModel | string; */
+  readonly defaultSettings: DyFM_GPTCall_Settings;
 
   get debugLog(): boolean {
     return this.defaultSettings.debugLog;
@@ -40,15 +37,15 @@ export class DyNTS_OpenAI_ServiceBase {
     return this.defaultSettings.systemPrompt;
   }
 
-  get defaultModel(): DyNTS_OpenAIModel | string {
+  get defaultModel(): DyFM_OpenAIModel | string {
     return this.defaultSettings.useModel;
   }
 
   constructor(
-    set: DyNTS_OpenAI_Settings
+    set: DyFM_OpenAI_Settings
   ) {
     this.openai = new OpenAI(set.openAIConfig);
-    this.defaultSettings = set.defaultSettings ?? new DyNTS_GPTCall_Settings();
+    this.defaultSettings = set.defaultSettings ?? new DyFM_GPTCall_Settings();
   }
   
   protected getDefaultErrorSettings(

package/src/_modules/open-ai/_services/vector-data.service.ts

@@ -0,0 +1,188 @@
+
+import {
+  DyFM_Array,
+  DyFM_DataModel_Params,
+  DyFM_DataProperty_Params,
+  DyFM_Error,
+  DyFM_Metadata
+} from '@futdevpro/fsm-dynamo';
+import { DyFM_OpenAI_Settings, DyFM_OpenAIModel } from '@futdevpro/fsm-dynamo/open-ai';
+
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+import { DyNTS_DataService } from '../../../_services/base/data.service';
+import { Embedding_ControlService } from './embedding.control-service';
+
+export class DyNTS_VectorDataService<T extends DyFM_Metadata> extends DyNTS_DataService<T> {
+
+  readonly vectorizeProperties: DyFM_DataProperty_Params<any>[];
+  /* readonly vectorizeProperties: { from: string, to: string }[]; */
+
+  constructor(
+    /**
+     * Initial data, this will be used by functions on default
+     */
+    data: T,
+    /**
+     * DB data prams will be used to connect to usable dbService on GlobalService
+     */
+    dataParams: DyFM_DataModel_Params<T>,
+    /**
+     * OpenAI settings
+     */
+    public readonly openAISettings: DyFM_OpenAI_Settings,
+    /**
+     * Initial set for issuer to be able to follow the issuer's activity
+     */
+    issuer: string
+  ) {
+    super(data, dataParams, issuer);
+    
+    const vectorizePropertyKeys: string[] = Object.keys(dataParams.properties).filter(
+      (key: string): boolean => dataParams.properties[key].vectorizeFrom &&
+        dataParams.properties[key].vectorizeFrom !== key
+    );
+
+    if (!vectorizePropertyKeys.length) {
+      throw new Error(
+        'vectorizedPropertyKeys is missing! ' +
+        `\nkeys with vectorizeFrom: ${Object.keys(dataParams.properties).filter(
+          (key: string): boolean => dataParams.properties[key].vectorizeFrom
+        ).join(', ')}`
+      );
+    }
+
+    this.vectorizeProperties = vectorizePropertyKeys.map(
+      (key: string): DyFM_DataProperty_Params<any> => dataParams.properties[key]
+    );
+  }
+
+  async vectorizeDataProperties(data?: T): Promise<T> {
+    try {
+      await DyFM_Array.asyncForEachAllAtOnce(
+        this.vectorizeProperties,
+        async (property: DyFM_DataProperty_Params<any>) => {
+          if (!data[property.key] || property.vectorizeAlways) {
+            data[property.key] = await this.vectorize(
+              data[property.key],
+              property.embeddingModel
+            );
+          }
+        }
+      );
+
+      return data;
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('vectorizeDataProperties', error),
+      });
+    }
+  }
+
+  async vectorize(
+    input: string, 
+    useModel: DyFM_OpenAIModel | string = this.openAISettings.defaultSettings.useModel
+  ): Promise<number[]> {
+    try {
+      const embedding_CS: Embedding_ControlService = new Embedding_ControlService(
+        this.openAISettings
+      );
+
+      return await embedding_CS.createEmbedding(
+        input,
+        useModel,
+        this.issuer
+      );
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('vectorize', error),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-VDB-V0`,
+      });
+    }
+  }
+
+  async vectorSearch(
+    input: string, 
+    searchInKey: string, 
+    /* useIndex: string,  */
+    limit: number = 5, 
+    useModel?: DyFM_OpenAIModel | string
+  ): Promise<any> {
+    try {
+      const embedding_CS: Embedding_ControlService = new Embedding_ControlService(
+        this.openAISettings
+      );
+
+      const property: DyFM_DataProperty_Params<any> = this.dataParams.properties[searchInKey];
+
+      if (!property) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'vectorSearch', 
+            new Error(`Property "${searchInKey}" not found!`)
+          ),
+
+          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-VDB-VS0`,
+        });
+      }
+
+      const embeddedInput: number[] = await embedding_CS.createEmbedding(
+        input,
+        useModel ?? property.embeddingModel,
+        this.issuer
+      );
+      
+      const result = await this.dataDBService.aggregate(
+        [
+          {
+            $vectorSearch: {
+              index: property.vectorizeUseIndex,
+              queryVector: embeddedInput,
+              path: searchInKey,
+              numCandidates: 100,
+              limit: limit
+            }
+          }
+        ]
+        /* {
+          $search: {
+            index: 'default',
+            knnBeta: {
+              vector: embeddedInput,
+              path: searchInKey,
+              numCandidates: 100,
+              limit: limit
+            }
+          }
+        } */
+      );
+
+      return result;
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('vectorSearch', error),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-VDB-VS0`,
+      });
+    }
+  }
+
+  override async saveData(data?: T, dontSetToService?: boolean): Promise<T> {
+    try {
+      data = this.ensureData(data);
+
+      data = await this.vectorizeDataProperties(data);
+      
+      return await super.saveData(data, dontSetToService);
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'saveData',
+          error
+        ),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-VDB-SD0`,
+      });
+    }
+  }
+}

package/src/_modules/open-ai/index.ts

@@ -1,13 +1,9 @@
 
 
-export * from './_enums/open-ai-model.enum';
-
-export * from './_models/gpt-call-settings.interface';
-export * from './_models/open-ai-api-env-settings.interface';
-export * from './_models/open-ai-settings.interface';
-
 export * from './_services/embedding.control-service';
 export * from './_services/gpt.service-base';
 export * from './_services/open-ai.service-base';
+export * from './_services/vector-data.service';
 
+export * from '@futdevpro/fsm-dynamo/open-ai';
 

package/src/_modules/server/errors/errors.data-service.ts

@@ -169,7 +169,11 @@ export class DyNTS_Errors_DataService<
         DyFM_Log.warn('error saved');
       }
     } catch (error) {
-      DyFM_Log.error('recordError error:', error);
+      if (error instanceof DyFM_Error) {
+        error.logSimple('recordError error');
+      } else {
+        DyFM_Log.error('recordError error:', error);
+      }
       /* throw new DyFM_Error({
         ...this.getDefaultErrorSettings(
           'recordError',

package/src/_modules/socket/_models/socket-presence.control-model.ts

@@ -197,7 +197,7 @@ export class DyNTS_SocketPresence {
           ),
           issuer
         ),
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE3`,
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE4`,
       });
     }
   }

package/src/_modules/socket/_services/socket-client.service.ts

@@ -36,7 +36,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       tasks: [
         async () => {
           this._connected = true;
-          DyFM_Log.success(`<   >  socket-client(${this.params.name}) connected!`);
+          DyFM_Log.success(`<   >  socket-client (${this.params.name}) connected!`);
         },
       ],
     }),
@@ -46,7 +46,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       tasks: [
         async () => {
           this._connected = false;
-          DyFM_Log.warn(`<x  >  socket-client(${this.params.name}) disconnected!`);
+          DyFM_Log.warn(`<x  >  socket-client (${this.params.name}) disconnected!`);
 
           if (this._params.reconnect) {
             await DyFM_delay(this._params.reconnectDelay);
@@ -60,7 +60,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       eventKey: DyFM_SocketEvent_Key.subscriptionSuccessful,
       tasks: [
         async () => {
-          DyFM_Log.success(`<=-->  socket-client(${this.params.name}) subscription successful!`);
+          DyFM_Log.success(`<=-->  socket-client (${this.params.name}) subscription successful!`);
         },
       ],
     }),
@@ -70,9 +70,9 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       tasks: [
         async (content: any) => {
           if (content instanceof DyFM_Error) {
-            content.logSimple(`=-->   socket-client(${this.params.name}) ERROR`);
+            content.logSimple(`=-->   socket-client (${this.params.name}) ERROR`);
           } else {
-            DyFM_Log.error(`=-->   socket-client(${this.params.name}) ERROR:`, content);
+            DyFM_Log.error(`=-->   socket-client (${this.params.name}) ERROR:`, content);
           }
         },
       ],
@@ -88,13 +88,13 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
         !(error instanceof DyFM_Error)
       ) {
         DyFM_Log.H_error(
-          `socket-client "${this.params?.name}" Service setup failed! ` +
+          `socket-client (${this.params?.name}) Service setup failed! ` +
           `(DyNTS_SocketClientService constructor catch)`,
           `\n    ERROR:`, error
         );
       } else {
         error.logSimple(
-          `socket-client "${this.params?.name}" Service setup failed! ` +
+          `socket-client (${this.params?.name}) Service setup failed! ` +
           `(DyNTS_SocketClientService constructor catch)`
         );
       }
@@ -118,11 +118,11 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
 
       await this.setupSocketEvents();
 
-      DyFM_Log.success(`\nsocket-client(${this.params?.name}) Service setup finished`);
+      DyFM_Log.success(`\nsocket-client (${this.params?.name}) Service setup finished`);
       
       await this.connectSocket();
     } catch (error) {
-      DyFM_Log.error(`socket-client(${this.params?.name}) Service setup failed!`, error);
+      DyFM_Log.error(`socket-client (${this.params?.name}) Service setup failed!`, error);
 
       throw new DyFM_Error({
         errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SCS-001`,
@@ -149,7 +149,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       });
     } catch (error) {
       DyFM_Log.error(
-        `socket-client(${this.params.name}) Service Setup Default Events failed, ` +
+        `socket-client (${this.params.name}) Service Setup Default Events failed, ` +
         `ERROR:`, error
       );
 
@@ -159,7 +159,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
 
   private async setupSocketEvents(): Promise<void> {
     try {
-      if (this.debugLog) console.log(`Setup socket-client(${this.params.name}) Events...`);
+      if (this.debugLog) console.log(`Setup socket-client (${this.params.name}) Events...`);
 
       await DyFM_Array.asyncForEach(
         this.incomingEvents, 
@@ -169,7 +169,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
             try {
               await event.executeEventTasks(content, this.params.service);
             } catch (error) {
-              DyFM_Log.error(`socket-client(${this.params.name}) Event failed, ERROR:`, error);
+              DyFM_Log.error(`socket-client (${this.params.name}) Event failed, ERROR:`, error);
               await this.emitEvent(DyFM_SocketEvent_Key.error, error);
             }
           });
@@ -177,7 +177,7 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
       );
     } catch (error) {
       DyFM_Log.error(
-        `socket-client(${this.params.name}) Service Setup Socket Events failed, ` +
+        `socket-client (${this.params.name}) Service Setup Socket Events failed, ` +
         `ERROR:`, error
       );
 
@@ -185,21 +185,22 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
     }
   }
   
-  private async connectSocket(): Promise<void> {
+  tryingToReconnect = false;
+  protected async connectSocket(): Promise<void> {
     try {
       DyFM_Log.info(
-        `< .. > socket-client(${this.params.name}) ` +
+        `< .. > socket-client (${this.params.name}) ` +
         `connecting to ${this.params.address}:${this.params.port} ...`
       );
 
       this.socket.connect();
 
-      if (this.params.reconnect) {
+      if (this.params.reconnect && !this.tryingToReconnect) {
         await this.tryReconnectIfNeeded();
       }
     } catch (error) {
       DyFM_Log.error(
-        `socket-client(${this.params.name}) Service Connect Socket failed, ` +
+        `socket-client (${this.params.name}) Service Connect Socket failed, ` +
         `ERROR:`, error
       );
 
@@ -210,14 +211,16 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
   private async tryReconnectIfNeeded(): Promise<void> {
     try {
       if (this.logFn) console.log(`\nFn:. tryReconnectIfNeeded`);
+      this.tryingToReconnect = true;
       await DyFM_delay(this._params.reconnectDelay);
       
+      this.tryingToReconnect = false;
       if (!this._connected) {
         await this.connectSocket();
       }
     } catch (error) {
       DyFM_Log.error(
-        `socket-client(${this.params.name}) Service Try Reconnect failed, ` +
+        `socket-client (${this.params.name}) Service Try Reconnect failed, ` +
         `ERROR:`, error
       );
 
@@ -232,11 +235,11 @@ export abstract class DyNTS_SocketClient_ServiceBase extends DyNTS_SingletonServ
    */
   async emitEvent(eventType: string, content: any): Promise<void> {
     try {
-      DyFM_Log.log(`<=--   outgoing socket-client(${this.params.name}) event: ${eventType}`);
+      DyFM_Log.log(`<=--   outgoing socket-client (${this.params.name}) event: ${eventType}`);
       this.socket.emit(eventType, content);
     } catch (error) {
       DyFM_Log.error(
-        `socket-client(${this.params.name}) ` +
+        `socket-client (${this.params.name}) ` +
         `Service Emit Event failed: ${this.params?.name} (${this.params?.port})`, error
       );