@futdevpro/nts-dynamo 1.10.23 → 1.10.24

package/src/_modules/open-ai/_enums/open-ai-model.enum.ts

@@ -0,0 +1,137 @@
+
+
+
+
+
+export enum DyNTS_OpenAIModel {
+  // GPT-3.5
+  /* gpt35_turbo = 'gpt-3.5-turbo',
+  gpt35_turbo0125 = 'gpt-3.5-turbo-0125',
+  gpt35_turbo1106 = 'gpt-3.5-turbo-1106',
+  gpt35_turbo16k = 'gpt-3.5-turbo-16k',
+  gpt35_turboInstruct = 'gpt-3.5-turbo-instruct',
+  gpt35_turboInstruct0914 = 'gpt-3.5-turbo-instruct-0914', */
+
+  // GPT-4
+  // gpt-4
+  gpt4o = 'gpt-4o',
+  // gpt-4o-2024-08-06
+  gpt4o_20240806 = 'gpt-4o-2024-08-06',
+  // gpt-4o-2024-05-13
+  gpt4o_20240513 = 'gpt-4o-2024-05-13',
+
+  /* gpt4 = 'gpt-4',
+  gpt4_0613 = 'gpt-4-0613',
+  gpt4_0125Preview = 'gpt-4-0125-preview',
+  gpt4_1106Preview = 'gpt-4-1106-preview',
+  gpt4_turbo = 'gpt-4-turbo',
+  gpt4_turbo20240409 = 'gpt-4-turbo-2024-04-09',
+  gpt4_turboPreview = 'gpt-4-turbo-preview', */
+
+  // GPT-Mini
+  // gpt-4o-mini
+  gpt4o_mini = 'gpt-4o-mini',
+  // gpt-4o-mini-2024-07-18
+  gpt4o_mini20240718 = 'gpt-4o-mini-2024-07-18',
+
+
+  // GPT-4o
+  /* gpt4o = 'gpt-4o',
+  gpt4o_20240513 = 'gpt-4o-2024-05-13',
+  gpt4o_mini = 'gpt-4o-mini',
+  gpt4o_mini20240718 = 'gpt-4o-mini-2024-07-18', */
+  
+  // DALL·E
+  /* dallE_2 = 'dall-e-2',
+  dallE_2_HD = 'dall-e-2',
+  dallE_3 = 'dall-e-3',
+  dallE_3_HD = 'dall-e-3', */
+  
+  // Text-to-Speech (TTS)
+  /* tts1 = 'tts-1',
+  tts1_1106 = 'tts-1-1106',
+  tts1_HD = 'tts-1-hd',
+  tts1_HD_1106 = 'tts-1-hd-1106',
+  whisper_1 = 'whisper-1', */
+
+  // Text Embeddings
+  // text-embedding-3-small
+  textEmbedding_3Small = 'text-embedding-3-small',
+  // text-embedding-3-large
+  textEmbedding_3Large = 'text-embedding-3-large',
+  // text-embedding-ada-002
+  textEmbedding_ada002 = 'text-embedding-ada-002',
+
+  /* textEmbedding_ada002 = 'text-embedding-ada-002',
+  textEmbedding_3Small = 'text-embedding-3-small',
+  textEmbedding_3Large = 'text-embedding-3-large', */
+  
+  // Moderation Models  
+  /* textModeration_007 = 'text-moderation-007',
+  textModeration_latest = 'text-moderation-latest',
+  textModeration_stable = 'text-moderation-stable', */
+
+
+  /* davinci002 = 'davinci-002', */
+  
+
+
+
+
+
+
+
+
+
+
+  /* // GPT-3.5
+  gpt35_turbo = 'gpt-3.5-turbo',
+  gpt35_turbo0125 = 'gpt-3.5-turbo-0125',
+  gpt35_turbo1106 = 'gpt-3.5-turbo-1106',
+  gpt35_turbo16k = 'gpt-3.5-turbo-16k',
+  gpt35_turboInstruct = 'gpt-3.5-turbo-instruct',
+  gpt35_turboInstruct0914 = 'gpt-3.5-turbo-instruct-0914',
+
+  // GPT-4
+  gpt4 = 'gpt-4',
+  gpt4_0613 = 'gpt-4-0613',
+  gpt4_0125Preview = 'gpt-4-0125-preview',
+  gpt4_1106Preview = 'gpt-4-1106-preview',
+  gpt4_turbo = 'gpt-4-turbo',
+  gpt4_turbo20240409 = 'gpt-4-turbo-2024-04-09',
+  gpt4_turboPreview = 'gpt-4-turbo-preview',
+
+  // GPT-4o
+  gpt4o = 'gpt-4o',
+  gpt4o_20240513 = 'gpt-4o-2024-05-13',
+  gpt4o_mini = 'gpt-4o-mini',
+  gpt4o_mini20240718 = 'gpt-4o-mini-2024-07-18',
+  
+  // DALL·E
+  dallE_2 = 'dall-e-2',
+  dallE_3 = 'dall-e-3',
+  
+  // Text-to-Speech (TTS)
+  tts1 = 'tts-1',
+  tts1_1106 = 'tts-1-1106',
+  tts1_HD = 'tts-1-hd',
+  tts1_HD_1106 = 'tts-1-hd-1106',
+  whisper_1 = 'whisper-1',
+
+  // Text Embeddings
+  textEmbedding_ada002 = 'text-embedding-ada-002',
+  textEmbedding_3Small = 'text-embedding-3-small',
+  textEmbedding_3Large = 'text-embedding-3-large',
+  
+  // Moderation Models  
+  textModeration_007 = 'text-moderation-007',
+  textModeration_latest = 'text-moderation-latest',
+  textModeration_stable = 'text-moderation-stable',
+
+
+  davinci002 = 'davinci-002', */
+}
+
+
+
+

