@cobrowser/chatgpt 0.7.32-dev.0 → 0.7.32-dev.2

package/dist/constants.d.ts

@@ -6,8 +6,8 @@ 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 \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 DEFAULT_PROMPT = "\n  You are a helpful assistant. Your role is to address visitor \n  queries related to the ongoing conversation and the last message received. Please ensure \n  that responses remain within the ongoing conversation. Politely decline any user queries \n  that is not present in the ongoing conversation. \n\n  You will always respond with a JSON. It will be in the format: \n\n  { answer: '', suggestions: [], connectWithAgent: true or false }\n\n  Fields in the JSON:\n\n  Answer: It will consist of the user's query answer based on the ongoing conversation. \n  Restrict this field to 100 characters.\n\n  Suggestions: Request 2 suggestions from user's perspective that he can ask. \n  It should be an array of strings. Restrict each suggestion to 50 characters.\n  \n  ConnectWithAgent: It is a boolean. It should be set to true if the user's query is \n  not found in the ongoing conversation. Politely tell the user to talk to a real agent. \n  Also 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";
+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  - 'translations': it is 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', 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  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** \n\n  Ensure that 'translation' accurately represents the meaning of 'original' while considering cultural nuances, usual expressions, and natural phrasing in the target language.\n\n  Your response must follow this structure strictly.\n";

package/dist/constants.js

@@ -12,26 +12,27 @@ 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: 
+  You will always respond with a JSON. It will be in the format: 
 
-{ answer: '', suggestions: [], connectWithAgent: true or false }
+  { answer: '', suggestions: [], connectWithAgent: true or false }
 
-Fields in the JSON:
+  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.
- 
-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.
+  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.
 `;
 // Default destination language
 exports.DESTINATION_LANGUAGE = 'English';
@@ -52,11 +53,14 @@ exports.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE = `
 // 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.
