Feature: Follow-up Prompts

packages/components/package.json

@@ -119,7 +119,7 @@
         "weaviate-ts-client": "^1.1.0",
         "winston": "^3.9.0",
         "ws": "^8.9.0",
-        "zod": "^3.22.4",
+        "zod": "3.22.4",
         "zod-to-json-schema": "^3.21.4"
     },
     "devDependencies": {

packages/components/src/Interface.ts

@@ -419,3 +419,25 @@ export interface IServerSideEventStreamer {
     streamAbortEvent(chatId: string): void
     streamEndEvent(chatId: string): void
 }
+
+export enum FollowUpPromptProvider {
+    ANTHROPIC = 'chatAnthropic',
+    AZURE_OPENAI = 'azureChatOpenAI',
+    GOOGLE_GENAI = 'chatGoogleGenerativeAI',
+    MISTRALAI = 'chatMistralAI',
+    OPENAI = 'chatOpenAI'
+}
+
+export type FollowUpPromptProviderConfig = {
+    [key in FollowUpPromptProvider]: {
+        credentialId: string
+        modelName: string
+        prompt: string
+        temperature: string
+    }
+}
+
+export type FollowUpPromptConfig = {
+    status: boolean
+    selectedProvider: FollowUpPromptProvider
+} & FollowUpPromptProviderConfig

packages/components/src/followUpPrompts.ts

@@ -0,0 +1,113 @@
+import { FollowUpPromptConfig, FollowUpPromptProvider, ICommonObject } from './Interface'
+import { getCredentialData } from './utils'
+import { ChatAnthropic } from '@langchain/anthropic'
+import { ChatGoogleGenerativeAI } from '@langchain/google-genai'
+import { ChatMistralAI } from '@langchain/mistralai'
+import { ChatOpenAI } from '@langchain/openai'
+import { z } from 'zod'
+import { PromptTemplate } from '@langchain/core/prompts'
+import { StructuredOutputParser } from '@langchain/core/output_parsers'
+
+const FollowUpPromptType = z
+    .object({
+        questions: z.array(z.string())
+    })
+    .describe('Generate Follow Up Prompts')
+
+export const generateFollowUpPrompts = async (
+    followUpPromptsConfig: FollowUpPromptConfig,
+    apiMessageContent: string,
+    options: ICommonObject
+) => {
+    if (followUpPromptsConfig) {
+        const providerConfig = followUpPromptsConfig[followUpPromptsConfig.selectedProvider]
+        const credentialId = providerConfig.credentialId as string
+        const credentialData = await getCredentialData(credentialId ?? '', options)
+        const followUpPromptsPrompt = providerConfig.prompt.replace('{history}', apiMessageContent)
+
+        switch (followUpPromptsConfig.selectedProvider) {
+            case FollowUpPromptProvider.ANTHROPIC: {
+                const llm = new ChatAnthropic({
+                    apiKey: credentialData.anthropicApiKey,
+                    model: providerConfig.modelName,
+                    temperature: parseFloat(`${providerConfig.temperature}`)
+                })
+                const structuredLLM = llm.withStructuredOutput(FollowUpPromptType)
+                const structuredResponse = await structuredLLM.invoke(followUpPromptsPrompt)
+                return structuredResponse
+            }
+            case FollowUpPromptProvider.AZURE_OPENAI: {
+                const azureOpenAIApiKey = credentialData['azureOpenAIApiKey']
+                const azureOpenAIApiInstanceName = credentialData['azureOpenAIApiInstanceName']
+                const azureOpenAIApiDeploymentName = credentialData['azureOpenAIApiDeploymentName']
+                const azureOpenAIApiVersion = credentialData['azureOpenAIApiVersion']
+
+                const llm = new ChatOpenAI({
+                    azureOpenAIApiKey,
+                    azureOpenAIApiInstanceName,
+                    azureOpenAIApiDeploymentName,
+                    azureOpenAIApiVersion,
+                    model: providerConfig.modelName,
+                    temperature: parseFloat(`${providerConfig.temperature}`)
+                })
+                // use structured output parser because withStructuredOutput is not working
+                const parser = StructuredOutputParser.fromZodSchema(FollowUpPromptType)
+                const formatInstructions = parser.getFormatInstructions()
+                const prompt = PromptTemplate.fromTemplate(`
+                    ${providerConfig.prompt}
+
+                    {format_instructions}
+                `)
+                const chain = prompt.pipe(llm).pipe(parser)
+                const structuredResponse = await chain.invoke({
+                    history: apiMessageContent,
+                    format_instructions: formatInstructions
+                })
+                return structuredResponse
+            }
+            case FollowUpPromptProvider.GOOGLE_GENAI: {
+                const llm = new ChatGoogleGenerativeAI({
+                    apiKey: credentialData.googleGenerativeAPIKey,
+                    model: providerConfig.modelName,
+                    temperature: parseFloat(`${providerConfig.temperature}`)
+                })
+                // use structured output parser because withStructuredOutput is not working
+                const parser = StructuredOutputParser.fromZodSchema(FollowUpPromptType)
+                const formatInstructions = parser.getFormatInstructions()
+                const prompt = PromptTemplate.fromTemplate(`
+                    ${providerConfig.prompt}
+
+                    {format_instructions}
+                `)
+                const chain = prompt.pipe(llm).pipe(parser)
+                const structuredResponse = await chain.invoke({
+                    history: apiMessageContent,
+                    format_instructions: formatInstructions
+                })
+                return structuredResponse
+            }
+            case FollowUpPromptProvider.MISTRALAI: {
+                const model = new ChatMistralAI({
+                    apiKey: credentialData.mistralAIAPIKey,
+                    model: providerConfig.modelName,
+                    temperature: parseFloat(`${providerConfig.temperature}`)
+                })
+                const structuredLLM = model.withStructuredOutput(FollowUpPromptType)
+                const structuredResponse = await structuredLLM.invoke(followUpPromptsPrompt)
+                return structuredResponse
+            }
+            case FollowUpPromptProvider.OPENAI: {
+                const model = new ChatOpenAI({
+                    apiKey: credentialData.openAIApiKey,
+                    model: providerConfig.modelName,
+                    temperature: parseFloat(`${providerConfig.temperature}`)
+                })
+                const structuredLLM = model.withStructuredOutput(FollowUpPromptType)
+                const structuredResponse = await structuredLLM.invoke(followUpPromptsPrompt)
+                return structuredResponse
+            }
+        }
+    } else {
+        return undefined
+    }
+}

packages/components/src/index.ts

@@ -9,3 +9,4 @@ export * from './utils'
 export * from './speechToText'
 export * from './storageUtils'
 export * from './handler'
+export * from './followUpPrompts'

packages/server/src/Interface.ts

@@ -50,6 +50,7 @@ export interface IChatMessage {
     createdDate: Date
     leadEmail?: string
     action?: string | null
+    followUpPrompts?: string
 }
 
 export interface IChatMessageFeedback {

packages/server/src/database/entities/ChatFlow.ts

@@ -34,6 +34,9 @@ export class ChatFlow implements IChatFlow {
     @Column({ nullable: true, type: 'text' })
     speechToText?: string
 
+    @Column({ nullable: true, type: 'text' })
+    followUpPrompts?: string
+
     @Column({ nullable: true, type: 'text' })
     category?: string
 

packages/server/src/database/entities/ChatMessage.ts

@@ -56,4 +56,7 @@ export class ChatMessage implements IChatMessage {
 
     @Column({ nullable: true, type: 'text' })
     leadEmail?: string
+
+    @Column({ nullable: true, type: 'text' })
+    followUpPrompts?: string
 }

packages/server/src/database/migrations/mariadb/1726666318346-AddFollowUpPrompts.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFollowUpPrompts1726666318346 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const columnExistsInChatflow = await queryRunner.hasColumn('chat_flow', 'followUpPrompts')
+        if (!columnExistsInChatflow) queryRunner.query(`ALTER TABLE \`chat_flow\` ADD COLUMN \`followUpPrompts\` TEXT;`)
+        const columnExistsInChatMessage = await queryRunner.hasColumn('chat_flow', 'followUpPrompts')
+        if (!columnExistsInChatMessage) queryRunner.query(`ALTER TABLE \`chat_flow\` ADD COLUMN \`followUpPrompts\` TEXT;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE \`chat_flow\` DROP COLUMN \`followUpPrompts\`;`)
+    }
+}

packages/server/src/database/migrations/mariadb/index.ts

@@ -25,6 +25,7 @@ import { AddActionToChatMessage1721078251523 } from './1721078251523-AddActionTo
 import { LongTextColumn1722301395521 } from './1722301395521-LongTextColumn'
 import { AddCustomTemplate1725629836652 } from './1725629836652-AddCustomTemplate'
 import { AddArtifactsToChatMessage1726156258465 } from './1726156258465-AddArtifactsToChatMessage'
+import { AddFollowUpPrompts1726666318346 } from './1726666318346-AddFollowUpPrompts'
 
 export const mariadbMigrations = [
     Init1693840429259,
@@ -53,5 +54,6 @@ export const mariadbMigrations = [
     AddActionToChatMessage1721078251523,
     LongTextColumn1722301395521,
     AddCustomTemplate1725629836652,
-    AddArtifactsToChatMessage1726156258465
+    AddArtifactsToChatMessage1726156258465,
+    AddFollowUpPrompts1726666318346
 ]

packages/server/src/database/migrations/mysql/1726666302024-AddFollowUpPrompts.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFollowUpPrompts1726666302024 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const columnExistsInChatflow = await queryRunner.hasColumn('chat_flow', 'followUpPrompts')
+        if (!columnExistsInChatflow) queryRunner.query(`ALTER TABLE \`chat_flow\` ADD COLUMN \`followUpPrompts\` TEXT;`)
+        const columnExistsInChatMessage = await queryRunner.hasColumn('chat_message', 'followUpPrompts')
+        if (!columnExistsInChatMessage) queryRunner.query(`ALTER TABLE \`chat_message\` ADD COLUMN \`followUpPrompts\` TEXT;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE \`chat_flow\` DROP COLUMN \`followUpPrompts\`;`)
+        await queryRunner.query(`ALTER TABLE \`chat_message\` DROP COLUMN \`followUpPrompts\`;`)
+    }
+}

