@cobrowser/chatgpt 0.5.1 → 0.5.3

package/README.md

@@ -13,6 +13,29 @@ the API key will be used to make authorization with the openAI APIs
 
 we will have a list of services to use for different purposes
 
+### CoPilotService 
+a service that can be used to make products recommendation and quick replies suggestion
+
+**Usage** 
+
+to suggest some quick replies for a conversation 
+
+```
+const { CopilotService } = require('@cobrowser/chatgpt');
+const copilotService = new CopilotService();
+const conversation = `
+  Customer: Hello
+  Agent: Hello
+  Customer: Need some help
+`;
+
+/**
+ * return a promise that will resolve a string ( a list of suggestions )  or an undefined or an error
+ */
+copilotService.suggest(conversation);
+
+```
+
 ### Translation Service 
 can be used to translate a text from one language to another
 

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 export * from './services/TranslationService/TranslationService';
-export * from './services/CoPilotService/CoPilotService';
+export * from './services/CopilotService/CopilotService';

package/dist/index.js

@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./services/TranslationService/TranslationService"), exports);
-__exportStar(require("./services/CoPilotService/CoPilotService"), exports);
+__exportStar(require("./services/CopilotService/CopilotService"), exports);

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

@@ -0,0 +1,25 @@
+import BaseService from '../BaseService/BaseService';
+import ChatGptMessage from '../../models/ChatGptMessage';
+import Item from '../../models/Item';
+export declare class CopilotService extends BaseService {
+    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number);
+    /**
+     * a method to be used to suggest some quick replies for the agent based on the conversation
+     *  will be added as a single string in the format
+     * ```
+     * customer: hi
+     * agent: hi
+     * customer: I need some help
+     * ```
+     *
+     * this will make it easy to ask chatGpt for quick replies
+     * @param conversation
+     */
+    suggest(conversation: string): Promise<string | 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
+     */
+    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<string | undefined>;
+}

package/dist/services/{CoPilotService/CoPilotService.js → CopilotService/CopilotService.js}

@@ -12,14 +12,60 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoPilotService = void 0;
+exports.CopilotService = void 0;
 const BaseService_1 = __importDefault(require("../BaseService/BaseService"));
 const logger_1 = __importDefault(require("../logger"));
 const ChatGptMessage_1 = require("../../models/ChatGptMessage");
-class CoPilotService extends BaseService_1.default {
+class CopilotService extends BaseService_1.default {
     constructor(apiUrl, model, maxNumberOfChoices) {
         super(apiUrl, model, maxNumberOfChoices);
     }
+    /**
+     * a method to be used to suggest some quick replies for the agent based on the conversation
+     *  will be added as a single string in the format
+     * ```
+     * customer: hi
+     * agent: hi
+     * customer: I need some help
+     * ```
+     *
+     * this will make it easy to ask chatGpt for quick replies
+     * @param conversation
+     */
+    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'));
+            }
+            try {
+                // main prompt used to instruct chatGPT to suggest some quick replies
+                const mainPrompt = `Propose some quick replies for the agent to be used on the following conversation
+          display your response as unordered list:-\n${conversation}`;
+                // main prompt will be the whole conversation as string
+                const mainPromptMessage = {
+                    role: ChatGptMessage_1.ChatGptRole.USER,
+                    content: mainPrompt,
+                };
+                // the body we need to send to the request
+                const requestBody = {
+                    model: this.chatGptModel,
+                    messages: [mainPromptMessage],
+                };
+                const response = yield this.request.post('', requestBody);
+                return this.getResponseFirstChoice(response);
+            }
+            catch (e) {
+                this.handleErrors(e);
+                return Promise.reject(e);
+            }
+        });
+    }
+    /**
+     * 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
+     */
     recommend(conversation, items) {
         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)) {
@@ -49,4 +95,4 @@ class CoPilotService extends BaseService_1.default {
         });
     }
 }
-exports.CoPilotService = CoPilotService;
+exports.CopilotService = CopilotService;

package/package.json

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

package/dist/services/CoPilotService/CoPilotService.d.ts

@@ -1,7 +0,0 @@
-import BaseService from '../BaseService/BaseService';
-import ChatGptMessage from '../../models/ChatGptMessage';
-import Item from '../../models/Item';
-export declare class CoPilotService extends BaseService {
-    constructor(apiUrl?: string, model?: string, maxNumberOfChoices?: number);
-    recommend(conversation: ChatGptMessage[], items: Item[]): Promise<string | undefined>;
-}