package/src/_modules/open-ai/_models/gpt-call-settings.interface.ts

@@ -0,0 +1,69 @@
+
+
+import { ClientOptions } from 'openai';
+import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
+
+export class DyNTS_GPTCall_Settings {
+  systemPrompt?: string = '';
+  useModel?: DyNTS_OpenAIModel | string = DyNTS_OpenAIModel.gpt4o;
+  gptProject?: string;
+  debugLog?: boolean;
+
+  /**
+   * This parameter controls the randomness and creativity of the generated output.   
+   *   
+   * Lower values (e.g., 0.2) produce more focused, predictable results,   
+   * while higher values (e.g., 0.8) introduce more variation and unexpected outputs,   
+   * making the model more creative and exploratory.     
+   *   
+   * Adjust this setting to balance between creativity and consistency.  
+   */
+  temperature?: number = 0.5;
+  /**
+   * Defines the upper limit of tokens (words or parts of words)   
+   * the model can generate in a single response.   
+   *   
+   * The total token count includes both the input (prompt) and the output (response).   
+   *   
+   * You can allocate up to 4096 tokens per request, but be mindful of prompt length,   
+   * as it affects how many tokens remain for the response.
+   */
+  maxTokens?: number = 2000;
+  /**
+   * This parameter adjusts the diversity of the output using nucleus sampling,   
+   * where the model considers tokens based on cumulative probability.   
+   *   
+   * A value of 0.5 ensures that only the most likely half of all possible tokens   
+   * are considered, while increasing the value (up to 1)   
+   * allows for a broader range of token options, leading to more varied responses.
+   */
+  topP?: number = 0.75;
+  /**
+   * This setting penalizes tokens that have already appeared frequently in the generated text,   
+   * discouraging repetition and encouraging the model to introduce new content.    
+   *   
+   * Higher values result in less repetition, making the output more diverse.   
+   */
+  frequencyPenalty?: number = 0;
+  /**
+   * This parameter influences the model by penalizing tokens based on   
+   * their presence in the text so far.   
+   *   
+   * It encourages the introduction of new topics or ideas by reducing the likelihood of   
+   * generating tokens that have already appeared,   
+   * helping to keep the conversation or text more varied and engaging.
+   */
+  presencePenalty?: number = 0;
+
+  /* organizationId?: string;
+  apiKey?: string;
+  project?: string; */
+
+  constructor(
+    set?: DyNTS_GPTCall_Settings
+  ) {
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}

package/src/_modules/open-ai/_models/open-ai-api-env-settings.interface.ts

@@ -0,0 +1,12 @@
+
+
+
+export interface DyNTS_OpenAIApiEnv_Settings {
+  accessKey: string;
+  organizationId: string;
+
+  legacyEndpoint: string;
+  newEndpoint: string;
+}
+
+

package/src/_modules/open-ai/_models/open-ai-settings.interface.ts

@@ -0,0 +1,31 @@
+
+
+import { ClientOptions } from 'openai';
+import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
+import { DyNTS_GPTCall_Settings } from './gpt-call-settings.interface';
+
+
+export class DyNTS_OpenAI_Settings {
+  /**
+   * OpenAI API configuration.
+   * 
+   * apiKey, organization and project are required.
+   * they are defaults to 
+   * process.env['OPENAI_API_KEY'], 
+   * process.env['OPENAI_ORG_ID'] and 
+   * process.env['OPENAI_PROJECT_ID']
+   */
+  openAIConfig: ClientOptions;
+  /* systemPrompt?: string;
+  useModel?: string | DyNTS_OpenAIModel = DyNTS_OpenAIModel.gpt4o; */
+
+  defaultSettings: DyNTS_GPTCall_Settings;
+
+  constructor(
+    set: DyNTS_OpenAI_Settings
+  ) {
+    if (set) {
+      Object.assign(this, set);
+    }
+  }
+}

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

@@ -0,0 +1,61 @@
+import OpenAI from 'openai';
+
+import { DyNTS_SingletonService } from '../../../_services/base/singleton.service';
+import { DyNTS_OpenAIModel } from '../_enums/open-ai-model.enum';
+import { DyNTS_OpenAI_ServiceBase } from './open-ai.service-base';
+
+/**
+ * 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
+  ): Promise<number[]> {
+    try {
+      const response = await this.openai.embeddings.create({
+        model,
+        input: text,
+      });
+
+      return response.data[0].embedding;
+    } catch (error) {
+      console.error('Error creating embedding:', error);
+      throw new Error('Failed to create embedding');
+    }
+  }
+
+  /**
+   * 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
+  ): Promise<number[][]> {
+    try {
+      const response = await this.openai.embeddings.create({
+        model,
+        input: texts,
+      });
+
+      return response.data.map(item => item.embedding);
+    } catch (error) {
+      console.error('Error creating embeddings:', error);
+      throw new Error('Failed to create embeddings');
+    }
+  }
+}