Certainly! Here's an enhanced README for your GitHub project with emojis and a more visually appealing format:
Blank is a chatbot with both short-term and long-term memory, designed with a focus on scalability and data safety, while ensuring lightning-fast responses. 🚀
To set up Blank, follow these steps:
-
Use
pip
to install all the required packages mentioned inrequirements.txt
.pip install -r requirements.txt
-
Create a separate file named
constants.py
and define the following variables with your values in uppercase using underscores:OPENAI_API_KEY = "" PINECONE_API_KEY = "" PINECONE_ENVIRONMENT = "" PINECONE_INDEX_NAME = "" UNSTRUCTURED_IO_API_KEY = ""
To use the retrieval capabilities of Blank, follow these steps:
-
Run the
chatbot.py
file with Python.python chatbot.py
-
🗨️ Enter your query when prompted.
To embed data into Pinecone vector storage, follow these steps:
-
Run the
embeddingUtils.py
file with Python.python embeddingUtils.py
-
Create a folder named 'data' and place all the files containing the data to be embedded inside this folder.