@xapp/stentor-service-generative-ai 1.62.41 → 1.62.43

package/lib/OpenAIService.d.ts

@@ -1,11 +1,21 @@
 /*! Copyright (c) 2024, XAPP AI */
 import type { LLMService, LLMServiceResponse, Prompt } from "./models";
 import type { HTTPService } from "./http/HTTPService";
+export declare const DEFAULT_OPEN_AI_URL = "https://api.openai.com";
 export type APIKeyGetter = () => string | Promise<string>;
 export interface OpenAIServiceProps {
+    /**
+     * Returns the API key to use for the OpenAI service authorization
+     */
     keyGetter: APIKeyGetter;
-    openAIUrl: string;
+    /**
+     * The HTTP service to use for making requests
+     */
     httpService: Pick<HTTPService, "post">;
+    /**
+     * The base URL for the OpenAI service
+     */
+    openAIUrl?: string;
 }
 export declare class InvalidPromptTypeError extends Error {
     constructor(type: string);

package/lib/OpenAIService.js

@@ -10,7 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAIService = exports.InvalidPromptTypeError = void 0;
+exports.OpenAIService = exports.InvalidPromptTypeError = exports.DEFAULT_OPEN_AI_URL = void 0;
+exports.DEFAULT_OPEN_AI_URL = "https://api.openai.com";
 class InvalidPromptTypeError extends Error {
     constructor(type) {
         super(`Unknown prompt type: ${type}`);
@@ -21,7 +22,7 @@ exports.InvalidPromptTypeError = InvalidPromptTypeError;
 class OpenAIService {
     constructor(props) {
         this.keyGetter = props.keyGetter;
-        this.openAIUrl = props.openAIUrl;
+        this.openAIUrl = props.openAIUrl || exports.DEFAULT_OPEN_AI_URL;
         this.httpService = props.httpService;
     }
     generate(prompt) {

package/lib/OpenAIService.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAIService.js","sourceRoot":"","sources":["../src/OpenAIService.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;AAalC,MAAa,sBAAuB,SAAQ,KAAK;IAE7C,YAAY,IAAY;QACpB,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACzC,CAAC;CACJ;AAND,wDAMC;AAED,MAAa,aAAa;IAMtB,YAAY,KAAyB;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACzC,CAAC;IAEK,QAAQ,CAAC,MAAc;;YACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;YACxB,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEK,WAAW,CAAC,MAAc;;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;gBAC7B,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,oBACG,MAAM,CACZ;aACJ,CAAC,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,CAAC;KAAA;IAEa,IAAI,CAAC,KAAiD;;YAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;gBACzC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE;oBACL,eAAe,EAAE,UAAU,MAAM,EAAE;iBACtC;aACJ,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAzCD,sCAyCC"}
+{"version":3,"file":"OpenAIService.js","sourceRoot":"","sources":["../src/OpenAIService.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;AAKrB,QAAA,mBAAmB,GAAG,wBAAwB,CAAC;AAkB5D,MAAa,sBAAuB,SAAQ,KAAK;IAE7C,YAAY,IAAY;QACpB,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACzC,CAAC;CACJ;AAND,wDAMC;AAED,MAAa,aAAa;IAMtB,YAAY,KAAyB;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,2BAAmB,CAAC;QACxD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACzC,CAAC;IAEK,QAAQ,CAAC,MAAc;;YACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;YACxB,IAAI,IAAI,KAAK,aAAa,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEK,WAAW,CAAC,MAAc;;YAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;gBAC7B,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,oBACG,MAAM,CACZ;aACJ,CAAC,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,CAAC;KAAA;IAEa,IAAI,CAAC,KAAiD;;YAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;gBACzC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE;oBACL,eAAe,EAAE,UAAU,MAAM,EAAE;iBACtC;aACJ,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAzCD,sCAyCC"}

package/lib/models/ChatSummary.d.ts

@@ -0,0 +1,10 @@
+/*! Copyright (c) 2024, XAPP AI */
+/**
+ * A quick summary returned by the LLM which summerizes the a chat widget transcript.
+ */
+export interface ChatSummary {
+    /**
+     * The summary that is returned by the LLM or undefined if the LLM failed.
+     */
+    summary: string | undefined;
+}

package/lib/models/ChatSummary.js

@@ -0,0 +1,4 @@
+"use strict";
+/*! Copyright (c) 2024, XAPP AI */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ChatSummary.js.map

package/lib/models/ChatSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatSummary.js","sourceRoot":"","sources":["../../src/models/ChatSummary.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/prompts/ChatSummary.d.ts

@@ -0,0 +1,43 @@
+/*! Copyright (c) 2024, XAPP AI */
+import { CompletionPrompt, PromptGenerator, ResponseParser } from "../models";
+import { ChatSummary } from "../models/ChatSummary";
+/**
+ * A conversation line that was said by the user or system.
+ */
+export interface SummaryLine {
+    /**
+     * The user that said the line.
+     */
+    user: string;
+    /**
+     * The content that was said by the user.
+     */
+    line: string;
+}
+/**
+ * The properties that are required to generate a chat summary prompt.
+ */
+export interface ChatSummaryPromptProps {
+    /**
+     * The lines that were said in the conversation.
+     */
+    summary: SummaryLine[];
+}
+export type ChatSummaryLLMOverrides = Partial<Pick<CompletionPrompt, "model" | "max_tokens" | "temperature" | "top_p" | "frequency_penalty" | "presence_penalty">>;
+/**
+ * Generates a prompt that can be used in an LLM to return a summary of a chat conversation.
+ *
+ * The expected output format from the LLM will be:
+ *
+ * <Full summary of the text>
+ *
+ * @param lead - The lead to analyze with the business description and other options to customize the prompt.
+ * @returns
+ */
+export declare const generateChatSummaryPrompt: PromptGenerator<ChatSummaryPromptProps, ChatSummaryLLMOverrides, CompletionPrompt>;
+/**
+ * Parser for the Chat Summary response.
+ * @param response
+ * @returns
+ */
+export declare const chatSummaryResponseParse: ResponseParser<ChatSummary>;

package/lib/prompts/ChatSummary.js

@@ -0,0 +1,54 @@
+"use strict";
+/*! Copyright (c) 2024, XAPP AI */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chatSummaryResponseParse = exports.generateChatSummaryPrompt = void 0;
+/**
+ * Generates a prompt that can be used in an LLM to return a summary of a chat conversation.
+ *
+ * The expected output format from the LLM will be:
+ *
+ * <Full summary of the text>
+ *
+ * @param lead - The lead to analyze with the business description and other options to customize the prompt.
+ * @returns
+ */
+const generateChatSummaryPrompt = ({ summary }, overrides) => {
+    return Object.assign(Object.assign({ model: "gpt-4o-mini", max_tokens: 256, frequency_penalty: 0, temperature: 1, top_p: 1, presence_penalty: 0 }, overrides), { response_format: {
+            type: "text"
+        }, type: "completions", messages: [{
+                role: "system",
+                content: {
+                    type: "text",
+                    text: "Summarize the transcript of a chat between a business's bot on a website and a person." +
+                        "Please summarize as if you are the bot in the transcript and you are taking notes for somebody that will be able to help the person with their query.  You may use first person." +
+                        "Do not call the user, \"user\" but instead use \"Someone\", \"Somebody\" or if they give their name you can use their first name however not last name." +
+                        "If the transcript contains additional identifying information from the user, such as last name, phone number, email address, or addresses then do not include theses in the summary.  If the bot provided contact information for the business, you may include it in your summary." +
+                        "The summary will be then be provided to the business owner so they are aware somebody will be in touch soon with the request they mentioned in the transcript." +
+                        "Keep the summary to one sentence around 100 words." +
+                        "An example of a good summary is:" +
+                        "\"Somebody reached out looking for a quote and I provided them with your contact information.\"" +
+                        "or" +
+                        "\"John reached out looking to schedule an appointment and I provided them with the scheduling link.\""
+                }
+            }, {
+                role: "user",
+                content: {
+                    type: "text",
+                    text: summary.map((s) => `${s.user}: ${s.line}`).join("\n")
+                }
+            }] });
+};
+exports.generateChatSummaryPrompt = generateChatSummaryPrompt;
+/**
+ * Parser for the Chat Summary response.
+ * @param response
+ * @returns
+ */
+const chatSummaryResponseParse = (response) => {
+    const summary = response.trim();
+    return {
+        summary
+    };
+};
+exports.chatSummaryResponseParse = chatSummaryResponseParse;
+//# sourceMappingURL=ChatSummary.js.map

package/lib/prompts/ChatSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatSummary.js","sourceRoot":"","sources":["../../src/prompts/ChatSummary.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;AA+BlC;;;;;;;;;GASG;AACI,MAAM,yBAAyB,GAAuF,CAAC,EAAE,OAAO,EAAE,EAAE,SAAS,EAAoB,EAAE;IACtK,qCACI,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,GAAG,EACf,iBAAiB,EAAE,CAAC,EACpB,WAAW,EAAE,CAAC,EACd,KAAK,EAAE,CAAC,EACR,gBAAgB,EAAE,CAAC,IAChB,SAAS,KACZ,eAAe,EAAE;YACb,IAAI,EAAE,MAAM;SACf,EACD,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,CAAC;gBACP,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,wFAAwF;wBAC1F,kLAAkL;wBAClL,yJAAyJ;wBACzJ,qRAAqR;wBACrR,gKAAgK;wBAChK,oDAAoD;wBACpD,kCAAkC;wBAClC,iGAAiG;wBACjG,IAAI;wBACJ,uGAAuG;iBAC9G;aACJ,EAAE;gBACC,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC9D;aACJ,CAAC,IACL;AACL,CAAC,CAAA;AApCY,QAAA,yBAAyB,6BAoCrC;AAED;;;;GAIG;AACI,MAAM,wBAAwB,GAAgC,CAAC,QAAQ,EAAE,EAAE;IAC9E,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAChC,OAAO;QACH,OAAO;KACV,CAAC;AACN,CAAC,CAAA;AALY,QAAA,wBAAwB,4BAKpC"}

package/lib/prompts/index.d.ts

@@ -1,2 +1,3 @@
 /*! Copyright (c) 2024, XAPP AI */
 export * from "./AnalyzeLead";
+export * from "./ChatSummary";

package/lib/prompts/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AnalyzeLead"), exports);
+__exportStar(require("./ChatSummary"), exports);
 //# sourceMappingURL=index.js.map

package/lib/prompts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/prompts/index.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;;;;;AAElC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/prompts/index.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;;;;;AAElC,gDAA8B;AAC9B,gDAA8B"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.62.41",
+  "version": "1.62.43",
   "description": "Generative AI Service",
   "types": "lib/index",
   "main": "lib/index",
@@ -38,5 +38,5 @@
     "test": "mocha --recursive -r ts-node/register \"./src/**/*.test.ts\"",
     "local": "npm run test"
   },
-  "gitHead": "e12e5ca62659db51c217c978348fdd76b244a4d1"
+  "gitHead": "a997c80519e50a8c7d0253618bdfedf7e4037c62"
 }