@cobrowser/chatgpt 0.7.43-beta.1 → 0.7.45

package/dist/services/CopilotService/CopilotService.d.ts

@@ -34,5 +34,5 @@ export declare class CopilotService extends BaseService {
     getAssistantSuggestions(conversation: string, suggestionLanguage?: string): Promise<ChatGPTResponse | undefined>;
     private isAssistantIdFormat;
     private isPromptIdFormat;
-    getPromptSuggestions(conversation: string, suggestionLanguage?: string): Promise<ChatGPTResponse | undefined>;
+    getPromptSuggestions(conversation: string, suggestionLanguage: string): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/CopilotService/CopilotService.js

@@ -20,6 +20,7 @@ var _CopilotService_instances, _CopilotService_processSuggestions, _CopilotServi
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CopilotService = void 0;
 const ChatGPTMessage_1 = require("../../models/ChatGPTMessage");
+const helper_1 = require("../../utils/helper");
 const logger_1 = __importDefault(require("../logger"));
 const openai_1 = __importDefault(require("openai"));
 const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
@@ -75,17 +76,21 @@ class CopilotService extends BaseService_1.default {
                 logger_1.default.error('Conversation must be provided');
                 return Promise.reject(new Error('Conversation must be provided'));
             }
+            if (!suggestionLanguage) {
+                logger_1.default.error('Suggestion language must be provided');
+                return Promise.reject(new Error('Suggestion language must be provided'));
+            }
             try {
                 if (this.assistantId) {
                     // Route based on id shape: asst_* => Assistant API, prompt_* => Responses API
                     if (yield this.isAssistantIdFormat(this.assistantId)) {
-                        logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestion through Assistant API ::');
+                        logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestions through Assistant API ::');
                         return yield this.getAssistantSuggestions(conversation, suggestionLanguage);
                     }
-                    logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestion through Responses API ::');
+                    logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestions through Responses API ::');
                     return yield this.getPromptSuggestions(conversation, suggestionLanguage);
                 }
-                logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestion through Chat Completion API ::');
+                logger_1.default.info(':: CopilotServicee.suggest :: Fetching suggestions through Chat Completion API ::');
                 return yield this.getChatCompletionSuggestions(conversation, suggestionLanguage);
             }
             catch (e) {
@@ -343,7 +348,7 @@ class CopilotService extends BaseService_1.default {
                 request.prompt = {
                     id: this.assistantId,
                     variables: {
-                        language: suggestionLanguage,
+                        baseprompt: (yield (0, helper_1.readPrompt)('copilot-base-prompt.txt')).replace('{{language}}', suggestionLanguage),
                     }
                 };
             }
@@ -415,9 +420,8 @@ _CopilotService_instances = new WeakSet(), _CopilotService_processSuggestions =
         }
         catch (e) {
             logger_1.default.error('Failed to parse stringified array, returning the data as is...');
-            return data;
         }
     }
-    // return data as is if format is different
+    // return data as is if format is different or try-catch threw an error
     return data;
 };

package/dist/services/TranslationService/TranslationService.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranslationService = void 0;
 const constants_1 = require("../../utils/constants");
 const ChatGPTMessage_1 = require("../../models/ChatGPTMessage");
