@cobrowser/chatgpt 0.7.2 → 0.7.4

package/dist/constants.d.ts

@@ -6,5 +6,5 @@ export declare const MESSAGE_TYPES: {
     text: string;
     button: string;
 };
-export declare const DEFAULT_PROMPT = "You are a helpful assistant. Your role is to address visitor queries related to the ongoing conversation and the last message received. Please ensure that responses remain within the ongoing conversation. Politely decline any user queries that 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. Restrict this field to 100 characters.\n\nSuggestions: Request 2 suggestions from user's perspective that he can ask. It 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 not found in the ongoing conversation. Politely tell the user to talk to a real agent. Also when it is true, do not provide any suggestions.\n";
+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";

package/dist/constants.js

@@ -12,7 +12,10 @@ exports.MESSAGE_TYPES = {
     button: 'button'
 };
 // Default prompt for ChatGPT
-exports.DEFAULT_PROMPT = `You are a helpful assistant. Your role is to address visitor queries related to the ongoing conversation and the last message received. Please ensure that responses remain within the ongoing conversation. Politely decline any user queries that is not present in the ongoing conversation. 
+exports.DEFAULT_PROMPT = `You are a helpful assistant. Your role is to address visitor 
+queries related to the ongoing conversation and the last message received. Please ensure 
+that responses remain within the ongoing conversation. Politely decline any user queries 
+that is not present in the ongoing conversation. 
 
 You will always respond with a JSON. It will be in the format: 
 
@@ -20,11 +23,15 @@ You will always respond with a JSON. It will be in the format:
 
 Fields in the JSON:
 
-Answer: It will consist of the user's query answer based on the ongoing conversation. Restrict this field to 100 characters.
+Answer: It will consist of the user's query answer based on the ongoing conversation. 
+Restrict this field to 100 characters.
 
-Suggestions: Request 2 suggestions from user's perspective that he can ask. It should be an array of strings. Restrict each suggestion to 50 characters.
+Suggestions: Request 2 suggestions from user's perspective that he can ask. 
+It should be an array of strings. Restrict each suggestion to 50 characters.
  
