- detailed README.md

- to the point queries.sql

Author: SebastianJames55

README.md

@@ -1,2 +1,39 @@
 # mind-reader-chatbot
-A chatbot aimed to mentally support people who are going through tough times. Powered by MindsDB. 
+A chatbot aimed to mentally support people who are going through tough times. Powered by MindsDB.
+
+Here's how you can set up an automated AI chatbot for yourself. 
+
+## Prerequisites
+
+- [Get an OpenAI API key](https://www.howtogeek.com/885918/how-to-get-an-openai-api-key/)
+- [Set up mindsdb locally](https://docs.mindsdb.com/setup/self-hosted/pip/source)
+- Configure YugabyteDB
+  - [Create an account](https://cloud.yugabyte.com/signup?utm_medium=direct&utm_source=docs&utm_campaign=YBM_signup) & a free cluster. Take a note of your DB credentials.   
+    Configure IP allow list  
+    ![Configure IP allow list](assets/public_access.png)
+    Launch cloud shell and login using DB credentials
+    ![Launch cloud shell](assets/cloud%20shell.png)
+  - Run the following commands:  
+    `create database demo;`  
+    Connect to database:  
+    `\c demo`  
+    ```
+      CREATE TABLE chatbot_input (
+       id SERIAL PRIMARY KEY,  
+       created_at timestamptz DEFAULT CURRENT_TIMESTAMP,
+       text varchar(255)
+    );
+    ```
+    ```
+    CREATE TABLE chatbot_output (
+       id SERIAL PRIMARY KEY,  
+       created_at timestamptz DEFAULT CURRENT_TIMESTAMP,
+       text varchar(1000)    
+    );  
+    ```
+  - Take a note of the host under connection parameters:  
+    ![Connection parameters](assets/connection_param.png)
+
+## Usage
+
+Head over to [queries.sql](queries.sql) file. You can run the commands line by line to create your own mind-reader chatbot.

assets/cloud shell.png

@@ -0,0 +1,121 @@
+-- You can run the following commands in your local mindsdb setup
+
+-- Creating a project. This will contain the model, views and job you are about to create
+CREATE PROJECT mind_reader_project;
+
+-- Creating a model which will predict the response
+CREATE MODEL mind_reader_project.gpt_model
+PREDICT response
+USING
+engine = 'openai',
+max_tokens = 300,
+api_key = '<your-openai-api-key>', -- In MindsDB cloud accounts we provide a default key
+model_name = 'gpt-3.5-turbo', -- You can also use 'text-davinci-003'
+prompt_template = 'Reply like a friend who cares and wants to help.\
+                Input message: {{text}}\
+                In less than 550 characters, when there is some sign of distress in the input share healthy habits, \
+                motivational quotes, inspirational real-life stories.
+                Provide options to seek out in-person help if you are not able to satisfy.'; -- Prompt which will decide the style of output
+
+-- Confirm if the model status is complete before proceeding
+SELECT *
+FROM mind_reader_project.models
+WHERE name='gpt_model'; -- Name of the model within our project
+
+-- Query the model to get a response
+SELECT response
+FROM mind_reader_project.gpt_model
+WHERE text = "Not doing so great"; -- Input to the model
+
+-- Creating yugabyteDB instance
+CREATE DATABASE yugabyte_demo
+WITH
+    engine = 'yugabyte',
+    parameters = {
+        "user": "admin", -- User name
+        "password": "password", -- Password associated with the user
+        "host": "link", -- Link to the instance which hosts the DB
+        "port": 5433,
+        "database": "demo", -- Database name in instance
+        "schema": "public" -- Schema name in instance
+    };
+
+-- Viewing the stored inputs
+SELECT * from yugabyte_demo.chatbot_input;
+
+-- Storing input into the table
+INSERT INTO yugabyte_demo.chatbot_input (text)
+VALUES ('feeling lonely');
+
+-- Storing output generated from the model based on the input data
+INSERT INTO yugabyte_demo.chatbot_output (
+SELECT r.response AS text -- Response from model
+FROM yugabyte_demo.chatbot_input t
+JOIN mind_reader_project.gpt_model r
+);
+
+-- Viewing the responses stored in table
+SELECT *
+FROM yugabyte_demo.chatbot_output;
+
+-- View that stores the input messages which haven't been replied to yet
+CREATE VIEW mind_reader_project.to_reply_to (
+SELECT id, text FROM yugabyte_demo.chatbot_input
+WHERE id NOT IN (SELECT r.id FROM yugabyte_demo.chatbot_output AS r) -- Fetching input which hasn't been replied to
+);
+
+-- View the messages which haven't been replied to
+SELECT *
+FROM mind_reader_project.to_reply_to;
+
+-- View that stores the responses (against the messages which weren't replied to) from model
+CREATE VIEW mind_reader_project.to_chatbot_output (
+    SELECT * FROM mind_reader_project.to_reply_to
+    JOIN mind_reader_project.gpt_model
+);
+
+-- Job to automate the flow, runs every minute
+CREATE JOB mind_reader_project.chatbot_job (
+    -- Storing the responses from model in output table
+    INSERT INTO yugabyte_demo.chatbot_output (
+        SELECT
+            id,
+            response AS text
+        FROM mind_reader_project.to_chatbot_output
+    )
+
+) EVERY MINUTE;
+
+-- See all the jobs within the project
+SELECT *
+FROM mind_reader_project.jobs where name = "chatbot_job";
+
+-- Once job is created, input message
+INSERT INTO yugabyte_demo.chatbot_input (text)
+VALUES ('feeling lonely');
+
+-- Output table will be updated by the job every minute in case of new input messages
+SELECT *
+FROM yugabyte_demo.chatbot_output;
+
+-- See the whole history of the jobs within the project
+SELECT *
+FROM mind_reader_project.jobs_history;
+
+-- Drop the database instance from mindsdb
+DROP DATABASE yugabyte_demo;
+
+-- Drop the running job
+DROP JOB mind_reader_project.chatbot_job;
+
+-- Drop the gpt_model
+DROP MODEL mind_reader_project.gpt_model;
+
+-- Drop the to_reply_to view
+DROP VIEW mind_reader_project.to_reply_to;
+
+-- Drop the to_chatbot_output view
+DROP VIEW mind_reader_project.to_chatbot_output;
+
+-- Drop the mind_reader_project
+DROP PROJECT mind_reader_project;