File size: 67,807 Bytes
38c016b 486eff6 38c016b 0fadcd4 38c016b 486eff6 38c016b 0dc7706 befd225 38c016b befd225 0fadcd4 38c016b 0dc7706 486eff6 0dc7706 486eff6 38c016b 486eff6 38c016b 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 0fadcd4 38c016b 0fadcd4 38c016b 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 38c016b 0fadcd4 486eff6 0fadcd4 38c016b 0fadcd4 38c016b 0fadcd4 38c016b 0fadcd4 38c016b 0fadcd4 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 0fadcd4 486eff6 38c016b befd225 38c016b befd225 486eff6 befd225 38c016b befd225 486eff6 38c016b 0dc7706 38c016b 0dc7706 38c016b befd225 38c016b befd225 38c016b befd225 486eff6 befd225 486eff6 befd225 486eff6 befd225 0fadcd4 befd225 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 486eff6 0fadcd4 0dc7706 0fadcd4 0dc7706 486eff6 0fadcd4 0dc7706 0fadcd4 0dc7706 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 38c016b 486eff6 |
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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
"""
Vector similarity search service using sentence-transformers and FAISS.
This implements true AI word generation via vector space nearest neighbor search.
"""
from math import log
import os
import logging
import asyncio
import time
import hashlib
import pickle
from datetime import datetime
from typing import List, Dict, Any, Optional, Tuple
import json
import numpy as np
import torch
from sentence_transformers import SentenceTransformer
import faiss
from pathlib import Path
logger = logging.getLogger(__name__)
# All logging now uses standard logger with filename/line numbers
class VectorSearchService:
"""
Service for finding semantically similar words using vector similarity search.
This replaces the old approach of filtering static word lists with true
vector space search through the model's full vocabulary.
"""
def __init__(self):
self.model = None
self.vocab = None
self.word_embeddings = None
self.faiss_index = None
self.is_initialized = False
# Configuration
self.model_name = os.getenv("EMBEDDING_MODEL", "sentence-transformers/all-mpnet-base-v2")
self.base_similarity_threshold = float(os.getenv("WORD_SIMILARITY_THRESHOLD", "0.55")) # Start high for quality
self.min_similarity_threshold = 0.45 # Never go below this to maintain relevance
self.max_results = 40 # Increased to get more candidates
self.use_hierarchical_search = os.getenv("USE_HIERARCHICAL_SEARCH", "true").lower() == "true"
# Cache manager for word fallback
self.cache_manager = None
# Session-based word tracking to prevent repetition across puzzles
self.used_words_by_topic = {} # topic -> set of used words
self.max_used_words_per_topic = int(os.getenv("MAX_USED_WORDS_MEMORY", "50")) # Remember last 50 words per topic
# Word exclusion mechanism - configurable list of words to never include
self.excluded_words = self._load_excluded_words()
# FAISS index caching
self.index_cache_dir = self._get_index_cache_dir()
self.vocab_cache_path = os.path.join(self.index_cache_dir, f"vocab_{self._get_model_hash()}.pkl")
self.embeddings_cache_path = os.path.join(self.index_cache_dir, f"embeddings_{self._get_model_hash()}.npy")
self.faiss_cache_path = os.path.join(self.index_cache_dir, f"faiss_index_{self._get_model_hash()}.faiss")
async def initialize(self):
"""Initialize the vector search service."""
try:
start_time = time.time()
# Log environment configuration for debugging
logger.info(f"π§ Environment Configuration:")
logger.info(f" π Model: {self.model_name}")
logger.info(f" π― Base Similarity Threshold: {self.base_similarity_threshold}")
logger.info(f" π Min Similarity Threshold: {self.min_similarity_threshold}")
logger.info(f" π Max Results: {self.max_results}")
logger.info(f" π Hierarchical Search: {self.use_hierarchical_search}")
logger.info(f" π Search Randomness: {os.getenv('SEARCH_RANDOMNESS', '0.02')}")
logger.info(f" πΎ Cache Dir: {os.getenv('WORD_CACHE_DIR', 'auto-detect')}")
logger.info(f"π§ Loading model: {self.model_name}")
# Load sentence transformer model
model_start = time.time()
self.model = SentenceTransformer(self.model_name)
model_time = time.time() - model_start
logger.info(f"β
Model loaded in {model_time:.2f}s: {self.model_name}")
# Try to load from cache first
if self._load_cached_index():
logger.info("π Using cached FAISS index - startup accelerated!")
else:
# Build from scratch
logger.info("π¨ Building FAISS index from scratch...")
# Get model vocabulary from tokenizer
vocab_start = time.time()
tokenizer = self.model.tokenizer
vocab_dict = tokenizer.get_vocab()
# Filter vocabulary for crossword-suitable words
self.vocab = self._filter_vocabulary(vocab_dict)
vocab_time = time.time() - vocab_start
logger.info(f"π Filtered vocabulary in {vocab_time:.2f}s: {len(self.vocab)} words")
# Pre-compute embeddings for all vocabulary words
embedding_start = time.time()
logger.info("π Starting embedding generation...")
await self._build_embeddings_index()
embedding_time = time.time() - embedding_start
logger.info(f"π Embeddings built in {embedding_time:.2f}s")
# Save to cache for next time
self._save_index_to_cache()
# Initialize cache manager
cache_start = time.time()
logger.info("π¦ Initializing word cache manager...")
try:
from .word_cache import WordCacheManager
self.cache_manager = WordCacheManager()
await self.cache_manager.initialize()
cache_time = time.time() - cache_start
logger.info(f"π¦ Cache manager initialized in {cache_time:.2f}s")
except Exception as e:
cache_time = time.time() - cache_start
logger.info(f"β οΈ Cache manager initialization failed in {cache_time:.2f}s: {e}")
logger.info("π Continuing without persistent caching (in-memory only)")
self.cache_manager = None
self.is_initialized = True
total_time = time.time() - start_time
logger.info(f"β
Vector search service fully initialized in {total_time:.2f}s")
except Exception as e:
logger.error(f"β Failed to initialize vector search: {e}")
self.is_initialized = False
raise
def _filter_vocabulary(self, vocab_dict: Dict[str, int]) -> List[str]:
"""Filter vocabulary to keep only crossword-suitable words."""
logger.info(f"π Filtering {len(vocab_dict)} vocabulary words...")
# Pre-compile excluded words set for faster lookup
excluded_words = {
# Generic/boring words
'THE', 'AND', 'FOR', 'ARE', 'BUT', 'NOT', 'YOU', 'ALL', 'THIS', 'THAT', 'WITH', 'FROM', 'THEY', 'WERE', 'BEEN', 'HAVE', 'THEIR', 'SAID', 'EACH', 'WHICH', 'WHAT', 'THERE', 'WILL', 'MORE', 'WHEN', 'SOME', 'LIKE', 'INTO', 'TIME', 'VERY', 'ONLY', 'HAS', 'HAD', 'WHO', 'OIL', 'ITS', 'NOW', 'FIND', 'LONG', 'DOWN', 'DAY', 'DID', 'GET', 'COME', 'MADE', 'MAY', 'PART',
# Topic words that are too obvious
'ANIMAL', 'ANIMALS', 'CREATURE', 'CREATURES', 'BEAST', 'BEASTS', 'THING', 'THINGS'
}
# Optimized filtering with list comprehension
filtered = []
processed = 0
for word, _ in vocab_dict.items():
processed += 1
# Progress logging for large vocabularies
if processed % 10000 == 0:
logger.info(f"π Vocabulary filtering progress: {processed}/{len(vocab_dict)}")
# Clean word (remove special tokens) - optimized
if word.startswith('##'):
clean_word = word[2:].upper()
else:
clean_word = word.upper()
# Quick length check first (fastest filter)
if len(clean_word) < 3 or len(clean_word) > 12:
continue
# Quick alphabet check
if not clean_word.isalpha():
continue
# Quick special token check
if clean_word.startswith(('[', '<')):
continue
# Excluded words check
if clean_word in excluded_words:
continue
# More expensive checks only for words that passed basic filters
if self._is_plural(clean_word) or self._is_boring_word(clean_word):
continue
filtered.append(clean_word)
# Remove duplicates efficiently and sort
unique_filtered = sorted(list(set(filtered)))
logger.info(f"π Vocabulary filtered: {len(vocab_dict)} β {len(unique_filtered)} words")
return unique_filtered
def _is_plural(self, word: str) -> bool:
"""Check if word is likely a plural."""
# Simple plural detection
if len(word) < 4:
return False
return (
word.endswith('S') and not word.endswith('SS') and
not word.endswith('US') and not word.endswith('IS')
)
def _is_boring_word(self, word: str) -> bool:
"""Check if word is boring or too generic for crosswords."""
boring_patterns = [
# Words ending in common suffixes that are often generic
word.endswith('ING') and len(word) > 6,
word.endswith('TION') and len(word) > 7,
word.endswith('NESS') and len(word) > 6,
# Very common short words
word in ['GET', 'GOT', 'PUT', 'SET', 'LET', 'RUN', 'CUT', 'HIT', 'SIT', 'WIN', 'BIG', 'NEW', 'OLD', 'BAD', 'GOOD', 'BEST', 'LAST', 'NEXT', 'REAL']
]
return any(boring_patterns)
async def _build_embeddings_index(self):
"""Build FAISS index with pre-computed embeddings for all vocabulary."""
logger.info("π¨ Building embeddings index...")
# Optimize batch size based on environment and CPU count
cpu_count = os.cpu_count() or 1
# Larger batches for better throughput, smaller for HF Spaces limited memory
batch_size = min(200 if cpu_count > 2 else 100, len(self.vocab) // 4)
logger.info(f"β‘ Using batch size {batch_size} with {cpu_count} CPUs")
embeddings_list = []
total_batches = (len(self.vocab) + batch_size - 1) // batch_size
# Process embeddings in parallel-friendly batches
for i in range(0, len(self.vocab), batch_size):
batch = self.vocab[i:i + batch_size]
batch_num = i // batch_size + 1
# Use sentence-transformers built-in optimization
# show_progress_bar=False to avoid cluttering logs
batch_embeddings = self.model.encode(
batch,
convert_to_numpy=True,
show_progress_bar=False,
batch_size=min(32, len(batch)), # Internal mini-batch size
normalize_embeddings=False # We'll normalize later for FAISS
)
embeddings_list.append(batch_embeddings)
# Progress logging - more frequent for slower HF Spaces
if batch_num % max(1, total_batches // 10) == 0:
progress = (batch_num / total_batches) * 100
logger.info(f"π Embedding progress: {progress:.1f}% ({i}/{len(self.vocab)} words)")
# Combine all embeddings
logger.info("π Combining embeddings...")
self.word_embeddings = np.vstack(embeddings_list)
logger.info(f"π Generated embeddings shape: {self.word_embeddings.shape}")
# Build FAISS index for fast similarity search
logger.info("ποΈ Building FAISS index...")
dimension = self.word_embeddings.shape[1]
self.faiss_index = faiss.IndexFlatIP(dimension) # Inner product similarity
# Normalize embeddings for cosine similarity
logger.info("π Normalizing embeddings for cosine similarity...")
faiss.normalize_L2(self.word_embeddings)
# Add to FAISS index
logger.info("π₯ Adding embeddings to FAISS index...")
self.faiss_index.add(self.word_embeddings)
logger.info(f"π FAISS index built with {self.faiss_index.ntotal} vectors")
async def find_similar_words(
self,
topic: str,
difficulty: str = "medium",
max_words: int = 15
) -> List[Dict[str, Any]]:
"""
Find words similar to the given topic using vector similarity search.
This is the core function that replaces embedding filtering with true
vector space nearest neighbor search.
"""
logger.info(f"π Starting word search for topic: '{topic}', difficulty: '{difficulty}', max_words: {max_words}")
logger.info(f"π€ Vector search initialized: {self.is_initialized}")
if not self.is_initialized:
logger.warning("π Vector search not initialized, using cached fallback")
return await self._get_cached_fallback(topic, difficulty, max_words)
try:
if self.use_hierarchical_search:
# Use hierarchical search for better word diversity and coverage
logger.info(f"π Using hierarchical semantic search for enhanced word generation")
# Perform hierarchical search (topic variations + subcategories)
all_candidates = await self._hierarchical_search(topic, difficulty, max_words)
# Combine and filter results intelligently
if all_candidates:
combined_results = self._combine_hierarchical_results(all_candidates, max_words * 2) # Get more candidates for filtering
# Apply word exclusions to remove inappropriate words
combined_results = self._apply_word_exclusions(combined_results)
# Filter out previously used words to improve variety
similar_words = self._filter_used_words(combined_results, topic)
# Trim to requested count
similar_words = similar_words[:max_words]
logger.info(f"π― Hierarchical search generated {len(similar_words)} words for '{topic}' (after variety filtering)")
# Track these words to prevent future repetition
if similar_words:
self._track_used_words(topic, similar_words)
# Cache successful results for future use
if similar_words:
await self._cache_successful_search(topic, difficulty, similar_words)
else:
similar_words = []
logger.warning(f"β οΈ Hierarchical search found no candidates for '{topic}'")
else:
# Fall back to original single-search approach
logger.info(f"π Using traditional single-search approach")
traditional_results = await self._traditional_single_search(topic, difficulty, max_words * 2) # Get more for filtering
# Apply word exclusions to remove inappropriate words
traditional_results = self._apply_word_exclusions(traditional_results)
# Filter out previously used words to improve variety
similar_words = self._filter_used_words(traditional_results, topic)
similar_words = similar_words[:max_words]
# Track these words to prevent future repetition
if similar_words:
self._track_used_words(topic, similar_words)
# If not enough words found, supplement with cached words (more aggressive)
if len(similar_words) < max_words * 0.75: # If less than 75% of target, supplement
cached_supplement = await self._get_cached_fallback(
topic, difficulty, max_words - len(similar_words)
)
similar_words.extend(cached_supplement)
logger.info(f"π Supplemented with {len(cached_supplement)} cached words")
# If still not enough, try emergency bootstrap
if len(similar_words) < max_words // 2:
emergency_words = self._get_emergency_bootstrap(
topic, difficulty, max_words - len(similar_words)
)
similar_words.extend(emergency_words)
logger.info(f"π Added {len(emergency_words)} emergency bootstrap words")
return similar_words[:max_words]
except Exception as e:
logger.error(f"β Vector search failed for '{topic}': {e}")
# Try cached fallback first
cached_words = await self._get_cached_fallback(topic, difficulty, max_words)
if cached_words:
return cached_words
# Last resort: bootstrap with simple topic-related words
logger.warning(f"β οΈ No cached words available, using emergency bootstrap for '{topic}'")
return self._get_emergency_bootstrap(topic, difficulty, max_words)
def _matches_difficulty(self, word: str, difficulty: str) -> bool:
"""Check if word matches difficulty criteria."""
difficulty_map = {
"easy": {"min_len": 3, "max_len": 8},
"medium": {"min_len": 4, "max_len": 10},
"hard": {"min_len": 5, "max_len": 15}
}
criteria = difficulty_map.get(difficulty, difficulty_map["medium"])
return criteria["min_len"] <= len(word) <= criteria["max_len"]
def _generate_clue(self, word: str, topic: str) -> str:
"""Generate a simple clue for the word."""
# Basic clue templates - can be enhanced with LLM generation later
clue_templates = {
"Animals": f"{word.lower()} (animal)",
"Technology": f"{word.lower()} (tech term)",
"Science": f"{word.lower()} (scientific term)",
"Geography": f"{word.lower()} (geographic feature)"
}
return clue_templates.get(topic, f"{word.lower()} (related to {topic.lower()})")
def _is_interesting_word(self, word: str, topic: str) -> bool:
"""Check if word is interesting enough for crosswords."""
# Exclude words that are too obvious for the topic
topic_lower = topic.lower()
word_lower = word.lower()
# Don't include the exact topic word, but allow meaningful variations
if word_lower == topic_lower:
return False
# More nuanced substring checking - avoid overly broad rejections
# Only reject if the word is a simple substring or the topic contains the word entirely
if len(word_lower) >= 4: # For longer words, be more permissive
# Allow words like TECH, ICT, BIOTECH even if topic is "technology"
if topic_lower in ['technology', 'tech'] and word_lower in ['tech', 'ict']:
return True
# Allow words like ANIMAL, MAMMAL even if topic is "animals"
if topic_lower in ['animals', 'animal'] and word_lower in ['animal', 'mammal']:
return True
# General rule: reject only if word is completely contained in topic and is short
if word_lower in topic_lower and len(word_lower) < 4:
return False
# Topic-specific filtering
if topic_lower == 'animals':
obvious_animals = ['mammal', 'mammals', 'wildlife', 'organism', 'organisms', 'livestock']
if word_lower in obvious_animals:
return False
# Prefer concrete nouns over abstract concepts
# Be more selective about abstract word filtering - many "-ment" words are concrete
truly_abstract_endings = ['tion', 'ness', 'ity', 'ism'] # Removed 'ment' as too broad
if any(word_lower.endswith(ending) for ending in truly_abstract_endings) and len(word) > 9:
# Additional check: only reject if the word seems truly abstract
abstract_prefixes = ['develop', 'manage', 'establish', 'improve', 'achieve']
if any(word_lower.startswith(prefix) for prefix in abstract_prefixes):
return False
return True
def _track_used_words(self, topic: str, words: List[Dict[str, Any]]):
"""Track words used for this topic to avoid repetition in future puzzles."""
topic_key = topic.lower()
if topic_key not in self.used_words_by_topic:
self.used_words_by_topic[topic_key] = set()
# Add new words to the used set
new_words = [w['word'].upper() for w in words]
self.used_words_by_topic[topic_key].update(new_words)
# Limit memory usage - keep only the most recent words
if len(self.used_words_by_topic[topic_key]) > self.max_used_words_per_topic:
# Convert to list, keep last N words, convert back to set
used_list = list(self.used_words_by_topic[topic_key])
self.used_words_by_topic[topic_key] = set(used_list[-self.max_used_words_per_topic:])
logger.info(f"π Tracking {len(new_words)} words for '{topic}' (total remembered: {len(self.used_words_by_topic[topic_key])})")
def _get_used_words_for_topic(self, topic: str) -> set:
"""Get the set of words already used for this topic."""
topic_key = topic.lower()
return self.used_words_by_topic.get(topic_key, set())
def _filter_used_words(self, candidates: List[Dict[str, Any]], topic: str) -> List[Dict[str, Any]]:
"""Filter out words that have been used recently for this topic."""
if not candidates:
return candidates
used_words = self._get_used_words_for_topic(topic)
if not used_words:
return candidates
# Filter out previously used words
filtered = []
filtered_out = []
for candidate in candidates:
word = candidate['word'].upper()
if word not in used_words:
filtered.append(candidate)
else:
filtered_out.append(word)
if filtered_out:
logger.info(f"π« Filtered out {len(filtered_out)} previously used words for '{topic}': {filtered_out[:5]}{'...' if len(filtered_out) > 5 else ''}")
logger.info(f"π Word variety filter: {len(candidates)} β {len(filtered)} candidates")
return filtered
def _expand_topic_variations(self, topic: str) -> List[str]:
"""
Expand topic to include singular/plural variations for better semantic coverage.
Examples:
- "Animal" β ["Animal", "Animals"]
- "Animals" β ["Animals", "Animal"]
- "Technology" β ["Technology", "Technologies"]
"""
variations = [topic] # Always include original
topic_lower = topic.lower()
# Handle common plural patterns
if topic_lower.endswith('s') and len(topic) > 3:
# Likely plural, try to get singular
if topic_lower.endswith('ies'):
# Technologies β Technology
singular = topic[:-3] + 'y'
elif topic_lower.endswith('sses') or topic_lower.endswith('shes') or topic_lower.endswith('ches') or topic_lower.endswith('xes'):
# Classes β Class, Boxes β Box, Watches β Watch
singular = topic[:-2]
elif topic_lower.endswith('es') and len(topic) > 4:
# Sciences β Science (but not "Yes" β "Ye")
singular = topic[:-1] # Try removing just 's' first for words ending in 'es'
elif topic_lower.endswith('s'):
# Animals β Animal
singular = topic[:-1]
else:
singular = topic
if singular != topic and len(singular) >= 3:
variations.append(singular)
else:
# Likely singular, add plural
if topic_lower.endswith('y') and topic_lower[-2] not in 'aeiou':
# Technology β Technologies
plural = topic[:-1] + 'ies'
elif topic_lower.endswith(('s', 'sh', 'ch', 'x', 'z')):
# Science β Sciences, Class β Classes
plural = topic + 'es'
else:
# Animal β Animals
plural = topic + 's'
variations.append(plural)
# Remove duplicates while preserving order
unique_variations = []
for variation in variations:
if variation not in unique_variations:
unique_variations.append(variation)
logger.info(f"π Topic variations for '{topic}': {unique_variations}")
return unique_variations
def _identify_subcategories(self, candidates: List[Dict[str, Any]], main_topic: str) -> List[str]:
"""
Identify which candidate words are likely sub-categories for hierarchical search.
Args:
candidates: List of word candidates with similarity scores
main_topic: The original topic being searched
Returns:
List of subcategory words suitable for secondary search
"""
subcategories = []
main_topic_lower = main_topic.lower()
# Category indicators - words that suggest this is a category rather than terminal word
category_patterns = {
# Scientific/academic suffixes
'academic': ['logy', 'ics', 'ism', 'ology'],
# Adjective forms that suggest categories
'adjective': ['logical', 'ical', 'tic', 'ian', 'nal', 'ous'],
# Collection/group words
'collective': ['life', 'stock', 'ware', 'kind', 'type', 'group'],
# General category indicators
'general': ['wild', 'domestic', 'marine', 'land', 'air', 'water']
}
# Known category words for common topics
known_categories = {
'animal': ['wildlife', 'livestock', 'mammal', 'mammalian', 'fauna', 'zoology', 'zoological',
'vertebrate', 'invertebrate', 'reptile', 'amphibian', 'primate', 'rodent',
'carnivore', 'herbivore', 'omnivore', 'predator', 'prey'],
'technology': ['software', 'hardware', 'digital', 'electronic', 'computing', 'internet',
'mobile', 'wireless', 'networking', 'cybernetic', 'robotic', 'automated'],
'science': ['physics', 'chemistry', 'biology', 'astronomy', 'geology', 'mathematics',
'theoretical', 'experimental', 'applied', 'quantum', 'molecular', 'atomic'],
'geography': ['continental', 'coastal', 'mountainous', 'desert', 'tropical', 'polar',
'urban', 'rural', 'geological', 'topographical', 'cartographic']
}
# for candidate in candidates[:10]: # Only consider top 10 for performance
for candidate in candidates: # Only consider top 10 for performance
word = candidate['word'].lower()
similarity = candidate['similarity']
# Skip if similarity is too low (likely not a good subcategory)
if similarity < 0.45:
continue
is_subcategory = False
# Check against known categories for this topic
topic_categories = known_categories.get(main_topic_lower, [])
if word in topic_categories:
is_subcategory = True
logger.info(f"π '{word.upper()}' identified as known subcategory for '{main_topic}'")
# Check pattern-based detection
if not is_subcategory:
for pattern_type, patterns in category_patterns.items():
for pattern in patterns:
if word.endswith(pattern):
is_subcategory = True
logger.info(f"π '{word.upper()}' identified as subcategory (pattern: {pattern})")
break
if is_subcategory:
break
# Additional heuristics
if not is_subcategory:
# Words that are likely categories based on length and composition
if (len(word) >= 6 and # Reasonable length
word.count('i') + word.count('o') >= 2 and # Contains vowels (not acronym)
not word.isupper() and # Not an acronym
word.isalpha()): # Only letters
# Check if it's an abstract/categorical concept
if any(word.endswith(ending) for ending in ['ism', 'ity', 'ness', 'tion', 'sion']):
is_subcategory = True
logger.info(f"π '{word.upper()}' identified as subcategory (abstract concept)")
if is_subcategory and word.upper() not in subcategories:
subcategories.append(word.upper())
# Limit subcategories to prevent explosion
max_subcategories = 5
limited_subcategories = subcategories[:max_subcategories]
if limited_subcategories:
logger.info(f"π³ Identified {len(limited_subcategories)} subcategories for '{main_topic}': {limited_subcategories}")
else:
logger.info(f"π³ No suitable subcategories found for '{main_topic}'")
return limited_subcategories
async def _hierarchical_search(
self,
topic: str,
difficulty: str,
max_words: int
) -> List[Dict[str, Any]]:
"""
Perform hierarchical semantic search using topic variations and subcategories.
Search strategy:
1. Search for topic variations (singular/plural)
2. Identify subcategories from initial results
3. Search subcategories for more specific words
4. Combine and weight all results
"""
all_candidates = []
# Phase 1: Search topic variations (singular/plural)
topic_variations = self._expand_topic_variations(topic)
logger.info(f"π Starting hierarchical search for '{topic}' with {len(topic_variations)} variations")
# Search each topic variation
main_topic_candidates = []
for variation in topic_variations:
logger.info(f"π Searching topic variation: '{variation}'")
# Get topic embedding
topic_embedding = self.model.encode([variation], convert_to_numpy=True)
# Add search randomness
noise_factor = float(os.getenv("SEARCH_RANDOMNESS", "0.02"))
if noise_factor > 0:
try:
noise = np.random.normal(0, noise_factor, topic_embedding.shape)
topic_embedding = topic_embedding + noise
except Exception:
pass # Continue without noise if it fails
topic_embedding = np.ascontiguousarray(topic_embedding, dtype=np.float32)
faiss.normalize_L2(topic_embedding)
# Search FAISS index
search_size = min(self.max_results * 3, 100) # Moderate size for variations
scores, indices = self.faiss_index.search(topic_embedding, search_size)
# Collect candidates for this variation
variation_candidates = self._collect_candidates_with_threshold(
scores, indices, self.base_similarity_threshold, variation, difficulty
)
# Weight main topic higher than variations
weight = 1.0 if variation == topic else 0.9
for candidate in variation_candidates:
candidate['similarity'] *= weight
candidate['search_source'] = f"main_topic:{variation}"
main_topic_candidates.extend(variation_candidates)
if len(main_topic_candidates) <= 10:
logger.info(f"π Main topic search found candidates: {main_topic_candidates}")
logger.info(f"π Main topic search found {len(main_topic_candidates)} candidates")
# Phase 2: Identify subcategories from best candidates
if main_topic_candidates:
# Sort by similarity to get best candidates for subcategory detection
main_topic_candidates.sort(key=lambda x: x['similarity'], reverse=True)
subcategories = self._identify_subcategories(main_topic_candidates, topic)
# Phase 3: Search subcategories
subcategory_candidates = []
for subcategory in subcategories:
logger.info(f"π³ Searching subcategory: '{subcategory}'")
try:
# Get subcategory embedding
subcat_embedding = self.model.encode([subcategory], convert_to_numpy=True)
subcat_embedding = np.ascontiguousarray(subcat_embedding, dtype=np.float32)
faiss.normalize_L2(subcat_embedding)
# Search with smaller result set for subcategories
sub_search_size = min(self.max_results * 2, 60)
sub_scores, sub_indices = self.faiss_index.search(subcat_embedding, sub_search_size)
# Use slightly lower threshold for subcategories to get more variety
sub_threshold = max(self.base_similarity_threshold - 0.05, self.min_similarity_threshold)
sub_candidates = self._collect_candidates_with_threshold(
sub_scores, sub_indices, sub_threshold, subcategory, difficulty
)
# Weight subcategory results lower than main topic
for candidate in sub_candidates:
candidate['similarity'] *= 0.8 # Lower weight for subcategory results
candidate['search_source'] = f"subcategory:{subcategory}"
subcategory_candidates.extend(sub_candidates)
logger.info(f"π³ Subcategory '{subcategory}' found {len(sub_candidates)} candidates")
except Exception as e:
logger.warning(f"β οΈ Failed to search subcategory '{subcategory}': {e}")
continue
logger.info(f"π³ Subcategory search found {len(subcategory_candidates)} additional candidates")
else:
subcategory_candidates = []
# Phase 4: Combine all candidates
all_candidates = main_topic_candidates + subcategory_candidates
logger.info(f"π Total candidates before deduplication: {len(all_candidates)}")
return all_candidates
async def _traditional_single_search(
self,
topic: str,
difficulty: str,
max_words: int
) -> List[Dict[str, Any]]:
"""
Traditional single-topic search approach (original implementation).
Kept as fallback option for compatibility.
"""
# Get topic embedding
topic_embedding = self.model.encode([topic], convert_to_numpy=True)
# Add small amount of noise to create variety in search results
import numpy as np
noise_factor = float(os.getenv("SEARCH_RANDOMNESS", "0.02"))
if noise_factor > 0:
try:
noise = np.random.normal(0, noise_factor, topic_embedding.shape)
topic_embedding = topic_embedding + noise
except Exception:
pass # Continue without noise if it fails
topic_embedding = np.ascontiguousarray(topic_embedding, dtype=np.float32)
faiss.normalize_L2(topic_embedding)
# Search for similar words using FAISS
search_size = min(self.max_results * 6, 150)
scores, indices = self.faiss_index.search(topic_embedding, search_size)
# Debug: log search results
logger.info(f"π FAISS search returned {len(scores[0])} results")
logger.info(f"π Top 5 scores: {scores[0][:5]}")
# Log the actual words found by FAISS for debugging
top_words_with_scores = []
for i, (score, idx) in enumerate(zip(scores[0][:10], indices[0][:10])):
word = self.vocab[idx]
top_words_with_scores.append(f"{word}({score:.3f})")
logger.info(f"π Top 10 FAISS words: {', '.join(top_words_with_scores)}")
# Adaptive threshold strategy
candidates = []
thresholds_to_try = [
self.base_similarity_threshold,
max(self.base_similarity_threshold - 0.05, self.min_similarity_threshold),
max(self.base_similarity_threshold - 0.10, self.min_similarity_threshold),
self.min_similarity_threshold
]
for threshold in thresholds_to_try:
logger.info(f"π― Trying threshold: {threshold}")
candidates = self._collect_candidates_with_threshold(scores, indices, threshold, topic, difficulty)
logger.info(f"π Found {len(candidates)} candidates with threshold {threshold}")
if len(candidates) >= max_words * 0.75:
logger.info(f"β
Sufficient words found with threshold {threshold}")
break
elif len(candidates) >= max_words // 2:
logger.info(f"β‘ Acceptable words found with threshold {threshold}")
break
# Smart randomization
import random
if len(candidates) > max_words * 2:
similar_words = self._weighted_random_selection(candidates, max_words)
else:
random.shuffle(candidates)
similar_words = candidates[:max_words]
logger.info(f"π― Traditional search found {len(similar_words)} words for '{topic}'")
# Cache successful results
if similar_words:
await self._cache_successful_search(topic, difficulty, similar_words)
return similar_words
def _combine_hierarchical_results(
self,
all_candidates: List[Dict[str, Any]],
max_words: int
) -> List[Dict[str, Any]]:
"""
Intelligently combine and deduplicate results from hierarchical search.
Strategy:
1. Remove duplicates while preserving best similarity scores
2. Apply source-based weighting (main topic > subcategories)
3. Ensure diverse representation from different search sources
4. Apply adaptive threshold filtering
"""
if not all_candidates:
return []
# Step 1: Strict deduplication by word while keeping best score
word_best_scores = {}
for candidate in all_candidates:
word = candidate['word'].upper() # Ensure consistent casing
similarity = candidate['similarity']
source = candidate.get('search_source', 'unknown')
# Only keep if this word hasn't been seen or if it has a better score
if word not in word_best_scores or similarity > word_best_scores[word]['similarity']:
candidate_copy = candidate.copy()
candidate_copy['word'] = word # Normalize case
word_best_scores[word] = candidate_copy
deduplicated = list(word_best_scores.values())
logger.info(f"π After strict deduplication: {len(all_candidates)} β {len(deduplicated)} unique words")
# Step 2: Add randomization to improve variety while maintaining quality
# Group by similarity tiers to maintain quality while adding variety
high_quality = [w for w in deduplicated if w['similarity'] >= self.base_similarity_threshold]
medium_quality = [w for w in deduplicated if self.base_similarity_threshold - 0.1 <= w['similarity'] < self.base_similarity_threshold]
lower_quality = [w for w in deduplicated if w['similarity'] < self.base_similarity_threshold - 0.1]
# Shuffle within each tier for variety, then recombine
import random
random.shuffle(high_quality)
random.shuffle(medium_quality)
random.shuffle(lower_quality)
# Combine back in quality order but with randomness within tiers
deduplicated = high_quality + medium_quality + lower_quality
logger.info(f"π² Randomized within quality tiers: {len(high_quality)} high, {len(medium_quality)} medium, {len(lower_quality)} lower")
# Step 3: Apply adaptive threshold filtering (reuse existing logic)
thresholds_to_try = [
self.base_similarity_threshold,
max(self.base_similarity_threshold - 0.05, self.min_similarity_threshold),
max(self.base_similarity_threshold - 0.10, self.min_similarity_threshold),
self.min_similarity_threshold
]
final_candidates = []
for threshold in thresholds_to_try:
filtered_candidates = [c for c in deduplicated if c['similarity'] >= threshold]
logger.info(f"π― Hierarchical threshold {threshold}: {len(filtered_candidates)} candidates")
if len(filtered_candidates) >= max_words * 0.75:
final_candidates = filtered_candidates
logger.info(f"β
Sufficient words found with hierarchical threshold {threshold}")
break
elif len(filtered_candidates) >= max_words // 2:
final_candidates = filtered_candidates
logger.info(f"β‘ Acceptable words found with hierarchical threshold {threshold}")
break
if not final_candidates:
final_candidates = deduplicated # Use all if threshold filtering too strict
# Step 4: Ensure source diversity in final selection
final_selection = self._ensure_source_diversity(final_candidates, max_words)
logger.info(f"π Final hierarchical selection: {len(final_selection)} words")
# Log the sources for debugging
source_counts = {}
for candidate in final_selection:
source = candidate.get('search_source', 'unknown')
source_counts[source] = source_counts.get(source, 0) + 1
logger.info(f"π Source distribution: {source_counts}")
return final_selection
def _ensure_source_diversity(
self,
candidates: List[Dict[str, Any]],
max_words: int
) -> List[Dict[str, Any]]:
"""
Balance word selection across different search sources for optimal variety.
Allocates selection quotas to ensure representation from main topic searches
and subcategory searches, preventing over-concentration from any single source
while maintaining quality standards.
Args:
candidates: Word candidates with search source metadata
max_words: Target number of words to select
Returns:
Balanced selection ensuring source diversity
"""
if len(candidates) <= max_words:
return candidates
# Group by source
source_groups = {}
for candidate in candidates:
source = candidate.get('search_source', 'unknown')
if source not in source_groups:
source_groups[source] = []
source_groups[source].append(candidate)
# If we have multiple sources, ensure representation from each
if len(source_groups) > 1:
selected = []
main_topic_quota = max_words * 2 // 3 # 2/3 from main topic
subcategory_quota = max_words - main_topic_quota # 1/3 from subcategories
# Select from main topic sources first
main_sources = [k for k in source_groups.keys() if k.startswith('main_topic:')]
for source in main_sources:
quota = main_topic_quota // len(main_sources) if main_sources else 0
selected.extend(source_groups[source][:quota])
# Fill remaining slots with subcategory sources
subcat_sources = [k for k in source_groups.keys() if k.startswith('subcategory:')]
if subcat_sources and len(selected) < max_words:
remaining_slots = max_words - len(selected)
quota_per_subcat = max(1, remaining_slots // len(subcat_sources))
for source in subcat_sources:
if len(selected) >= max_words:
break
selected.extend(source_groups[source][:quota_per_subcat])
# Fill any remaining slots with best remaining candidates
if len(selected) < max_words:
used_words = {c['word'] for c in selected}
remaining = [c for c in candidates if c['word'] not in used_words]
needed = max_words - len(selected)
selected.extend(remaining[:needed])
return selected[:max_words]
else:
# Single source, just return top candidates
return candidates[:max_words]
def _get_index_cache_dir(self) -> str:
"""Get the directory for caching FAISS indexes."""
# Use different cache locations based on environment
if os.path.exists("/.dockerenv") or os.getenv("SPACE_ID"):
# Docker/HF Spaces - use /tmp for persistence across container restarts
cache_dir = os.getenv("FAISS_CACHE_DIR", "/tmp/faiss_cache")
else:
# Local development - use local cache directory
cache_dir = os.getenv("FAISS_CACHE_DIR", "faiss_cache")
os.makedirs(cache_dir, exist_ok=True)
return cache_dir
def _get_model_hash(self) -> str:
"""Generate a hash for the model configuration to use in cache keys."""
# Create hash based on model name and configuration
config_str = f"{self.model_name}_v2" # v2 for new caching format
return hashlib.md5(config_str.encode()).hexdigest()[:8]
def _cache_exists(self) -> bool:
"""Check if all cached files exist."""
return (os.path.exists(self.vocab_cache_path) and
os.path.exists(self.embeddings_cache_path) and
os.path.exists(self.faiss_cache_path))
def _load_excluded_words(self) -> set:
"""Load list of words to exclude from crossword generation."""
# Default excluded words - overly generic or inappropriate for crosswords
default_excluded = {
"WORD", "THING", "STUFF", "ITEMS", "THINGS", "WORDS", "TEXT", "STRING",
"DATA", "INFO", "CONTENT", "MATERIAL", "ELEMENT", "OBJECT", "ENTITY",
"CONCEPT", "IDEA", "NOTION", "ABSTRACT", "GENERAL", "SPECIFIC", "VARIOUS",
"MULTIPLE", "SEVERAL", "MANY", "SOME", "MOST", "ALL", "EACH", "EVERY",
"DIFFERENT", "SIMILAR", "SAME", "OTHER", "ANOTHER", "VARIOUS", "CERTAIN"
}
# Load additional exclusions from environment or file
env_excluded = os.getenv("EXCLUDED_WORDS", "")
if env_excluded:
env_words = {word.strip().upper() for word in env_excluded.split(",") if word.strip()}
default_excluded.update(env_words)
# Try to load from exclusion file if it exists
exclusion_file = os.getenv("WORD_EXCLUSION_FILE", "")
if exclusion_file and os.path.exists(exclusion_file):
try:
with open(exclusion_file, 'r') as f:
file_words = {word.strip().upper() for line in f for word in [line.strip()] if word and not word.startswith('#')}
default_excluded.update(file_words)
logger.info(f"π Loaded {len(file_words)} additional excluded words from {exclusion_file}")
except Exception as e:
logger.warning(f"β οΈ Failed to load exclusion file {exclusion_file}: {e}")
logger.info(f"π« Loaded {len(default_excluded)} excluded words for filtering")
return default_excluded
def _apply_word_exclusions(self, candidates: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
"""Filter out excluded words from candidates."""
if not candidates or not self.excluded_words:
return candidates
filtered = []
excluded_count = 0
for candidate in candidates:
word = candidate['word'].upper()
if word not in self.excluded_words:
filtered.append(candidate)
else:
excluded_count += 1
if excluded_count > 0:
logger.info(f"π« Excluded {excluded_count} inappropriate words from results")
return filtered
def _load_cached_index(self) -> bool:
"""Load FAISS index from cache if available."""
try:
if not self._cache_exists():
logger.info("π No cached index found - will build new index")
return False
logger.info("π Loading cached FAISS index...")
cache_start = time.time()
# Load vocabulary
with open(self.vocab_cache_path, 'rb') as f:
self.vocab = pickle.load(f)
logger.info(f"π Loaded {len(self.vocab)} vocabulary words from cache")
# Load embeddings
self.word_embeddings = np.load(self.embeddings_cache_path)
logger.info(f"π Loaded embeddings shape: {self.word_embeddings.shape}")
# Load FAISS index
self.faiss_index = faiss.read_index(self.faiss_cache_path)
logger.info(f"π Loaded FAISS index with {self.faiss_index.ntotal} vectors")
cache_time = time.time() - cache_start
logger.info(f"β
Successfully loaded cached index in {cache_time:.2f}s")
return True
except Exception as e:
logger.info(f"β Failed to load cached index: {e}")
logger.info("π Will rebuild index from scratch")
return False
def _save_index_to_cache(self):
"""Save the built FAISS index to cache for future use."""
try:
logger.info("πΎ Saving FAISS index to cache...")
save_start = time.time()
# Save vocabulary
with open(self.vocab_cache_path, 'wb') as f:
pickle.dump(self.vocab, f)
# Save embeddings
np.save(self.embeddings_cache_path, self.word_embeddings)
# Save FAISS index
faiss.write_index(self.faiss_index, self.faiss_cache_path)
save_time = time.time() - save_start
logger.info(f"β
Index cached successfully in {save_time:.2f}s")
logger.info(f"π Cache location: {self.index_cache_dir}")
except Exception as e:
logger.info(f"β οΈ Failed to cache index: {e}")
logger.info("π Continuing without caching (performance will be slower next startup)")
def _is_topic_relevant(self, word: str, topic: str) -> bool:
"""
Enhanced topic relevance check to prevent unrelated words.
This is an additional filter beyond similarity scores.
"""
word_lower = word.lower()
topic_lower = topic.lower()
# Topic-specific validation
if topic_lower in ['animals', 'animal']:
# Animal-related keywords that should appear in related words
animal_indicators = [
'bird', 'fish', 'mammal', 'reptile', 'insect', 'creature', 'wild', 'domestic',
'hunt', 'prey', 'pack', 'herd', 'flock', 'swarm', 'nest', 'den', 'habitat',
'fur', 'feather', 'scale', 'claw', 'tail', 'wing', 'beak', 'hoof',
'zoo', 'farm', 'forest', 'ocean', 'jungle', 'safari'
]
# Reject obviously non-animal words
tech_indicators = ['computer', 'software', 'digital', 'internet', 'mobile', 'app', 'code', 'data']
if any(indicator in word_lower for indicator in tech_indicators):
logger.info(f"π« Rejected '{word}' for {topic}: contains tech indicators")
return False
elif topic_lower in ['technology', 'tech']:
# Technology-related validation - reject obvious animal names
animal_indicators = ['bird', 'fish', 'mammal', 'animal', 'creature', 'wild', 'fur', 'feather',
'elephant', 'tiger', 'lion', 'bear', 'wolf', 'cat', 'dog', 'horse']
if any(indicator in word_lower for indicator in animal_indicators):
logger.info(f"π« Rejected '{word}' for {topic}: contains animal indicators")
return False
elif topic_lower in ['science', 'scientific']:
# Science should avoid overly casual or non-scientific terms
casual_indicators = ['phone', 'app', 'game', 'fun', 'cool', 'awesome']
if any(indicator in word_lower for indicator in casual_indicators):
logger.info(f"π« Rejected '{word}' for {topic}: too casual for science")
return False
elif topic_lower in ['geography', 'geographic']:
# Geography should relate to places, landforms, etc.
tech_indicators = ['software', 'computer', 'digital', 'code', 'app']
if any(indicator in word_lower for indicator in tech_indicators):
logger.info(f"π« Rejected '{word}' for {topic}: tech term in geography")
return False
# Additional general filters
# Reject words that are too generic or meta
meta_words = ['word', 'term', 'name', 'thing', 'stuff', 'item', 'object']
if word_lower in meta_words:
logger.info(f"π« Rejected '{word}': too generic/meta")
return False
# Word should have some length for crosswords
if len(word) < 3:
return False
return True
def _collect_candidates_with_threshold(
self,
scores: np.ndarray,
indices: np.ndarray,
threshold: float,
topic: str,
difficulty: str
) -> List[Dict[str, Any]]:
"""Collect word candidates using a specific similarity threshold."""
candidates = []
above_threshold = 0
difficulty_passed = 0
interesting_passed = 0
rejected_words = []
for score, idx in zip(scores[0], indices[0]):
if score < threshold:
continue
above_threshold += 1
word = self.vocab[idx]
# Filter by difficulty and quality
if self._matches_difficulty(word, difficulty):
difficulty_passed += 1
# if self._is_interesting_word(word, topic) and self._is_topic_relevant(word, topic):
interesting_passed += 1
candidates.append({
"word": word,
"clue": self._generate_clue(word, topic),
"similarity": float(score),
"source": "vector_search"
})
# else:
# rejected_words.append(f"{word}({score:.3f})")
else:
rejected_words.append(f"{word}({score:.3f})")
# Log rejected words for debugging (show first 5)
if rejected_words and len(rejected_words) <= 10:
logger.info(f"π« Rejected words at threshold {threshold}: {', '.join(rejected_words[:5])}")
elif rejected_words:
logger.info(f"π« Rejected {len(rejected_words)} words at threshold {threshold} (showing first 5): {', '.join(rejected_words[:5])}")
logger.info(f"π Threshold {threshold}: {len(scores[0])} total β {above_threshold} above threshold β {difficulty_passed} difficulty OK β {interesting_passed} relevant β {len(candidates)} final")
# Log the words that passed all filters for this threshold
if candidates:
passed_words = [f"{w['word']}({w['similarity']:.3f})" for w in candidates[:8]] # Show first 8
logger.info(f"β
Words passing threshold {threshold}: {', '.join(passed_words)}")
return candidates
def _weighted_random_selection(self, candidates: List[Dict[str, Any]], max_words: int) -> List[Dict[str, Any]]:
"""
Weighted random selection that favors higher similarity scores but adds variety.
This ensures we don't always get the exact same words, while still preferring
high-quality matches.
"""
import random
if len(candidates) <= max_words:
return candidates
# Create tiers based on similarity scores
candidates_sorted = sorted(candidates, key=lambda w: w["similarity"], reverse=True)
# Tier 1: Top 25% - very high probability
tier1_size = max(1, len(candidates_sorted) // 4)
tier1 = candidates_sorted[:tier1_size]
# Tier 2: Next 25% - high probability
tier2_size = max(1, len(candidates_sorted) // 4)
tier2 = candidates_sorted[tier1_size:tier1_size + tier2_size]
# Tier 3: Next 35% - medium probability
tier3_size = max(1, len(candidates_sorted) * 35 // 100)
tier3 = candidates_sorted[tier1_size + tier2_size:tier1_size + tier2_size + tier3_size]
# Tier 4: Remaining - low probability
tier4 = candidates_sorted[tier1_size + tier2_size + tier3_size:]
selected = []
# Always include some from tier 1 (but not all)
tier1_count = min(max_words // 3, len(tier1))
selected.extend(random.sample(tier1, tier1_count))
# Fill remaining slots with weighted random selection
remaining_slots = max_words - len(selected)
if remaining_slots > 0:
# Create weighted pool
weighted_pool = []
weighted_pool.extend([(w, 3) for w in tier2]) # 3x weight
weighted_pool.extend([(w, 2) for w in tier3]) # 2x weight
weighted_pool.extend([(w, 1) for w in tier4]) # 1x weight
# Also add remaining tier1 words with high weight
remaining_tier1 = [w for w in tier1 if w not in selected]
weighted_pool.extend([(w, 4) for w in remaining_tier1]) # 4x weight
# Weighted random selection
for _ in range(remaining_slots):
if not weighted_pool:
break
# Create weighted list
weighted_words = []
for word, weight in weighted_pool:
weighted_words.extend([word] * weight)
if weighted_words:
chosen = random.choice(weighted_words)
selected.append(chosen)
# Remove chosen word from pool
weighted_pool = [(w, wt) for w, wt in weighted_pool if w != chosen]
# Final shuffle to mix up the order
random.shuffle(selected)
logger.info(f"π² Weighted selection: {len(selected)} words from {len(candidates)} candidates")
return selected[:max_words]
async def _get_cached_fallback(
self,
topic: str,
difficulty: str,
max_words: int
) -> List[Dict[str, Any]]:
"""Fallback to cached words when vector search fails."""
if not self.cache_manager:
logger.warning(f"π No cache manager available for fallback")
return []
logger.info(f"π Looking for cached words for topic: '{topic}', difficulty: '{difficulty}'")
try:
cached_words = await self.cache_manager.get_cached_words(topic, difficulty, max_words)
if cached_words:
logger.info(f"π¦ Found {len(cached_words)} cached words for '{topic}/{difficulty}'")
return cached_words
else:
logger.info(f"π No cached words available for '{topic}/{difficulty}'")
return []
except Exception as e:
logger.error(f"β Failed to get cached fallback for '{topic}': {e}")
return []
async def _cache_successful_search(
self,
topic: str,
difficulty: str,
words: List[Dict[str, Any]]
):
"""Cache successful vector search results for future use."""
if not self.cache_manager:
return
try:
# Filter out any existing cached words to avoid duplicates
vector_words = [w for w in words if w.get("source") == "vector_search"]
if vector_words:
success = await self.cache_manager.cache_words(topic, difficulty, vector_words)
if success:
logger.info(f"πΎ Successfully cached {len(vector_words)} words for {topic}/{difficulty}")
except Exception as e:
logger.error(f"β Failed to cache search results: {e}")
def _get_emergency_bootstrap(self, topic: str, difficulty: str, max_words: int) -> List[Dict[str, Any]]:
"""
Emergency bootstrap words when vector search and cache both fail.
This prevents complete failure by providing basic topic-related words.
"""
bootstrap_words = {
"animals": [
{"word": "DOG", "clue": "Man's best friend"},
{"word": "CAT", "clue": "Feline pet"},
{"word": "FISH", "clue": "Aquatic animal"},
],
"science": [
# {"word": "ATOM", "clue": "Basic unit of matter"},
# {"word": "CELL", "clue": "Basic unit of life"},
# {"word": "DNA", "clue": "Genetic material"},
# {"word": "ENERGY", "clue": "Capacity to do work"},
# {"word": "FORCE", "clue": "Push or pull"},
# {"word": "GRAVITY", "clue": "Force of attraction"},
# {"word": "LIGHT", "clue": "Electromagnetic radiation"},
# {"word": "MATTER", "clue": "Physical substance"},
# {"word": "MOTION", "clue": "Change in position"},
# {"word": "OXYGEN", "clue": "Essential gas"},
# {"word": "PHYSICS", "clue": "Study of matter and energy"},
# {"word": "THEORY", "clue": "Scientific explanation"}
],
"technology": [
# {"word": "COMPUTER", "clue": "Electronic device"},
# {"word": "INTERNET", "clue": "Global network"},
# {"word": "SOFTWARE", "clue": "Computer programs"},
# {"word": "ROBOT", "clue": "Automated machine"},
# {"word": "DATA", "clue": "Information"},
# {"word": "CODE", "clue": "Programming instructions"},
# {"word": "DIGITAL", "clue": "Electronic format"},
# {"word": "NETWORK", "clue": "Connected systems"},
# {"word": "SYSTEM", "clue": "Organized whole"},
# {"word": "DEVICE", "clue": "Technical apparatus"},
# {"word": "MOBILE", "clue": "Portable technology"},
# {"word": "SCREEN", "clue": "Display surface"}
],
"geography": [
# {"word": "MOUNTAIN", "clue": "High landform"},
# {"word": "RIVER", "clue": "Flowing water"},
# {"word": "OCEAN", "clue": "Large body of water"},
# {"word": "DESERT", "clue": "Arid region"},
# {"word": "FOREST", "clue": "Dense trees"},
# {"word": "ISLAND", "clue": "Land surrounded by water"},
# {"word": "VALLEY", "clue": "Low area between hills"},
# {"word": "LAKE", "clue": "Inland water body"},
# {"word": "COAST", "clue": "Land by the sea"},
# {"word": "PLAIN", "clue": "Flat land"},
# {"word": "HILL", "clue": "Small elevation"},
# {"word": "CLIFF", "clue": "Steep rock face"}
]
}
topic_lower = topic.lower()
words = bootstrap_words.get(topic_lower, [])
if not words:
# Generic fallback for unknown topics
words = [
{"word": "WORD", "clue": "Unit of language"},
{"word": "PUZZLE", "clue": "Brain teaser"},
{"word": "GAME", "clue": "Form of play"},
{"word": "CROSS", "clue": "Intersecting lines"},
{"word": "GRID", "clue": "Pattern of squares"},
{"word": "CLUE", "clue": "Helpful hint"}
]
# Filter by difficulty and format
filtered_words = []
for word_obj in words:
word = word_obj["word"]
if self._matches_difficulty(word, difficulty):
filtered_words.append({
"word": word,
"clue": word_obj["clue"],
"similarity": 0.7, # Moderate relevance
"source": "emergency_bootstrap"
})
# Shuffle and limit
import random
random.shuffle(filtered_words)
result = filtered_words[:max_words]
logger.info(f"π Emergency bootstrap provided {len(result)} words for '{topic}'")
return result
async def cleanup(self):
"""Cleanup resources."""
logger.info("π§Ή Cleaning up vector search service")
if hasattr(self, 'model'):
del self.model
if hasattr(self, 'word_embeddings'):
del self.word_embeddings
if hasattr(self, 'faiss_index'):
del self.faiss_index
if self.cache_manager:
await self.cache_manager.cleanup_expired_caches()
self.is_initialized = False
|