@cobrowser/chatgpt 0.7.31 → 0.7.32-dev.0

package/dist/constants.d.ts

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

package/dist/constants.js

@@ -12,27 +12,26 @@ 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';
@@ -53,14 +52,11 @@ 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:
-  - '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.
+  - 'data': it is an array of objects. Each object in the array must contain:
+    - 'translated_message': The original input message before translation.
+    - 'translation: The translated version of 'translated_message', ensuring it is natural, culturally appropriate, and commonly used by native speakers.
   - 'isError': a boolean value (true if translation fails, false otherwise).
 
-  **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.
-
+  Ensure that 'translation' accurately represents the meaning of 'translated_message' while considering cultural nuances, usual expressions, and natural phrasing in the target language.  
   Your response must follow this structure strictly.
 `;

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export * from './services/TranslationService/TranslationService';
 export * from './services/CopilotService/CopilotService';
 export * from './services/ChatService/ChatService';
 export * from './services/AssistantService/AssistantService';
+export * from './services/ResponseService/ResponseService';

package/dist/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./services/TranslationService/TranslationService"), export
 __exportStar(require("./services/CopilotService/CopilotService"), exports);
 __exportStar(require("./services/ChatService/ChatService"), exports);
 __exportStar(require("./services/AssistantService/AssistantService"), exports);
+__exportStar(require("./services/ResponseService/ResponseService"), exports);

package/dist/models/ConversationHistory.d.ts

@@ -1,13 +1,13 @@
 interface ConversationHistory {
-    to: string;
     from: string;
-    body: MessageBody[];
+    to: string;
     datetime: number;
+    body: MessageBody[];
 }
 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;
-    rating?: string;
     category?: string;
-    description?: string;
+    rating?: string;
 }
 export default Item;

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

@@ -1,6 +1,6 @@
-import { AssistantResponseFormatOption } from 'openai/resources/beta/threads/threads';
+import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
-import ChatGPTResponse from '../../models/ChatGPTResponse';
+import { AssistantResponseFormatOption } from 'openai/resources/beta/threads/threads';
 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

@@ -68,19 +68,20 @@ class AssistantService extends BaseService_1.default {
             const openai = new openai_1.default({ apiKey: this.openaiApiKey });
             let run;
             if (runOptions.functionOutputs && this.runId) {
-                run = yield openai.beta.threads.runs.submitToolOutputsAndPoll(this.threadId, this.runId, { tool_outputs: JSON.parse(runOptions.functionOutputs) });
+                run = yield openai.beta.threads.runs.submitToolOutputsAndPoll(this.runId, {
+                    thread_id: this.threadId,
+                    tool_outputs: JSON.parse(runOptions.functionOutputs)
+                });
             }
             else {
-                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);
+                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);
                 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,
@@ -94,16 +95,16 @@ class AssistantService extends BaseService_1.default {
             }
             while (['queued', 'in_progress', 'cancelling'].includes(run.status)) {
                 yield new Promise(resolve => setTimeout(resolve, 500));
-                run = yield openai.beta.threads.runs.retrieve(run.thread_id, run.id);
+                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 }), 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');
+                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');
                 if (assistantMessages.length) {
-                    // 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);
+                    let answer = assistantMessages.map(message => message.value).join('\n');
                     return {
-                        data: parsed,
+                        firstChoice: answer.replace(/【.*?】/g, ''),
                         threadId: run.thread_id,
                         usageTokens: run.usage,
                     };
@@ -111,7 +112,7 @@ class AssistantService extends BaseService_1.default {
             }
             if (run.status === 'requires_action') {
                 return {
-                    requiredActions: run.required_action,
+                    requiredActions: JSON.stringify(run.required_action),
                     threadId: run.thread_id,
                     usageTokens: run.usage,
                 };

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

@@ -1,38 +1,30 @@
 import { AxiosError, AxiosInstance, AxiosResponse } from 'axios';
-import ChatGPTUsageTokens from '../../models/ChatGPTUsageTokens';
+import ChatGptUsageTokens from '../../models/ChatGptUsageTokens';
 declare class BaseService {
-    readonly BASE_CHAT_COMPLETION_URL = "https://api.openai.com/v1/chat/completions";
     request: AxiosInstance;
+    readonly BASE_CHAT_COMPLETION_URL = "https://api.openai.com/v1/chat/completions";
     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): any;
+    getResponseFirstChoice(response: AxiosResponse): string | undefined;
     /**
      * 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,40 +1,31 @@
 "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, "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, "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, "openaiApiKey", {
             enumerable: true,
@@ -64,58 +55,9 @@ 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('handle') ||
-                methodName.includes('Sanitize') ||
-                methodName.includes('sanitize')) {
-                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) {
@@ -123,7 +65,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 JSON.parse(firstChatGptResponseMessage.content);
+            return firstChatGptResponseMessage.content;
         }
         return undefined;
     }

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

@@ -1,9 +1,8 @@
 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<ChatGPTResponse | undefined>;
+    ask(context: string | undefined, conversationHistory: ConversationHistory[]): Promise<string | 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 constants_1 = require("../../utils/constants");
-const logger_1 = __importDefault(require("../logger"));
+const ChatGptMessage_1 = require("../../models/ChatGptMessage");
 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(apiKey, model, apiUrl, maxNumberOfChoices) {
         super(apiKey, model, apiUrl, maxNumberOfChoices);
@@ -45,15 +45,10 @@ 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({
-                requestBody: JSON.stringify(requestBody)
-            }, ':: ChatService.ask :: Request Body');
+            logger_1.default.info(`:: ChatService.ask :: ${JSON.stringify(requestBody)}`);
             try {
                 const response = yield this.request.post('', requestBody);
-                return {
-                    data: this.getResponseFirstChoice(response),
-                    usageTokens: this.getResponseUsageTokens(response),
-                };
+                return this.getResponseFirstChoice(response);
             }
             catch (e) {
                 this.handleErrors(e);
@@ -66,7 +61,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,
         }
     ];
@@ -76,19 +71,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,9 +1,11 @@
+import ChatGptResponse from '../../models/ChatGptResponse';
 import BaseService from '../BaseService/BaseService';
-import ChatGPTResponse from '../../models/ChatGPTResponse';
+import ChatGptMessage from '../../models/ChatGptMessage';
+import Item from '../../models/Item';
 export declare class CopilotService extends BaseService {
-    #private;
     assistantId: string | undefined;
     threadId: string | undefined;
+    conversationId: string | undefined;
     constructor(apiKey?: string, model?: string, assistantId?: string, threadId?: string, apiUrl?: string, maxNumberOfChoices?: number);
     /**
      * a method to be used to suggest some quick replies for the agent based on the conversation
@@ -17,17 +19,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>;
     /**
-     * Get suggestions from Chat Completion API.
-     *
-     * @param message
+     * 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
      */
-    getChatCompletionSuggestions(conversation: string): Promise<ChatGPTResponse | undefined>;
+    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<string | undefined>;
     /**
      * Get the reply of the assistant if the assistant_id is available
      *
      * @param message
      */
-    getAssistantSuggestions(conversation: string): Promise<ChatGPTResponse | undefined>;
+    getAssistantReply(message: string): Promise<ChatGptResponse | undefined>;
+    private isAssistantIdFormat;
+    private isPromptIdFormat;
+    private ensureConversation;
+    getPromptReply(message: string): Promise<ChatGptResponse | undefined>;
 }