Spaces:
Running
Running
File size: 3,609 Bytes
009f12b 925aaa4 009f12b 8159b22 009f12b 925aaa4 009f12b e31c1a9 be7d2ce e31c1a9 be7d2ce e31c1a9 be7d2ce e31c1a9 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
---
title: RegRadar
emoji: 🛡️
colorFrom: blue
colorTo: indigo
sdk: gradio
sdk_version: 5.34.2
app_file: app.py
pinned: true
license: apache-2.0
short_description: RegRadar watches the worlds regulators so you dont have to.
---
# RegRadar
RegRadar is an AI-powered regulatory compliance assistant that monitors global regulations so you don't have to. It helps compliance professionals, legal teams, and businesses stay up-to-date with the latest regulatory changes across industries and regions.
[](https://youtu.be/0l9e0WlMsQQ)
## 🚀 Features
- **Automatic Query Type Detection**: Understands if your message is a regulatory compliance query or a general question, and selects the right tools.
- **Information Extraction**: Extracts key details (industry, region, keywords) from your queries for precise analysis.
- **Regulatory Web Crawler**: Crawls official regulatory websites (e.g., SEC, FDA, FTC, ESMA, BIS) for recent updates and compliance changes (last 30 days).
- **Regulatory Search Engine**: Searches across multiple sources for industry-specific compliance information and aggregates results.
- **Memory System**: Remembers past queries and responses, personalizing results for each session/user.
- **AI Analysis Engine**: Summarizes findings and generates actionable compliance recommendations and executive summaries.
## 🏁 Getting Started
Follow these steps to set up and run RegRadar locally:
1. **Create a virtual environment (recommended):**
On Windows:
```bash
python -m venv venv
.\venv\Scripts\activate
```
On macOS/Linux:
```bash
python3 -m venv venv
source venv/bin/activate
```
2. **Install dependencies:**
```bash
pip install -r requirements.txt
```
3. **Run the app:**
```bash
python app.py
```
The app will start and you can access it via the provided local URL in your browser.
## 🔑 Setting Up API Keys
Before running RegRadar, you must set up API keys for the required services as environment variables.
**On Windows (PowerShell):**
```powershell
$env:TAVILY_API_KEY="your-tavily-api-key"
$env:KEYWORDS_API_KEY="your-keywordsai-api-key"
$env:MEM0_API_KEY="your-mem0-api-key"
```
**On macOS/Linux (bash):**
```bash
export TAVILY_API_KEY="your-tavily-api-key"
export KEYWORDS_API_KEY="your-keywordsai-api-key"
export MEM0_API_KEY="your-mem0-api-key"
```
You can add these lines to your `.env` file or your shell profile for convenience.
## 🤖 Adding Your OpenAI API Key to KeywordsAI
RegRadar uses the KeywordsAI platform, which requires an OpenAI API key for LLM access. Here's how to add your OpenAI API key:
1. **Get your OpenAI API key:**
- Go to [OpenAI Platform](https://platform.openai.com/).
- Log in and navigate to your profile > **View API Keys**.
- Click **Create new secret key** and copy the generated key.
2. **Add your OpenAI API key to KeywordsAI:**
- Log in to your KeywordsAI account.
- Go to the [KeywordsAI Providers page](https://platform.keywordsai.co/platform/api/providers).
- Find the OpenAI provider and paste your OpenAI API key into the provided field.
- Save your changes.
> For more details, see the [KeywordsAI Providers documentation](https://platform.keywordsai.co/platform/api/providers).
## 🛠️ Tools Used
- **Gradio**: For the interactive web UI.
- **OpenAI/KeywordsAI LLM**: For natural language understanding, information extraction, summarization, and LLM tracking.
- **Tavily**: For regulatory web crawling and search.
- **Mem0**: For session-based memory and personalization.
|