https://github.com/dsba6010-llm-applications/agenticrag-charlotteeatz
An agentic retrieval augmented generated (RAG) application to help foodies in Charlotte satisfy their culinary cravings.
https://github.com/dsba6010-llm-applications/agenticrag-charlotteeatz
Last synced: 3 months ago
JSON representation
An agentic retrieval augmented generated (RAG) application to help foodies in Charlotte satisfy their culinary cravings.
- Host: GitHub
- URL: https://github.com/dsba6010-llm-applications/agenticrag-charlotteeatz
- Owner: dsba6010-llm-applications
- License: mit
- Created: 2024-09-07T22:15:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T11:09:02.000Z (about 1 year ago)
- Last Synced: 2024-10-24T11:38:39.897Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 72.9 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🍴 Charlotte Eatz 🤖
Eric P., product mgr. | Yaxin Z., data/prompt engr. | Lakshmi J. K., app dev. | Gaurav S., LLM ops.
Welcome to Charlotte Eatz, your go-to app for exploring Charlotte's tastiest spots! We aim to simplify dining experiences in Charlotte, NC by seamlessly integrating restaurant reservations with additional end-to-end services like transportation booking and retrieving restaurant reviews. The core value and heart of Charlotte Eatz lies in its ability to streamline multiple tasks through DineBot, the app’s chatbot, saving time and improving users’ foodie experience.
DineBot, the heart of Charlotte Eatz. Generated by DALL-E.
## ✨ Ready to Get Started?
### 1. Streamlit Cloud ☁️
The _quickest_ and _easiest_ way to our app is through [Streamlit Cloud!](https://dinebot-uncc-dsba.streamlit.app/)
Simply input your __OpenAI API Key__ and you are ready to chat with DineBot 🤖!
### 2. Local Deployment ⚙️
First, clone the repo like this:
```bash
git clone --depth 1 https://github.com/dsba6010-llm-applications/AgenticRAG-CharlotteEatz.git
```
> [!WARNING]
> Our virtual environment was accidentally included in the initial push. It has since been removed from the repo but will be present in git history.
> Be sure to include ```--depth 1``` when cloning the repo to exclude git history and avoid downloading the virtual environment.
Then `cd` into the folder `AgenticRAG-CharlotteEatz`.
Create a virtual environment, activate it, and install the dependencies.
```python
python3 -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
```
> [!TIP]
> If you're using Windows CMD, the 2nd line will be `.\venv\Scripts\activate.bat`.
> Alternatively, if you're using Windows PowerShell, it would be `.\venv\Scripts\activate.ps1`
Lastly, create a .env file with `OPENAI_API_KEY='Your OpenAI API Key'`.
You are now able to run our app locally using `streamlit run dinebot_app.py`!
## 🛠️ Behind the Scenes
- **Core Architecture**: Powered by an **agentic RAG** (Retrieval-Augmented Generation) system made by and for Charlotte foodies.
- Built using **FAISS** for fast and efficient information retrieval.
- Developed with **LangChain** for agents, tools, and overall advanced conversational flows.
- Leveraging OpenAI's **GPT** model for easy integration and support.
- Using **Streamlit** for a simple and accesible user experience.
For more details (or if you are just curious), please take a look at our [Final Report!](https://github.com/dsba6010-llm-applications/AgenticRAG-CharlotteEatz/blob/main/docs/Final%20Project%20Report.pdf)
---
💕 Thanks for using Charlotte Eatz! Let’s make every meal an adventure with DineBot. 🍷🍕