Spaces:
Runtime error
Runtime error
File size: 16,898 Bytes
9e118e4 | 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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | """
BPS School Finder - Database Query Interface
==============================================
Runtime query class for the chatbot. Import this module:
from database import BPSDatabase
db = BPSDatabase()
"""
import sqlite3
import json
import math
from pathlib import Path
# ---------------------------------------------------------------------------
# Config
# ---------------------------------------------------------------------------
DB_PATH = Path(__file__).parent / "bps_schools.db"
VECTOR_DIR = Path(__file__).parent / "vector_store"
EMBEDDING_MODEL = "all-MiniLM-L6-v2"
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def haversine_miles(lat1, lon1, lat2, lon2):
"""Calculate distance in miles between two lat/lon points."""
R = 3958.8
dlat = math.radians(lat2 - lat1)
dlon = math.radians(lon2 - lon1)
a = (math.sin(dlat / 2) ** 2 +
math.cos(math.radians(lat1)) * math.cos(math.radians(lat2)) *
math.sin(dlon / 2) ** 2)
return R * 2 * math.asin(math.sqrt(a))
# ---------------------------------------------------------------------------
# Query Interface
# ---------------------------------------------------------------------------
class BPSDatabase:
"""Query interface for the chatbot."""
def __init__(self, db_path=None, vector_dir=None):
self.db_path = db_path or DB_PATH
self.vector_dir = vector_dir or VECTOR_DIR
self.conn = sqlite3.connect(str(self.db_path))
self.conn.row_factory = sqlite3.Row
self.index = None
self.documents = None
self.metadata = None
self.model = None
self._load_vector_store()
def _load_vector_store(self):
"""Load FAISS index and metadata."""
try:
meta_path = Path(self.vector_dir) / "metadata.json"
docs_path = Path(self.vector_dir) / "documents.json"
index_path = Path(self.vector_dir) / "school_index.faiss"
if meta_path.exists():
with open(meta_path) as f:
self.metadata = json.load(f)
with open(docs_path) as f:
self.documents = json.load(f)
if index_path.exists():
import faiss
self.index = faiss.read_index(str(index_path))
from sentence_transformers import SentenceTransformer
self.model = SentenceTransformer(EMBEDDING_MODEL)
print(f"Vector store loaded: {self.index.ntotal} schools indexed")
except Exception as e:
print(f"Vector store not fully loaded: {e}")
# --- Hard Filtering (SQL) ---
def find_schools_by_grade(self, grade: int) -> list:
"""Find BPS schools that serve a specific grade level.
Grade encoding: K0=-2, K1=-1, K2=0, 1-12 as integers."""
cur = self.conn.execute(
"SELECT * FROM schools WHERE grade_min <= ? AND grade_max >= ? ORDER BY school",
(grade, grade),
)
return [dict(r) for r in cur.fetchall()]
def find_schools_by_age(self, age_months: int) -> list:
"""Find non-BPS schools that serve a specific age in months."""
cur = self.conn.execute(
"SELECT * FROM schools WHERE age_min_months <= ? AND age_max_months >= ? ORDER BY school",
(age_months, age_months),
)
return [dict(r) for r in cur.fetchall()]
def find_schools_near(self, lat: float, lon: float, radius_miles: float = 1.0) -> list:
"""Find schools within radius_miles of a given lat/lon."""
lat_delta = radius_miles / 69.0
lon_delta = radius_miles / 53.0
cur = self.conn.execute(
"""SELECT * FROM schools
WHERE latitude BETWEEN ? AND ?
AND longitude BETWEEN ? AND ?""",
(lat - lat_delta, lat + lat_delta, lon - lon_delta, lon + lon_delta),
)
results = []
for row in cur.fetchall():
d = dict(row)
if d["latitude"] and d["longitude"]:
dist = haversine_miles(lat, lon, d["latitude"], d["longitude"])
if dist <= radius_miles:
d["distance_miles"] = round(dist, 2)
results.append(d)
results.sort(key=lambda x: x["distance_miles"])
return results
def find_schools_by_provider_type(self, provider_type: str) -> list:
"""Find schools by provider type (exact match)."""
cur = self.conn.execute(
"SELECT * FROM schools WHERE provider_type = ? ORDER BY school",
(provider_type,),
)
return [dict(r) for r in cur.fetchall()]
def find_schools_by_filters(self, **kwargs) -> list:
"""
Combined AND filter for boolean/integer fields.
Supported kwargs: UPK, ADA, accepts_ccfa, headstart, has_language_program,
has_advanced_placement, has_international_baccalaureate, uniform,
special_admission, surround_care, build_care, tuition.
"""
allowed = {
"UPK", "ADA", "accepts_ccfa", "headstart", "has_language_program",
"has_advanced_placement", "has_international_baccalaureate", "uniform",
"special_admission", "surround_care", "build_care", "tuition",
}
query = "SELECT * FROM schools WHERE 1=1"
params = []
for key, val in kwargs.items():
if key in allowed and val is not None:
query += f" AND {key} = ?"
params.append(val)
cur = self.conn.execute(query + " ORDER BY school", params)
return [dict(r) for r in cur.fetchall()]
def hard_filter(self, grade: int = None, age_months: int = None,
provider_type: str = None, lat: float = None, lon: float = None,
radius_miles: float = 1.0, **boolean_filters) -> list:
"""
Combined hard filter. All specified conditions must match (AND logic).
"""
query = "SELECT * FROM schools WHERE 1=1"
params = []
if grade is not None:
query += " AND grade_min <= ? AND grade_max >= ?"
params.extend([grade, grade])
if age_months is not None:
query += " AND age_min_months <= ? AND age_max_months >= ?"
params.extend([age_months, age_months])
if provider_type:
query += " AND provider_type = ?"
params.append(provider_type)
allowed_bools = {
"UPK", "ADA", "accepts_ccfa", "headstart", "has_language_program",
"has_advanced_placement", "has_international_baccalaureate", "uniform",
"special_admission", "surround_care", "build_care", "tuition",
}
for key, val in boolean_filters.items():
if key in allowed_bools and val is not None:
query += f" AND {key} = ?"
params.append(val)
cur = self.conn.execute(query + " ORDER BY school", params)
results = [dict(r) for r in cur.fetchall()]
# Post-filter by distance if location provided
if lat is not None and lon is not None:
filtered = []
for r in results:
if r["latitude"] and r["longitude"]:
dist = haversine_miles(lat, lon, r["latitude"], r["longitude"])
if dist <= radius_miles:
r["distance_miles"] = round(dist, 2)
filtered.append(r)
results = sorted(filtered, key=lambda x: x["distance_miles"])
return results
# --- Soft Filtering (Vector Search / RAG) ---
def semantic_search(self, query: str, top_k: int = 10,
pre_filter_ids: set = None) -> list:
"""
Semantic search over BPS school descriptions.
Args:
query: Natural language query
top_k: Number of results to return
pre_filter_ids: If provided, only search within these school IDs
"""
if self.index is None or self.model is None:
return self._keyword_search(query, top_k, pre_filter_ids)
import numpy as np
query_vec = self.model.encode([query], normalize_embeddings=True)
query_vec = np.array(query_vec).astype("float32")
search_k = min(top_k * 5, self.index.ntotal) if pre_filter_ids else top_k
scores, indices = self.index.search(query_vec, search_k)
results = []
for score, idx in zip(scores[0], indices[0]):
if idx < 0:
continue
meta = self.metadata[idx]
if pre_filter_ids and meta["id"] not in pre_filter_ids:
continue
results.append({
"id": meta["id"],
"school": meta["school"],
"score": float(score),
"description": self.documents[idx],
"metadata": meta,
})
if len(results) >= top_k:
break
return results
def _keyword_search(self, query: str, top_k: int = 10,
pre_filter_ids: set = None) -> list:
"""Fallback keyword search when FAISS/embeddings not available."""
if not self.documents:
return []
query_words = set(query.lower().split())
scored = []
for i, (doc, meta) in enumerate(zip(self.documents, self.metadata)):
if pre_filter_ids and meta["id"] not in pre_filter_ids:
continue
doc_lower = doc.lower()
score = sum(1 for w in query_words if w in doc_lower)
if score > 0:
scored.append({
"id": meta["id"],
"school": meta["school"],
"score": score / len(query_words),
"description": doc,
"metadata": meta,
})
scored.sort(key=lambda x: x["score"], reverse=True)
return scored[:top_k]
# --- Combined Hard + Soft Filter ---
def search(self, query: str = None, grade: int = None, provider_type: str = None,
lat: float = None, lon: float = None, radius_miles: float = 1.0,
top_k: int = 10, **filters) -> list:
"""
Full search pipeline:
1. Apply hard filters (grade, provider_type, location, booleans)
2. Within hard-filtered results, rank by semantic similarity to query
"""
hard_results = self.hard_filter(
grade=grade, provider_type=provider_type,
lat=lat, lon=lon, radius_miles=radius_miles, **filters,
)
if not query or not query.strip():
return hard_results[:top_k]
eligible_ids = set(r["id"] for r in hard_results)
if not eligible_ids:
return self.semantic_search(query, top_k)
soft_results = self.semantic_search(query, top_k, eligible_ids)
dist_map = {r["id"]: r.get("distance_miles") for r in hard_results}
for r in soft_results:
if dist_map.get(r["id"]) is not None:
r["distance_miles"] = dist_map[r["id"]]
return soft_results
# --- Filter Based on Preferences ---
def filter_based_on_preferences(self, school_ids: list, **preferences) -> dict:
"""
Filter eligible school IDs by preferences. Returns results split by
BPS vs non-BPS, with BPS schools semantically ranked when a query is provided.
Args:
school_ids: List of school IDs (from find_eligible_schools). Required, cannot be empty.
**preferences: Optional filters (query, top_k, ADA, UPK, has_language_program, etc.)
Returns:
Dict with bps_schools, non_bps_schools, bps_count, non_bps_count, notes.
"""
if not school_ids:
return {
"error": "school_ids is required and cannot be empty. Call find_eligible_schools first to get eligible school IDs.",
"bps_schools": [],
"non_bps_schools": [],
"notes": [],
}
query = preferences.pop("query", None)
top_k = preferences.pop("top_k", 10)
lat = preferences.pop("lat", None)
lon = preferences.pop("lon", None)
radius_miles = preferences.pop("radius_miles", 1.0)
provider_type = preferences.pop("provider_type", None)
# Build SQL with ID constraint + optional filters
placeholders = ",".join("?" for _ in school_ids)
sql = f"SELECT * FROM schools WHERE id IN ({placeholders})"
params = list(school_ids)
if provider_type:
sql += " AND provider_type = ?"
params.append(provider_type)
allowed_bools = {
"UPK", "ADA", "accepts_ccfa", "headstart", "has_language_program",
"has_advanced_placement", "has_international_baccalaureate", "uniform",
"special_admission", "surround_care", "build_care", "tuition",
}
for key, val in preferences.items():
if key in allowed_bools and val is not None:
sql += f" AND {key} = ?"
params.append(val)
cur = self.conn.execute(sql + " ORDER BY school", params)
rows = [dict(r) for r in cur.fetchall()]
# Post-filter by distance
if lat is not None and lon is not None:
filtered = []
for r in rows:
if r["latitude"] and r["longitude"]:
dist = haversine_miles(lat, lon, r["latitude"], r["longitude"])
if dist <= radius_miles:
r["distance_miles"] = round(dist, 2)
filtered.append(r)
rows = sorted(filtered, key=lambda x: x["distance_miles"])
# Split BPS vs non-BPS
bps_rows = [r for r in rows if r["provider_type"] == "Boston Public School"]
non_bps_rows = [r for r in rows if r["provider_type"] != "Boston Public School"]
bps_count = len(bps_rows)
non_bps_count = len(non_bps_rows)
notes = []
# Semantic ranking for BPS if query provided
if query and bps_rows:
bps_ids = set(str(r["id"]) for r in bps_rows)
ranked = self.semantic_search(query, top_k=len(bps_rows), pre_filter_ids=bps_ids)
ranked_ids = [r["id"] for r in ranked]
score_map = {r["id"]: r["score"] for r in ranked}
# Build ranked BPS list: ranked first, then unranked
bps_by_id = {str(r["id"]): r for r in bps_rows}
ranked_bps = []
for rid in ranked_ids:
if str(rid) in bps_by_id:
row = bps_by_id.pop(str(rid))
row["score"] = score_map[rid]
ranked_bps.append(row)
# Append any BPS schools not in FAISS results
for row in sorted(bps_by_id.values(), key=lambda x: x["school"]):
ranked_bps.append(row)
bps_rows = ranked_bps
if query and non_bps_count > 0:
notes.append(
f"Non-BPS schools cannot be ranked by their semantic preference "
f"'{query}' because detailed program descriptions are not publicly "
f"available for these providers, tell this to the user."
)
if bps_count == 0 and non_bps_count == 0:
notes.append(
"No schools matched the given filters. Tell the user to broaden "
"their criteria or to reach out to their eligible schools for more information."
)
return {
"bps_schools": bps_rows[:top_k],
"non_bps_schools": non_bps_rows[:top_k],
"bps_count": bps_count,
"non_bps_count": non_bps_count,
"notes": notes,
}
# --- Utility methods ---
def get_school_detail(self, school_id: str) -> dict:
"""Get full school record + RAG description if available."""
cur = self.conn.execute("SELECT * FROM schools WHERE id = ?", (school_id,))
row = cur.fetchone()
if row:
result = dict(row)
if self.metadata:
for i, m in enumerate(self.metadata):
if m["id"] == school_id:
result["description"] = self.documents[i]
break
return result
return None
def get_all_provider_types(self) -> list:
"""Get distinct provider types."""
cur = self.conn.execute(
"SELECT DISTINCT provider_type FROM schools ORDER BY provider_type"
)
return [r[0] for r in cur.fetchall()]
def close(self):
self.conn.close()
|