Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datvodinh/finbot
Realtime RAG Chatbot Project for Finance.
https://github.com/datvodinh/finbot
chatbot llm playwright qdrant rag redis
Last synced: 6 days ago
JSON representation
Realtime RAG Chatbot Project for Finance.
- Host: GitHub
- URL: https://github.com/datvodinh/finbot
- Owner: datvodinh
- License: apache-2.0
- Created: 2024-11-29T01:55:01.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-27T05:08:06.000Z (7 days ago)
- Last Synced: 2024-12-27T05:22:38.273Z (7 days ago)
- Topics: chatbot, llm, playwright, qdrant, rag, redis
- Language: Python
- Homepage:
- Size: 1.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Realtime RAG Chatbot Project for Finance.
## Table of Contents
- [⭐ Key Features](#⭐-key-features)
- [🚀 Getting Started](#🚀-getting-started)
- [☑️ Prerequisites](#☑️-prerequisites)
- [⚙️ Advanced Installation](#⚙️-advanced-installation)
- [🤖 Usage](#🤖-usage)
- [📌 Project Roadmap](#📌-project-roadmap)
- [🎗 License](#🎗-license)
- [🙌 Contributors](#🙌-contributors)
## ⭐ Key Features
---
## 🚀 Getting Started
### ☑️ Prerequisites
Before getting started with , ensure your runtime environment meets the following requirements:
- **Programming Language:** Python
- **Package Manager:** Pip, Poetry
- **Container Runtime:** Docker
### 🤖 Usage
Run using the following command:
**Add environment variables to [docker-compose.yaml](./docker-compose.yaml)** [
](https://www.docker.com/)
```sh
services:
agent:
image: ghcr.io/datvodinh/finbot:main
container_name: finbot-agent
environment:
- REDIS_HOST=cache-db
- REDIS_PORT=6379
- QDRANT_URL=http://vector-db:6333
- OPENAI_API_KEY=
- GOOGLE_API_KEY=
- GOOGLE_CSE_ID=
```
**Using `docker`** [](https://www.docker.com/)
```sh
docker compose up -d --build
```
### ⚙️ Advanced Installation
Install using one of the following methods:
**Build from source:**
1. Clone the repository:
```sh
git clone https://github.com/datvodinh/finbot.git
```
2. Navigate to the project directory:
```sh
cd
```
3. Install the project dependencies:
**Using `poetry`** [
](https://python-poetry.org/)
```sh
poetry install
```
**Add environment variables to [.env](./apps/agent/)**
```sh
REDIS_HOST=0.0.0.0
REDIS_PORT=6379
QDRANT_URL=http://0.0.0.0:6333
OPENAI_API_KEY=
GOOGLE_API_KEY=
GOOGLE_CSE_ID=
```
**Run using `pip`** [
](https://pypi.org/project/pip/)
```sh
python src/main.py
```
---
## 📌 Project Roadmap
- [ ] **`Task 1`**: More Robust Crawling.
- [ ] **`Task 2`**: Support Model from Ollama and Huggingface.
---
## 🎗 License
This project is protected under the [Apache 2 LICENSE](https://choosealicense.com/licenses/apache-2.0/).
---
## 🙌 Contributors
- Shout out to [datvodinh](https://github.com/datvodinh) and [2uanDM](https://github.com/2uanDM) who helped bring this project to life!
---