This is a fork from https://github.com/sdw-online/ai-postgres-database-chatbot

This is an AI chatbot that is able to answer any question about the information stored in a relational database. The chatbot created is plugged into a Postgres database.

• Streamlit: For an interactive, user-friendly web-based interface.
• OpenAI: The power behind the chatbot's intelligent responses.
• Postgres: The database where all the magic data resides.

.
├── app.py
├── assets
│   ├── dark_theme.py
│   ├── light_theme.py
│   ├── made_by_sdw.py
│   └─.....
├── conda_config.yaml
├── conversation_history
│   └── ....
├── data
│   └── employees.sql.gz
├── docs
│   └── postgresql-setup.md
├── LICENSE
├── README.md
├── start.sh
└── utils
    ├── api_functions.py
    ├── chat_functions.py
    ├── config.py
    ├── database_functions.py
    ├── function_calling_spec.py
    ├── helper_functions.py
    └── system_prompts.py

1. Clone this repository with 'git clone URL'

2. Install PostgreSQL (only first time) Read document about postgresql at ./docs folder

3. Add your database credentials in the user enviroment in linux bash create a file 'env-vars' in the up-folder for app. This file should not be at the app folder for security reasons:

     export POSTGRES_SEMANTIC_DB='employees'
     export POSTGRES_USERNAME='user_database'
     export POSTGRES_PASSWORD='pass_database'
     export POSTGRES_HOST='localhost'
     export POSTGRES_PORT='5432'
   

4. Add your OpenAI API key in the user enviroment in Linux bash, add to your .bashrc file:

     export OPENAI_API_KEY='your-api-key-value'
   

   then reload your .bashrc runnig source .bashrc (only first time)

• run: chmod 755 ./start.sh (it is was not executable) ./start.sh

The chatbot UI will open in your default web browser.

• Ask questions - Post questions related to data stored in the database the chatbot is connected to
• Get answers - Enjoy the structured and dynamic answers the chatbot provides
• Save conversations - Preserve conversations into a markdown file for your future use