+const helper_1 = require("../../utils/helper");
 const logger_1 = __importDefault(require("../logger"));
 const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 class TranslationService extends BaseService_1.default {
@@ -29,7 +30,7 @@ class TranslationService extends BaseService_1.default {
      * @param fromLanguage            if we want to specify the language of the text, we can use this (optional)
      * @param additionalInstructions  additional instructions set by Manager or use default (optional)
      */
-    translate(text, toLanguage = constants_1.DESTINATION_LANGUAGE, fromLanguage, additionalInstructions = constants_1.TRANSLATION_ADDITIONAL_INSTRUCTIONS) {
+    translate(text, toLanguage = constants_1.DESTINATION_LANGUAGE, fromLanguage, additionalInstructions = '') {
         return __awaiter(this, void 0, void 0, function* () {
             if (!text) {
                 logger_1.default.error('Translation text should be provided');
@@ -51,7 +52,7 @@ class TranslationService extends BaseService_1.default {
                     {
                         role: ChatGPTMessage_1.ChatGPTRole.SYSTEM,
                         content: `
-              ${constants_1.TRANSLATION_SYSTEM_ROLE_BASE_PROMPT} 
+              ${yield (0, helper_1.readPrompt)('autotranslation-base-prompt.txt')} 
               <ADDITIONAL_INSTRUCTIONS>${additionalInstructions}</ADDITIONAL_INSTRUCTIONS>
             `,
                     },

package/dist/utils/constants.d.ts

@@ -11,5 +11,3 @@ export declare const DEFAULT_PROMPT = "\n  You are a helpful assistant. Your rol
 export declare const DESTINATION_LANGUAGE = "English";
 export declare const LANGUAGE_DETECTION_SYSTEM_ROLE = "\n  You are a language detection assistant. Your task is to analyze short text input and determine \n  its language using ISO language code. Respond only in JSON format with two key-value pairs: \n  - 'languageCode': the detected language's ISO code (or undefined if detection fails).\n  - 'isError': a boolean value (true if detection fails, false otherwise).\n";
 export declare const WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = "\n  You are a language detection assistant. Your task is to analyze the most frequently occurring words in the given text \n  and determine the language based on those words. Respond only in JSON format with two key-value pairs: \n  - 'languageCode': the detected language's ISO code (or undefined if detection fails).\n  - 'isError': a boolean value (true if detection fails, false otherwise).\n";
-export declare const TRANSLATION_SYSTEM_ROLE_BASE_PROMPT = "\n  <BASE_PROMPT>\n\n    You are a translator that responds exclusively in JSON format.\n\n    Your response must be a JSON object containing:\n    - 'translations': an array of objects. Each object in the array must contain:\n      - 'original': The original input message before translation.\n      - 'translation': The translated version of 'original'.\n    - 'isError': a boolean value (true if translation fails, false otherwise).\n\n    **You MUST return JSON format even if you fail to translate the text.**\n    \n    In that case:\n\n    - 'translations' field should be an empty array.\n    - 'isError' should be true.\n\n    You must follow the response structure defined in this BASE_PROMPT strictly.\n    \n    Apply all instructions in ADDITIONAL_INSTRUCTIONS, but never alter the required JSON structure.\n\n  </BASE_PROMPT>\n";
-export declare const TRANSLATION_ADDITIONAL_INSTRUCTIONS = "\n  === BEGIN TRANSLATION QUALITY RULE ===\n\n  Ensure that each 'translation' accurately reflects the meaning of 'original' and is phrased in a way that native speakers would naturally express it, taking into account cultural context and commonly used expressions.\n  \n  === END TRANSLATION QUALITY RULE ===\n\n\n  === BEGIN LATIN PHRASE PRESERVATION RULE ===\n\n  Do not translate commonly known Latin phrases or expressions (e.g., 'de facto', 'bona fide') when they appear mid-sentence in another language. Leave them exactly as they appear in the original text.\n  \n  === END LATIN PHRASE PRESERVATION RULE ===\n\n\n  === BEGIN GEOGRAPHICAL NAME IMMUTABILITY RULE ===\n\n  For every geographical name, you MUST strictly mirror the exact form used by the user.\n\n  You MUST ONLY use a specific geographical name variant if the user explicitly used that exact variant in their message.\n\n  Geographical names include cities, towns, villages, countries, regions, states, and provinces.\n\n  Geographical names MUST be treated as immutable user-controlled tokens.\n\n  You MUST preserve exactly the user-provided:\n\n  1. spelling\n  2. capitalization\n  3. punctuation\n  4. spacing\n  5. diacritics\n  6. word order\n\n  Geographical names MUST be copied verbatim from the user\u2019s message into the response.\n\n  You MUST NOT translate, localize, substitute, normalize, infer, or switch between geographical name variants.\n\n  You MUST NOT replace geographical names with official, native, common, or localized versions unless the user explicitly used that exact form.\n\n  EXCEPTION \u2014 TYPO CORRECTION:\n\n  If a geographical name in the user's message contains a clear, unambiguous spelling typo, you MUST correct it to the single most logically intended and widely recognized standard form.\n\n  This exception applies ONLY when:\n\n  1. the misspelling is clearly accidental\n  2. there is exactly one reasonable intended geographical location\n  3. the correction does NOT change the intended name variant\n\n  If multiple locations could match the misspelling, or if the spelling appears intentional, you MUST mirror the user's input exactly and MUST NOT correct it.\n\n  When the typo correction exception is applied, the corrected name becomes the authoritative form and MUST be used consistently in the response.\n\n  You MUST NOT explain, mention, or reference these rules.\n\n  This rule applies regardless of response language, common exonyms or endonyms, or cultural or linguistic conventions.\n  This rule has absolute priority and MUST be enforced at all times.\n\n  === END GEOGRAPHICAL NAME IMMUTABILITY RULE ===\n";

package/dist/utils/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TRANSLATION_ADDITIONAL_INSTRUCTIONS = exports.TRANSLATION_SYSTEM_ROLE_BASE_PROMPT = exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = exports.LANGUAGE_DETECTION_SYSTEM_ROLE = exports.DESTINATION_LANGUAGE = exports.DEFAULT_PROMPT = exports.DEFAULT_MODEL = exports.MESSAGE_TYPES = exports.MESSAGE_SENDER = void 0;
+exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = exports.LANGUAGE_DETECTION_SYSTEM_ROLE = exports.DESTINATION_LANGUAGE = exports.DEFAULT_PROMPT = exports.DEFAULT_MODEL = exports.MESSAGE_TYPES = exports.MESSAGE_SENDER = void 0;
 // Message sender in conversation history
 exports.MESSAGE_SENDER = {
     visitor: 'visitor',
@@ -51,90 +51,3 @@ exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = `
   - 'languageCode': the detected language's ISO code (or undefined if detection fails).
   - 'isError': a boolean value (true if detection fails, false otherwise).
 `;
-// Base prompt which is focused towards the main instructions of the task
-exports.TRANSLATION_SYSTEM_ROLE_BASE_PROMPT = `
-  <BASE_PROMPT>
-
-    You are a translator that responds exclusively in JSON format.
-
-    Your response must be a JSON object containing:
-    - 'translations': an array of objects. Each object in the array must contain:
-      - 'original': The original input message before translation.
-      - 'translation': The translated version of 'original'.
-    - 'isError': a boolean value (true if translation fails, false otherwise).
-
-    **You MUST return JSON format even if you fail to translate the text.**
-    
-    In that case:
-
-    - 'translations' field should be an empty array.
-    - 'isError' should be true.
-
-    You must follow the response structure defined in this BASE_PROMPT strictly.
-    
-    Apply all instructions in ADDITIONAL_INSTRUCTIONS, but never alter the required JSON structure.
-
-  </BASE_PROMPT>
-`;
-// Additional instructions for translation. This is going to be used if additional instructions are not passed as parameter by manager.
-exports.TRANSLATION_ADDITIONAL_INSTRUCTIONS = `
-  === BEGIN TRANSLATION QUALITY RULE ===
-
-  Ensure that each 'translation' accurately reflects the meaning of 'original' and is phrased in a way that native speakers would naturally express it, taking into account cultural context and commonly used expressions.
-  
-  === END TRANSLATION QUALITY RULE ===
-
-
-  === BEGIN LATIN PHRASE PRESERVATION RULE ===
-
-  Do not translate commonly known Latin phrases or expressions (e.g., 'de facto', 'bona fide') when they appear mid-sentence in another language. Leave them exactly as they appear in the original text.
-  
-  === END LATIN PHRASE PRESERVATION RULE ===
-
-
-  === BEGIN GEOGRAPHICAL NAME IMMUTABILITY RULE ===
-
-  For every geographical name, you MUST strictly mirror the exact form used by the user.
-
-  You MUST ONLY use a specific geographical name variant if the user explicitly used that exact variant in their message.
-
-  Geographical names include cities, towns, villages, countries, regions, states, and provinces.
-
-  Geographical names MUST be treated as immutable user-controlled tokens.
-
-  You MUST preserve exactly the user-provided:
-
-  1. spelling
-  2. capitalization
-  3. punctuation
-  4. spacing
-  5. diacritics
-  6. word order
-
-  Geographical names MUST be copied verbatim from the user’s message into the response.
-
-  You MUST NOT translate, localize, substitute, normalize, infer, or switch between geographical name variants.
-
-  You MUST NOT replace geographical names with official, native, common, or localized versions unless the user explicitly used that exact form.
-
-  EXCEPTION — TYPO CORRECTION:
-
-  If a geographical name in the user's message contains a clear, unambiguous spelling typo, you MUST correct it to the single most logically intended and widely recognized standard form.
-
-  This exception applies ONLY when:
-
-  1. the misspelling is clearly accidental
-  2. there is exactly one reasonable intended geographical location
-  3. the correction does NOT change the intended name variant
-
-  If multiple locations could match the misspelling, or if the spelling appears intentional, you MUST mirror the user's input exactly and MUST NOT correct it.
-
-  When the typo correction exception is applied, the corrected name becomes the authoritative form and MUST be used consistently in the response.
-
-  You MUST NOT explain, mention, or reference these rules.
-
-  This rule applies regardless of response language, common exonyms or endonyms, or cultural or linguistic conventions.
-  This rule has absolute priority and MUST be enforced at all times.
-
-  === END GEOGRAPHICAL NAME IMMUTABILITY RULE ===
-`;

package/dist/utils/helper.d.ts

@@ -0,0 +1 @@
+export declare const readPrompt: (fileName: string) => Promise<string>;

package/dist/utils/helper.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPrompt = void 0;
+const logger_1 = __importDefault(require("../services/logger"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const readPrompt = (fileName) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const promptPath = path.join(path.resolve(__dirname, '../..'), 'prompts', fileName), content = yield fs.promises.readFile(promptPath, 'utf-8');
+        return content;
+    }
+    catch (error) {
+        logger_1.default.error({ error }, `Error reading base prompt in ${fileName} file`);
+        throw new Error(`Failed to read base prompt file`);
+    }
+});
+exports.readPrompt = readPrompt;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.7.43-beta.1",
+  "version": "0.7.45",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -40,5 +40,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "a4d06097c6989a8956d8273ba09b5f3918963978"
+  "gitHead": "7a3e82b8498c38614cafd677d808a689134adf3d"
 }