@cobrowser/chatgpt 0.4.1 → 0.5.2

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 +1,2 @@
 export * from './services/TranslationService/TranslationService';
+export * from './services/CopilotService/CopilotService';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,4 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const CopilotService_1 = require("./services/CopilotService/CopilotService");
 __exportStar(require("./services/TranslationService/TranslationService"), exports);
+__exportStar(require("./services/CopilotService/CopilotService"), exports);
+const copilotService = new CopilotService_1.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);

package/dist/models/Item.d.ts

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

package/dist/models/Item.js

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

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

@@ -0,0 +1,98 @@
+"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 });
+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 {
+    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)) {
+                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
+                const firstMessage = {
+                    role: ChatGptMessage_1.ChatGptRole.ASSISTANT,
+                    content: mainPrompt,
+                };
+                // the body we need to send to the request
+                const requestBody = {
+                    model: this.chatGptModel,
+                    messages: [firstMessage, ...conversation],
+                };
+                const response = yield this.request.post('', requestBody);
+                return this.getResponseFirstChoice(response);
+            }
+            catch (e) {
+                this.handleErrors(e);
+                return Promise.reject(e);
+            }
+        });
+    }
+}
+exports.CopilotService = CopilotService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobrowser/chatgpt",
-  "version": "0.4.1",
+  "version": "0.5.2",
   "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": "77659f6a9a47d7199bc70985aad19ac8e7616355"
+  "gitHead": "42de31ffab1af1627e6c16a19b19b5861d477088"
 }