(EAI-989): Refactor verified answers to wrap GenerateResponse (#688)

verified answer generate response

Co-authored-by: Ben Perlmutter <[email protected]>

Author: mongodben

packages/chatbot-server-mongodb-public/src/config.ts

@@ -16,11 +16,11 @@ import {
   requireValidIpAddress,
   requireRequestOrigin,
   AddCustomDataFunc,
-  makeVerifiedAnswerGenerateUserPrompt,
   makeDefaultFindVerifiedAnswer,
   defaultCreateConversationCustomData,
   defaultAddMessageToConversationCustomData,
   makeLegacyGeneratateResponse,
+  makeVerifiedAnswerGenerateResponse,
 } from "mongodb-chatbot-server";
 import cookieParser from "cookie-parser";
 import { makeStepBackRagGenerateUserPrompt } from "./processors/makeStepBackRagGenerateUserPrompt";
@@ -174,8 +174,8 @@ export const preprocessorOpenAiClient = wrapOpenAI(
   })
 );
 
-export const generateUserPrompt = wrapTraced(
-  makeVerifiedAnswerGenerateUserPrompt({
+export const generateResponse = wrapTraced(
+  makeVerifiedAnswerGenerateResponse({
     findVerifiedAnswer,
     onVerifiedAnswerFound: (verifiedAnswer) => {
       return {
@@ -184,11 +184,17 @@ export const generateUserPrompt = wrapTraced(
       };
     },
     onNoVerifiedAnswerFound: wrapTraced(
-      makeStepBackRagGenerateUserPrompt({
-        openAiClient: preprocessorOpenAiClient,
-        model: retrievalConfig.preprocessorLlm,
-        findContent,
-        numPrecedingMessagesToInclude: 6,
+      makeLegacyGeneratateResponse({
+        llm,
+        generateUserPrompt: makeStepBackRagGenerateUserPrompt({
+          openAiClient: preprocessorOpenAiClient,
+          model: retrievalConfig.preprocessorLlm,
+          findContent,
+          numPrecedingMessagesToInclude: 6,
+        }),
+        systemMessage: systemPrompt,
+        llmNotWorkingMessage: "LLM not working. Sad!",
+        noRelevantContentMessage: "No relevant content found. Sad!",
       }),
       { name: "makeStepBackRagGenerateUserPrompt" }
     ),
@@ -294,13 +300,7 @@ export const config: AppConfig = {
           : undefined,
       segment: segmentConfig,
     }),
-    generateResponse: makeLegacyGeneratateResponse({
-      llm,
-      generateUserPrompt,
-      systemMessage: systemPrompt,
-      llmNotWorkingMessage: "LLM not working. Sad!",
-      noRelevantContentMessage: "No relevant content found. Sad!",
-    }),
+    generateResponse,
     maxUserMessagesInConversation: 50,
     maxUserCommentLength: 500,
     conversations,

packages/mongodb-chatbot-server/src/processors/index.ts

@@ -4,5 +4,5 @@ export * from "./QueryPreprocessorFunc";
 export * from "./filterOnlySystemPrompt";
 export * from "./makeDefaultReferenceLinks";
 export * from "./makeFilterNPreviousMessages";
-export * from "./makeVerifiedAnswerGenerateUserPrompt";
+export * from "./makeVerifiedAnswerGenerateResponse";
 export * from "./includeChunksForMaxTokensPossible";

packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateResponse.test.ts

@@ -0,0 +1,80 @@
+import { ObjectId } from "mongodb-rag-core/mongodb";
+import { makeVerifiedAnswerGenerateResponse } from "./makeVerifiedAnswerGenerateResponse";
+import { VerifiedAnswer, WithScore } from "mongodb-rag-core";
+
+describe("makeVerifiedAnswerGenerateResponse", () => {
+  const MAGIC_VERIFIABLE = "VERIFIABLE";
+  const references = [
+    {
+      title: "title",
+      url: "url",
+    },
+  ];
+  const generateResponse = makeVerifiedAnswerGenerateResponse({
+    findVerifiedAnswer: async ({ query }) => {
+      return {
+        queryEmbedding: [1, 2, 3],
+        answer:
+          query === MAGIC_VERIFIABLE
+            ? ({
+                answer: "verified answer",
+                _id: "123",
+                author_email: "[email protected]",
+                created: new Date(),
+                references,
+                question: {
+                  text: "question",
+                  embedding: [1, 2, 3],
+                  embedding_model: "model",
+                  embedding_model_version: "version",
+                },
+                updated: new Date(),
+                score: 1,
+              } satisfies WithScore<VerifiedAnswer>)
+            : undefined,
+      };
+    },
+    onNoVerifiedAnswerFound: async () => {
+      return {
+        messages: [
+          {
+            role: "user",
+            content: "returned from onNoVerifiedAnswerFound",
+          },
+        ],
+      };
+    },
+  });
+  it("uses onNoVerifiedAnswerFound if no verified answer is found", async () => {
+    // Given message text will not turn up verified answer
+    const answer = await generateResponse({
+      reqId: "",
+      latestMessageText: "not verified",
+      shouldStream: false,
+      conversation: {
+        _id: new ObjectId(),
+        messages: [],
+        createdAt: new Date(),
+      },
+    });
+    expect(answer.messages).toHaveLength(1);
+    expect(answer.messages[0].content).toBe(
+      "returned from onNoVerifiedAnswerFound"
+    );
+  });
+  it("uses verified answer if available, onNoVerifiedAnswerFound otherwise", async () => {
+    // This will find a verified answer
+    const answer = await generateResponse({
+      reqId: "",
+      latestMessageText: MAGIC_VERIFIABLE,
+      shouldStream: false,
+      conversation: {
+        _id: new ObjectId(),
+        messages: [],
+        createdAt: new Date(),
+      },
+    });
+    expect(answer.messages).toHaveLength(2);
+    expect(answer.messages[0].content).toBe(MAGIC_VERIFIABLE);
+  });
+});

packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateUserPrompt.ts renamed to packages/mongodb-chatbot-server/src/processors/makeVerifiedAnswerGenerateResponse.ts

@@ -1,10 +1,14 @@
-import { VerifiedAnswer, FindVerifiedAnswerFunc } from "mongodb-rag-core";
 import {
-  GenerateUserPromptFunc,
-  GenerateUserPromptFuncReturnValue,
-} from "../routes/legacyGenerateResponse";
+  VerifiedAnswer,
+  FindVerifiedAnswerFunc,
+  SomeMessage,
+} from "mongodb-rag-core";
+import {
+  GenerateResponse,
+  GenerateResponseReturnValue,
+} from "../routes/conversations/addMessageToConversation";
 
-export interface MakeVerifiedAnswerGenerateUserPromptParams {
+export interface MakeVerifiedAnswerGenerateResponseParams {
   /**
     Find content based on the user's message and preprocessing.
    */
@@ -15,24 +19,24 @@ export interface MakeVerifiedAnswerGenerateUserPromptParams {
    */
   onVerifiedAnswerFound?: (verifiedAnswer: VerifiedAnswer) => VerifiedAnswer;
 
-  onNoVerifiedAnswerFound: GenerateUserPromptFunc;
+  onNoVerifiedAnswerFound: GenerateResponse;
 }
 
 /**
-  Constructs a GenerateUserPromptFunc that searches for verified answers for the
-  user query. If no verified answer can be found for the given query, the
-  onNoVerifiedAnswerFound GenerateUserPromptFunc is called instead.
+  Searches for verified answers for the user query.
+  If no verified answer can be found for the given query, the
+  `onNoVerifiedAnswerFound` function is called instead.
  */
-export const makeVerifiedAnswerGenerateUserPrompt = ({
+export const makeVerifiedAnswerGenerateResponse = ({
   findVerifiedAnswer,
   onVerifiedAnswerFound,
   onNoVerifiedAnswerFound,
-}: MakeVerifiedAnswerGenerateUserPromptParams): GenerateUserPromptFunc => {
+}: MakeVerifiedAnswerGenerateResponseParams): GenerateResponse => {
   return async (args) => {
-    const { userMessageText } = args;
+    const { latestMessageText } = args;
     const { answer: foundVerifiedAnswer, queryEmbedding } =
       await findVerifiedAnswer({
-        query: userMessageText,
+        query: latestMessageText,
       });
 
     if (foundVerifiedAnswer === undefined) {
@@ -41,25 +45,25 @@ export const makeVerifiedAnswerGenerateUserPrompt = ({
 
     const verifiedAnswer =
       onVerifiedAnswerFound?.(foundVerifiedAnswer) ?? foundVerifiedAnswer;
-    return {
-      userMessage: {
-        embedding: queryEmbedding,
-        content: userMessageText,
+    const messages = [
+      {
         role: "user",
+        embedding: queryEmbedding,
+        content: latestMessageText,
       },
-      references: verifiedAnswer.references,
-      staticResponse: {
+      {
+        role: "assistant",
+        content: verifiedAnswer.answer,
+        references: verifiedAnswer.references,
         metadata: {
           verifiedAnswer: {
             _id: verifiedAnswer._id,
             created: verifiedAnswer.created,
             updated: verifiedAnswer.updated,
           },
         },
-        references: verifiedAnswer.references,
-        content: verifiedAnswer.answer,
-        role: "assistant",
       },
-    } satisfies GenerateUserPromptFuncReturnValue;
+    ] satisfies SomeMessage[];
+    return { messages } satisfies GenerateResponseReturnValue;
   };
 };