Feature/Add Neo4j GraphRag support #3686

ghondar · 2024-12-12T01:51:40Z

Summary:

This pull request introduces a Neo4j database connectivity, provides configuration settings for Neo4j credentials, and supports the usage of the GraphCypherQaChain node. Additionally, it modifies the FewShotPromptTemplate node to handle variables from the prefix field.

Description:

New Neo4j Node:
A new node has been created to allow seamless connection to a Neo4j database. This node streamlines the process of querying and managing graph data.
Credential Configuration Section:
A dedicated configuration section for Neo4j credentials has been introduced, enabling management of authentication details.
GraphCypherQaChain Support:
A new node has been implemented for integrating GraphCypherQaChain, allowing you to leverage Cypher queries directly within LangChain workflows.
Enhancement to FewShotPromptTemplate:
The FewShotPromptTemplate node has been updated to support variables derived from the prefix field.

References:

For additional guidance and best practices on graph-related integrations, please see the LangChain documentation on graph prompting: LangChain Graph Prompting.

Points to Consider:

Ensure you configure your Neo4j connection and credentials accurately within the new configuration section to maintain a stable and secure graph integration.
When working with the GraphCypherQaChain node, take advantage of the streamlined Cypher query functionalities to enhance the performance and depth of your Q&A scenarios.
The updated FewShotPromptTemplate now provides increased flexibility in managing and using prefix-related variables, enabling more dynamic prompt constructions.

Screenshots:

…sage of the GraphCypherQaChain node and modifies the FewShotPromptTemplate node to handle variables from the prefix field.

…hragsupport

HenryHengZJ · 2024-12-17T19:39:08Z

thank you @ghondar , will probably take some time (1-2 weeks) for me to review and play around with it!

ghondar · 2024-12-18T00:19:04Z

Thanks for the update, @HenryHengZJ Let me know if you have any questions during your review.

HenryHengZJ · 2024-12-18T01:01:36Z

Thanks for the update, @HenryHengZJ Let me know if you have any questions during your review.

also feel free to bring up any ideas/integrations or PR like this, love the work!

