@cobrowser/chatgpt 0.6.3 → 0.6.4

package/dist/models/ChatGptMessage.d.ts

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

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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/dist/models/CopilotSuggestion.d.ts

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

package/dist/models/CopilotSuggestion.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";
@@ -16,6 +17,11 @@ declare class BaseService {
      * @param response
      */
     getResponseFirstChoice(response: AxiosResponse): string | undefined;
+    /**
+     * Filter the response from chatGpt API and only get the first choice
+     * @param response
+     */
+    getResponseUsageTokens(response: AxiosResponse): ChatGptUsageTokens | undefined;
     /**
      * function to handle requests errors
      * @param error

package/dist/services/BaseService/BaseService.js

@@ -12,7 +12,7 @@ class BaseService {
      * @param model the main chatGPT model to use
      * @param maxNumberOfChoices How many chat completion choices to generate for each request.
      */
-    constructor(apiUrl, model = 'gpt-3.5-turbo', maxNumberOfChoices = 1) {
+    constructor(apiUrl, model = 'gpt-3.5-turbo-1106', maxNumberOfChoices = 1) {
         Object.defineProperty(this, "request", {
             enumerable: true,
             configurable: true,
@@ -60,6 +60,19 @@ class BaseService {
         }
         return undefined;
     }
+    /**
+     * Filter the response from chatGpt API and only get the first choice
+     * @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/CopilotService/CopilotService.d.ts

@@ -1,5 +1,6 @@
 import BaseService from '../BaseService/BaseService';
 import ChatGptMessage from '../../models/ChatGptMessage';
+import CopilotSuggestion from '../../models/CopilotSuggestion';
 import Item from '../../models/Item';
 export declare class CopilotService extends BaseService {
     constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number);
@@ -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<CopilotSuggestion | 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

@@ -53,7 +53,10 @@ class CopilotService extends BaseService_1.default {
                     messages: [mainPromptMessage],
                 };
                 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);

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

@@ -8,5 +8,6 @@ export declare class TranslationService extends BaseService {
      * @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<any | undefined>;
+    findTextLanguage(text: string): Promise<any | undefined>;
 }

package/dist/services/TranslationService/TranslationService.js

@@ -44,14 +44,59 @@ 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: "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.",
+                    },
+                    {
                         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);
+                return Promise.reject(e);
+            }
+        });
+    }
+    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 = `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.`, 
+            // the body we need to send to the request
+            requestBody = {
+                model: this.chatGptModel,
+                messages: [
+                    {
+                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        content: "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.",
+                    },
+                    {
+                        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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -22,8 +22,8 @@
   },
   "dependencies": {
     "@cobrowser/logger": "^1.0.0",
-    "axios": "^1.6.1",
-    "axios-mock-adapter": "^1.22.0"
+    "axios": "^1.3.5",
+    "axios-mock-adapter": "^1.21.4"
   },
   "directories": {
     "dist": "dist"
@@ -38,5 +38,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "776fc3a9a455791a81880f83df04eb178aff5760"
+  "gitHead": "0d2b7809e9ec1456985f4f7ecf30f43632fbf75b"
 }