@cobrowser/chatgpt 0.7.18 → 0.7.19

package/dist/constants.d.ts

@@ -8,3 +8,6 @@ export declare const MESSAGE_TYPES: {
 };
 export declare const DEFAULT_PROMPT = "You are a helpful assistant. Your role is to address visitor \nqueries related to the ongoing conversation and the last message received. Please ensure \nthat responses remain within the ongoing conversation. Politely decline any user queries \nthat is not present in the ongoing conversation. \n\nYou will always respond with a JSON. It will be in the format: \n\n{ answer: '', suggestions: [], connectWithAgent: true or false }\n\nFields in the JSON:\n\nAnswer: It will consist of the user's query answer based on the ongoing conversation. \nRestrict this field to 100 characters.\n\nSuggestions: Request 2 suggestions from user's perspective that he can ask. \nIt should be an array of strings. Restrict each suggestion to 50 characters.\n \nConnectWithAgent: It is a boolean. It should be set to true if the user's query is \nnot found in the ongoing conversation. Politely tell the user to talk to a real agent. \nAlso when it is true, do not provide any suggestions.\n";
 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 = "\n  You are a translator that responds exclusively in JSON format. Your response must be a JSON object containing:\n  - 'data': it is an array of objects. Each object in the array must contain:\n    - 'translated_message': The original input message before translation.\n    - 'translation: The translated version of 'translated_message', ensuring it is natural, culturally appropriate, and commonly used by native speakers.\n  - 'isError': a boolean value (true if translation fails, false otherwise).\n\n  Ensure that 'translation' accurately represents the meaning of 'translated_message' while considering cultural nuances, usual expressions, and natural phrasing in the target language.  \n  Your response must follow this structure strictly.\n";

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DESTINATION_LANGUAGE = exports.DEFAULT_PROMPT = exports.MESSAGE_TYPES = exports.MESSAGE_SENDER = void 0;
+exports.TRANSLATION_SYSTEM_ROLE = exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = exports.LANGUAGE_DETECTION_SYSTEM_ROLE = exports.DESTINATION_LANGUAGE = exports.DEFAULT_PROMPT = exports.MESSAGE_TYPES = exports.MESSAGE_SENDER = void 0;
 // Message sender in conversation history
 exports.MESSAGE_SENDER = {
     visitor: 'visitor',
@@ -35,3 +35,28 @@ Also when it is true, do not provide any suggestions.
 `;
 // Default destination language
 exports.DESTINATION_LANGUAGE = 'English';
+// Language detection system role
+exports.LANGUAGE_DETECTION_SYSTEM_ROLE = `
+  You are a language detection assistant. Your task is to analyze short text input and determine 
+  its language using ISO language code. Respond only in JSON format with two key-value pairs: 
+  - 'languageCode': the detected language's ISO code (or undefined if detection fails).
+  - 'isError': a boolean value (true if detection fails, false otherwise).
+`;
+// Word frequency language detection system role
+exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = `
+  You are a language detection assistant. Your task is to analyze the most frequently occurring words in the given text 
+  and determine the language based on those words. Respond only in JSON format with two key-value pairs: 
+  - 'languageCode': the detected language's ISO code (or undefined if detection fails).
+  - 'isError': a boolean value (true if detection fails, false otherwise).
+`;
+// Message translation system role
+exports.TRANSLATION_SYSTEM_ROLE = `
+  You are a translator that responds exclusively in JSON format. Your response must be a JSON object containing:
+  - 'data': it is an array of objects. Each object in the array must contain:
+    - 'translated_message': The original input message before translation.
+    - 'translation: The translated version of 'translated_message', ensuring it is natural, culturally appropriate, and commonly used by native speakers.
+  - 'isError': a boolean value (true if translation fails, false otherwise).
+
+  Ensure that 'translation' accurately represents the meaning of 'translated_message' while considering cultural nuances, usual expressions, and natural phrasing in the target language.  
+  Your response must follow this structure strictly.
+`;

package/dist/services/TranslationService/TranslationService.d.ts

@@ -1,17 +1,25 @@
-import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
+import ChatGptResponse from '../../models/ChatGptResponse';
 export declare class TranslationService extends BaseService {
-    SYSTEM_ROLE_MESSAGE: string;
-    FIND_TEXT_LANGUAGE_SYSTEM_ROLE: string;
     constructor(apiKey?: string, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
-     * request the chatGpt Api to translate a specific test to a desired language
-     * @param text the text to translate
-     * @param toLanguage the desired language to translate to ( English is the default )
-     * @param fromLanguage if we want to specify the language of the text, we can use this ( optional)
+     * Request the ChatGPT API to translate a specific test to a desired language
+     *
+     * @param text          the text to translate
+     * @param toLanguage    the desired language to translate to ( English is the default )
+     * @param fromLanguage  if we want to specify the language of the text, we can use this ( optional)
      */
     translate(text: string, toLanguage?: string, fromLanguage?: string): Promise<ChatGptResponse | undefined>;
+    /**
+     * Detects the ISO language code of a text
+     *
+     * @param text text to detect
+     */
     findTextLanguage(text: string): Promise<ChatGptResponse | undefined>;
-    getFindTextLanguagePromptMessage(text: string): string;
+    /**
+     * Detects the ISO language code of a text based on frequency of words
+     *
+     * @param text text to detect
+     */
     findTextLanguageBasedOnFrequency(text: string): Promise<ChatGptResponse | undefined>;
 }

package/dist/services/TranslationService/TranslationService.js

@@ -13,56 +13,37 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranslationService = void 0;
+const constants_1 = require("../../constants");
 const ChatGptMessage_1 = require("../../models/ChatGptMessage");
-const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 const logger_1 = __importDefault(require("../logger"));
-const constants_1 = require("../../constants");
+const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 class TranslationService extends BaseService_1.default {
     constructor(apiKey, model, apiUrl, maxNumberOfChoices) {
         super(apiKey, model, apiUrl, maxNumberOfChoices);
-        Object.defineProperty(this, "SYSTEM_ROLE_MESSAGE", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 'You are a translator that provides a response in JSON format only. '
-                + 'The response should be a JSON object with a boolean called \'error\' and \'data,\''
-                + ' which is an array of objects. Each object in the array will contain a \'translation\' property, '
-                + 'holding the translation of the message, and a \'translated_message\' property, '
-                + 'which will contain the original message before being translated.'
-                + ' Additionally, the \'translation\' property will hold the translation of the \'translated_message\' property.'
-        });
-        Object.defineProperty(this, "FIND_TEXT_LANGUAGE_SYSTEM_ROLE", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 'You are a translator that provides a response in JSON format only—a JSON that contains'
-                + ' \'languageCode\' and \'isError\' if you cannot detect the language.'
-        });
     }
     /**
-     * request the chatGpt Api to translate a specific test to a desired language
-     * @param text the text to translate
-     * @param toLanguage the desired language to translate to ( English is the default )
-     * @param fromLanguage if we want to specify the language of the text, we can use this ( optional)
+     * Request the ChatGPT API to translate a specific test to a desired language
+     *
+     * @param text          the text to translate
+     * @param toLanguage    the desired language to translate to ( English is the default )
+     * @param fromLanguage  if we want to specify the language of the text, we can use this ( optional)
      */
     translate(text, toLanguage = constants_1.DESTINATION_LANGUAGE, fromLanguage) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!text) {
-                logger_1.default.error('translation text should be provided');
-                return Promise.reject(new Error('test must be provided'));
+                logger_1.default.error('Translation text should be provided');
+                return Promise.reject(new Error('Text must be provided'));
             }
-            const desiredLanguage = toLanguage, 
-            // instruction on what to do with the text
-            translateText = `Translate the following ${fromLanguage} text to ${desiredLanguage} 
-      if it's not already in ${desiredLanguage}: ${text}`, 
-            // the body we need to send to the request
-            requestBody = {
+            const translateText = `
+      Translate the following text from ${fromLanguage} to ${toLanguage} if it's not already in ${toLanguage}: ${text}.
+    `;
+            const requestBody = {
                 model: this.chatGptModel,
                 response_format: { type: 'json_object' },
                 messages: [
                     {
                         role: ChatGptMessage_1.ChatGptRole.SYSTEM,
-                        content: this.SYSTEM_ROLE_MESSAGE,
+                        content: constants_1.TRANSLATION_SYSTEM_ROLE,
                     },
                     {
                         role: ChatGptMessage_1.ChatGptRole.USER,
@@ -83,22 +64,24 @@ class TranslationService extends BaseService_1.default {
             }
         });
     }
+    /**
+     * Detects the ISO language code of a text
+     *
+     * @param text text to detect
+     */
     findTextLanguage(text) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!text) {
-                logger_1.default.error('translation text should be provided');
-                return Promise.reject(new Error('text must be provided'));
+                logger_1.default.error('Translation text should be provided');
+                return Promise.reject(new Error('Text must be provided'));
             }
-            // instruction on what to do with the text
-            const translateText = this.getFindTextLanguagePromptMessage(text), 
-            // the body we need to send to the request
-            requestBody = {
+            const translateText = `Detect the ISO language code of this text: '${text}'`, requestBody = {
                 model: this.chatGptModel,
                 response_format: { type: 'json_object' },
                 messages: [
                     {
                         role: ChatGptMessage_1.ChatGptRole.SYSTEM,
-                        content: this.FIND_TEXT_LANGUAGE_SYSTEM_ROLE,
+                        content: constants_1.LANGUAGE_DETECTION_SYSTEM_ROLE,
                     },
                     {
                         role: ChatGptMessage_1.ChatGptRole.USER,
@@ -119,28 +102,24 @@ class TranslationService extends BaseService_1.default {
             }
         });
     }
-    getFindTextLanguagePromptMessage(text) {
-        return `In which language is this text in '${text}'? The response should be {'languageCode': 'language_code_here', 'isError': 'true or false based on whether you did find the language code or not'}. 
-    Other responses or explanations are not allowed.`;
-    }
+    /**
+     * Detects the ISO language code of a text based on frequency of words
+     *
+     * @param text text to detect
+     */
     findTextLanguageBasedOnFrequency(text) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!text) {
-                logger_1.default.error('translation text should be provided');
-                return Promise.reject(new Error('text must be provided'));
+                logger_1.default.error('Translation text should be provided');
+                return Promise.reject(new Error('Text must be provided'));
             }
-            text = '```' + text + '```';
-            // instruction on what to do with the text
-            const translateText = `Tell me the language ISO code of the  enclosed between triple backticks ${text}
-    based on most words used. Give me the result in just one word, the ISO code of the language with most words.`, 
-            // the body we need to send to the request
-            requestBody = {
+            const translateText = `Detect the ISO language code based on the most words used in this text: '${text}'`, requestBody = {
                 model: this.chatGptModel,
                 response_format: { type: 'json_object' },
                 messages: [
                     {
                         role: ChatGptMessage_1.ChatGptRole.SYSTEM,
-                        content: this.FIND_TEXT_LANGUAGE_SYSTEM_ROLE,
+                        content: constants_1.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE,
                     },
                     {
                         role: ChatGptMessage_1.ChatGptRole.USER,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.7.18",
+  "version": "0.7.19",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -39,5 +39,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "b899586229b32621acf33af6870b3664786ad970"
+  "gitHead": "92f181d648d5372db54258bf3518092251c855fd"
 }