Merge pull request #149 from llm-tools/loaders

Introduced parameter storeConversationsToDefaultThread
llm-tools · Oct 31, 2024 · 081163b · 081163b
2 parents e166a4c + 2fdbb09
commit 081163b
Show file tree

Hide file tree

Showing 5 changed files with 173 additions and 140 deletions.
diff --git a/core/embedjs-interfaces/src/interfaces/base-model.ts b/core/embedjs-interfaces/src/interfaces/base-model.ts
@@ -2,7 +2,7 @@ import { HumanMessage, AIMessage, SystemMessage } from '@langchain/core/messages
 import createDebugMessages from 'debug';
 import { v4 as uuidv4 } from 'uuid';
 
-import { Chunk, QueryResponse, Message, SourceDetail, ModelResponse } from '../types.js';
+import { Chunk, QueryResponse, Message, SourceDetail, ModelResponse, Conversation } from '../types.js';
 import { BaseCache } from './base-cache.js';
 
 export abstract class BaseModel {
@@ -78,23 +78,32 @@ export abstract class BaseModel {
         system: string,
         userQuery: string,
         supportingContext: Chunk[],
-        conversationId = 'default',
+        conversationId?: string,
     ): Promise<QueryResponse> {
-        if (!(await BaseModel.cache.hasConversation(conversationId))) {
-            this.baseDebug(`Conversation with id '${conversationId}' is new`);
-            await BaseModel.cache.addConversation(conversationId);
-        }
+        let conversation: Conversation;
 
-        const conversation = await BaseModel.cache.getConversation(conversationId);
-        this.baseDebug(`${conversation.entries.length} history entries found for conversationId '${conversationId}'`);
+        if (conversationId) {
+            if (!(await BaseModel.cache.hasConversation(conversationId))) {
+                this.baseDebug(`Conversation with id '${conversationId}' is new`);
+                await BaseModel.cache.addConversation(conversationId);
+            }
 
-        // Add user query to history
-        await BaseModel.cache.addEntryToConversation(conversationId, {
-            id: uuidv4(),
-            timestamp: new Date(),
-            actor: 'HUMAN',
-            content: userQuery,
-        });
+            conversation = await BaseModel.cache.getConversation(conversationId);
+            this.baseDebug(
+                `${conversation.entries.length} history entries found for conversationId '${conversationId}'`,
+            );
+
+            // Add user query to history
+            await BaseModel.cache.addEntryToConversation(conversationId, {
+                id: uuidv4(),
+                timestamp: new Date(),
+                actor: 'HUMAN',
+                content: userQuery,
+            });
+        } else {
+            this.baseDebug('Conversation history is disabled as no conversationId was provided');
+            conversation = { conversationId: 'default', entries: [] };
+        }
 
         const messages = await this.prepare(system, userQuery, supportingContext, conversation.entries.slice(0, -1));
         const uniqueSources = this.extractUniqueSources(supportingContext);
@@ -112,8 +121,11 @@ export abstract class BaseModel {
             sources: uniqueSources,
         };
 
-        // Add AI response to history
-        await BaseModel.cache.addEntryToConversation(conversationId, newEntry);
+        if (conversationId) {
+            // Add AI response to history
+            await BaseModel.cache.addEntryToConversation(conversationId, newEntry);
+        }
+
         return {
             ...newEntry,
             tokenUse: {

diff --git a/core/embedjs/src/core/rag-application-builder.ts b/core/embedjs/src/core/rag-application-builder.ts
@@ -12,6 +12,7 @@ export class RAGApplicationBuilder {
     private searchResultCount: number;
     private embeddingModel: BaseEmbeddings;
     private embeddingRelevanceCutOff: number;
+    private storeConversationsToDefaultThread: boolean;
 
     constructor() {
         this.loaders = [];
@@ -24,6 +25,7 @@ export class RAGApplicationBuilder {
 
         Do not use words like context or training data when responding. You can say you do not have all the information but do not indicate that you are not a reliable source.`;
 
+        this.storeConversationsToDefaultThread = true;
         this.embeddingRelevanceCutOff = 0;
         this.cache = new MemoryCache();
     }
@@ -101,6 +103,15 @@ export class RAGApplicationBuilder {
         return this;
     }
 
+    /**
+     * The setParamStoreConversationsToDefaultThread configures whether the conversation hisotry for queries made
+     * without a conversationId passed should be stored in the default thread. This is set to True by default.
+     */
+    setParamStoreConversationsToDefaultThread(storeConversationsToDefaultThread: boolean) {
+        this.storeConversationsToDefaultThread = storeConversationsToDefaultThread;
+        return this;
+    }
+
     getLoaders() {
         return this.loaders;
     }
@@ -136,4 +147,8 @@ export class RAGApplicationBuilder {
     getModel() {
         return this.model;
     }
+
+    getParamStoreConversationsToDefaultThread() {
+        return this.storeConversationsToDefaultThread;
+    }
 }
diff --git a/core/embedjs/src/core/rag-application.ts b/core/embedjs/src/core/rag-application.ts
@@ -19,6 +19,7 @@ import { cleanString, getUnique } from '@llm-tools/embedjs-utils';
 
 export class RAGApplication {
     private readonly debug = createDebugMessages('embedjs:core');
+    private readonly storeConversationsToDefaultThread: boolean;
     private readonly embeddingRelevanceCutOff: number;
     private readonly searchResultCount: number;
     private readonly systemMessage: string;
@@ -30,6 +31,7 @@ export class RAGApplication {
     constructor(llmBuilder: RAGApplicationBuilder) {
         if (!llmBuilder.getEmbeddingModel()) throw new Error('Embedding model must be set!');
 
+        this.storeConversationsToDefaultThread = llmBuilder.getParamStoreConversationsToDefaultThread();
         this.cache = llmBuilder.getCache();
         BaseLoader.setCache(this.cache);
         BaseModel.setCache(this.cache);
@@ -382,11 +384,16 @@ export class RAGApplication {
         let context = options?.customContext;
         if (!context) context = await this.search(userQuery);
 
+        let conversationId = options?.conversationId;
+        if (!conversationId && this.storeConversationsToDefaultThread) {
+            conversationId = 'default';
+        }
+
         const sources = [...new Set(context.map((chunk) => chunk.metadata.source))];
         this.debug(
             `Query resulted in ${context.length} chunks after filteration; chunks from ${sources.length} unique sources.`,
         );
 
-        return this.model.query(this.systemMessage, userQuery, context, options?.conversationId);
+        return this.model.query(this.systemMessage, userQuery, context, conversationId);
     }
 }