@fonoster/autopilot 0.7.32 → 0.7.35

package/README.md

@@ -94,7 +94,30 @@ The Autopilot supports multiple language model providers. The following is a lis
 
 ## Adding Knowledge Base
 
-Coming soon...
+A knowledge base provides information to the language model, such as business hours, services, or products.
+
+Currently, we support retrieving documents from an S3 bucket.
+
+To add a knowledge base, include a new entry in the `knowledgeBase` array in the configuration file. Below is an example of a knowledge for a menu PDF.
+
+```json
+{
+  "conversationSettings": { ... },
+  "languageModel": {
+    "provider": "openai",
+    "model": "gpt-4o-mini",
+    "apiKey": "your-api-key",
+    "maxTokens": 100,
+    "temperature": 0.4,
+    "knowledgeBase": [{
+      "type": "s3",
+      "title": "Menu PDF",
+      "document": "sample.pdf"
+    }],
+    "tools": []
+  }
+}
+```
 
 ## Adding Tools
 
@@ -108,8 +131,9 @@ You can configure a new tool by adding a new entry in the `tools` array in the c
   "languageModel": {
     "provider": "openai",
     "model": "gpt-4o-mini",
-    "maxTokens": 250,
-    "temperature": 0.7,
+    "apiKey": "your-api-key",
+    "maxTokens": 100,
+    "temperature": 0.4,
     "knowledgeBase": [],
     "tools": [
       {

package/dist/assistants/AssistantSchema.d.ts

@@ -227,7 +227,10 @@ declare const languageModelConfigSchema: z.ZodObject<{
         requestStartMessage?: string | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
+    provider: LANGUAGE_MODEL_PROVIDER;
     model: string;
+    temperature: number;
+    maxTokens: number;
     knowledgeBase: {
         type: "s3" | "file";
         url: string;
@@ -253,13 +256,13 @@ declare const languageModelConfigSchema: z.ZodObject<{
         };
         requestStartMessage?: string | undefined;
     }[];
-    temperature: number;
-    maxTokens: number;
-    provider: LANGUAGE_MODEL_PROVIDER;
     apiKey?: string | undefined;
     baseUrl?: string | undefined;
 }, {
+    provider: LANGUAGE_MODEL_PROVIDER;
     model: string;
+    temperature: number;
+    maxTokens: number;
     knowledgeBase: {
         type: "s3" | "file";
         url: string;
@@ -285,9 +288,6 @@ declare const languageModelConfigSchema: z.ZodObject<{
         };
         requestStartMessage?: string | undefined;
     }[];
-    temperature: number;
-    maxTokens: number;
-    provider: LANGUAGE_MODEL_PROVIDER;
     apiKey?: string | undefined;
     baseUrl?: string | undefined;
 }>;
@@ -519,7 +519,10 @@ declare const assistantSchema: z.ZodObject<{
             requestStartMessage?: string | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
+        provider: LANGUAGE_MODEL_PROVIDER;
         model: string;
+        temperature: number;
+        maxTokens: number;
         knowledgeBase: {
             type: "s3" | "file";
             url: string;
@@ -545,13 +548,13 @@ declare const assistantSchema: z.ZodObject<{
             };
             requestStartMessage?: string | undefined;
         }[];
-        temperature: number;
-        maxTokens: number;
-        provider: LANGUAGE_MODEL_PROVIDER;
         apiKey?: string | undefined;
         baseUrl?: string | undefined;
     }, {
+        provider: LANGUAGE_MODEL_PROVIDER;
         model: string;
+        temperature: number;
+        maxTokens: number;
         knowledgeBase: {
             type: "s3" | "file";
             url: string;
@@ -577,9 +580,6 @@ declare const assistantSchema: z.ZodObject<{
             };
             requestStartMessage?: string | undefined;
         }[];
-        temperature: number;
-        maxTokens: number;
-        provider: LANGUAGE_MODEL_PROVIDER;
         apiKey?: string | undefined;
         baseUrl?: string | undefined;
     }>;
@@ -609,7 +609,10 @@ declare const assistantSchema: z.ZodObject<{
         } | undefined;
     };
     languageModel: {
+        provider: LANGUAGE_MODEL_PROVIDER;
         model: string;
+        temperature: number;
+        maxTokens: number;
         knowledgeBase: {
             type: "s3" | "file";
             url: string;
@@ -635,9 +638,6 @@ declare const assistantSchema: z.ZodObject<{
             };
             requestStartMessage?: string | undefined;
         }[];
-        temperature: number;
-        maxTokens: number;
-        provider: LANGUAGE_MODEL_PROVIDER;
         apiKey?: string | undefined;
         baseUrl?: string | undefined;
     };
@@ -667,7 +667,10 @@ declare const assistantSchema: z.ZodObject<{
         } | undefined;
     };
     languageModel: {
+        provider: LANGUAGE_MODEL_PROVIDER;
         model: string;
+        temperature: number;
+        maxTokens: number;
         knowledgeBase: {
             type: "s3" | "file";
             url: string;
@@ -693,9 +696,6 @@ declare const assistantSchema: z.ZodObject<{
             };
             requestStartMessage?: string | undefined;
         }[];
-        temperature: number;
-        maxTokens: number;
-        provider: LANGUAGE_MODEL_PROVIDER;
         apiKey?: string | undefined;
         baseUrl?: string | undefined;
     };

package/dist/createLanguageModel.d.ts

@@ -1,8 +1,8 @@
-import { AssistantConfig, FilesKnowledgeBase, TelephonyContext, Voice } from ".";
+import { AssistantConfig, KnowledgeBase, TelephonyContext, Voice } from ".";
 declare function createLanguageModel(params: {
     voice: Voice;
     assistantConfig: AssistantConfig;
-    knowledgeBase: FilesKnowledgeBase;
+    knowledgeBase: KnowledgeBase;
     telephonyContext: TelephonyContext;
 }): import("./models/AbstractLanguageModel").AbstractLanguageModel;
 export { createLanguageModel };

package/dist/handleVoiceRequest.js

@@ -56,7 +56,6 @@ const common_1 = require("@fonoster/common");
 const logger_1 = require("@fonoster/logger");
 const createLanguageModel_1 = require("./createLanguageModel");
 const loadAssistantConfigFromFile_1 = require("./loadAssistantConfigFromFile");
-const loadKnowledgeBaseFromFile_1 = require("./loadKnowledgeBaseFromFile");
 const _1 = __importStar(require("."));
 const logger = (0, logger_1.getLogger)({ service: "autopilot", filePath: __filename });
 async function handleVoiceRequest(req, res) {
@@ -68,7 +67,8 @@ async function handleVoiceRequest(req, res) {
         metadata: req.metadata
     });
     const assistantConfig = (0, loadAssistantConfigFromFile_1.loadAssistantConfigFromFile)(`${process.cwd()}/config/assistant.json`);
-    const knowledgeBase = await (0, loadKnowledgeBaseFromFile_1.loadKnowledgeBaseFromFile)(`${process.cwd()}/config/sample.pdf`);
+    // const knowledgeBase = await loadKnowledgeBaseFromS3(["sample.pdf"]);
+    const knowledgeBase = await (0, _1.loadKnowledgeBaseFromFiles)(`${process.cwd()}/config/sample.pdf`);
     const voice = new _1.VoiceImpl(sessionRef, res);
     const languageModel = (0, createLanguageModel_1.createLanguageModel)({
         voice,

package/dist/knowledge/AbstractKnowledgeBase.d.ts

@@ -7,7 +7,8 @@ declare abstract class AbstractKnowledgeBase implements KnowledgeBase {
     constructor(params?: {
         embeddings?: Embeddings;
     });
-    abstract load(params: unknown): Promise<void>;
+    abstract getLoaders(): Promise<unknown>;
+    load(): Promise<void>;
     queryKnowledgeBase(query: string, k?: number): Promise<string>;
 }
 export { AbstractKnowledgeBase };

package/dist/knowledge/AbstractKnowledgeBase.js

@@ -2,16 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractKnowledgeBase = void 0;
 const openai_1 = require("@langchain/openai");
+const text_splitter_1 = require("langchain/text_splitter");
+const memory_1 = require("langchain/vectorstores/memory");
 class AbstractKnowledgeBase {
     constructor(params) {
         this.embeddings = params?.embeddings || new openai_1.OpenAIEmbeddings();
     }
+    async load() {
+        const loaders = (await this.getLoaders());
+        if (loaders.length === 0) {
+            throw new Error("No files provided");
+        }
+        const loadedDocs = await Promise.all(loaders.map((loader) => loader.load()));
+        const textSplitter = new text_splitter_1.RecursiveCharacterTextSplitter({
+            chunkSize: 1000,
+            chunkOverlap: 200
+        });
+        const splitDocs = await Promise.all(loadedDocs.map((docs) => textSplitter.splitDocuments(docs)));
+        console.log("xxxx splitDocs", splitDocs);
+        this.vectorStore = await memory_1.MemoryVectorStore.fromDocuments(splitDocs.flat(), this.embeddings);
+    }
     async queryKnowledgeBase(query, k = 2) {
-        const { vectorStore } = this;
-        if (!vectorStore) {
+        if (!this.vectorStore) {
             throw new Error("Vector store is not initialized");
         }
-        const results = await vectorStore.similaritySearch(query, k);
+        const results = await this.vectorStore.similaritySearch(query, k);
         return results.join("\n");
     }
 }

package/dist/knowledge/FilesKnowledgeBase.d.ts

@@ -1,3 +1,4 @@
+import { PDFLoader } from "@langchain/community/document_loaders/fs/pdf";
 import { Embeddings } from "@langchain/core/embeddings";
 import { AbstractKnowledgeBase } from "./AbstractKnowledgeBase";
 declare class FilesKnowledgeBase extends AbstractKnowledgeBase {
@@ -7,6 +8,6 @@ declare class FilesKnowledgeBase extends AbstractKnowledgeBase {
         embeddings?: Embeddings;
         files: string[];
     });
-    load(): Promise<void>;
+    getLoaders(): Promise<PDFLoader[]>;
 }
 export { FilesKnowledgeBase };

package/dist/knowledge/FilesKnowledgeBase.js

@@ -20,8 +20,6 @@ exports.FilesKnowledgeBase = void 0;
  * limitations under the License.
  */
 const pdf_1 = require("@langchain/community/document_loaders/fs/pdf");
-const text_splitter_1 = require("langchain/text_splitter");
-const memory_1 = require("langchain/vectorstores/memory");
 const AbstractKnowledgeBase_1 = require("./AbstractKnowledgeBase");
 class FilesKnowledgeBase extends AbstractKnowledgeBase_1.AbstractKnowledgeBase {
     constructor(params) {
@@ -29,22 +27,11 @@ class FilesKnowledgeBase extends AbstractKnowledgeBase_1.AbstractKnowledgeBase {
         this.params = params;
         this.files = params?.files || [];
     }
-    async load() {
-        const { files } = this;
-        if (files.length === 0) {
-            throw new Error("No files provided");
-        }
-        else if (!files.every((file) => file.endsWith(".pdf"))) {
+    async getLoaders() {
+        if (!this.files.every((file) => file.endsWith(".pdf"))) {
             throw new Error("Only PDF files are supported");
         }
-        const loaders = files.map((file) => new pdf_1.PDFLoader(file, { splitPages: false }));
-        const loadedDocs = await Promise.all(loaders.map((loader) => loader.load()));
-        const textSplitter = new text_splitter_1.RecursiveCharacterTextSplitter({
-            chunkSize: 1000,
-            chunkOverlap: 200
-        });
-        const splitDocs = await Promise.all(loadedDocs.map((docs) => textSplitter.splitDocuments(docs)));
-        this.vectorStore = await memory_1.MemoryVectorStore.fromDocuments(splitDocs.flat(), this.embeddings);
+        return this.files.map((file) => new pdf_1.PDFLoader(file, { splitPages: false }));
     }
 }
 exports.FilesKnowledgeBase = FilesKnowledgeBase;

package/dist/knowledge/S3KnowledgeBase.d.ts

@@ -0,0 +1,10 @@
+import { S3Loader } from "@langchain/community/document_loaders/web/s3";
+import { AbstractKnowledgeBase } from "./AbstractKnowledgeBase";
+import { S3KnowledgeBaseParams } from "./types";
+declare class S3KnowledgeBase extends AbstractKnowledgeBase {
+    private params;
+    documents: string[];
+    constructor(params: S3KnowledgeBaseParams);
+    getLoaders(): Promise<S3Loader[]>;
+}
+export { S3KnowledgeBase };

package/dist/knowledge/S3KnowledgeBase.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3KnowledgeBase = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const s3_1 = require("@langchain/community/document_loaders/web/s3");
+const AbstractKnowledgeBase_1 = require("./AbstractKnowledgeBase");
+class S3KnowledgeBase extends AbstractKnowledgeBase_1.AbstractKnowledgeBase {
+    constructor(params) {
+        super(params);
+        this.params = params;
+        this.params = params;
+    }
+    async getLoaders() {
+        if (!this.documents.every((file) => file.endsWith(".pdf"))) {
+            throw new Error("Only PDF files are supported");
+        }
+        const { bucket, key, s3Config, unstructuredAPIURL, unstructuredAPIKey } = this.params;
+        return this.documents.map(() => new s3_1.S3Loader({
+            bucket,
+            key,
+            s3Config,
+            unstructuredAPIURL,
+            unstructuredAPIKey
+        }));
+    }
+}
+exports.S3KnowledgeBase = S3KnowledgeBase;

package/dist/knowledge/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./AbstractKnowledgeBase";
 export * from "./FilesKnowledgeBase";
+export * from "./S3KnowledgeBase";
+export * from "./loadKnowledgeBaseFromFiles";
+export * from "./loadKnowledgeBaseFromS3";
 export * from "./types";

package/dist/knowledge/index.js

@@ -14,8 +14,6 @@ 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 });
-__exportStar(require("./AbstractKnowledgeBase"), exports);
-__exportStar(require("./FilesKnowledgeBase"), exports);
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -34,4 +32,9 @@ __exportStar(require("./FilesKnowledgeBase"), exports);
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+__exportStar(require("./AbstractKnowledgeBase"), exports);
+__exportStar(require("./FilesKnowledgeBase"), exports);
+__exportStar(require("./S3KnowledgeBase"), exports);
+__exportStar(require("./loadKnowledgeBaseFromFiles"), exports);
+__exportStar(require("./loadKnowledgeBaseFromS3"), exports);
 __exportStar(require("./types"), exports);

package/dist/knowledge/loadKnowledgeBaseFromFiles.d.ts

@@ -0,0 +1,3 @@
+import { FilesKnowledgeBase } from "..";
+declare function loadKnowledgeBaseFromFiles(pathToKnowledgeBase: string): Promise<FilesKnowledgeBase>;
+export { loadKnowledgeBaseFromFiles };

package/dist/{loadKnowledgeBaseFromFile.js → knowledge/loadKnowledgeBaseFromFiles.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadKnowledgeBaseFromFile = loadKnowledgeBaseFromFile;
+exports.loadKnowledgeBaseFromFiles = loadKnowledgeBaseFromFiles;
 /*
  * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -19,9 +19,9 @@ exports.loadKnowledgeBaseFromFile = loadKnowledgeBaseFromFile;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const _1 = require(".");
-async function loadKnowledgeBaseFromFile(pathToKnowledgeBase) {
-    const knowledgeBase = new _1.FilesKnowledgeBase({
+const __1 = require("..");
+async function loadKnowledgeBaseFromFiles(pathToKnowledgeBase) {
+    const knowledgeBase = new __1.FilesKnowledgeBase({
         files: [pathToKnowledgeBase]
     });
     await knowledgeBase.load();

package/dist/knowledge/loadKnowledgeBaseFromS3.d.ts

@@ -0,0 +1,3 @@
+import { S3KnowledgeBase, S3KnowledgeBaseParams } from ".";
+declare function loadKnowledgeBaseFromS3(params: S3KnowledgeBaseParams): Promise<S3KnowledgeBase>;
+export { loadKnowledgeBaseFromS3 };

package/dist/knowledge/loadKnowledgeBaseFromS3.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadKnowledgeBaseFromS3 = loadKnowledgeBaseFromS3;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const _1 = require(".");
+async function loadKnowledgeBaseFromS3(params) {
+    const knowledgeBase = new _1.S3KnowledgeBase(params);
+    await knowledgeBase.load();
+    return knowledgeBase;
+}

package/dist/knowledge/types.d.ts

@@ -1,4 +1,22 @@
+import { Embeddings } from "@langchain/core/embeddings";
 type KnowledgeBase = {
     queryKnowledgeBase: (query: string, k?: number) => Promise<string>;
 };
-export { KnowledgeBase };
+type S3KnowledgeBaseParams = {
+    embeddings?: Embeddings;
+    documents: string[];
+    bucket: string;
+    key: string;
+    s3Config: {
+        endpoint: string;
+        region: string;
+        credentials: {
+            accessKeyId: string;
+            secretAccessKey: string;
+        };
+        forcePathStyle: boolean;
+    };
+    unstructuredAPIURL: string;
+    unstructuredAPIKey: string;
+};
+export { KnowledgeBase, S3KnowledgeBaseParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/autopilot",
-  "version": "0.7.32",
+  "version": "0.7.35",
   "description": "Voice AI for the Fonoster platform",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -35,10 +35,11 @@
     "url": "https://github.com/fonoster/fonoster/issues"
   },
   "dependencies": {
-    "@fonoster/common": "^0.7.32",
-    "@fonoster/logger": "^0.7.32",
-    "@fonoster/types": "^0.7.32",
-    "@fonoster/voice": "^0.7.32",
+    "@aws-sdk/client-s3": "^3.701.0",
+    "@fonoster/common": "^0.7.35",
+    "@fonoster/logger": "^0.7.35",
+    "@fonoster/types": "^0.7.35",
+    "@fonoster/voice": "^0.7.35",
     "@langchain/community": "^0.3.16",
     "@langchain/core": "^0.3.19",
     "@langchain/groq": "^0.1.2",
@@ -56,5 +57,5 @@
   "devDependencies": {
     "typescript": "^5.5.4"
   },
-  "gitHead": "96c1aa03e97f05179d83c3bbdda4cc2dde61a367"
+  "gitHead": "310b53e483cda3937e2d093c56428c94a15466e6"
 }

package/dist/loadKnowledgeBaseFromFile.d.ts

@@ -1,3 +0,0 @@
-import { FilesKnowledgeBase } from ".";
-declare function loadKnowledgeBaseFromFile(pathToKnowledgeBase: string): Promise<FilesKnowledgeBase>;
-export { loadKnowledgeBaseFromFile };