Setup

Note

Follow steps 1 through 5 ONLY if you want to work with Neo4j as the backend. If you intend to use just DuckDB feel free to skip these steps.

1. Install Neo4j desktop from here

2. Create a new project by giving it a name of your choice. Make sure to choose the latest version of Neo4j. At this time it is (v5.21.2).

3. Create an empty database with a name of your choice and Start it.

   • Credentials can be as declared here

4. Install the APOC plugin in Neo4j Desktop. It is listed under the Plugins tab which appears when you single-click the database.

5. Click on Settings which is visible when you click on the 3 dots that appears to the right of the db on single-clicking as well. It should match neo4j_db_settings.conf

   The main edits you’ll need to do are these 3 lines:

   dbms.memory.heap.initial_size=1G
   dbms.memory.heap.max_size=16G
   dbms.security.procedures.allowlist=apoc.coll.*,apoc.load.*,gds.*,apoc.meta.data
   

   Update the memory heaps as per your preference.

For Developers

6. Clone this repository locally

7. Create a virtual environment of your choice and pip install poetry in it.

8. cd kg-chat
   poetry install
   

9. Replace the data/nodes.tsv and data/edges.tsv file in the project with corresponding files of choice that needs to be queried against.

For Users

10. Install the package from PyPI

    pip install kg-chat
    

    or

    pip install poetry
    poetry add kg-chat@latest
    

Note

• The KGX files should have the names nodes.tsv and edges.tsv.

• The data directory must be provided to run every command. The data directory contains the nodes.tsv and edges.tsv files.