packages/server/src/database/migrations/mysql/index.ts

@@ -26,6 +26,7 @@ import { AddActionToChatMessage1721078251523 } from './1721078251523-AddActionTo
 import { LongTextColumn1722301395521 } from './1722301395521-LongTextColumn'
 import { AddCustomTemplate1725629836652 } from './1725629836652-AddCustomTemplate'
 import { AddArtifactsToChatMessage1726156258465 } from './1726156258465-AddArtifactsToChatMessage'
+import { AddFollowUpPrompts1726666302024 } from './1726666302024-AddFollowUpPrompts'
 
 export const mysqlMigrations = [
     Init1693840429259,
@@ -55,5 +56,6 @@ export const mysqlMigrations = [
     AddActionToChatMessage1721078251523,
     LongTextColumn1722301395521,
     AddCustomTemplate1725629836652,
-    AddArtifactsToChatMessage1726156258465
+    AddArtifactsToChatMessage1726156258465,
+    AddFollowUpPrompts1726666302024
 ]

packages/server/src/database/migrations/postgres/1726666309552-AddFollowUpPrompts.ts

@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFollowUpPrompts1726666309552 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "chat_flow" ADD COLUMN IF NOT EXISTS "followUpPrompts" TEXT;`)
+        await queryRunner.query(`ALTER TABLE "chat_message" ADD COLUMN IF NOT EXISTS "followUpPrompts" TEXT;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "chat_flow" DROP COLUMN "followUpPrompts";`)
+        await queryRunner.query(`ALTER TABLE "chat_message" DROP COLUMN "followUpPrompts";`)
+    }
+}

packages/server/src/database/migrations/postgres/index.ts

@@ -26,6 +26,7 @@ import { AddApiKey1720230151480 } from './1720230151480-AddApiKey'
 import { AddActionToChatMessage1721078251523 } from './1721078251523-AddActionToChatMessage'
 import { AddCustomTemplate1725629836652 } from './1725629836652-AddCustomTemplate'
 import { AddArtifactsToChatMessage1726156258465 } from './1726156258465-AddArtifactsToChatMessage'
+import { AddFollowUpPrompts1726666309552 } from './1726666309552-AddFollowUpPrompts'
 
 export const postgresMigrations = [
     Init1693891895163,
@@ -55,5 +56,6 @@ export const postgresMigrations = [
     AddApiKey1720230151480,
     AddActionToChatMessage1721078251523,
     AddCustomTemplate1725629836652,
-    AddArtifactsToChatMessage1726156258465
+    AddArtifactsToChatMessage1726156258465,
+    AddFollowUpPrompts1726666309552
 ]

packages/server/src/database/migrations/sqlite/1726666294213-AddFollowUpPrompts.ts

@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFollowUpPrompts1726666294213 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "chat_flow" ADD COLUMN "followUpPrompts" TEXT;`)
+        await queryRunner.query(`ALTER TABLE "chat_message" ADD COLUMN "followUpPrompts" TEXT;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "chat_flow" DROP COLUMN "followUpPrompts";`)
+        await queryRunner.query(`ALTER TABLE "chat_message" DROP COLUMN "followUpPrompts";`)
+    }
+}