+  - 'translations': it is an array of objects. Each object in the array must contain:
+    - 'original': The original input message before translation.
+    - 'translation: The translated version of 'original', 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.  
+  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** 
+
+  Ensure that 'translation' accurately represents the meaning of 'original' while considering cultural nuances, usual expressions, and natural phrasing in the target language.
+
   Your response must follow this structure strictly.
 `;

package/dist/models/ChatGPTMessage.d.ts

@@ -0,0 +1,17 @@
+export declare enum ChatGPTRole {
+    USER = "user",
+    SYSTEM = "system",
+    ASSISTANT = "assistant"
+}
+export interface ChatGPTRequestBody {
+    model: string;
+    response_format?: {
+        type: string;
+    };
+    messages: ChatGPTMessage[];
+}
+interface ChatGPTMessage {
+    role: ChatGPTRole;
+    content: string;
+}
+export default ChatGPTMessage;

package/dist/models/ChatGPTMessage.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatGPTRole = void 0;
+var ChatGPTRole;
+(function (ChatGPTRole) {
+    ChatGPTRole["USER"] = "user";
+    ChatGPTRole["SYSTEM"] = "system";
+    ChatGPTRole["ASSISTANT"] = "assistant";
+})(ChatGPTRole = exports.ChatGPTRole || (exports.ChatGPTRole = {}));

package/dist/models/ChatGPTResponse.d.ts

@@ -0,0 +1,8 @@
+import ChatGPTUsageTokens from './ChatGPTUsageTokens';
+interface ChatGPTResponse {
+    data?: any;
+    usageTokens?: ChatGPTUsageTokens;
+    threadId?: string;
+    requiredActions?: any;
+}
+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/models/ConversationHistory.d.ts

@@ -1,13 +1,13 @@
 interface ConversationHistory {
-    from: string;
     to: string;
-    datetime: number;
+    from: string;
     body: MessageBody[];
+    datetime: number;
 }
 interface MessageBody {
+    id?: string;
     type: string;
     text?: string;
-    id?: string;
     label?: string;
 }
 export default ConversationHistory;

package/dist/models/Item.d.ts

@@ -1,10 +1,10 @@
 interface Item {
     id?: string;
     name?: string;
-    description?: string;
     link?: string;
     price: number;
-    category?: string;
     rating?: string;
+    category?: string;
+    description?: string;
 }
 export default Item;

package/dist/models/Response.d.ts

@@ -0,0 +1,3 @@
+export interface Response<Data = any> {
+    result: Data;
+}

package/dist/models/Response.js

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

package/dist/services/AssistantService/AssistantService.d.ts

@@ -1,6 +1,6 @@
-import ChatGptResponse from '../../models/ChatGptResponse';
-import BaseService from '../BaseService/BaseService';
 import { AssistantResponseFormatOption } from 'openai/resources/beta/threads/threads';
+import BaseService from '../BaseService/BaseService';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 export declare class AssistantService extends BaseService {
     assistantId: string | undefined;
     threadId: string | undefined;
@@ -22,5 +22,5 @@ export declare class AssistantService extends BaseService {
         tools?: any[];
         functionOutputs?: string;
         definedSchema?: AssistantResponseFormatOption;
-    }): Promise<ChatGptResponse | undefined>;
+    }): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/AssistantService/AssistantService.js

@@ -74,14 +74,16 @@ class AssistantService extends BaseService_1.default {
                 });
             }
             else {
-                const lastThreadMessasges = yield openai.beta.threads.messages.list(this.threadId, { order: "desc", limit: 2 });
-                const isRepeatedMessage = lastThreadMessasges.data.find(msg => msg.content[0].type === 'text' && msg.content[0].text.value === message);
+                const lastThreadMessasges = yield openai.beta.threads.messages.list(this.threadId, { order: "desc", limit: 2 }), isRepeatedMessage = lastThreadMessasges.data.find(msg => msg.content[0].type === 'text' && msg.content[0].text.value === message);
                 if (isRepeatedMessage) {
                     const runs = yield openai.beta.threads.runs.list(this.threadId, { order: "desc", limit: 1 });
                     run = runs.data[0];
                 }
                 else {
-                    yield openai.beta.threads.messages.create(this.threadId, { role: "user", content: message });
+                    yield openai.beta.threads.messages.create(this.threadId, {
+                        role: "user",
+                        content: message
+                    });
                     run = yield openai.beta.threads.runs.create(this.threadId, {
                         assistant_id: (_a = this.assistantId) !== null && _a !== void 0 ? _a : '',
                         additional_instructions: runOptions.instructions,
@@ -98,13 +100,13 @@ class AssistantService extends BaseService_1.default {
                 run = yield openai.beta.threads.runs.retrieve(run.id, { thread_id: run.thread_id });
             }
             if (run.status === 'completed') {
-                const { data } = yield openai.beta.threads.messages.list(run.thread_id, { order: 'desc', limit: 1 });
-                const messages = data.flatMap((message) => message === null || message === void 0 ? void 0 : message.content.map((content) => ((content.type === 'text' && message.role === 'assistant') ? content.text : '')));
-                const assistantMessages = messages.filter(message => typeof message === 'object' && 'value' in message && typeof message.value === 'string');
+                const { data } = yield openai.beta.threads.messages.list(run.thread_id, { order: 'desc', limit: 1 }), messages = data.flatMap((message) => message === null || message === void 0 ? void 0 : message.content.map((content) => ((content.type === 'text' && message.role === 'assistant') ? content.text : ''))), assistantMessages = messages.filter(message => typeof message === 'object' && 'value' in message && typeof message.value === 'string');
                 if (assistantMessages.length) {
-                    let answer = assistantMessages.map(message => message.value).join('\n');
+                    // as we will always get one message (limit = 1 from desc order), 
+                    // we can just directly access the message here
+                    const answer = assistantMessages[0].value, replaced = answer.replace(/【.*?】/g, ''), parsed = JSON.parse(replaced);
                     return {
-                        firstChoice: answer.replace(/【.*?】/g, ''),
+                        data: parsed,
                         threadId: run.thread_id,
                         usageTokens: run.usage,
                     };
@@ -112,7 +114,7 @@ class AssistantService extends BaseService_1.default {
             }
             if (run.status === 'requires_action') {
                 return {
-                    requiredActions: JSON.stringify(run.required_action),
+                    requiredActions: run.required_action,
                     threadId: run.thread_id,
                     usageTokens: run.usage,
                 };

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

@@ -1,30 +1,38 @@
 import { AxiosError, AxiosInstance, AxiosResponse } from 'axios';
-import ChatGptUsageTokens from '../../models/ChatGptUsageTokens';
+import ChatGPTUsageTokens from '../../models/ChatGPTUsageTokens';
 declare class BaseService {
-    request: AxiosInstance;
     readonly BASE_CHAT_COMPLETION_URL = "https://api.openai.com/v1/chat/completions";
+    request: AxiosInstance;
     openaiApiKey: string | undefined;
     chatGptModel: string;
     maxNumberOfChatCompletionResult: number;
     /**
-     *
      * @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(apiKey?: string | undefined, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
+    /**
+     * Automatically wraps some specific async methods to return a specific sanitized
+     * and encoded JSON without any developer intervention.
+     */
+    private processAsyncMethods;
+    /**
+     * Recursively sanitizes any value
+     */
+    private sanitize;
     /**
      * Filter the response from chatGpt API and only get the first choice
+     *
      * @param response
      */
-    getResponseFirstChoice(response: AxiosResponse): string | undefined;
+    getResponseFirstChoice(response: AxiosResponse): any;
     /**
      * Filter the response from chatGpt API and get the usage tokens
      * @param response
      */
-    getResponseUsageTokens(response: AxiosResponse): ChatGptUsageTokens | undefined;
+    getResponseUsageTokens(response: AxiosResponse): ChatGPTUsageTokens | undefined;
     /**
      * function to handle requests errors
      * @param error

package/dist/services/BaseService/BaseService.js

@@ -1,31 +1,40 @@
 "use strict";
+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 });
 const axios_1 = __importDefault(require("axios"));
+const Response_1 = require("../../utils/Response");
+const xss_validation_1 = require("@cobrowser/xss-validation");
 const logger_1 = __importDefault(require("../logger"));
 class BaseService {
     /**
-     *
      * @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(apiKey = process.env.OPEN_AI_API_KEY, model = 'gpt-4o', apiUrl, maxNumberOfChoices = 1) {
-        Object.defineProperty(this, "request", {
+        Object.defineProperty(this, "BASE_CHAT_COMPLETION_URL", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: void 0
+            value: 'https://api.openai.com/v1/chat/completions'
         });
-        Object.defineProperty(this, "BASE_CHAT_COMPLETION_URL", {
+        Object.defineProperty(this, "request", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 'https://api.openai.com/v1/chat/completions'
+            value: void 0
         });
         Object.defineProperty(this, "openaiApiKey", {
             enumerable: true,
@@ -55,9 +64,60 @@ class BaseService {
         this.openaiApiKey = apiKey;
         this.chatGptModel = model;
         this.maxNumberOfChatCompletionResult = maxNumberOfChoices;
+        this.processAsyncMethods();
+    }
+    /**
+     * Automatically wraps some specific async methods to return a specific sanitized
+     * and encoded JSON without any developer intervention.
+     */
+    processAsyncMethods() {
+        const proto = Object.getPrototypeOf(this), methodNames = Object.getOwnPropertyNames(proto);
+        for (const methodName of methodNames) {
+            const method = proto[methodName];
+            // Skip constructor, non-functions, and utility methods But include service methods
+            // like getReply, getAssistant, etc. Please note that new methods that are not final 
+            // output should be skipped here.
+            if (methodName === 'constructor' ||
+                methodName === 'suggest' ||
+                typeof method !== 'function' ||
+                (methodName.startsWith('get') &&
+                    !methodName.startsWith('getReply') &&
+                    !methodName.startsWith('getAssist') &&
+                    !methodName.startsWith('getChat') &&
+                    !methodName.startsWith('getPrompt')) ||
+                methodName.startsWith('handle') ||
+                methodName.includes('Sanitize') ||
+                methodName.includes('sanitize') ||
+                methodName.includes('createConversation')) {
+                continue;
+            }
+            const originalMethod = method.bind(this);
+            // Replace the method with a wrapper
+            this[methodName] = (...args) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const response = Response_1.ResponseBuilder.build(yield originalMethod(...args)), sanitized = this.sanitize(response);
+                    return sanitized;
+                }
+                catch (error) {
+                    throw error;
+                }
+            });
+        }
+    }
+    /**
+     * Recursively sanitizes any value
+     */
+    sanitize(data) {
+        if (!data) {
+            return;
+        }
+        const sanitized = xss_validation_1.XSSProtector.sanitize(data), encoded = xss_validation_1.XSSProtector.encode(sanitized);
+        logger_1.default.info({ data, sanitized, encoded }, ':: Sanitized Response ::');
+        return encoded;
     }
     /**
      * Filter the response from chatGpt API and only get the first choice
+     *
      * @param response
      */
     getResponseFirstChoice(response) {
@@ -65,7 +125,7 @@ class BaseService {
         if ((_a = response.data.choices) === null || _a === void 0 ? void 0 : _a.length) {
             const firstChatGptResponseMessage = response.data.choices[0].message;
             logger_1.default.info(`First ChatGpt Message: ${firstChatGptResponseMessage.content}`);
-            return firstChatGptResponseMessage.content;
+            return JSON.parse(firstChatGptResponseMessage.content);
         }
         return undefined;
     }

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

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

package/dist/services/ChatService/ChatService.js

@@ -19,10 +19,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _ChatService_instances, _ChatService_formatConversationHistory;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatService = void 0;
-const ChatGptMessage_1 = require("../../models/ChatGptMessage");
-const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
+const ChatGPTMessage_1 = require("../../models/ChatGPTMessage");
+const constants_1 = require("../../utils/constants");
 const logger_1 = __importDefault(require("../logger"));
-const constants_1 = require("../../constants");
+const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 class ChatService extends BaseService_1.default {
     constructor(apiKey, model, apiUrl, maxNumberOfChoices) {
         super(apiKey, model, apiUrl, maxNumberOfChoices);
@@ -45,10 +45,15 @@ class ChatService extends BaseService_1.default {
                 model: this.model,
                 messages: __classPrivateFieldGet(this, _ChatService_instances, "m", _ChatService_formatConversationHistory).call(this, context, conversationHistory),
             };
-            logger_1.default.info(`:: ChatService.ask :: ${JSON.stringify(requestBody)}`);
+            logger_1.default.info({
+                requestBody: JSON.stringify(requestBody)
+            }, ':: ChatService.ask :: Request Body');
             try {
                 const response = yield this.request.post('', requestBody);
-                return this.getResponseFirstChoice(response);
+                return {
+                    data: this.getResponseFirstChoice(response),
+                    usageTokens: this.getResponseUsageTokens(response),
+                };
             }
             catch (e) {
                 this.handleErrors(e);
@@ -61,7 +66,7 @@ exports.ChatService = ChatService;
 _ChatService_instances = new WeakSet(), _ChatService_formatConversationHistory = function _ChatService_formatConversationHistory(context, conversationHistory) {
     const formatted = [
         {
-            role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+            role: ChatGPTMessage_1.ChatGPTRole.SYSTEM,
             content: context || constants_1.DEFAULT_PROMPT,
         }
     ];
@@ -71,19 +76,19 @@ _ChatService_instances = new WeakSet(), _ChatService_formatConversationHistory =
             for (const body of messageBody) {
                 if (body.type === constants_1.MESSAGE_TYPES.text && message.from === constants_1.MESSAGE_SENDER.visitor) {
                     formatted.push({
-                        role: ChatGptMessage_1.ChatGptRole.USER,
+                        role: ChatGPTMessage_1.ChatGPTRole.USER,
                         content: body.text
                     });
                 }
                 else if (body.type === constants_1.MESSAGE_TYPES.text && message.from === constants_1.MESSAGE_SENDER.chatbot) {
                     formatted.push({
-                        role: ChatGptMessage_1.ChatGptRole.ASSISTANT,
+                        role: ChatGPTMessage_1.ChatGPTRole.ASSISTANT,
                         content: body.text
                     });
                 }
                 else if (body.type === constants_1.MESSAGE_TYPES.button && message.from === constants_1.MESSAGE_SENDER.chatbot) {
                     formatted.push({
-                        role: ChatGptMessage_1.ChatGptRole.ASSISTANT,
+                        role: ChatGPTMessage_1.ChatGPTRole.ASSISTANT,
                         content: body.label
                     });
                 }

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

@@ -1,8 +1,7 @@
-import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
-import ChatGptMessage from '../../models/ChatGptMessage';
-import Item from '../../models/Item';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 export declare class CopilotService extends BaseService {
+    #private;
     assistantId: string | undefined;
     threadId: string | undefined;
     conversationId: string | undefined;
@@ -19,21 +18,21 @@ export declare class CopilotService extends BaseService {
      * this will make it easy to ask chatGpt for quick replies
      * @param conversation
      */
-    suggest(conversation: string): Promise<ChatGptResponse | 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
-     * @param items the items to recommend from
+     * Get suggestions from Chat Completion API.
+     *
+     * @param message
      */
-    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<string | undefined>;
+    getChatCompletionSuggestions(conversation: string): Promise<ChatGPTResponse | undefined>;
     /**
      * Get the reply of the assistant if the assistant_id is available
      *
      * @param message
      */
-    getAssistantReply(message: string): Promise<ChatGptResponse | undefined>;
+    getAssistantSuggestions(conversation: string): Promise<ChatGPTResponse | undefined>;
     private isAssistantIdFormat;
     private isPromptIdFormat;
     private ensureConversation;
-    getPromptReply(message: string): Promise<ChatGptResponse | undefined>;
+    getPromptSuggestions(message: string): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/CopilotService/CopilotService.js

@@ -8,18 +8,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _CopilotService_instances, _CopilotService_processSuggestions;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CopilotService = void 0;
-const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
+const ChatGPTMessage_1 = require("../../models/ChatGPTMessage");
 const logger_1 = __importDefault(require("../logger"));
-const ChatGptMessage_1 = require("../../models/ChatGptMessage");
 const openai_1 = __importDefault(require("openai"));
+const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 class CopilotService extends BaseService_1.default {
     constructor(apiKey, model, assistantId, threadId, apiUrl, maxNumberOfChoices) {
         super(apiKey, model, apiUrl, maxNumberOfChoices);
+        _CopilotService_instances.add(this);
         Object.defineProperty(this, "assistantId", {
             enumerable: true,
             configurable: true,
@@ -56,8 +63,8 @@ class CopilotService extends BaseService_1.default {
     suggest(conversation) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!(conversation === null || conversation === void 0 ? void 0 : conversation.length)) {
-                logger_1.default.error('conversation must be provided');
-                return Promise.reject(new Error('conversation must be provided'));
+                logger_1.default.error('Conversation must be provided');
+                return Promise.reject(new Error('Conversation must be provided'));
             }
             try {
                 if (this.assistantId) {
@@ -71,28 +78,11 @@ class CopilotService extends BaseService_1.default {
                     }
                     // Route based on id shape: asst_* => Assistant API, prompt_* => Responses API
                     if (this.isAssistantIdFormat(this.assistantId)) {
-                        return yield this.getAssistantReply(lastCustomerMessage);
+                        return yield this.getAssistantSuggestions(conversation);
                     }
-                    return yield this.getPromptReply(lastCustomerMessage);
+                    return yield this.getPromptSuggestions(lastCustomerMessage);
                 }
-                // 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
-          Your response must only contains a valid JSON array of strings like this:
-          ["Reply 1", "Reply 2", "Reply 3"]. the conversation is:-\n${conversation}`, 
-                // main prompt will be the whole conversation as string
-                mainPromptMessage = {
-                    role: ChatGptMessage_1.ChatGptRole.USER,
-                    content: mainPrompt,
-                }, 
-                // the body we need to send to the request
-                requestBody = {
-                    model: this.chatGptModel,
-                    messages: [mainPromptMessage],
-                }, response = yield this.request.post('', requestBody);
-                return {
-                    firstChoice: this.getResponseFirstChoice(response),
-                    usageTokens: this.getResponseUsageTokens(response),
-                };
+                return yield this.getChatCompletionSuggestions(conversation);
             }
             catch (e) {
                 this.handleErrors(e);
@@ -101,35 +91,30 @@ class CopilotService extends BaseService_1.default {
         });
     }
     /**
-     * this will request chatGPT to recommend product or item based on the whole conversation
-     * @param conversation the whole chat conversation
-     * @param items the items to recommend from
+     * Get suggestions from Chat Completion API.
+     *
+     * @param message
      */
