Hugging Face's logo

Spaces:
kingabzpro
/
RegRadar
Running

App Files Community
RegRadar / README.md
Abid Ali Awan
Update README with new SDK version 5.34.2, enhance UIHandler to clarify execution time for crawling, and improve regulatory sources in settings.py by adding full names and reordering entries for better clarity.
8159b22
preview code
|
raw
history blame contribute delete
3.61 kB
metadata
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.

RegRadar (100 Agents Hackathon)

🚀 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:

    python -m venv venv
.\venv\Scripts\activate

    On macOS/Linux:

    python3 -m venv venv
source venv/bin/activate

  2. Install dependencies:

    pip install -r requirements.txt

  3. Run the app:

    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):

$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):

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.
    • 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.
    • 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.

🛠️ 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.