@futdevpro/nts-dynamo 1.11.16 → 1.11.17

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

@@ -1,4 +1,3 @@
-/* import { DyFM_safeParseList } from '@futdevpro/fsm-dynamo'; */
 import { OpenAI } from 'openai';
 
 import { DyFM_OpenAI_Settings, DyFM_OpenAIModel, DyFM_GPTCall_Settings } from '@futdevpro/fsm-dynamo/open-ai';
@@ -81,16 +80,18 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * and the {@link DyNTS_OAI_LLM_Predefined_Requests.yesNo.upperCaseYes} to check the answer
    */
   async askYesNoQuestion(
-    question: string, 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string
+    }
   ): Promise<boolean> {
-    question += this.predefinedRequests.yesNo.request;
+    set.question += this.predefinedRequests.yesNo.request;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return answer.toUpperCase().includes(this.predefinedRequests.yesNo.upperCaseYes);
   }
@@ -103,20 +104,22 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link DyNTS_OAI_LLM_Predefined_Requests.percentageOnly} to ask the question
    */
   async askPercentageQuestion(
-    question: string, 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<number> {
-    question += this.predefinedRequests.percentageOnly;
+    set.question += this.predefinedRequests.percentageOnly;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     if (isNaN(+answer)) {
       DyFM_Log.error('GPT_ServiceBase', 'asykPercentageQuestion', 'Invalid answer', {
-        question,
+        question: set.question,
         answer,
       });
 
@@ -134,26 +137,28 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link DyNTS_OAI_LLM_Predefined_Requests.selectRequest} to ask the question
    */
   async askSelectQuestion(
-    question: string, 
-    selectFrom: string[], 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      selectFrom: string[], 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<string> {
     // replace the {{DyNTS_selectOptions}} with the list of options
     const selectQuestionAddition = this.predefinedRequests.selectRequest.replace(
       '{{DyNTS_selectOptions}}', 
-      this.getTextListAsText(selectFrom)
+      this.getTextListAsText(set.selectFrom)
     );
-    question += selectQuestionAddition;
+    set.question += selectQuestionAddition;
 
-    let answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    let answer = await this.askQuestion(set);
     
     answer = answer.toLocaleUpperCase();
     
-    for (const item of selectFrom) {
+    for (const item of set.selectFrom) {
       if (answer.includes(item.toLocaleUpperCase())) return item;
     }
 
@@ -170,21 +175,23 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link DyNTS_OAI_LLM_Predefined_Requests.selectRequest} to ask the question
    */
   async requestSelect<T>(
-    question: string,
-    selectFrom: T[],
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string,
+    set: {
+      question: string,
+      selectFrom: T[],
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<T | { unparsableResult: string }> {
     const selectQuestionAddition = this.predefinedRequests.selectRequest.replace(
       '{{DyNTS_selectOptions}}', 
-      this.getTextListAsText(selectFrom.map(item => `"${JSON.stringify(item)}"`))
+      this.getTextListAsText(set.selectFrom.map(item => `"${JSON.stringify(item)}"`))
     );
-    question += selectQuestionAddition;
+    set.question += selectQuestionAddition;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return DyFM_safeParseJSON<T>(answer);
   }
@@ -197,27 +204,29 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link DyNTS_OAI_LLM_Predefined_Requests.multiselect} to ask the question
    */
   async askMultipleSelectQuestionWithOptions(
-    question: string, 
-    options: string[], 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      options: string[], 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<string[]> {
     const selectQuestionAddition = this.predefinedRequests.multiselect.replace(
       '{{DyNTS_selectOptions}}', 
-      this.getTextListAsText(options)
+      this.getTextListAsText(set.options)
     );
-    question += selectQuestionAddition;
+    set.question += selectQuestionAddition;
 
-    let answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    let answer = await this.askQuestion(set);
     
     answer = answer.toLocaleUpperCase();
     
     const result: string[] = [];
 
-    for (const item of options) {
+    for (const item of set.options) {
       if (answer.includes(item.toLocaleUpperCase())) {
         result.push(item);
       }
@@ -236,21 +245,23 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link DyNTS_OAI_LLM_Predefined_Requests.multiselect} to ask the question
    */
   async requestMultipleSelect<T>(
-    question: string,
-    options: T[],
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string,
+    set: {
+      question: string,
+      options: T[],
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<T[]> {
     const selectQuestionAddition = this.predefinedRequests.multiselect.replace(
       '{{DyNTS_selectOptions}}', 
-      this.getTextListAsText(options.map(item => `"${JSON.stringify(item)}"`))
+      this.getTextListAsText(set.options.map(item => `"${JSON.stringify(item)}"`))
     );
-    question += selectQuestionAddition;
+    set.question += selectQuestionAddition;
     
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return DyFM_safeParseList<T[]>(answer);
   }
@@ -267,16 +278,18 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * (uses {@link DyFM_safeParseJSON})
    */
   async askJSONQuestion<T = any>(
-    question: string, 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<T | { unparsableResult: string }> {
-    question += this.predefinedRequests.jsonRequest;
+    set.question += this.predefinedRequests.jsonRequest;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
     
     return DyFM_safeParseJSON<T>(answer);
   }
@@ -293,21 +306,23 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * (uses {@link DyFM_safeParseJSON})
    */
   async askJSONQuestionWithKeysDescription<T = any>(
-    question: string, 
-    keysDescription: string,
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      keysDescription: string,
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<T | { unparsableResult: string }> {
     const jsonRequestWithKeysDescription = this.predefinedRequests.jsonRequestWithKeysDescription.replace(
       '{{DyNTS_jsonKeysDescription}}', 
-      keysDescription
+      set.keysDescription
     );
-    question += jsonRequestWithKeysDescription;
+    set.question += jsonRequestWithKeysDescription;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return DyFM_safeParseJSON<T>(answer);
   }
@@ -324,21 +339,23 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * (uses {@link DyFM_safeParseJSON})
    */
   async askJSONQuestionWithExactKeys<T = any>(
-    question: string, 
-    keys: string[],
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string
+    set: {
+      question: string, 
+      keys: string[],
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<T | { unparsableResult: string }> {
     const jsonRequestWithExactKeys = this.predefinedRequests.jsonRequestWithExactKeys.replace(
       '{{DyNTS_jsonKeys}}', 
-      this.getTextListAsText(keys)
+      this.getTextListAsText(set.keys)
     );
-    question += jsonRequestWithExactKeys;
+    set.question += jsonRequestWithExactKeys;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return DyFM_safeParseJSON<T>(answer);
   }
@@ -355,16 +372,18 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * (uses {@link DyFM_safeParseList})
    */
   async askListQuestion(
-    question: string, 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string,
+    set: {
+      question: string, 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<string[]> {
-    question += this.predefinedRequests.listRequest;
+    set.question += this.predefinedRequests.listRequest;
 
-    const answer = await this.askQuestion(question, issuer, settings, debugLog, replaceThisInLog);
+    const answer = await this.askQuestion(set);
 
     return DyFM_safeParseList(answer);
   }
@@ -379,16 +398,22 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link resolveSimpleUserMessage}
    */
   async askQuestion(
-    question: string, 
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    debugLog?: boolean,
-    /** this is used to readably replace too long contents to eg '...' in logs */
-    replaceThisInLog?: string,
+    set: {
+      question: string, 
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      debugLog?: boolean,
+      /** this is used to readably replace too long contents to eg '...' in logs */
+      replaceThisInLog?: string,
+    }
   ): Promise<string> {
-    this.logQuestion(question, replaceThisInLog, debugLog);
+    this.logQuestion(set);
 
-    const answer = await this.resolveSimpleUserMessage(question, issuer, settings);
+    const answer = await this.resolveSimpleUserMessage({
+      message: set.question,
+      issuer: set.issuer,
+      settings: set.settings,
+    });
 
     if (this.debugLog) {
       console.log(' - ', answer);
@@ -426,16 +451,18 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link resolveMessage}
    */
   async resolveSimpleUserMessage(
-    message: string,
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings
+    set: {
+      message: string,
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings
+    }
   ): Promise<string> {
-    return this.resolveMessage(
-      [{ role: DyNTS_OAI_GPT_Message_Role.user, content: message }], 
-      issuer,
-      settings, 
-      false
-    ) as Promise<string>;
+    return this.resolveMessage({
+      conversation: [{ role: DyNTS_OAI_GPT_Message_Role.user, content: set.message }], 
+      issuer: set.issuer,
+      settings: set.settings,
+      getFullResponse: false,
+    }) as Promise<string>;
   }
   /** the exact same as {@link resolveSimpleUserMessage} */
   simpleUserMessage = this.resolveSimpleUserMessage;
@@ -448,26 +475,28 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link getMessageCreateInput}
    */
   async resolveMessage(
-    conversation: DyNTS_OAI_GPT_Message[],
-    issuer: string,
-    settings?: DyFM_GPTCall_Settings,
-    getFullResponse?: boolean
+    set: {
+      conversation: DyNTS_OAI_GPT_Message[],
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings,
+      getFullResponse?: boolean
+    }
   ): Promise<string | ChatCompletion> {
     try {
-      conversation.unshift(this.getDefaultSystemMessage(settings));
+      set.conversation.unshift(this.getDefaultSystemMessage(set.settings));
 
       const result: ChatCompletion = await this.openai.chat.completions.create(
-        this.getMessageCreateInput(conversation, issuer, settings)
+        this.getMessageCreateInput(set)
       ) as ChatCompletion;
 
-      if (getFullResponse) {
+      if (set.getFullResponse) {
         return result;
       }
 
       return result.choices[0].message.content;
     } catch (error) {
       throw new DyFM_Error({
-        ...this.getDefaultErrorSettings('resolveConversation', error, issuer),
+        ...this.getDefaultErrorSettings('resolveConversation', error, set.issuer),
         
         errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-OAB-RC0`,
       });
@@ -479,13 +508,19 @@ export class DyNTS_OAI_LLM_ServiceBase {
   /**
    * Logs the question if the debugLog is true
    */
-  protected logQuestion(question: string, replaceThisInLog?: string, debugLog?: boolean): void {
-    if (debugLog ?? this.debugLog) {
-      if (replaceThisInLog) {
-        question = question.replace(replaceThisInLog, this.defaultLogReplacer);
+  protected logQuestion(
+    set: {
+      question: string, 
+      replaceThisInLog?: string, 
+      debugLog?: boolean
+    }
+  ): void {
+    if (set.debugLog ?? this.debugLog) {
+      if (set.replaceThisInLog) {
+        set.question = set.question.replace(set.replaceThisInLog, this.defaultLogReplacer);
       }
 
-      console.log('\n - ', question);
+      console.log('\n - ', set.question);
     }
   }
 
@@ -509,40 +544,47 @@ export class DyNTS_OAI_LLM_ServiceBase {
    * Uses the {@link getDefaultSystemMessage}
    */
   protected getMessageCreateInput(
-    messages: DyNTS_OAI_GPT_Message[],
-    issuer: string,
-    settings: DyFM_GPTCall_Settings = this.defaultSettings
+    set: {
+      conversation: DyNTS_OAI_GPT_Message[],
+      issuer: string,
+      settings?: DyFM_GPTCall_Settings
+    }
   ): ChatCompletionCreateParamsBase {
     try {
+      const settings = set.settings ?? this.defaultSettings;
+
       const result: ChatCompletionCreateParamsBase = {
-        model: settings.useModel ?? this.defaultModel,
-        messages: messages as ChatCompletionMessageParam[],
+        model: settings?.useModel ?? this.defaultModel,
+        messages: set.conversation as ChatCompletionMessageParam[],
       };
 
-      if (DyFM_notNull(settings.temperature)) {
-        result.temperature = settings.temperature;
-      }
+      result.temperature = DyFM_notNull(settings?.temperature) ? 
+        settings.temperature : 
+        this.defaultSettings.temperature;
       
-      if (DyFM_notNull(settings.maxTokens)) {
-        result.max_tokens = settings.maxTokens;
-      }
+      /* result.max_tokens = DyFM_notNull(settings?.maxTokens) ? 
+        settings.maxTokens : 
+        this.defaultSettings.maxTokens; */
+      result.max_completion_tokens = DyFM_notNull(settings?.maxTokens) ? 
+        settings.maxTokens : 
+        this.defaultSettings.maxTokens;
 
-      if (DyFM_notNull(settings.topP)) {
-        result.top_p = settings.topP;
-      }
+      result.top_p = DyFM_notNull(settings?.topP) ? 
+        settings.topP : 
+        this.defaultSettings.topP;
 
-      if (DyFM_notNull(settings.frequencyPenalty)) {
-        result.frequency_penalty = settings.frequencyPenalty;
-      }
+      result.frequency_penalty = DyFM_notNull(settings?.frequencyPenalty) ? 
+        settings.frequencyPenalty : 
+        this.defaultSettings.frequencyPenalty;
 
-      if (DyFM_notNull(settings.presencePenalty)) {
-        result.presence_penalty = settings.presencePenalty;
-      }
+      result.presence_penalty = DyFM_notNull(settings?.presencePenalty) ? 
+        settings.presencePenalty : 
+        this.defaultSettings.presencePenalty;
 
       return result;
     } catch (error) {
       throw new DyFM_Error({
-        ...this.getDefaultErrorSettings('getMessageCreateSettings', error, issuer),
+        ...this.getDefaultErrorSettings('getMessageCreateSettings', error, set.issuer),
         
         errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-OAB-RC0`,
       });