-    recommend(conversation, items) {
+    getChatCompletionSuggestions(conversation) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(items === null || items === void 0 ? void 0 : items.length) || !(conversation === null || conversation === void 0 ? void 0 : conversation.length)) {
-                logger_1.default.error('conversation or items not found');
-                return Promise.reject(new Error('conversation and items must be provided'));
-            }
-            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`, 
-                // main prompt will be the first message of the whole conversation
-                firstMessage = {
-                    role: ChatGptMessage_1.ChatGptRole.ASSISTANT,
-                    content: mainPrompt,
-                }, 
-                // the body we need to send to the request
-                requestBody = {
-                    model: this.chatGptModel,
-                    messages: [firstMessage, ...conversation],
-                }, response = yield this.request.post('', requestBody);
-                return this.getResponseFirstChoice(response);
-            }
-            catch (e) {
-                this.handleErrors(e);
-                return Promise.reject(e);
-            }
+            // 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
+        Your response must only contains a valid JSON array of strings like this:
+        ["Reply 1", "Reply 2", "Reply 3"]. the conversation is:-\n${conversation}`, 
+            // main prompt will be the whole conversation as string
+            mainPromptMessage = {
+                role: ChatGPTMessage_1.ChatGPTRole.USER,
+                content: mainPrompt,
+            }, 
+            // the body we need to send to the request
+            requestBody = {
+                model: this.chatGptModel,
+                messages: [mainPromptMessage],
+            }, response = yield this.request.post('', requestBody);
+            return {
+                data: __classPrivateFieldGet(this, _CopilotService_instances, "m", _CopilotService_processSuggestions).call(this, this.getResponseFirstChoice(response)),
+                usageTokens: this.getResponseUsageTokens(response),
+            };
         });
     }
     /**
@@ -137,24 +122,30 @@ class CopilotService extends BaseService_1.default {
      *
      * @param message
      */