-ConnectWithAgent: It is a boolean. It should be set to true if the user's query is not found in the ongoing conversation. Politely tell the user to talk to a real agent. Also when it is true, do not provide any suggestions.
+ConnectWithAgent: It is a boolean. It should be set to true if the user's query is 
+not found in the ongoing conversation. Politely tell the user to talk to a real agent. 
+Also when it is true, do not provide any suggestions.
 `;
 // Default destination language
 exports.DESTINATION_LANGUAGE = 'English';

package/dist/models/ChatGptMessage.d.ts

@@ -5,6 +5,9 @@ export declare enum ChatGptRole {
 }
 export interface ChatGptRequestBody {
     model: string;
+    response_format?: {
+        type: string;
+    };
     messages: ChatGptMessage[];
 }
 interface ChatGptMessage {

package/dist/models/ChatGptResponse.d.ts

@@ -0,0 +1,6 @@
+import ChatGptUsageTokens from './ChatGptUsageTokens';
+interface ChatGptResponse {
+    firstChoice?: string;
+    usageTokens?: ChatGptUsageTokens;
+}
+export default ChatGptResponse;

package/dist/models/ChatGptResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/ChatGptUsageTokens.d.ts

@@ -0,0 +1,6 @@
+interface ChatGptUsageTokens {
+    prompt_tokens: Number;
+    completion_tokens: Number;
+    total_tokens: Number;
+}
+export default ChatGptUsageTokens;

package/dist/models/ChatGptUsageTokens.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/BaseService/BaseService.d.ts

@@ -1,4 +1,5 @@
 import { AxiosError, AxiosInstance, AxiosResponse } from 'axios';
+import ChatGptUsageTokens from '../../models/ChatGptUsageTokens';
 declare class BaseService {
     request: AxiosInstance;
     readonly BASE_CHAT_COMPLETION_URL = "https://api.openai.com/v1/chat/completions";
@@ -6,16 +7,23 @@ declare class BaseService {
     maxNumberOfChatCompletionResult: number;
     /**
      *
-     * @param apiUrl Api url to be used to make API calls to openAI services
+     * @param apiKey
      * @param model the main chatGPT model to use
+     * @param apiUrl Api url to be used to make API calls to openAI services
      * @param maxNumberOfChoices How many chat completion choices to generate for each request.
+     *
      */
-    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number, apiKey?: string | undefined);
+    constructor(apiKey?: string | undefined, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
      * Filter the response from chatGpt API and only get the first choice
      * @param response
      */
     getResponseFirstChoice(response: AxiosResponse): string | undefined;
+    /**
+     * Filter the response from chatGpt API and get the usage tokens
+     * @param response
+     */
+    getResponseUsageTokens(response: AxiosResponse): ChatGptUsageTokens | undefined;
     /**
      * function to handle requests errors
      * @param error

package/dist/services/BaseService/BaseService.js

@@ -8,11 +8,13 @@ const logger_1 = __importDefault(require("../logger"));
 class BaseService {
     /**
      *
-     * @param apiUrl Api url to be used to make API calls to openAI services
+     * @param apiKey
      * @param model the main chatGPT model to use
+     * @param apiUrl Api url to be used to make API calls to openAI services
      * @param maxNumberOfChoices How many chat completion choices to generate for each request.
+     *
      */
-    constructor(apiUrl, model = 'gpt-3.5-turbo', maxNumberOfChoices = 1, apiKey = process.env.OPEN_AI_API_KEY) {
+    constructor(apiKey = process.env.OPEN_AI_API_KEY, model = 'gpt-3.5-turbo', apiUrl, maxNumberOfChoices = 1) {
         Object.defineProperty(this, "request", {
             enumerable: true,
             configurable: true,
@@ -60,6 +62,19 @@ class BaseService {
         }
         return undefined;
     }
+    /**
+     * Filter the response from chatGpt API and get the usage tokens
+     * @param response
+     */
+    getResponseUsageTokens(response) {
+        var _a;
+        if ((_a = response.data) === null || _a === void 0 ? void 0 : _a.usage) {
+            const usage = response.data.usage;
+            logger_1.default.info(`ChatGpt response usage tokens: ${JSON.stringify(usage)}`);
+            return usage;
+        }
+        return undefined;
+    }
     /**
      * function to handle requests errors
      * @param error

package/dist/services/ChatService/ChatService.d.ts

@@ -3,6 +3,6 @@ import ConversationHistory from 'src/models/ConversationHistory';
 export declare class ChatService extends BaseService {
     #private;
     model: string | undefined;
-    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number, apiKey?: string);
+    constructor(apiKey?: string, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     ask(context: string | undefined, conversationHistory: ConversationHistory[]): Promise<string | undefined>;
 }

package/dist/services/ChatService/ChatService.js

@@ -24,8 +24,8 @@ const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 const logger_1 = __importDefault(require("../logger"));
 const constants_1 = require("../../constants");
 class ChatService extends BaseService_1.default {
-    constructor(apiUrl, model, maxNumberOfChoices, apiKey) {
-        super(apiUrl, model, maxNumberOfChoices, apiKey);
+    constructor(apiKey, model, apiUrl, maxNumberOfChoices) {
+        super(apiKey, model, apiUrl, maxNumberOfChoices);
         _ChatService_instances.add(this);
         Object.defineProperty(this, "model", {
             enumerable: true,

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

@@ -1,8 +1,9 @@
+import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
 import ChatGptMessage from '../../models/ChatGptMessage';
 import Item from '../../models/Item';
 export declare class CopilotService extends BaseService {
-    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number, apiKey?: string);
+    constructor(apiKey?: string, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
      * a method to be used to suggest some quick replies for the agent based on the conversation
      *  will be added as a single string in the format
@@ -15,7 +16,7 @@ export declare class CopilotService extends BaseService {
      * this will make it easy to ask chatGpt for quick replies
      * @param conversation
      */
-    suggest(conversation: string): Promise<string | undefined>;
+    suggest(conversation: string): Promise<ChatGptResponse | undefined>;
     /**
      * this will request chatGPT to recommend product or item based on the whole conversation
      * @param conversation the whole chat conversation

package/dist/services/CopilotService/CopilotService.js

@@ -17,8 +17,8 @@ const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 const logger_1 = __importDefault(require("../logger"));
 const ChatGptMessage_1 = require("../../models/ChatGptMessage");
 class CopilotService extends BaseService_1.default {
-    constructor(apiUrl, model, maxNumberOfChoices, apiKey) {
-        super(apiUrl, model, maxNumberOfChoices, apiKey);
+    constructor(apiKey, model, apiUrl, maxNumberOfChoices) {
+        super(apiKey, model, apiUrl, maxNumberOfChoices);
     }
     /**
      * a method to be used to suggest some quick replies for the agent based on the conversation
@@ -41,19 +41,21 @@ class CopilotService extends BaseService_1.default {
             try {
                 // main prompt used to instruct chatGPT to suggest some quick replies
                 const mainPrompt = `Propose some quick replies for the agent to be used on the following conversation
-          display your response as unordered list:-\n${conversation}`;
+          display your response as unordered list:-\n${conversation}`, 
                 // main prompt will be the whole conversation as string
