Skip to content

Commit

Permalink
Add basic Graph Rag implementation (#1)
Browse files Browse the repository at this point in the history
* Add basic Graph Rag implementation

* Add readme notes for the project

* fix(lint): fix linting issues

* Add sample python implementation

* fix: fix issues and refactor code

* fix(lint): fix linting issues
  • Loading branch information
bilalshareef authored Apr 10, 2024
1 parent 3e05452 commit 60c05fe
Show file tree
Hide file tree
Showing 11 changed files with 3,088 additions and 53 deletions.
4 changes: 4 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
OPENAI_API_KEY=
NEO4J_URI=
NEO4J_USERNAME=
NEO4J_PASSWORD=
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ node_modules

# OS X
.DS_Store

.env
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
![CI](https://github.com/nearform/hub-template/actions/workflows/ci.yml/badge.svg?event=push)
# Graph RAG JS Research
Repository to research on Graph RAG(Graph Retrieval Augmented Generation) using OpenAI and Neo4J Graph database to improve accuracy of prompt results.

# Hub Template

A feature-packed template to start a new repository on the hub, including:

- code linting with [ESlint](https://eslint.org) and [prettier](https://prettier.io)
- pre-commit code linting and commit message linting with [husky](https://www.npmjs.com/package/husky) and [commitlint](https://commitlint.js.org/)
- dependabot setup with automatic merging thanks to ["merge dependabot" GitHub action](https://github.com/fastify/github-action-merge-dependabot)
- notifications about commits waiting to be released thanks to ["notify release" GitHub action](https://github.com/nearform/github-action-notify-release)
- PRs' linked issues check with ["check linked issues" GitHub action](https://github.com/nearform/github-action-check-linked-issues)
- Continuous Integration GitHub workflow
## Setup
- Create a `.env` file in the root folder and copy the contents from `.env.sample` file. Get Open AI API key and Neo4J credentials and set those values to the env variables in the `.env` file.
- Run `npm install` command to install dependencies.
- Run `npm run retriever` command to run the application.
Empty file removed index.js
Empty file.
Loading

0 comments on commit 60c05fe

Please sign in to comment.