Skip to main content

kg-chat

Project description

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

  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.

Supported Backends

  • DuckDB [default]
  • Neo4j

Commands

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

    poetry run kg import
    
  2. Test Query: Run a test query.

    poetry run kg test-query
    
  3. QnA: Ask questions about the data.

    poetry run kg qna "how many nodes do we have here?"
    
  4. Chat: Start an interactive chat session.

    poetry run kg chat
    
  5. App: Deploy a local web application.

    poetry run kg app
    

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kg_chat-0.1.1.tar.gz (418.5 kB view details)

Uploaded Source

Built Distribution

kg_chat-0.1.1-py3-none-any.whl (420.5 kB view details)

Uploaded Python 3

File details

Details for the file kg_chat-0.1.1.tar.gz.

File metadata

  • Download URL: kg_chat-0.1.1.tar.gz
  • Upload date:
  • Size: 418.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for kg_chat-0.1.1.tar.gz
Algorithm Hash digest
SHA256 49b0954ad320b58688000c300a108a862b9d6355e97ebf1f5b837c47d933b6a6
MD5 a81141bb49d03bed6c953ac399eb4a1f
BLAKE2b-256 64c1ccbb1755b80ddaca3570507d0246e1cd91257e2abf1ca6a511591f820f79

See more details on using hashes here.

File details

Details for the file kg_chat-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: kg_chat-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 420.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for kg_chat-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd240298762b75982acea557c6e412cb4f7a392b984f088e078d39e0a0884fa3
MD5 c18b09d7e787b9712ab17e0715767d65
BLAKE2b-256 f2337ebf13692fdc0e3317237eec5d98ff9b78f4b5ec98863c18802f6b57803e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page