Merge pull request #26 from aditya452007/feat/hybrid-setup-gemini

jenilsavani9 · web-flow · commit b09a3c5f4d2a · 2025-12-06T13:03:41.000+05:30
feat: Add Gemini Support + Hybrid Setup Docs + Neo4j Aura Fixes
diff --git a/.env.example b/.env.example
@@ -10,7 +10,11 @@ LOG_LEVEL=INFO  # DEBUG | INFO | WARNING | ERROR | CRITICAL
 # Neo4j Database
 # =============================================================================
 
+# URI Formats:
+# Local: bolt://localhost:7687
+# Cloud (Aura): neo4j+s://<instance-id>.databases.neo4j.io
 NEO4J_URI=bolt://localhost:7687
+
 NEO4J_USER=neo4j
 NEO4J_PASS=your_password_here
 NEO4J_DB=neo4j
@@ -26,6 +30,8 @@ NEO4J_CONNECTION_TIMEOUT=30
 
 # Provider: openai | ollama | sentence_transformer
 EMBEDDING_PROVIDER=ollama
+
+# Note: Dimension must match the specific model used (e.g., 1024 for mxbai, 384 for MiniLM, 1536 for OpenAI)
 EMBEDDING_DIMENSION=1024
 EMBEDDING_BATCH_SIZE=100
 EMBEDDING_CACHE_TTL=3600
@@ -41,25 +47,30 @@ OLLAMA_BASE_URL=http://localhost:11434
 OLLAMA_EMBEDDING_MODEL=mxbai-embed-large
 OLLAMA_TIMEOUT=120
 
-# Sentence Transformer Settings
+# Sentence Transformer Settings (Local CPU/GPU)
+# Common model: sentence-transformers/all-MiniLM-L6-v2 (Requires EMBEDDING_DIMENSION=384)
 SENTENCE_TRANSFORMER_MODEL=sentence-transformers/all-MiniLM-L6-v2
 SENTENCE_TRANSFORMER_DEVICE=cpu  # cpu | cuda | mps
 
 # =============================================================================
 # LLM Configuration (for Question Answering)
 # =============================================================================
 
-# Provider: ollama
-LLM_PROVIDER=ollama  
-
-# Ollama LLM Settings
-LLM_MODEL_OLLAMA=llama3.2
+# Provider: ollama | gemini
+LLM_PROVIDER=ollama
 
 # LLM General Settings
 LLM_TIMEOUT=120
 LLM_MAX_TOKENS=1000
 LLM_TEMPERATURE=0.7
 
+# Ollama LLM Settings
+LLM_MODEL_OLLAMA=llama3.2
+
+# Google Gemini Settings
+GEMINI_API_KEY=your_gemini_api_key_here
+LLM_MODEL_GEMINI=gemini-2.5-flash
+
 # =============================================================================
 # Vector Search Configuration
 # =============================================================================
@@ -121,4 +132,4 @@ FEATURE_EMBEDDINGS=true
 FEATURE_VECTOR_SEARCH=true
 FEATURE_HYBRID_SEARCH=true
 FEATURE_BATCH_PROCESSING=true