HenryHengZJ · 2024-12-18T20:45:57Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+                type: 'Neo4j'
+            },
+            {
+                label: 'Memory',


I dont think we can have memory here, since the chain itself is not able to accept memory like conversation chain

HenryHengZJ · 2024-12-18T20:46:43Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+                description: 'If true, return the raw query results instead of using the QA chain'
+            },
+            {
+                label: 'Return Intermediate Steps',


Turning on this doesn't have any difference though, still seeing the same streaming output, prob can remove this

sure, intermediate steps generates a new array type field intermediateSteps in which the query and the data returned from neo4j come for the specific case of flowise it would not be necessary, I have removed it

HenryHengZJ · 2024-12-18T20:48:14Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+                baseClasses: [this.type, ...getBaseClasses(GraphCypherQAChain)]
+            },
+            {
+                label: 'Output Prediction',


here we allow this chain to output a string or json, but we dont have any function that checks for the output

You can reference LLMChain

I took RetrievalQAChain as a reference and removed Output Prediction

I have added it back. Works now!

HenryHengZJ · 2024-12-18T20:48:56Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+        }
+
+        // Validate required variables in prompts
+        if (!cypherPromptTemplate.inputVariables.includes('schema') || !cypherPromptTemplate.inputVariables.includes('question')) {


cypherPromptTemplate might be undefined, then it will throw error

add optional operator to prevent undefined

HenryHengZJ · 2024-12-18T20:58:41Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+        try {
+            let response
+            if (shouldStreamResponse) {
+                const handler = new CustomChainHandler(sseStreamer, chatId)


We use CustomChainHandler to stream the LLM output back to UI. However, this chain has 2 chains under the hood, this will then stream both LLM outputs back to UI, but we are only interested in the latter one.

To prevent this from happening, CustomChainHandler takes in a parameter called skipK. This will skip streaming for first K numbers of handleLLMStart event. In this scenario, you can specify 2 for that. And you will be able to see only the last LLM response will be streamed back.

By setting skipK to 2, it works without returnDirect. But when returnDirect is turned on, only Cypher Chain LLM is executed, not the QA Chain. Since we set it to 2, the LLM output from Cypher Chain will be skipped, causing nothing to stream back to UI.

To solve this, we can just directly get the final answer let result = response?.result, and stream the whole response back if (result) streamResponse(sseStreamer, chatId, result)

thanks for the explication, the response has been fixed

HenryHengZJ · 2024-12-18T21:02:00Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+                description: 'Memory to store chat history for context'
+            },
+            {
+                label: 'Cypher Generation Prompt',


we can have all of these prompts as optional.

in future, we will be adding conditional input

nice, Cypher Generation Prompt now will be optional

HenryHengZJ · 2024-12-18T21:02:33Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+    constructor(fields?: { sessionId?: string }) {
+        this.label = 'Graph Cypher QA Chain'
+        this.name = 'graphCypherQAChain'
+        this.version = 2.0


version 1.0

you right, fix version number

HenryHengZJ · 2024-12-18T23:07:53Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+            cypherLLM: cypherModel,
+            graph,
+            cypherPrompt: cypherPromptTemplate,
+            qaPrompt: omitQaPrompt ? undefined : qaPromptTemplate,


why do we need omitQaPrompt ? cant we just pass in qaPrompt: qaPromptTemplate?

omitQaPrompt variable removed

…hragsupport

…ut, and enhance prompt handling - Changed version from 2.0 to 1.0. - Removed the 'Memory' input parameter from the GraphCypherQAChain. - Made 'cypherPrompt' optional and improved error handling for prompt validation. - Updated the 'init' and 'run' methods to streamline input processing and response handling. - Enhanced streaming response logic based on the 'returnDirect' flag.

…signature - Consolidated import statements for better readability. - Removed the 'input' and 'options' parameters from the 'init' method, streamlining its signature to only accept 'nodeData'.

ghondar · 2024-12-19T22:05:18Z

@HenryHengZJ thanks for review

…Flowise into feature/graphragsupport

HenryHengZJ · 2024-12-21T00:36:29Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+            qaLLM: qaModel,
+            cypherLLM: cypherModel,
+            graph,
+            cypherPrompt: cypherPromptTemplate,


error when nothing is connected:

HenryHengZJ · 2024-12-21T00:53:48Z

packages/components/nodes/chains/GraphCypherQAChain/GraphCypherQAChain.ts

+
+        // Validate required variables in prompts
+        if (
+            cypherPromptTemplate &&


here we check if cypherPromptTemplate is not undefined first

HenryHengZJ · 2024-12-21T00:57:10Z

@ghondar I've fixed all the remaining issues, can you give it a final test?

…hragsupport

ghondar · 2024-12-22T21:32:09Z

I've already done all the tests and it works correctly, thanks for the support @HenryHengZJ It has helped me a lot to understand the flow of the project 🤙🏿

HenryHengZJ

awesome, thank you so much @ghondar !

ghondar added 5 commits December 11, 2024 20:37

added: Neo4j database connectivity, Neo4j credentials, supports the u…

a45b035

…sage of the GraphCypherQaChain node and modifies the FewShotPromptTemplate node to handle variables from the prefix field.

Merge branch 'main' of github.com:FlowiseAI/Flowise into feature/grap…

2489d45

…hragsupport

revert pnpm-lock.yaml

441b5c5

revert pnpm-lock.yaml

d48d4c3

add: neo4j package

d8decef

Merge branch 'main' into feature/graphragsupport

0ea4784

HenryHengZJ reviewed Dec 18, 2024

View reviewed changes

ghondar added 3 commits December 19, 2024 09:49

Merge branch 'main' of github.com:FlowiseAI/Flowise into feature/grap…

2f3f3ad

…hragsupport

Refactor GraphCypherQAChain: Simplify imports and update init method …

e35aaf0

…signature - Consolidated import statements for better readability. - Removed the 'input' and 'options' parameters from the 'init' method, streamlining its signature to only accept 'nodeData'.

Merge branch 'feature/graphragsupport' of https://github.com/ghondar/…

287849a

…Flowise into feature/graphragsupport

HenryHengZJ reviewed Dec 21, 2024

View reviewed changes

add output, format final response, fix optional inputs

4ed5dd4

HenryHengZJ reviewed Dec 21, 2024

View reviewed changes

Merge branch 'main' of github.com:FlowiseAI/Flowise into feature/grap…

0a9c041

…hragsupport

HenryHengZJ approved these changes Dec 23, 2024

View reviewed changes

HenryHengZJ merged commit a7c1ab8 into FlowiseAI:main Dec 23, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/Add Neo4j GraphRag support #3686

Feature/Add Neo4j GraphRag support #3686

ghondar commented Dec 12, 2024

HenryHengZJ commented Dec 17, 2024

ghondar commented Dec 18, 2024

HenryHengZJ commented Dec 18, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 21, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

HenryHengZJ Dec 18, 2024

ghondar Dec 19, 2024

ghondar commented Dec 19, 2024

HenryHengZJ Dec 21, 2024

HenryHengZJ Dec 21, 2024

HenryHengZJ commented Dec 21, 2024

ghondar commented Dec 22, 2024

HenryHengZJ left a comment

Feature/Add Neo4j GraphRag support #3686

Feature/Add Neo4j GraphRag support #3686

Conversation

ghondar commented Dec 12, 2024

Description:

References:

Points to Consider:

HenryHengZJ commented Dec 17, 2024

ghondar commented Dec 18, 2024

HenryHengZJ commented Dec 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghondar commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HenryHengZJ commented Dec 21, 2024

ghondar commented Dec 22, 2024

HenryHengZJ left a comment

Choose a reason for hiding this comment