Merge remote-tracking branch 'flowise/main'

# Conflicts:
#	package.json
#	packages/components/package.json

Author: hemati

.github/workflows/autoSyncMergedPullRequest.yml

@@ -0,0 +1,33 @@
+name: autoSyncMergedPullRequest
+on:
+  pull_request_target:
+    types:
+      - closed
+    branches: [ "main" ]
+jobs:
+  autoSyncMergedPullRequest:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Show PR info
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          echo The PR #${{ github.event.pull_request.number }} was merged on main branch!
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ secrets.AUTOSYNC_TOKEN }}
+          repository: ${{ secrets.AUTOSYNC_CH_URL }}
+          event-type: ${{ secrets.AUTOSYNC_PR_EVENT_TYPE }}
+          client-payload: >-
+            {
+              "ref": "${{ github.ref }}",
+              "prNumber": "${{ github.event.pull_request.number }}",
+              "prTitle": "${{ github.event.pull_request.title }}",
+              "prDescription": "${{ github.event.pull_request.description }}",
+              "sha": "${{ github.sha }}"
+            }

.github/workflows/autoSyncSingleCommit.yml

@@ -0,0 +1,36 @@
+name: autoSyncSingleCommit
+on:
+  push:
+    branches:
+      - main
+jobs:
+  doNotAutoSyncSingleCommit:
+    if: github.event.commits[1] != null
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: IGNORE autoSyncSingleCommit
+        run: |
+          echo This single commit has came from a merged commit. We will ignore it. This case is handled in autoSyncMergedPullRequest workflow for merge commits comming from merged pull requests only! Beware, the regular merge commits are not handled by any workflow for the moment.
+  autoSyncSingleCommit:
+    if: github.event.commits[1] == null
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: autoSyncSingleCommit
+        env:
+          GITHUB_CONTEXT: ${{ toJSON(github) }}
+        run: |
+          echo Autosync a single commit with id: ${{ github.sha }} from openSource main branch towards cloud hosted version.
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ secrets.AUTOSYNC_TOKEN }}
+          repository: ${{ secrets.AUTOSYNC_CH_URL }}
+          event-type: ${{ secrets.AUTOSYNC_SC_EVENT_TYPE }}
+          client-payload: >-
+            {
+              "ref": "${{ github.ref }}",
+              "sha": "${{ github.sha }}",
+              "commitMessage": "${{ github.event.commits[0].message }}"
+            }

CONTRIBUTING-ZH.md

