Skip to content

datvodinh/finbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Realtime RAG Chatbot Project for Finance.

alt text

Table of Contents

⭐ Key Features

alt text


🚀 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  

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  

docker compose up -d --build

⚙️ Advanced Installation

Install using one of the following methods:

Build from source:

  1. Clone the repository:
git clone https://github.com/datvodinh/finbot.git
  1. Navigate to the project directory:
cd 
  1. Install the project dependencies:

Using poetry  

poetry install

Add environment variables to .env

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  

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.


🙌 Contributors