-                const mainPromptMessage = {
+                mainPromptMessage = {
                     role: ChatGptMessage_1.ChatGptRole.USER,
                     content: mainPrompt,
-                };
+                }, 
                 // the body we need to send to the request
-                const requestBody = {
+                requestBody = {
                     model: this.chatGptModel,
                     messages: [mainPromptMessage],
+                }, response = yield this.request.post('', requestBody);
+                return {
+                    firstChoice: this.getResponseFirstChoice(response),
+                    usageTokens: this.getResponseUsageTokens(response),
                 };
-                const response = yield this.request.post('', requestBody);
-                return this.getResponseFirstChoice(response);
             }
             catch (e) {
                 this.handleErrors(e);
@@ -74,18 +76,17 @@ class CopilotService extends BaseService_1.default {
             }
             try {
                 // main prompt used to instruct chatGPT to recommend products
-                const mainPrompt = `we have this list of Items: ${JSON.stringify(items)}, what to recommend for you`;
+                const mainPrompt = `we have this list of Items: ${JSON.stringify(items)}, what to recommend for you`, 
                 // main prompt will be the first message of the whole conversation
-                const firstMessage = {
+                firstMessage = {
                     role: ChatGptMessage_1.ChatGptRole.ASSISTANT,
                     content: mainPrompt,
-                };
+                }, 
                 // the body we need to send to the request
-                const requestBody = {
+                requestBody = {
                     model: this.chatGptModel,
                     messages: [firstMessage, ...conversation],
-                };
-                const response = yield this.request.post('', requestBody);
+                }, response = yield this.request.post('', requestBody);
                 return this.getResponseFirstChoice(response);
             }
             catch (e) {

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

@@ -1,11 +1,16 @@
+import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
 export declare class TranslationService extends BaseService {
-    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number, apiKey?: string);
+    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)
      */
-    translate(text: string, toLanguage?: string, fromLanguage?: string): Promise<string | undefined>;
+    translate(text: string, toLanguage?: string, fromLanguage?: string): Promise<ChatGptResponse | undefined>;
+    findTextLanguage(text: string): Promise<ChatGptResponse | undefined>;
+    getFindTextLanguagePromptMessage(text: string): string;
 }

package/dist/services/TranslationService/TranslationService.js

@@ -18,8 +18,26 @@ const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 const logger_1 = __importDefault(require("../logger"));
 const constants_1 = require("../../constants");
 class TranslationService extends BaseService_1.default {
-    constructor(apiUrl, model, maxNumberOfChoices, apiKey) {
-        super(apiUrl, model, maxNumberOfChoices, apiKey);
+    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
@@ -39,14 +57,24 @@ class TranslationService extends BaseService_1.default {
             // the body we need to send to the request
             requestBody = {
                 model: this.chatGptModel,
-                messages: [{
+                response_format: { type: 'json_object' },
+                messages: [
+                    {
+                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        content: this.SYSTEM_ROLE_MESSAGE,
+                    },
+                    {
                         role: ChatGptMessage_1.ChatGptRole.USER,
                         content: translateText,
-                    }],
+                    },
+                ],
             };
             try {
                 const response = yield this.request.post('', requestBody);
-                return this.getResponseFirstChoice(response);
+                return {
+                    firstChoice: this.getResponseFirstChoice(response),
+                    usageTokens: this.getResponseUsageTokens(response),
+                };
             }
             catch (e) {
                 this.handleErrors(e);
@@ -54,5 +82,45 @@ class TranslationService extends BaseService_1.default {
             }
         });
     }
+    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'));
+            }
+            // instruction on what to do with the text
+            const translateText = this.getFindTextLanguagePromptMessage(text), 
+            // the body we need to send to the request
+            requestBody = {
+                model: this.chatGptModel,
+                response_format: { type: 'json_object' },
+                messages: [
+                    {
+                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        content: this.FIND_TEXT_LANGUAGE_SYSTEM_ROLE,
+                    },
+                    {
+                        role: ChatGptMessage_1.ChatGptRole.USER,
+                        content: translateText,
+                    }
+                ],
+            };
+            try {
+                const response = yield this.request.post('', requestBody);
+                return {
+                    firstChoice: this.getResponseFirstChoice(response),
+                    usageTokens: this.getResponseUsageTokens(response),
+                };
+            }
+            catch (e) {
+                this.handleErrors(e);
+                return Promise.reject(e);
+            }
+        });
+    }
+    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.`;
+    }
 }
 exports.TranslationService = TranslationService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -38,5 +38,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "0429dead571677c56bd9e618d6e3ec91acf3d4f3"
+  "gitHead": "e71a58b5be231da26741a5ded6e51db3b86aa419"
 }