@@ -138,6 +138,7 @@ Flowise 支持不同的环境变量来配置您的实例。您可以在 `package
 | DATABASE_NAME               | 数据库名称（当 DATABASE_TYPE 不是 sqlite 时）          | 字符串                                          |                                     |
 | SECRETKEY_PATH              | 保存加密密钥（用于加密/解密凭据）的位置                | 字符串                                          | `your-path/Flowise/packages/server` |
 | FLOWISE_SECRETKEY_OVERWRITE | 加密密钥用于替代存储在 SECRETKEY_PATH 中的密钥         | 字符串                                          |
+| DISABLE_FLOWISE_TELEMETRY   | 关闭遥测                                               | 字符串                                          |
 
 您也可以在使用 `npx` 时指定环境变量。例如：
 

CONTRIBUTING.md

@@ -141,6 +141,7 @@ Flowise support different environment variables to configure your instance. You
 | DATABASE_SSL                | Database connection overssl (When DATABASE_TYPE is postgre)                  | Boolean                                          | false                               |
 | SECRETKEY_PATH              | Location where encryption key (used to encrypt/decrypt credentials) is saved | String                                           | `your-path/Flowise/packages/server` |
 | FLOWISE_SECRETKEY_OVERWRITE | Encryption key to be used instead of the key stored in SECRETKEY_PATH        | String                                           |
+| DISABLE_FLOWISE_TELEMETRY   | Turn off telemetry                                                           | Boolean                                          |
 
 You can also specify the env variables when using `npx`. For example:
 

artillery-load-test.yml

@@ -33,4 +33,4 @@ scenarios:
 #     Seconds
 # Total Users = 2 + 3 + 3 = 8
 # Each making 1 HTTP call
-# Over a duration of 3 seconds
+# Over a durations of 3 seconds

docker/.env.example

@@ -25,4 +25,6 @@ LOG_PATH=/root/.flowise/logs
 # LANGCHAIN_TRACING_V2=true
 # LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
 # LANGCHAIN_API_KEY=your_api_key
-# LANGCHAIN_PROJECT=your_project
+# LANGCHAIN_PROJECT=your_project
+
+# DISABLE_FLOWISE_TELEMETRY=true

docker/docker-compose.yml

@@ -22,6 +22,7 @@ services:
             - FLOWISE_SECRETKEY_OVERWRITE=${FLOWISE_SECRETKEY_OVERWRITE}
             - LOG_LEVEL=${LOG_LEVEL}
             - LOG_PATH=${LOG_PATH}
+            - DISABLE_FLOWISE_TELEMETRY=${DISABLE_FLOWISE_TELEMETRY}
         ports:
             - '${PORT}:${PORT}'
         volumes:

package.json

@@ -1,6 +1,6 @@
 {
     "name": "flowise",
-    "version": "1.4.9",
+    "version": "1.4.11",
     "private": true,
     "homepage": "https://langflux.space",
     "workspaces": [

packages/components/credentials/PineconeApi.credential.ts

@@ -16,11 +16,6 @@ class PineconeApi implements INodeCredential {
                 label: 'Pinecone Api Key',
                 name: 'pineconeApiKey',
                 type: 'password'
-            },
-            {
-                label: 'Pinecone Environment',
-                name: 'pineconeEnv',
-                type: 'string'
             }
         ]
     }

packages/components/nodes/chains/ConversationChain/ConversationChain.ts

@@ -1,13 +1,12 @@
 import { FlowiseMemory, ICommonObject, IMessage, INode, INodeData, INodeParams } from '../../../src/Interface'
 import { ConversationChain } from 'langchain/chains'
-import { getBaseClasses } from '../../../src/utils'
+import { getBaseClasses, handleEscapeCharacters } from '../../../src/utils'
 import { ChatPromptTemplate, HumanMessagePromptTemplate, MessagesPlaceholder, SystemMessagePromptTemplate } from 'langchain/prompts'
 import { BaseChatModel } from 'langchain/chat_models/base'
 import { ConsoleCallbackHandler, CustomChainHandler, additionalCallbacks } from '../../../src/handler'
-import { flatten } from 'lodash'
-import { Document } from 'langchain/document'
 import { RunnableSequence } from 'langchain/schema/runnable'
 import { StringOutputParser } from 'langchain/schema/output_parser'
+import { ConsoleCallbackHandler as LCConsoleCallbackHandler } from '@langchain/core/tracers/console'
 
 let systemMessage = `The following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.`
 const inputKey = 'input'
@@ -27,7 +26,7 @@ class ConversationChain_Chains implements INode {
     constructor(fields?: { sessionId?: string }) {
         this.label = 'Conversation Chain'
         this.name = 'conversationChain'
-        this.version = 1.0
+        this.version = 2.0
         this.type = 'ConversationChain'
         this.icon = 'conv.svg'
         this.category = 'Chains'
@@ -44,6 +43,14 @@ class ConversationChain_Chains implements INode {
                 name: 'memory',
                 type: 'BaseMemory'
             },
+            {
+                label: 'Chat Prompt Template',
+                name: 'chatPromptTemplate',
+                type: 'ChatPromptTemplate',
+                description: 'Override existing prompt with Chat Prompt Template. Human Message must includes {input} variable',
+                optional: true
+            },
+            /* Deprecated
             {
                 label: 'Document',
                 name: 'document',
@@ -52,15 +59,17 @@ class ConversationChain_Chains implements INode {
                     'Include whole document into the context window, if you get maximum context length error, please use model with higher context window like Claude 100k, or gpt4 32k',
                 optional: true,
                 list: true
-            },
+            },*/
             {
                 label: 'System Message',
                 name: 'systemMessagePrompt',
                 type: 'string',
                 rows: 4,
+                description: 'If Chat Prompt Template is provided, this will be ignored',
                 additionalParams: true,
                 optional: true,
-                placeholder: 'You are a helpful assistant that write codes'
+                default: systemMessage,
+                placeholder: systemMessage
             }
         ]
         this.sessionId = fields?.sessionId
@@ -76,15 +85,21 @@ class ConversationChain_Chains implements INode {
         const chain = prepareChain(nodeData, this.sessionId, options.chatHistory)
 
         const loggerHandler = new ConsoleCallbackHandler(options.logger)
-        const callbacks = await additionalCallbacks(nodeData, options)
+        const additionalCallback = await additionalCallbacks(nodeData, options)
 
         let res = ''
+        let callbacks = [loggerHandler, ...additionalCallback]
+
+        if (process.env.DEBUG === 'true') {
+            callbacks.push(new LCConsoleCallbackHandler())
+        }
 
         if (options.socketIO && options.socketIOClientId) {
             const handler = new CustomChainHandler(options.socketIO, options.socketIOClientId)
-            res = await chain.invoke({ input }, { callbacks: [loggerHandler, handler, ...callbacks] })
+            callbacks.push(handler)
+            res = await chain.invoke({ input }, { callbacks })
         } else {
-            res = await chain.invoke({ input }, { callbacks: [loggerHandler, ...callbacks] })
+            res = await chain.invoke({ input }, { callbacks })
         }
 
         await memory.addChatMessages(
@@ -108,28 +123,27 @@ class ConversationChain_Chains implements INode {
 const prepareChatPrompt = (nodeData: INodeData) => {
     const memory = nodeData.inputs?.memory as FlowiseMemory
     const prompt = nodeData.inputs?.systemMessagePrompt as string
-    const docs = nodeData.inputs?.document as Document[]
-
-    const flattenDocs = docs && docs.length ? flatten(docs) : []
-    const finalDocs = []
-    for (let i = 0; i < flattenDocs.length; i += 1) {
-        if (flattenDocs[i] && flattenDocs[i].pageContent) {
-            finalDocs.push(new Document(flattenDocs[i]))
+    const chatPromptTemplate = nodeData.inputs?.chatPromptTemplate as ChatPromptTemplate
+
+    if (chatPromptTemplate && chatPromptTemplate.promptMessages.length) {
+        const sysPrompt = chatPromptTemplate.promptMessages[0]
+        const humanPrompt = chatPromptTemplate.promptMessages[chatPromptTemplate.promptMessages.length - 1]
+        const chatPrompt = ChatPromptTemplate.fromMessages([
+            sysPrompt,
+            new MessagesPlaceholder(memory.memoryKey ?? 'chat_history'),
+            humanPrompt
+        ])
+
+        if ((chatPromptTemplate as any).promptValues) {
+            // @ts-ignore
+            chatPrompt.promptValues = (chatPromptTemplate as any).promptValues
         }
-    }
 
-    let finalText = ''
-    for (let i = 0; i < finalDocs.length; i += 1) {
-        finalText += finalDocs[i].pageContent
+        return chatPrompt
     }
 
-    const replaceChar: string[] = ['{', '}']
-    for (const char of replaceChar) finalText = finalText.replaceAll(char, '')
-
-    if (finalText) systemMessage = `${systemMessage}\nThe AI has the following context:\n${finalText}`
-
     const chatPrompt = ChatPromptTemplate.fromMessages([
-        SystemMessagePromptTemplate.fromTemplate(prompt ? `${prompt}\n${systemMessage}` : systemMessage),
+        SystemMessagePromptTemplate.fromTemplate(prompt ? prompt : systemMessage),
         new MessagesPlaceholder(memory.memoryKey ?? 'chat_history'),
         HumanMessagePromptTemplate.fromTemplate(`{${inputKey}}`)
     ])
@@ -142,15 +156,31 @@ const prepareChain = (nodeData: INodeData, sessionId?: string, chatHistory: IMes
     const memory = nodeData.inputs?.memory as FlowiseMemory
     const memoryKey = memory.memoryKey ?? 'chat_history'
 
+    const chatPrompt = prepareChatPrompt(nodeData)
+    let promptVariables = {}
+    const promptValuesRaw = (chatPrompt as any).promptValues
+    if (promptValuesRaw) {
+        const promptValues = handleEscapeCharacters(promptValuesRaw, true)
+        for (const val in promptValues) {
+            promptVariables = {
+                ...promptVariables,
+                [val]: () => {
+                    return promptValues[val]
+                }
+            }
+        }
+    }
+
     const conversationChain = RunnableSequence.from([
         {
             [inputKey]: (input: { input: string }) => input.input,
             [memoryKey]: async () => {
                 const history = await memory.getChatMessages(sessionId, true, chatHistory)
                 return history
-            }
+            },
+            ...promptVariables
         },
-        prepareChatPrompt(nodeData),
+        chatPrompt,
         model,
         new StringOutputParser()
     ])

packages/components/nodes/chains/ConversationalRetrievalQAChain/ConversationalRetrievalQAChain.ts

@@ -13,6 +13,7 @@ import { applyPatch } from 'fast-json-patch'
 import { convertBaseMessagetoIMessage, getBaseClasses } from '../../../src/utils'
 import { ConsoleCallbackHandler, additionalCallbacks } from '../../../src/handler'
 import { FlowiseMemory, ICommonObject, IMessage, INode, INodeData, INodeParams, MemoryMethods } from '../../../src/Interface'
+import { ConsoleCallbackHandler as LCConsoleCallbackHandler } from '@langchain/core/tracers/console'
 
 type RetrievalChainInput = {
     chat_history: string
@@ -176,11 +177,17 @@ class ConversationalRetrievalQAChain_Chains implements INode {
         const history = ((await memory.getChatMessages(this.sessionId, false, options.chatHistory)) as IMessage[]) ?? []
 
         const loggerHandler = new ConsoleCallbackHandler(options.logger)
-        const callbacks = await additionalCallbacks(nodeData, options)
+        const additionalCallback = await additionalCallbacks(nodeData, options)
+
+        let callbacks = [loggerHandler, ...additionalCallback]
+
+        if (process.env.DEBUG === 'true') {
+            callbacks.push(new LCConsoleCallbackHandler())
+        }
 
         const stream = answerChain.streamLog(
             { question: input, chat_history: history },
-            { callbacks: [loggerHandler, ...callbacks] },
+            { callbacks },
             {
                 includeNames: [sourceRunnableName]
             }

packages/components/nodes/chains/LLMChain/LLMChain.ts

@@ -82,7 +82,7 @@ class LLMChain_Chains implements INode {
         const model = nodeData.inputs?.model as BaseLanguageModel
         const prompt = nodeData.inputs?.prompt
         const output = nodeData.outputs?.output as string
-        const promptValues = prompt.promptValues as ICommonObject
+        let promptValues: ICommonObject | undefined = nodeData.inputs?.prompt.promptValues as ICommonObject
         const llmOutputParser = nodeData.inputs?.outputParser as BaseOutputParser
         this.outputParser = llmOutputParser
         if (llmOutputParser) {
@@ -107,17 +107,24 @@ class LLMChain_Chains implements INode {
                 verbose: process.env.DEBUG === 'true'
             })
             const inputVariables = chain.prompt.inputVariables as string[] // ["product"]
+            promptValues = injectOutputParser(this.outputParser, chain, promptValues)
             const res = await runPrediction(inputVariables, chain, input, promptValues, options, nodeData)
             // eslint-disable-next-line no-console
             console.log('\x1b[92m\x1b[1m\n*****OUTPUT PREDICTION*****\n\x1b[0m\x1b[0m')
             // eslint-disable-next-line no-console
             console.log(res)
+
+            let finalRes = res
+            if (this.outputParser && typeof res === 'object' && Object.prototype.hasOwnProperty.call(res, 'json')) {
+                finalRes = (res as ICommonObject).json
+            }
+
             /**
              * Apply string transformation to convert special chars:
              * FROM: hello i am ben\n\n\thow are you?
              * TO: hello i am benFLOWISE_NEWLINEFLOWISE_NEWLINEFLOWISE_TABhow are you?
              */
-            return handleEscapeCharacters(res, false)
+            return handleEscapeCharacters(finalRes, false)
         }
     }