packages/server/src/database/migrations/sqlite/index.ts

@@ -25,6 +25,7 @@ import { AddApiKey1720230151480 } from './1720230151480-AddApiKey'
 import { AddActionToChatMessage1721078251523 } from './1721078251523-AddActionToChatMessage'
 import { AddArtifactsToChatMessage1726156258465 } from './1726156258465-AddArtifactsToChatMessage'
 import { AddCustomTemplate1725629836652 } from './1725629836652-AddCustomTemplate'
+import { AddFollowUpPrompts1726666294213 } from './1726666294213-AddFollowUpPrompts'
 
 export const sqliteMigrations = [
     Init1693835579790,
@@ -53,5 +54,6 @@ export const sqliteMigrations = [
     AddApiKey1720230151480,
     AddActionToChatMessage1721078251523,
     AddArtifactsToChatMessage1726156258465,
-    AddCustomTemplate1725629836652
+    AddCustomTemplate1725629836652,
+    AddFollowUpPrompts1726666294213
 ]

packages/server/src/utils/SSEStreamer.ts

@@ -211,6 +211,9 @@ export class SSEStreamer implements IServerSideEventStreamer {
         if (apiResponse.memoryType) {
             metadataJson['memoryType'] = apiResponse.memoryType
         }
+        if (apiResponse.followUpPrompts) {
+            metadataJson['followUpPrompts'] = JSON.parse(apiResponse.followUpPrompts)
+        }
         if (Object.keys(metadataJson).length > 0) {
             this.streamCustomEvent(chatId, 'metadata', metadataJson)
         }

packages/server/src/utils/buildChatflow.ts

@@ -8,6 +8,7 @@ import {
     addArrayFilesToStorage,
     mapMimeTypeToInputField,
     mapExtToInputField,
+    generateFollowUpPrompts,
     IServerSideEventStreamer
 } from 'flowise-components'
 import { StatusCodes } from 'http-status-codes'
@@ -452,6 +453,18 @@ export const utilBuildChatflow = async (req: Request, isInternal: boolean = fals
         if (result?.usedTools) apiMessage.usedTools = JSON.stringify(result.usedTools)
         if (result?.fileAnnotations) apiMessage.fileAnnotations = JSON.stringify(result.fileAnnotations)
         if (result?.artifacts) apiMessage.artifacts = JSON.stringify(result.artifacts)
+        if (chatflow.followUpPrompts) {
+            const followUpPromptsConfig = JSON.parse(chatflow.followUpPrompts)
+            const followUpPrompts = await generateFollowUpPrompts(followUpPromptsConfig, apiMessage.content, {
+                chatId,
+                chatflowid,
+                appDataSource: appServer.AppDataSource,
+                databaseEntities
+            })
+            if (followUpPrompts?.questions) {
+                apiMessage.followUpPrompts = JSON.stringify(followUpPrompts.questions)
+            }
+        }
 
         const chatMessage = await utilAddChatMessage(apiMessage)
 
@@ -470,6 +483,7 @@ export const utilBuildChatflow = async (req: Request, isInternal: boolean = fals
         result.question = incomingInput.question
         result.chatId = chatId
         result.chatMessageId = chatMessage?.id
+        result.followUpPrompts = JSON.stringify(apiMessage.followUpPrompts)
         result.isStreamValid = isStreamValid
 
         if (sessionId) result.sessionId = sessionId