Spaces:
Sleeping
Sleeping
File size: 9,214 Bytes
f9ad313 b404e8f f9ad313 a8441ef f9ad313 a8441ef f9ad313 a8441ef f9ad313 b404e8f f9ad313 b404e8f a8441ef f9ad313 b404e8f f9ad313 a8441ef f9ad313 a8441ef f9ad313 |
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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
"""
Configuration module for the Schema-Agnostic Database Chatbot.
This module handles all configuration including:
- Database connection settings (MySQL, PostgreSQL, SQLite)
- LLM provider settings (Groq / OpenAI / Local LLaMA)
- Embedding model configuration
- Security settings
"""
import os
from pathlib import Path
from dataclasses import dataclass, field
from typing import Optional, List
from enum import Enum
# Load .env file BEFORE any os.getenv calls
from dotenv import load_dotenv
env_path = Path(__file__).parent / ".env"
load_dotenv(env_path)
class DatabaseType(Enum):
"""Supported database types."""
MYSQL = "mysql"
POSTGRESQL = "postgresql"
SQLITE = "sqlite"
class LLMProvider(Enum):
"""Supported LLM providers."""
GROQ = "groq" # FREE!
OPENAI = "openai"
LOCAL_LLAMA = "local_llama"
class EmbeddingProvider(Enum):
"""Supported embedding providers."""
OPENAI = "openai"
SENTENCE_TRANSFORMERS = "sentence_transformers"
@dataclass
class DatabaseConfig:
"""
Database configuration supporting MySQL and PostgreSQL.
All sensitive values are loaded from environment variables.
"""
# Database type (mysql, postgresql)
db_type: DatabaseType = field(
default_factory=lambda: DatabaseType(os.getenv("DB_TYPE", "mysql").lower())
)
# Common connection settings (for MySQL/PostgreSQL)
host: str = field(default_factory=lambda: os.getenv("DB_HOST", os.getenv("MYSQL_HOST", "")))
port: int = field(default_factory=lambda: int(os.getenv("DB_PORT", os.getenv("MYSQL_PORT", "3306"))))
database: str = field(default_factory=lambda: os.getenv("DB_DATABASE", os.getenv("MYSQL_DATABASE", "")))
username: str = field(default_factory=lambda: os.getenv("DB_USERNAME", os.getenv("MYSQL_USERNAME", "")))
password: str = field(default_factory=lambda: os.getenv("DB_PASSWORD", os.getenv("MYSQL_PASSWORD", "")))
# SSL configuration
ssl_ca: Optional[str] = field(default_factory=lambda: os.getenv("DB_SSL_CA", os.getenv("MYSQL_SSL_CA", None)))
@property
def connection_string(self) -> str:
"""Generate SQLAlchemy connection string based on database type."""
if self.db_type == DatabaseType.POSTGRESQL:
# PostgreSQL connection string
base_url = f"postgresql+psycopg2://{self.username}:{self.password}@{self.host}:{self.port}/{self.database}"
if self.ssl_ca:
return f"{base_url}?sslmode=verify-full&sslrootcert={self.ssl_ca}"
return base_url
elif self.db_type == DatabaseType.SQLITE:
# SQLite connection string (e.g. sqlite:///database.db)
# If database is just a name, it will be in the current directory
# If it starts with / or \, it's an absolute path
return f"sqlite:///{self.database}"
else: # MySQL (default)
# MySQL connection string
base_url = f"mysql+pymysql://{self.username}:{self.password}@{self.host}:{self.port}/{self.database}"
if self.ssl_ca:
return f"{base_url}?ssl_ca={self.ssl_ca}"
return base_url
def is_configured(self) -> bool:
"""Check if all required database settings are configured."""
if self.db_type == DatabaseType.SQLITE:
return bool(self.database)
# MySQL/PostgreSQL need host, database, username, password
return all([self.host, self.database, self.username, self.password])
@property
def is_mysql(self) -> bool:
"""Check if using MySQL."""
return self.db_type == DatabaseType.MYSQL
@property
def is_postgresql(self) -> bool:
"""Check if using PostgreSQL."""
return self.db_type == DatabaseType.POSTGRESQL
@property
def is_sqlite(self) -> bool:
"""Check if using SQLite."""
return self.db_type == DatabaseType.SQLITE
@dataclass
class LLMConfig:
"""LLM configuration for query routing and response generation."""
provider: LLMProvider = field(
default_factory=lambda: LLMProvider(os.getenv("LLM_PROVIDER", "openai"))
)
openai_api_key: str = field(default_factory=lambda: os.getenv("OPENAI_API_KEY", ""))
openai_model: str = field(default_factory=lambda: os.getenv("OPENAI_MODEL", "gpt-4o-mini"))
# Local LLaMA settings
local_model_path: str = field(
default_factory=lambda: os.getenv("LOCAL_MODEL_PATH", "")
)
local_model_name: str = field(
default_factory=lambda: os.getenv("LOCAL_MODEL_NAME", "llama-2-7b-chat")
)
# Generation parameters
temperature: float = 0.1 # Low temperature for more deterministic outputs
max_tokens: int = 1024
def is_configured(self) -> bool:
"""Check if LLM is properly configured."""
if self.provider == LLMProvider.OPENAI:
return bool(self.openai_api_key)
return bool(self.local_model_path)
@dataclass
class EmbeddingConfig:
"""Embedding model configuration for RAG."""
provider: EmbeddingProvider = field(
default_factory=lambda: EmbeddingProvider(
os.getenv("EMBEDDING_PROVIDER", "sentence_transformers")
)
)
# OpenAI embedding settings
openai_embedding_model: str = "text-embedding-3-small"
# Sentence Transformers settings
st_model_name: str = field(
default_factory=lambda: os.getenv(
"EMBEDDING_MODEL",
"sentence-transformers/all-MiniLM-L6-v2"
)
)
# Embedding dimensions (varies by model)
embedding_dim: int = 384 # Default for all-MiniLM-L6-v2
@dataclass
class SecurityConfig:
"""Security settings for SQL validation and execution."""
# SQL operations whitelist - ONLY SELECT allowed
allowed_operations: List[str] = field(default_factory=lambda: ["SELECT"])
# Dangerous keywords that should never appear in queries
forbidden_keywords: List[str] = field(default_factory=lambda: [
"INSERT", "UPDATE", "DELETE", "DROP", "CREATE", "ALTER",
"TRUNCATE", "GRANT", "REVOKE", "EXECUTE", "EXEC",
"INTO OUTFILE", "INTO DUMPFILE", "LOAD_FILE",
"INFORMATION_SCHEMA.USER_PRIVILEGES"
])
# Maximum number of rows to return
max_result_rows: int = 100
# Default LIMIT clause if not specified
default_limit: int = 50
@dataclass
class RAGConfig:
"""RAG (Retrieval-Augmented Generation) configuration."""
# FAISS index settings
faiss_index_path: str = "./faiss_index"
# Number of top results to retrieve
top_k: int = 5
# Minimum similarity score for relevance
similarity_threshold: float = 0.3
# Text columns to consider for RAG (common across database types)
text_column_types: List[str] = field(default_factory=lambda: [
# MySQL types
"TEXT", "MEDIUMTEXT", "LONGTEXT", "TINYTEXT", "VARCHAR", "CHAR",
# PostgreSQL types
"CHARACTER VARYING", "CHARACTER"
])
# Minimum character length to consider a column for RAG
min_text_length: int = 50
# Chunk size for long text documents
chunk_size: int = 500
chunk_overlap: int = 50
@dataclass
class ChatConfig:
"""Chat and memory configuration."""
# Short-term memory (in session)
max_session_messages: int = 20
# Long-term memory table name (will be created if not exists)
memory_table_name: str = "_chatbot_memory"
# Number of recent messages to include in context
context_messages: int = 5
class AppConfig:
"""
Main application configuration aggregator.
Combines all configuration sections and provides
validation methods.
"""
def __init__(self):
self.database = DatabaseConfig()
self.llm = LLMConfig()
self.embedding = EmbeddingConfig()
self.security = SecurityConfig()
self.rag = RAGConfig()
self.chat = ChatConfig()
def validate(self) -> tuple[bool, List[str]]:
"""
Validate all configuration settings.
Returns:
tuple: (is_valid, list of error messages)
"""
errors = []
if not self.database.is_configured():
db_type = self.database.db_type.value.upper()
errors.append(f"{db_type} configuration incomplete. Check DB_* environment variables.")
if not self.llm.is_configured():
errors.append(
f"LLM configuration incomplete for provider: {self.llm.provider.value}. "
"Check API keys or model paths."
)
return len(errors) == 0, errors
@classmethod
def from_env(cls) -> "AppConfig":
"""Create configuration from environment variables."""
return cls()
# Global configuration instance
config = AppConfig.from_env()
|