kg-chat 0.1.2

kg-chat

kg-chat

LLM-based chatbot that queries and visualizes KGX nodes and edges TSV files loaded into either DuckDB (default) or neo4j database backend.

NOTE:
Ensure OPENAI_API_KEY is set as an environmental variable.

Setup

For Neo4j Backend (Optional)

1. Install Neo4j desktop from here.
2. Create a new project and database, then start it.
3. Install the APOC plugin in Neo4j Desktop.
4. Update settings to match neo4j_db_settings.conf.

General Setup

For Developers

1. Clone this repository.
2. Create a virtual environment and install dependencies:

   cd kg-chat
   pip install poetry
   poetry install
   

3. Replace data/nodes.tsv and data/edges.tsv with desired KGX files if needed.

For using kg-chat as a dependency

pip install kg-chat

OR

poetry add kg-chat@latest

Supported Backends

• DuckDB [default]
• Neo4j

Commands

1. Import KG: Load nodes and edges into a database (default: duckdb).

   poetry run kg import --data-dir data
   

2. Test Query: Run a test query.

   NOTE: --data-dir is a required parameter for all commands. This is the path for the directory which contains the nodes.tsv and edges.tsv file. The filenames are expected to be exactly that.

   poetry run kg test-query --data-dir data
   

3. QnA: Ask questions about the data.

   poetry run kg qna "how many nodes do we have here?" --data-dir data
   

4. Chat: Start an interactive chat session.

   poetry run kg chat --data-dir data
   

5. App: Deploy a local web application.

   poetry run kg app --data-dir data
   

Visualization

Use show me in prompts for KG visualization.

---

Acknowledgements

This cookiecutter project was developed from the monarch-project-template template and will be kept up-to-date using cruft.