Giter VIP home page Giter VIP logo

neo4j-llms's Introduction

Neoj_LLMs

Neoj_LLMs is a sophisticated tool that facilitates seamless interaction with your Neo4j database, whether it's hosted locally or on a sandbox. This repository enables users to ask natural language questions about their databases, which are then intelligently translated into Neo4j Cypher Queries using Language Model Models (LLMs), making the querying process intuitive and accessible.

Features

  • Database Connection: Connect to your Neo4j database, whether it's locally hosted or on a sandbox.

  • Natural Language Queries: Ask questions about your database using natural language, simplifying user interactions with the graph.

  • LLM Translation: Leverage the power of Language Model Models to intelligently translate natural language queries into Neo4j Cypher Queries.

Getting Started

Follow these steps to get started with Neoj_LLMs:

  1. Clone the repository:

    git clone https://github.com/elmondhir/Neo4j-LLMS.git
    cd Neoj-LLMs
  2. Install dependencies:

    pip install -r requirements.txt
  3. Configure your Neo4j database connection details in the config.py file.

  4. Set up the Hugging Face API key for LLM translation.

  5. Run the application:

    python -B manage.py runserver
  6. Open your browser and go to http://localhost:8000 to access the Neoj_LLMs interface.

Usage

  1. Connect to your Neo4j database by providing the necessary connection details.

  2. Ask natural language questions about your database in the provided interface.

  3. Neoj_LLMs will intelligently translate your natural language questions into Neo4j Cypher Queries using Language Model Models.

  4. View and execute the generated Cypher Queries on your Neo4j database.

Screenshots

First you need to login to your neo4 instance:

Login Screenshot

### Then you chose which database you want to work with:

Login Screenshot

### Finally you input your prompt and HF token:

Login Screenshot

## Running with Docker

To run Neoj_LLMs using Docker, make sure Docker is installed on your machine. If not, you can download and install Docker from the official Docker website.

Follow these steps:

  1. Build the Docker image:

    docker-compose build
  2. Start the application:

    docker-compose up
  3. Open your browser and go to http://localhost:8000 to access the Neoj_LLMs interface.

Contributing

We welcome contributions! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

neo4j-llms's People

Contributors

elmondhir avatar

Stargazers

 avatar Ayoub KABLI avatar

Watchers

Kostas Georgiou avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.