-    getAssistantReply(message) {
+    getAssistantSuggestions(conversation) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            // Here we get the last customer message as we dont need the whole conversation
+            // as we are doing with the other approach.
+            const conversationArray = conversation.split('\n'), lastCustomerMessage = conversationArray.reverse().find(e => e.includes('customer:'));
+            if (!lastCustomerMessage) {
+                logger_1.default.error('Last customer message not found');
+                return Promise.reject(new Error('Last customer message not found'));
+            }
             const openai = new openai_1.default({ apiKey: this.openaiApiKey });
             let run;
             if (!this.threadId) {
                 const thread = yield openai.beta.threads.create();
                 this.threadId = thread.id;
             }
-            const lastThreadMessasges = yield openai.beta.threads.messages.list(this.threadId, { order: "desc", limit: 2 });
-            const isRepeatedMessage = lastThreadMessasges.data.find(msg => msg.content[0].type === 'text' && msg.content[0].text.value === message);
+            const lastThreadMessasges = yield openai.beta.threads.messages.list(this.threadId, { order: "desc", limit: 2 }), isRepeatedMessage = lastThreadMessasges.data.find(msg => msg.content[0].type === 'text' && msg.content[0].text.value === lastCustomerMessage);
             // making sure that we're not saving repeated messages
             if (isRepeatedMessage) {
                 const runs = yield openai.beta.threads.runs.list(this.threadId, { order: "desc", limit: 1 });
                 run = runs.data[0];
             }
             else {
-                yield openai.beta.threads.messages.create(this.threadId, { role: "user", content: message });
+                yield openai.beta.threads.messages.create(this.threadId, { role: "user", content: lastCustomerMessage });
                 run = yield openai.beta.threads.runs.create(this.threadId, { assistant_id: (_a = this.assistantId) !== null && _a !== void 0 ? _a : '' });
             }
             while (['queued', 'in_progress', 'cancelling'].includes(run.status)) {
@@ -162,13 +153,11 @@ class CopilotService extends BaseService_1.default {
                 run = yield openai.beta.threads.runs.retrieve(run.id, { thread_id: run.thread_id });
             }
             if (run.status === 'completed') {
-                const { data } = yield openai.beta.threads.messages.list(run.thread_id, { order: 'desc', limit: 1 });
-                const messages = data.flatMap((message) => message === null || message === void 0 ? void 0 : message.content.map((content) => ((content.type === 'text' && message.role === 'assistant') ? content.text : '')));
-                const assistantMessages = messages.filter(message => typeof message === 'object' && 'value' in message && typeof message.value === 'string');
+                const { data } = yield openai.beta.threads.messages.list(run.thread_id, { order: 'desc', limit: 1 }), messages = data.flatMap((message) => message === null || message === void 0 ? void 0 : message.content.map((content) => ((content.type === 'text' && message.role === 'assistant') ? content.text : ''))), assistantMessages = messages.filter(message => typeof message === 'object' && 'value' in message && typeof message.value === 'string');
                 if (assistantMessages.length) {
-                    let answers = assistantMessages.map(message => message.value);
+                    const answers = assistantMessages.map(message => message.value);
                     return {
-                        firstChoice: JSON.stringify(answers),
+                        data: __classPrivateFieldGet(this, _CopilotService_instances, "m", _CopilotService_processSuggestions).call(this, answers),
                         threadId: run.thread_id,
                         usageTokens: run.usage,
                     };
@@ -193,7 +182,7 @@ class CopilotService extends BaseService_1.default {
             return conv.id;
         });
     }
-    getPromptReply(message) {
+    getPromptSuggestions(message) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         return __awaiter(this, void 0, void 0, function* () {
             const openai = new openai_1.default({ apiKey: this.openaiApiKey });
@@ -221,7 +210,7 @@ class CopilotService extends BaseService_1.default {
             if (assistantMessages.length) {
                 const text = assistantMessages.flatMap((m) => { var _a, _b; return ((_b = (_a = m.content) === null || _a === void 0 ? void 0 : _a.filter((c) => c.type === 'output_text')) === null || _b === void 0 ? void 0 : _b.map((c) => c.text)) || []; });
                 return {
-                    firstChoice: text.pop(),
+                    data: JSON.stringify([text.pop()]),
                     threadId: this.conversationId,
                     usageTokens: {
                         prompt_tokens: Number((_c = ((_b = response.usage) === null || _b === void 0 ? void 0 : _b.prompt_tokens)) !== null && _c !== void 0 ? _c : 0),
@@ -232,7 +221,7 @@ class CopilotService extends BaseService_1.default {
             }
             if (response.output_text) {
                 return {
-                    firstChoice: response.output_text,
+                    data: JSON.stringify([response.output_text]),
                     threadId: this.conversationId,
                     usageTokens: {
                         prompt_tokens: Number((_j = ((_h = response.usage) === null || _h === void 0 ? void 0 : _h.prompt_tokens)) !== null && _j !== void 0 ? _j : 0),
@@ -246,3 +235,8 @@ class CopilotService extends BaseService_1.default {
     }
 }
 exports.CopilotService = CopilotService;
+_CopilotService_instances = new WeakSet(), _CopilotService_processSuggestions = function _CopilotService_processSuggestions(suggestions) {
+    suggestions = suggestions ? suggestions : [];
+    suggestions = suggestions.filter(suggestion => !!suggestion.trim());
+    return suggestions;
+};

package/dist/services/ResponseService/ResponseService.d.ts

@@ -1,5 +1,4 @@
-import ChatGptResponse from '../../models/ChatGptResponse';
-import OpenAI from "openai";
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 import BaseService from '../BaseService/BaseService';
 interface ResponseServiceOptions {
     instructions?: string;
@@ -14,7 +13,7 @@ export declare class ResponseService extends BaseService {
     lastResponseId: string | undefined;
     constructor(apiKey?: string, promptId?: string, conversationId?: string);
     /**
-     * Create a new conversation/response chain
+     * Create a new conversation
      */
     createConversation(): Promise<string>;
     /**
@@ -23,9 +22,7 @@ export declare class ResponseService extends BaseService {
      * @param message
      * @param runOptions
      */
-    getReply(message: string, runOptions?: ResponseServiceOptions): Promise<ChatGptResponse | undefined>;
-    handleFunctionOutputs(openai: OpenAI, functionOutputs: string, runOptions?: ResponseServiceOptions): Promise<ChatGptResponse>;
-    processResponseOutput(response: any): ChatGptResponse;
+    getReply(message: string, runOptions?: ResponseServiceOptions): Promise<ChatGPTResponse | undefined>;
     reset(): void;
     getConversationId(): string | undefined;
     getLastResponseId(): string | undefined;

package/dist/services/ResponseService/ResponseService.js

@@ -41,11 +41,10 @@ class ResponseService extends BaseService_1.default {
         this.conversationId = conversationId;
     }
     /**
-     * Create a new conversation/response chain
+     * Create a new conversation
      */
     createConversation() {
         return __awaiter(this, void 0, void 0, function* () {
-            // Create a real conversation using the Conversations API
             const openai = new openai_1.default({ apiKey: this.openaiApiKey });
             const conversation = yield openai.conversations.create();
             this.conversationId = conversation.id;
@@ -68,38 +67,54 @@ class ResponseService extends BaseService_1.default {
             logger_1.default.info(`New response with message: ${message} & options: ${JSON.stringify(runOptions)}`);
             const openai = new openai_1.default({ apiKey: this.openaiApiKey });
             try {
-                if (runOptions.functionOutputs) {
-                    return yield this.handleFunctionOutputs(openai, runOptions.functionOutputs, runOptions);
-                }
-                if (!runOptions.conversationId && !this.conversationId) {
-                    const createdId = yield this.createConversation();
-                    this.conversationId = createdId;
-                }
                 const responseRequest = {
-                    input: message,
                     store: true,
-                    include: ['file_search_call.results'],
                 };
+                // Handle function outputs
+                if (runOptions.functionOutputs) {
+                    const toolOutputs = JSON.parse(runOptions.functionOutputs);
+                    const formattedInputs = toolOutputs.map((output) => ({
+                        type: 'function_call_output',
+                        call_id: output.call_id,
+                        output: output.output
+                    }));
+                    responseRequest.input = formattedInputs;
+                    const conversationIdToUse = runOptions.conversationId || this.conversationId;
+                    if (!conversationIdToUse) {
+                        const createdId = yield this.createConversation();
+                        this.conversationId = createdId;
+                    }
+                    responseRequest.conversation = runOptions.conversationId || this.conversationId;
+                }
+                else {
+                    // Handle regular message
+                    if (!runOptions.conversationId && !this.conversationId) {
+                        const createdId = yield this.createConversation();
+                        this.conversationId = createdId;
+                    }
+                    responseRequest.input = message;
+                    responseRequest.include = ['file_search_call.results'];
+                    if (runOptions.instructions) {
+                        responseRequest.instructions = runOptions.instructions;
+                    }
+                    const conversationIdToUse = runOptions.conversationId || this.conversationId;
+                    if (conversationIdToUse) {
+                        responseRequest.conversation = conversationIdToUse;
+                    }
+                    if ((_a = runOptions.tools) === null || _a === void 0 ? void 0 : _a.length) {
+                        responseRequest.tools = runOptions.tools;
+                    }
+                    if (runOptions.definedSchema) {
+                        responseRequest.text = {
+                            format: runOptions.definedSchema
+                        };
+                    }
+                }
                 if (this.promptId) {
                     responseRequest.prompt = {
                         id: this.promptId
                     };
                 }
-                if (runOptions.instructions) {
-                    responseRequest.instructions = runOptions.instructions;
-                }
-                const conversationIdToUse = runOptions.conversationId || this.conversationId;
-                if (conversationIdToUse) {
-                    responseRequest.conversation = conversationIdToUse;
-                }
-                if ((_a = runOptions.tools) === null || _a === void 0 ? void 0 : _a.length) {
-                    responseRequest.tools = runOptions.tools;
-                }
-                if (runOptions.definedSchema) {
-                    responseRequest.text = {
-                        format: runOptions.definedSchema
-                    };
-                }
                 const response = yield openai.responses.create(responseRequest);
                 this.lastResponseId = response.id;
                 if ((_b = response.conversation) === null || _b === void 0 ? void 0 : _b.id) {
@@ -108,84 +123,49 @@ class ResponseService extends BaseService_1.default {
                 else if (runOptions.conversationId) {
                     this.conversationId = runOptions.conversationId;
                 }
-                return this.processResponseOutput(response);
-            }
-            catch (error) {
-                logger_1.default.error('Error in ResponseService.getReply:', error);
-                return Promise.reject(error);
-            }
-        });
-    }
-    handleFunctionOutputs(openai, functionOutputs, runOptions = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const toolOutputs = JSON.parse(functionOutputs);
-                const formattedInputs = toolOutputs.map((output) => ({
-                    type: 'function_call_output',
-                    call_id: output.call_id,
-                    output: output.output
-                }));
-                const responseRequest = {
-                    input: formattedInputs,
-                    store: true,
-                };
-                const conversationIdToUse = runOptions.conversationId || this.conversationId;
-                if (!conversationIdToUse) {
-                    const createdId = yield this.createConversation();
-                    this.conversationId = createdId;
+                // Process response output
+                const output = response.output || [];
+                const assistantMessages = output.filter((item) => item.type === 'message' && item.role === 'assistant');
+                const functionCalls = output.filter((item) => item.type === 'function_call');
+                if (functionCalls.length > 0) {
+                    return {
+                        requiredActions: JSON.stringify(functionCalls),
+                        threadId: this.conversationId,
+                        usageTokens: response.usage,
+                    };
                 }
-                responseRequest.conversation = runOptions.conversationId || this.conversationId;
-                if (this.promptId) {
-                    responseRequest.prompt = {
-                        id: this.promptId
+                if (assistantMessages.length > 0) {
+                    const textContent = assistantMessages
+                        .flatMap((msg) => msg.content || [])
+                        .filter((content) => content.type === 'output_text' || content.type === 'text')
+                        .map((content) => content.text || content.value)
+                        .filter((text) => text);
+                    if (textContent.length > 0) {
+                        return {
+                            data: textContent.pop(),
+                            threadId: this.conversationId,
+                            usageTokens: response.usage,
+                        };
+                    }
+                }
+                if (response.output_text) {
+                    return {
+                        data: response.output_text,
+                        threadId: this.conversationId,
+                        usageTokens: response.usage,
                     };
                 }
-                const response = yield openai.responses.create(responseRequest);
-                this.lastResponseId = response.id;
-                return this.processResponseOutput(response);
-            }
-            catch (error) {
-                logger_1.default.error('Error handling function outputs:', error);
-                throw error;
-            }
-        });
-    }
-    processResponseOutput(response) {
-        const output = response.output || [];
-        const assistantMessages = output.filter((item) => item.type === 'message' && item.role === 'assistant');
-        const functionCalls = output.filter((item) => item.type === 'function_call');
-        if (functionCalls.length > 0) {
-            return {
-                requiredActions: JSON.stringify(functionCalls),
-                threadId: this.conversationId,
-                usageTokens: response.usage,
-            };
-        }
-        if (assistantMessages.length > 0) {
-            const textContent = assistantMessages
-                .flatMap((msg) => msg.content || [])
-                .filter((content) => content.type === 'output_text' || content.type === 'text')
-                .map((content) => content.text || content.value)
-                .filter((text) => text);
-            if (textContent) {
                 return {
-                    firstChoice: textContent.pop().replace(/【.*?】/g, ''),
+                    data: undefined,
                     threadId: this.conversationId,
                     usageTokens: response.usage,
                 };
             }
-        }
-        if (response.output_text) {
-            return {
-                firstChoice: response.output_text.replace(/【.*?】/g, ''),
-                threadId: this.conversationId,
-                usageTokens: response.usage,
-            };
-        }
-        return {
-            threadId: this.conversationId,
-            usageTokens: response.usage,
-        };
+            catch (error) {
+                logger_1.default.error('Error in ResponseService.getReply:', error);
+                return Promise.reject(error);
+            }
+        });
     }
     reset() {
         this.lastResponseId = undefined;

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

@@ -1,5 +1,5 @@
 import BaseService from '../BaseService/BaseService';
-import ChatGptResponse from '../../models/ChatGptResponse';
+import ChatGPTResponse from '../../models/ChatGPTResponse';
 export declare class TranslationService extends BaseService {
     constructor(apiKey?: string, model?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
@@ -9,17 +9,17 @@ 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<ChatGptResponse | undefined>;
+    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>;
+    findTextLanguage(text: string): Promise<ChatGPTResponse | undefined>;
     /**
      * Detects the ISO language code of a text based on frequency of words
      *
      * @param text text to detect
      */
-    findTextLanguageBasedOnFrequency(text: string): Promise<ChatGptResponse | undefined>;
+    findTextLanguageBasedOnFrequency(text: string): Promise<ChatGPTResponse | undefined>;
 }

package/dist/services/TranslationService/TranslationService.js

@@ -13,8 +13,8 @@ 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 constants_1 = require("../../utils/constants");
+const ChatGPTMessage_1 = require("../../models/ChatGPTMessage");
 const logger_1 = __importDefault(require("../logger"));
 const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 class TranslationService extends BaseService_1.default {
@@ -42,19 +42,20 @@ class TranslationService extends BaseService_1.default {
                 response_format: { type: 'json_object' },
                 messages: [
                     {
-                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        role: ChatGPTMessage_1.ChatGPTRole.SYSTEM,
                         content: constants_1.TRANSLATION_SYSTEM_ROLE,
                     },
                     {
-                        role: ChatGptMessage_1.ChatGptRole.USER,
+                        role: ChatGPTMessage_1.ChatGPTRole.USER,
                         content: translateText,
                     },
                 ],
             };
             try {
+                logger_1.default.info({ requestBody }, ':: TranslationServicee.translate :: Translating ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.getResponseFirstChoice(response),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }
@@ -80,19 +81,20 @@ class TranslationService extends BaseService_1.default {
                 response_format: { type: 'json_object' },
                 messages: [
                     {
-                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        role: ChatGPTMessage_1.ChatGPTRole.SYSTEM,
                         content: constants_1.LANGUAGE_DETECTION_SYSTEM_ROLE,
                     },
                     {
-                        role: ChatGptMessage_1.ChatGptRole.USER,
+                        role: ChatGPTMessage_1.ChatGPTRole.USER,
                         content: translateText,
                     }
                 ],
             };
             try {
+                logger_1.default.info({ requestBody }, ':: TranslationServicee.findTextLanguage :: Finding text language ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.getResponseFirstChoice(response),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }
@@ -118,19 +120,20 @@ class TranslationService extends BaseService_1.default {
                 response_format: { type: 'json_object' },
                 messages: [
                     {
-                        role: ChatGptMessage_1.ChatGptRole.SYSTEM,
+                        role: ChatGPTMessage_1.ChatGPTRole.SYSTEM,
                         content: constants_1.WORD_FREQUENCY_LANGUAGE_DETECTION_SYSTEM_ROLE,
                     },
                     {
-                        role: ChatGptMessage_1.ChatGptRole.USER,
+                        role: ChatGPTMessage_1.ChatGPTRole.USER,
                         content: translateText,
                     }
                 ],
             };
             try {
+                logger_1.default.info({ requestBody }, ':: TranslationServicee.findTextLanguageBasedOnFrequency :: Finding text language ::');
                 const response = yield this.request.post('', requestBody);
                 return {
-                    firstChoice: this.getResponseFirstChoice(response),
+                    data: this.getResponseFirstChoice(response),
                     usageTokens: this.getResponseUsageTokens(response),
                 };
             }

package/dist/utils/Response.d.ts

@@ -0,0 +1,4 @@
+import { Response } from '../models/Response';
+export declare class ResponseBuilder {
+    static build<Data>(data: Data): Response<Data>;
+}

package/dist/utils/Response.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseBuilder = void 0;
+class ResponseBuilder {
+    static build(data) {
+        return {
+            result: data,
+        };
+    }
+}
+exports.ResponseBuilder = ResponseBuilder;

package/dist/utils/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const MESSAGE_SENDER: {
+    visitor: string;
+    chatbot: string;
+};
+export declare const MESSAGE_TYPES: {
+    text: string;
+    button: string;
+};
+export declare const DEFAULT_PROMPT = "\n  You are a helpful assistant. Your role is to address visitor \n  queries related to the ongoing conversation and the last message received. Please ensure \n  that responses remain within the ongoing conversation. Politely decline any user queries \n  that is not present in the ongoing conversation. \n\n  You will always respond with a JSON. It will be in the format: \n\n  { answer: '', suggestions: [], connectWithAgent: true or false }\n\n  Fields in the JSON:\n\n  Answer: It will consist of the user's query answer based on the ongoing conversation. \n  Restrict this field to 100 characters.\n\n  Suggestions: Request 2 suggestions from user's perspective that he can ask. \n  It should be an array of strings. Restrict each suggestion to 50 characters.\n  \n  ConnectWithAgent: It is a boolean. It should be set to true if the user's query is \n  not found in the ongoing conversation. Politely tell the user to talk to a real agent. \n  Also 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  - 'translations': it is 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', ensuring it is natural, culturally appropriate, and commonly used by native speakers. The tone should be formal.\n  - 'isError': a boolean value (true if translation fails, false otherwise).\n\n  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** \n\n  Ensure that 'translation' accurately represents the meaning of 'original' while considering formal tone, cultural nuances, usual expressions, and natural phrasing in the target language.\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 \n  appear in the original text.\n\n  Your response must follow this structure strictly.\n";

package/dist/utils/constants.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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',
+    chatbot: 'chatbot'
+};
+// Message types in conversation history
+exports.MESSAGE_TYPES = {
+    text: 'text',
+    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. 
+
+  You will always respond with a JSON. It will be in the format: 
+
+  { answer: '', suggestions: [], connectWithAgent: true or false }
+
+  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.
+
+  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.
+`;
+// 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:
+  - 'translations': it is an array of objects. Each object in the array must contain:
+    - 'original': The original input message before translation.
+    - 'translation: The translated version of 'original', ensuring it is natural, culturally appropriate, and commonly used by native speakers. The tone should be formal.
+  - 'isError': a boolean value (true if translation fails, false otherwise).
+
+  **You MUST return the JSON format even if you fail to translate the text. In this case, translations field will be empty array and isError should be true.** 
+
+  Ensure that 'translation' accurately represents the meaning of 'original' while considering formal tone, cultural nuances, usual expressions, and natural phrasing in the target language.
+
+  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.
+
+  Your response must follow this structure strictly.
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.7.32-dev.0",
+  "version": "0.7.32-dev.2",
   "description": "chatgpt services to connect our projects with chatgpt api",
   "keywords": [
     "chatgpt",
@@ -22,6 +22,7 @@
   },
   "dependencies": {
     "@cobrowser/logger": "^2.0.6",
+    "@cobrowser/xss-validation": "^2.0.1",
     "axios": "^1.6.1",
     "axios-mock-adapter": "^1.22.0",
     "openai": "^6.3.0"
@@ -39,5 +40,5 @@
   "bugs": {
     "url": "https://bitbucket.org/cobrowser/cb_utils/issues"
   },
-  "gitHead": "246db1800e2c2238ae01d99a69c971fe6ecd4795"
+  "gitHead": "599a71119dc7aadc13737d41bea48957b738dfa8"
 }