-FEATURE_CACHING=false
+FEATURE_CACHING=false
diff --git a/SETUP_GUIDE.md b/SETUP_GUIDE.md
@@ -0,0 +1,182 @@
+# 🚀 Secrin Setup Guide
+
+Welcome to Secrin! This guide covers two ways to run the project:
+
+1. **☁️ Hybrid Mode (Recommended):** Cloud DB + Gemini API. Fast, lightweight, runs on any laptop.  
+2. **🔒 Local Mode:** Local Docker DB + Ollama. Privacy-focused, requires good hardware (16GB+ RAM).
+
+---
+
+## 🛠️ 1. Prerequisites (Check these first!)
+Open your terminal and check these versions. If missing, install them.
+
+- **Git:** `git --version`  
+- **Python (3.10+):** `python --version`  
+- **Node.js (v20+):** `node -v`  
+- **Poetry:** `pip install poetry`  
+- **(Optional) Docker:** Required only if you choose "Local Mode".  
+- **(Optional) Ollama:** Required only if you choose "Local Mode".
+
+---
+
+## 🔑 2. Credentials & Services
+Choose **Option A** (Easier) or **Option B** (Private).
+
+### Option A — Hybrid (Cloud DB + Gemini)
+1. **Database:** Go to https://console.neo4j.io  
+    - Create a **Free Instance**.  
+    - ⚠️ **Copy the password immediately.** You won't see it again.  
+    - Copy the URI (example: `neo4j+s://abc12345.databases.neo4j.io`).  
+2. **AI Model:** Get a key from Google AI Studio: https://aistudio.google.com/app/apikey
+
+### Option B — Fully Local (Docker + Ollama)
+1. **Database:** Run this Docker command to start Neo4j locally:
+```bash
+docker run --restart always --publish=7474:7474 --publish=7687:7687 --env NEO4J_AUTH=neo4j/password neo4j:latest
+```
+2. **AI Model:** Install Ollama and pull the model:
+```bash
+ollama pull llama3.2
+ollama serve
+```
+
+---
+
+## 🖥️ 3. Backend Setup (Terminal 1)
+
+### Step 3.1 — Install dependencies
+```bash
+git clone https://github.com/SecrinLabs/secrin.git
+cd secrin
+poetry install
+```
+
+### Step 3.2 — Configure environment (.env)
+Create the .env file from the example:
+
+```bash
+cp .env.example .env
+```
+
+Open `.env` and paste the configuration matching your choice from Step 2.
+
+Option A (Hybrid / Gemini) — example `.env`:
+
+```Bash
+# --- Database (Neo4j Aura) ---
+NEO4J_URI=neo4j+s://<YOUR_INSTANCE_ID>.databases.neo4j.io
+NEO4J_USER=neo4j
+NEO4J_PASS=<YOUR_SAVED_PASSWORD>
+NEO4J_DB=neo4j
+
+# --- Embedding (Local CPU/GPU) ---
+EMBEDDING_PROVIDER=sentence_transformer
+SENTENCE_TRANSFORMER_MODEL=sentence-transformers/all-MiniLM-L6-v2
+EMBEDDING_DIMENSION=384
+
+# --- LLM (Gemini) ---
+LLM_PROVIDER=gemini
+GOOGLE_API_KEY=<YOUR_GEMINI_KEY>
+```
+
+Option B (Local / Ollama) — example `.env`:
+
+```Bash
+# --- Database (Local Docker) ---
+NEO4J_URI=bolt://localhost:7687
+NEO4J_USER=neo4j
+NEO4J_PASS=password
+NEO4J_DB=neo4j
+
+# --- Embedding (Ollama) ---
+EMBEDDING_PROVIDER=ollama
+OLLAMA_BASE_URL=http://localhost:11434
+OLLAMA_EMBEDDING_MODEL=mxbai-embed-large
+EMBEDDING_DIMENSION=1024
+
+# --- LLM (Ollama) ---
+LLM_PROVIDER=ollama
+LLM_MODEL_OLLAMA=llama3.2
+```
+
+### Step 3.3 — Launch backend
+```bash
+# 1. Verify connection
+poetry run setup
+
+# 2. Start server
+poetry run server
+```
+Success: you should see Uvicorn running on http://0.0.0.0:8000.
+
+---
+
+## 🎨 4. Frontend Setup (Terminal 2)
+
+Open a new terminal window:
+```bash
+cd secrin/apps/web
+```
+
+### Step 4.1 — Install dependencies
+The project prefers pnpm. Try these methods in order.
+
+Method 1 — Standard:
+```bash
+corepack enable
+pnpm install
+```
+
+Method 2 — If you get "Permission Denied" (Windows) (PowerShell):
+
+```powershell
+iwr https://get.pnpm.io/install.ps1 -useb | iex
+```
+Then retry Method 1.
+
+Method 3 — Fallback to npm:
+```bash
+npm install
+```
+
+### Step 4.2 — Start UI
+```bash
+cp .env.example .env
+pnpm dev   # OR 'npm run dev' if you used Method 3
+```
+Success: open http://localhost:3000
+
+---
+
+## 🚀 5. First Run & Ingestion
+- The graph will be blank on first login. This is normal.  
+- Login using your Neo4j credentials.  
+- Hybrid users: if `neo4j+s://` fails to connect, try `bolt+s://`.
+
+Ingest data:
+1. Go to "Integrations" in the sidebar.  
+2. Paste a GitHub URL (example: `https://github.com/SecrinLabs/secrin`).  
+3. Click "Ingest".  
+4. Watch the backend terminal — it will clone the repo and embed it.  
+5. When the backend terminal says "Finished", go to the Graph tab to view your data.
+
+---
+
+## ❓ Troubleshooting — Common Errors
+
+- "No routing servers available"  
+  1. Check if Neo4j Aura is "Paused" in the console. Resume it.  
+  2. Try using `bolt+s://` instead of `neo4j+s://`.  
+  3. Try a mobile hotspot (some Wi‑Fi blocks port 7687).
+
+- "Database does not exist"  
+  - Neo4j Aura Free tier only allows the database name `neo4j`. Check your `.env`.
+
+- "Command pnpm not found"  
+  - Restart your terminal after installing it. If it still fails, in PowerShell run:
+```powershell
+$env:PATH = "$env:LOCALAPPDATA\pnpm;$env:PATH"
+```
+
+- "Unsupported LLM provider: gemini"  
+  - You are running an old version. `git pull` the latest changes or check `llm_factory.py`.
diff --git a/apps/web/components/Neo4jGraph.tsx b/apps/web/components/Neo4jGraph.tsx
@@ -92,11 +92,21 @@ export default function Neo4jGraph({
       // Dynamic import of neo4j-driver for client-side only
       const neo4j = (await import("neo4j-driver")).default;
 
+      // FIX: Check if the URL implies a secure connection (Cloud/Aura)
+      const isSecure =
+         neo4jUrl.startsWith('neo4j+s://') ||
+         neo4jUrl.startsWith('neo4j+ssc://') ||
+         neo4jUrl.startsWith('bolt+s://') ||
+         neo4jUrl.startsWith('bolt+ssc://');
+      
       const driver = neo4j.driver(
         neo4jUrl,
         neo4j.auth.basic(username, password),
-        { encrypted: false }
+        // If it's a secure URL, don't pass any config (let the URL handle it).
+        // If it's local, explicitly turn off encryption.
+        isSecure ? {} : { encrypted: "ENCRYPTION_OFF" }
       );
+      
       const session = driver.session({ database });
 
       const start = Date.now();
diff --git a/packages/config/settings.py b/packages/config/settings.py
@@ -100,6 +100,12 @@ class Settings(BaseSettings):
         description="Embedding cache TTL in seconds (if caching enabled)"
     )
     
+    # Google Gemini Api Configuration
+    GEMINI_API_KEY: str = Field(
+        default="",
+        description="Gemini API key"
+    )
+
     # OpenAI Configuration
     OPENAI_API_KEY: str = Field(
         default="",
diff --git a/packages/memory/factories/llm_factory.py b/packages/memory/factories/llm_factory.py
@@ -6,6 +6,8 @@
 from typing import Optional
 from packages.memory.llm.base import BaseLLMProvider
 from packages.memory.llm.providers.ollama import OllamaProvider
+# --- ADDED: Import Gemini ---
+from packages.memory.llm.providers.gemini import GeminiProvider
 from packages.config import Settings
 
 
@@ -47,10 +49,16 @@ def create_provider(
                 temperature=temperature,
                 max_tokens=max_tokens
             )
+        elif provider.lower() == "gemini":
+            return GeminiProvider(
+                model=model,
+                temperature=temperature,
+                max_tokens=max_tokens
+            )
         else:
             raise ValueError(
                 f"Unsupported LLM provider: {provider}. "
-                f"Currently supported: ['ollama']"
+                f"Currently supported: ['ollama', 'gemini']"
             )
     
     @classmethod
diff --git a/packages/memory/llm/providers/gemini.py b/packages/memory/llm/providers/gemini.py
