Spaces:
Running
Running
File size: 46,088 Bytes
468b0c0 35426f1 | 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 | """
Memory Service for MathPulse AI โ hybrid memory architecture.
Layers:
1. Working Memory (LangChain FirestoreChatMessageHistory) โ session turns
2. Persistent Profile Memory (Firestore doc) โ long-term student profile
3. Episodic / Session Memory (Firestore doc) โ session summaries
4. Active State (Firestore doc) โ current topic, problem, unresolved context
5. Retrieval Pipeline โ collect_memory_context()
6. Update Pipeline โ profile updates, session summaries, pruning
"""
import os
import re
import logging
from datetime import datetime, timezone
from typing import Any, Dict, List, Optional, Tuple
logger = logging.getLogger(__name__)
# โโโ Lazy Firebase Init โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# Follows existing pattern from main.py
_firestore_client = None
def _get_firestore():
global _firestore_client
if _firestore_client is not None:
return _firestore_client
try:
import firebase_admin
from firebase_admin import firestore as _fs
if firebase_admin._apps:
_firestore_client = _fs.client()
return _firestore_client
except Exception:
logger.debug("Firestore not available for memory service")
return None
def _has_firestore():
return _get_firestore() is not None
# โโโ Constants โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
MAX_HISTORY_TOKENS = 4000 # Max tokens for working memory turns
PROFILE_DOC_PATH = "tutorMemory/profile/current"
SESSION_COLLECTION = "tutorMemory/sessions"
WORKING_COLLECTION = "tutorMemory/working"
ACTIVE_STATE_DOC = "tutorMemory/working/active_state"
MEMORY_CONTEXT_TEMPLATE = """MEMORY CONTEXT โ Previous conversation, student profile, and tutoring state:
{content}
Use this context to provide personalized, continuous tutoring."""
# โโโ Data Types โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
class WorkingMemoryState:
"""Active tutoring session state stored in Firestore."""
def __init__(self, session_id: str = "", active_topic: str = "",
current_problem: str = "", turn_count: int = 0,
unresolved_context: Optional[List[str]] = None,
corrections: Optional[List[str]] = None):
self.session_id = session_id
self.active_topic = active_topic
self.current_problem = current_problem
self.turn_count = turn_count
self.unresolved_context = unresolved_context or []
self.corrections = corrections or []
def to_dict(self) -> dict:
return {
"session_id": self.session_id,
"active_topic": self.active_topic,
"current_problem": self.current_problem,
"turn_count": self.turn_count,
"unresolved_context": self.unresolved_context,
"corrections": self.corrections,
"updated_at": datetime.now(timezone.utc).isoformat(),
}
@classmethod
def from_dict(cls, data: dict) -> "WorkingMemoryState":
return cls(
session_id=data.get("session_id", ""),
active_topic=data.get("active_topic", ""),
current_problem=data.get("current_problem", ""),
turn_count=data.get("turn_count", 0),
unresolved_context=data.get("unresolved_context", []),
corrections=data.get("corrections", []),
)
class ProfileMemory:
"""Long-term student profile stored in Firestore."""
def __init__(self, preferred_name: str = "", grade_level: str = "",
strand: str = "", weak_topics: Optional[List[str]] = None,
learning_style: str = "", explanation_depth: str = "auto",
language_tone: str = "english", prior_goals: Optional[List[str]] = None,
stable_tutoring_facts: Optional[List[str]] = None,
recurring_mistakes: Optional[List[str]] = None):
self.preferred_name = preferred_name
self.grade_level = grade_level
self.strand = strand
self.weak_topics = weak_topics or []
self.learning_style = learning_style
self.explanation_depth = explanation_depth # "auto", "basic", "detailed", "advanced"
self.language_tone = language_tone # "english", "filipino-friendly"
self.prior_goals = prior_goals or []
self.stable_tutoring_facts = stable_tutoring_facts or []
self.recurring_mistakes = recurring_mistakes or []
def to_dict(self) -> dict:
return {
"preferred_name": self.preferred_name,
"grade_level": self.grade_level,
"strand": self.strand,
"weak_topics": self.weak_topics,
"learning_style": self.learning_style,
"explanation_depth": self.explanation_depth,
"language_tone": self.language_tone,
"prior_goals": self.prior_goals,
"stable_tutoring_facts": self.stable_tutoring_facts,
"recurring_mistakes": self.recurring_mistakes,
"updated_at": datetime.now(timezone.utc).isoformat(),
}
@classmethod
def from_dict(cls, data: dict) -> "ProfileMemory":
return cls(
preferred_name=data.get("preferred_name", ""),
grade_level=data.get("grade_level", ""),
strand=data.get("strand", ""),
weak_topics=data.get("weak_topics", []),
learning_style=data.get("learning_style", ""),
explanation_depth=data.get("explanation_depth", "auto"),
language_tone=data.get("language_tone", "english"),
prior_goals=data.get("prior_goals", []),
stable_tutoring_facts=data.get("stable_tutoring_facts", []),
recurring_mistakes=data.get("recurring_mistakes", []),
)
class SessionSummary:
"""Episodic memory โ summary of a completed tutoring session."""
def __init__(self, session_id: str = "", topics_covered: Optional[List[str]] = None,
what_learned: Optional[List[str]] = None,
what_struggled: Optional[List[str]] = None,
unfinished_items: Optional[List[str]] = None,
summary: str = "", session_start: str = "",
session_end: str = "", turn_count: int = 0,
competency_progress: Optional[List[str]] = None):
self.session_id = session_id
self.topics_covered = topics_covered or []
self.what_learned = what_learned or []
self.what_struggled = what_struggled or []
self.unfinished_items = unfinished_items or []
self.summary = summary
self.session_start = session_start
self.session_end = session_end
self.turn_count = turn_count
self.competency_progress = competency_progress or []
def to_dict(self) -> dict:
return {
"session_id": self.session_id,
"topics_covered": self.topics_covered,
"what_learned": self.what_learned,
"what_struggled": self.what_struggled,
"unfinished_items": self.unfinished_items,
"summary": self.summary,
"session_start": self.session_start,
"session_end": self.session_end,
"turn_count": self.turn_count,
"competency_progress": self.competency_progress,
"created_at": datetime.now(timezone.utc).isoformat(),
}
@classmethod
def from_dict(cls, data: dict) -> "SessionSummary":
return cls(
session_id=data.get("session_id", ""),
topics_covered=data.get("topics_covered", []),
what_learned=data.get("what_learned", []),
what_struggled=data.get("what_struggled", []),
unfinished_items=data.get("unfinished_items", []),
summary=data.get("summary", ""),
session_start=data.get("session_start", ""),
session_end=data.get("session_end", ""),
turn_count=data.get("turn_count", 0),
competency_progress=data.get("competency_progress", []),
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 1. WORKING MEMORY โ LangChain FirestoreChatMessageHistory
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def get_working_memory(uid: str, session_id: str):
"""Get LangChain FirestoreChatMessageHistory for the session.
Returns None if LangChain or Firestore unavailable (graceful degradation)."""
try:
from langchain_google_firestore import FirestoreChatMessageHistory
client = _get_firestore()
if client is None:
return None
return FirestoreChatMessageHistory(
collection="users",
doc=f"{uid}/tutorMemory/working",
session_id=session_id,
firestore_client=client,
)
except ImportError:
logger.debug("langchain-google-firestore not installed โ working memory disabled")
return None
except Exception as e:
logger.debug(f"Failed to initialize working memory: {e}")
return None
def load_recent_turns(
uid: str, session_id: str, max_tokens: int = MAX_HISTORY_TOKENS
) -> List[Dict[str, str]]:
"""Load recent conversation turns within token budget.
Returns list of dicts with 'role' and 'content' keys.
Falls back to active_state stored turns if LangChain unavailable."""
try:
wm = get_working_memory(uid, session_id)
if wm is not None:
all_messages = wm.messages
selected = _select_within_token_budget(all_messages, max_tokens)
result = []
for msg in selected:
role = "assistant" if msg.type == "ai" else msg.type
result.append({"role": role, "content": msg.content})
return result
# Fallback: load from active state stored messages
state = get_active_state(uid, session_id)
stored = _get_stored_turns(uid, session_id)
return _select_within_token_budget_dict(stored, max_tokens)
except Exception as e:
logger.debug(f"Failed to load recent turns: {e}")
return []
def persist_turns(uid: str, session_id: str, messages: List[Dict[str, str]]) -> None:
"""Append messages to working memory. Fire-and-forget."""
try:
wm = get_working_memory(uid, session_id)
if wm is not None:
from langchain.schema import HumanMessage, AIMessage
for msg in messages:
role = msg.get("role", "user")
content = msg.get("content", "")
if not content:
continue
if role == "assistant":
wm.add_message(AIMessage(content=content))
elif role == "user":
wm.add_message(HumanMessage(content=content))
# Also store raw turns in Firestore for fallback
_append_stored_turns(uid, session_id, messages)
except ImportError:
_append_stored_turns(uid, session_id, messages)
except Exception as e:
logger.debug(f"Failed to persist turns: {e}")
def _stored_turns_ref(uid: str, session_id: str):
"""Get Firestore doc reference for stored turns."""
try:
db = _get_firestore()
if db is None:
return None
return db.collection("users").document(uid).collection(WORKING_COLLECTION).document(session_id)
except Exception:
return None
def _get_stored_turns(uid: str, session_id: str) -> List[Dict[str, str]]:
"""Get raw stored turns from Firestore fallback."""
try:
ref = _stored_turns_ref(uid, session_id)
if ref is None:
return []
doc = ref.get()
if doc.exists:
data = doc.to_dict() or {}
return data.get("turns", [])
return []
except Exception as e:
logger.debug(f"Failed to get stored turns: {e}")
return []
def _append_stored_turns(uid: str, session_id: str, new_turns: List[Dict[str, str]]) -> None:
"""Append turns to Firestore fallback storage."""
try:
ref = _stored_turns_ref(uid, session_id)
if ref is None:
return
# Use arrayUnion for atomic append
from google.cloud.firestore import ArrayUnion
ref.set({
"turns": ArrayUnion(new_turns),
"updated_at": datetime.now(timezone.utc).isoformat(),
}, merge=True)
except Exception as e:
logger.debug(f"Failed to append stored turns: {e}")
def _select_within_token_budget(messages: list, max_tokens: int) -> list:
"""Select messages from end to fit within token budget (rough char/4 estimate)."""
total = 0
selected = []
for msg in reversed(messages):
estimated = len(msg.content) // 4 # rough token estimate
if total + estimated > max_tokens and total > 0:
break
total += estimated
selected.insert(0, msg)
return selected
def _select_within_token_budget_dict(messages: List[Dict], max_tokens: int) -> List[Dict]:
"""Same as above but for dict messages."""
total = 0
selected = []
for msg in reversed(messages):
estimated = len(msg.get("content", "")) // 4
if total + estimated > max_tokens and total > 0:
break
total += estimated
selected.insert(0, msg)
return selected
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 2. ACTIVE STATE โ Current topic, problem, unresolved context
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def get_active_state(uid: str, session_id: str) -> Optional[WorkingMemoryState]:
"""Load the active tutoring state for the session."""
try:
db = _get_firestore()
if db is None:
return None
doc = db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state").get()
if doc.exists:
data = doc.to_dict() or {}
# Filter by session_id to handle multiple sessions
if data.get("session_id") == session_id:
return WorkingMemoryState.from_dict(data)
return None
except Exception as e:
logger.debug(f"Failed to load active state: {e}")
return None
def set_active_state(uid: str, session_id: str, state: WorkingMemoryState) -> None:
"""Save the active tutoring state for the session."""
try:
db = _get_firestore()
if db is None:
return
state.session_id = session_id
db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state").set(
state.to_dict(), merge=True
)
except Exception as e:
logger.debug(f"Failed to save active state: {e}")
def increment_turn_count(uid: str, session_id: str) -> int:
"""Atomically increment turn count and return new value."""
try:
db = _get_firestore()
if db is None:
return 0
doc_ref = db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state")
doc = doc_ref.get()
current = doc.to_dict().get("turn_count", 0) if doc.exists else 0
new_count = current + 1
doc_ref.set({
"session_id": session_id,
"turn_count": new_count,
"updated_at": datetime.now(timezone.utc).isoformat(),
}, merge=True)
return new_count
except Exception as e:
logger.debug(f"Failed to increment turn count: {e}")
return 0
def update_active_topic(uid: str, session_id: str, topic: str) -> None:
"""Update the current tutoring topic."""
try:
db = _get_firestore()
if db is None:
return
db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state").set({
"session_id": session_id,
"active_topic": topic,
"updated_at": datetime.now(timezone.utc).isoformat(),
}, merge=True)
except Exception as e:
logger.debug(f"Failed to update active topic: {e}")
def update_current_problem(uid: str, session_id: str, problem: str) -> None:
"""Update the current problem being solved."""
try:
db = _get_firestore()
if db is None:
return
db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state").set({
"session_id": session_id,
"current_problem": problem,
"updated_at": datetime.now(timezone.utc).isoformat(),
}, merge=True)
except Exception as e:
logger.debug(f"Failed to update current problem: {e}")
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 3. PERSISTENT PROFILE MEMORY
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def load_profile(uid: str) -> Optional[ProfileMemory]:
"""Load student profile memory from Firestore."""
try:
db = _get_firestore()
if db is None:
return None
doc = db.collection("users").document(uid).collection("tutorMemory").document("profile").get()
if doc.exists:
return ProfileMemory.from_dict(doc.to_dict() or {})
return None
except Exception as e:
logger.debug(f"Failed to load profile: {e}")
return None
def upsert_profile(uid: str, profile: ProfileMemory) -> None:
"""Save or update profile memory. All fields merge (never delete)."""
try:
db = _get_firestore()
if db is None:
return
db.collection("users").document(uid).collection("tutorMemory").document("profile").set(
profile.to_dict(), merge=True
)
except Exception as e:
logger.debug(f"Failed to save profile: {e}")
def extract_profile_info_from_message(text: str) -> dict:
"""Heuristic extraction of profile info from student messages.
Uses simple regex patterns โ not AI. Returns dict of detected fields."""
updates = {}
# Preferred name: "my name is X", "I'm X", "call me X"
name_patterns = [
r"(?:my\s+name\s+is|i'm|i\s+am|call\s+me)\s+([A-Z][a-z]+(?:\s+[A-Z][a-z]+)?)",
]
for pat in name_patterns:
m = re.search(pat, text, re.IGNORECASE)
if m and not _is_negative_context(text, m.start()):
name = m.group(1).strip()
if len(name) > 1 and len(name) < 50:
updates["preferred_name"] = name
break
# Grade level: "Grade X", "I'm in Grade X", "Grade 11-STEM"
grade_patterns = [
r"(?:grade\s*)(\d{1,2})",
r"(?:i'?m?\s+(?:in\s+)?)?grade\s*[โ\-]?\s*(\d{1,2})\s*(?:[โ\-]\s*\d{1,2})?(?:\s*(STEM|ABM|HUMSS|GAS|TVL))?",
]
for pat in grade_patterns:
m = re.search(pat, text, re.IGNORECASE)
if m:
grade_num = m.group(1)
if grade_num in {"11", "12", "9", "10", "7", "8"}:
strand = m.group(2) if m.lastindex and m.group(2) else ""
updates["grade_level"] = f"Grade {grade_num}"
if strand:
updates["strand"] = strand.upper()
break
# Weak topics: "I struggle with X", "I don't understand X", "I always get confused by X"
weak_patterns = [
r"(?:struggle\s+with|don'?t\s+(?:understand|get)\s+|confused\s+(?:by|about|with)\s+|weak\s+(?:in|at|on)\s+|hard\s+time\s+(?:with|on)\s+|bad\s+at\s+)([^.!?]{3,60})",
]
for pat in weak_patterns:
m = re.search(pat, text, re.IGNORECASE)
if m:
topic = m.group(1).strip().lower()
if len(topic) > 2 and not _is_negative_context(text, m.start()):
if "weak_topics" not in updates:
updates["weak_topics"] = []
updates["weak_topics"].append(topic)
# Learning style / preference
style_patterns = [
(r"(?:prefer|like|want)\s+(step[-\s]by[-\s]step|detailed|simple|short|long|visual|example)", "explanation_depth"),
(r"(?:keep|make)\s+(?:it\s+)?(?:short|simple|brief|concise)", "explanation_depth"),
]
for pat, field in style_patterns:
m = re.search(pat, text, re.IGNORECASE)
if m:
if field == "explanation_depth":
matched = m.group(1).lower() if m.lastindex else ""
if matched in ("simple", "short", "brief", "concise"):
updates[field] = "basic"
elif matched in ("detailed", "long", "step-by-step"):
updates[field] = "detailed"
else:
updates[field] = matched
# Language preference
if re.search(r"(?:tagalog|filipino|bisaya|ilocano)", text, re.IGNORECASE):
updates["language_tone"] = "filipino-friendly"
return updates
def _is_negative_context(text: str, pos: int) -> bool:
"""Check if the position is in a negative context like 'I don't have a name'."""
surrounding = text[max(0, pos-30):pos+30].lower()
negative_triggers = ["don't have", "not my", "not sure", "don't know", "no name"]
for trigger in negative_triggers:
if trigger in surrounding:
return True
return False
def update_profile_from_chat(uid: str, user_message: str) -> None:
"""Detect profile-relevant info in user message and update Firestore.
Called asynchronously after each chat response."""
try:
updates = extract_profile_info_from_message(user_message)
if not updates:
return
profile = load_profile(uid)
if profile is None:
profile = ProfileMemory()
if "preferred_name" in updates and not profile.preferred_name:
profile.preferred_name = updates["preferred_name"]
if "grade_level" in updates and not profile.grade_level:
profile.grade_level = updates["grade_level"]
if "strand" in updates and not profile.strand:
profile.strand = updates["strand"]
if "weak_topics" in updates:
for topic in updates["weak_topics"]:
if topic not in profile.weak_topics:
profile.weak_topics.append(topic)
if "explanation_depth" in updates:
profile.explanation_depth = updates["explanation_depth"]
if "language_tone" in updates:
profile.language_tone = updates["language_tone"]
upsert_profile(uid, profile)
# Extract stable tutoring fact if profile was updated meaningfully
if updates:
_maybe_record_stable_fact(uid, profile, user_message)
except Exception as e:
logger.debug(f"Failed to update profile from chat: {e}")
def _maybe_record_stable_fact(uid: str, profile: ProfileMemory, message: str) -> None:
"""Record a stable tutoring fact when student reveals important info."""
facts_to_record = []
if profile.weak_topics:
facts_to_record.append(f"Student struggles with: {', '.join(profile.weak_topics[-3:])}")
if profile.explanation_depth and profile.explanation_depth != "auto":
facts_to_record.append(f"Student prefers {profile.explanation_depth} explanations")
if profile.language_tone == "filipino-friendly":
facts_to_record.append("Student prefers Filipino-friendly language")
if facts_to_record:
for fact in facts_to_record:
if fact not in profile.stable_tutoring_facts:
profile.stable_tutoring_facts.append(fact)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 4. EPISODIC / SESSION MEMORY
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def load_session_summary(uid: str, session_id: str) -> Optional[SessionSummary]:
"""Load session summary from Firestore."""
try:
db = _get_firestore()
if db is None:
return None
doc = db.collection("users").document(uid).collection(SESSION_COLLECTION).document(session_id).get()
if doc.exists:
return SessionSummary.from_dict(doc.to_dict() or {})
return None
except Exception as e:
logger.debug(f"Failed to load session summary: {e}")
return None
def load_latest_session_summary(uid: str, exclude_session_id: str = "") -> Optional[SessionSummary]:
"""Load the most recent previous session summary, excluding current session."""
try:
db = _get_firestore()
if db is None:
return None
docs = (
db.collection("users").document(uid).collection(SESSION_COLLECTION)
.order_by("created_at", direction="DESCENDING")
.limit(5)
.get()
)
for doc in docs:
data = doc.to_dict() or {}
if data.get("session_id") != exclude_session_id:
return SessionSummary.from_dict(data)
return None
except Exception as e:
logger.debug(f"Failed to load latest session summary: {e}")
return None
def generate_session_summary(uid: str, session_id: str, messages: List[Dict[str, str]]) -> SessionSummary:
"""Generate a structured session summary from conversation messages.
Uses content analysis rather than AI call to keep it fast and cheap."""
try:
topics_covered = set()
struggles = []
learned = []
summary_parts = []
for msg in messages:
role = msg.get("role", "")
content = msg.get("content", "")
if role == "user":
# Detect topics from user messages (look for math keywords)
topic = _detect_topic(content)
if topic:
topics_covered.add(topic)
# Detect struggles
if re.search(r"(?:don'?t\s+understand|confused|struggl|hard|difficult)", content, re.IGNORECASE):
struggles.append(content[:100])
elif role == "assistant":
# Detect topics from assistant explanations
topic = _detect_topic(content)
if topic:
topics_covered.add(topic)
# Look for teaching signals
if "correct" in content.lower() and "good" in content.lower():
learned.append(content[:100])
# Build summary
covered = list(topics_covered)[:10]
summary_text = f"Session covered: {', '.join(covered) if covered else 'general math topics'}."
if struggles:
summary_text += f" Student struggled with {len(struggles)} concepts."
if learned:
summary_text += f" Demonstrated understanding of {len(learned)} concepts."
return SessionSummary(
session_id=session_id,
topics_covered=covered,
what_struggled=struggles[:5],
what_learned=learned[:5],
summary=summary_text,
session_start=datetime.now(timezone.utc).isoformat(),
session_end=datetime.now(timezone.utc).isoformat(),
turn_count=len(messages) // 2,
)
except Exception as e:
logger.debug(f"Failed to generate session summary: {e}")
return SessionSummary(session_id=session_id, summary="Session summary unavailable.")
_DETECTED_TOPICS = {
"algebra": r"\b(algebra|equation|inequalit|polynomial|factor|quadratic|linear)",
"arithmetic": r"\b(arithmetic|addition|subtract|multiply|division|fraction|decimal|percent)",
"geometry": r"\b(geometry|angle|triangle|circle|polygon|area|perimeter|volume)",
"trigonometry": r"\b(trig|sin|cos|tan|sine|cosine|tangent|identity)",
"statistics": r"\b(statistic|mean|median|mode|probability|distribution|variance|standard.dev)",
"calculus": r"\b(calculus|derivative|integral|limit|differentiat|optimization)",
"functions": r"\b(function|domain|range|composition|inverse|piecewise)",
"matrices": r"\b(matrix|determinant|inverse|transpose|linear.equation)",
"business_math": r"\b(interest|loan|investment|profit|loss|markup|discount|commission|tax)",
"logic": r"\b(logic|proposition|truth|table|argument|premise|conclusion)",
}
def _detect_topic(text: str) -> str:
"""Detect math topic from text content."""
text_lower = text.lower()
for topic, pattern in _DETECTED_TOPICS.items():
if re.search(pattern, text_lower):
return topic
return ""
def save_session_summary(uid: str, summary: SessionSummary) -> None:
"""Save session summary to Firestore."""
try:
db = _get_firestore()
if db is None:
return
db.collection("users").document(uid).collection(SESSION_COLLECTION).document(
summary.session_id
).set(summary.to_dict(), merge=True)
except Exception as e:
logger.debug(f"Failed to save session summary: {e}")
def finalize_session(uid: str, session_id: str, messages: List[Dict[str, str]]) -> None:
"""Generate and save session summary at session end.
Safe to call multiple times โ updates existing summary."""
try:
summary = generate_session_summary(uid, session_id, messages)
save_session_summary(uid, summary)
except Exception as e:
logger.debug(f"Failed to finalize session: {e}")
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 5. MEMORY RETRIEVAL PIPELINE
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# Rate at which we auto-summarize sessions (every N turns)
AUTO_SUMMARIZE_INTERVAL = 15
async def collect_memory_context(
uid: str, session_id: str, current_message: str,
include_profile: bool = True, include_recent_turns: bool = True,
include_active_state: bool = True, include_previous_session: bool = True,
) -> str:
"""Collect all memory sources into a formatted context string.
This is injected into the system prompt before the tutor instructions.
Returns empty string if no memory available (graceful degradation)."""
try:
context_parts = []
# 1. Profile memory
if include_profile:
profile = load_profile(uid)
if profile:
context_parts.append(_format_profile_context(profile))
# 2. Active state
if include_active_state:
state = get_active_state(uid, session_id)
if state and (state.active_topic or state.current_problem):
context_parts.append(_format_active_state(state))
# 3. Previous session summary (for continuity across sessions)
if include_previous_session:
prev_summary = load_latest_session_summary(uid, exclude_session_id=session_id)
if prev_summary:
context_parts.append(_format_previous_session(prev_summary))
# 4. Recent turns
if include_recent_turns:
recent = load_recent_turns(uid, session_id, max_tokens=2000)
if recent:
context_parts.append(_format_recent_turns(recent))
if not context_parts:
return ""
combined = "\n\n".join(context_parts)
return MEMORY_CONTEXT_TEMPLATE.format(content=combined)
except Exception as e:
logger.debug(f"Failed to collect memory context: {e}")
return ""
def _format_profile_context(profile: ProfileMemory) -> str:
"""Format profile memory for prompt injection."""
lines = ["=== STUDENT PROFILE ==="]
if profile.preferred_name:
lines.append(f"Name: {profile.preferred_name}")
if profile.grade_level:
lines.append(f"Grade Level: {profile.grade_level}")
if profile.strand:
lines.append(f"Strand: {profile.strand}")
if profile.weak_topics:
lines.append(f"Weak Topics: {', '.join(profile.weak_topics[:5])}")
if profile.explanation_depth and profile.explanation_depth != "auto":
lines.append(f"Explanation Preference: {profile.explanation_depth} explanations")
if profile.language_tone and profile.language_tone != "english":
lines.append(f"Language: {profile.language_tone}")
if profile.stable_tutoring_facts:
lines.append(f"Tutoring Facts: {'; '.join(profile.stable_tutoring_facts[-3:])}")
if profile.prior_goals:
lines.append(f"Prior Goals: {'; '.join(profile.prior_goals[-3:])}")
if profile.recurring_mistakes:
lines.append(f"Watch For: Student tends to {profile.recurring_mistakes[-1]}")
return "\n".join(lines)
def _format_active_state(state: WorkingMemoryState) -> str:
"""Format active tutoring state for prompt injection."""
lines = ["=== CURRENT SESSION STATE ==="]
if state.active_topic:
lines.append(f"Current Topic: {state.active_topic}")
if state.current_problem:
lines.append(f"Current Problem: {state.current_problem}")
if state.turn_count:
lines.append(f"Turn Count: {state.turn_count}")
if state.unresolved_context:
lines.append(f"Unresolved: {'; '.join(state.unresolved_context[-3:])}")
if state.corrections:
lines.append(f"Recent Corrections: {'; '.join(state.corrections[-2:])}")
return "\n".join(lines)
def _format_previous_session(prev: SessionSummary) -> str:
"""Format previous session summary for prompt injection."""
lines = ["=== PREVIOUS SESSION ==="]
if prev.summary:
lines.append(f"Summary: {prev.summary}")
if prev.topics_covered:
lines.append(f"Topics Covered: {', '.join(prev.topics_covered)}")
if prev.what_struggled:
lines.append(f"Previously Struggled: {len(prev.what_struggled)} concepts")
if prev.unfinished_items:
lines.append(f"Unfinished: {'; '.join(prev.unfinished_items[:3])}")
return "\n".join(lines)
def _format_recent_turns(turns: List[Dict[str, str]]) -> str:
"""Format recent conversation turns for prompt injection."""
if not turns:
return ""
lines = ["=== RECENT CONVERSATION ==="]
for turn in turns[-10:]: # Last 10 turns max
role = turn.get("role", "user")
content = turn.get("content", "")
prefix = "Student" if role == "user" else "Tutor"
content_trimmed = content[:300] if content else ""
lines.append(f"{prefix}: {content_trimmed}")
return "\n".join(lines)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 6. MEMORY UPDATE PIPELINE
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def update_memory_after_response(
uid: str, session_id: str, user_message: str,
ai_response: str, turn_count: int,
) -> None:
"""Update all memory layers after a chat response.
Called asynchronously โ never blocks the response.
Updates:
1. Working memory (persist turns)
2. Active state (increment turn count)
3. Profile (extract info from user message)
4. Session summary (auto-summarize every N turns)"""
try:
# 1. Persist turns to working memory
persist_turns(uid, session_id, [
{"role": "user", "content": user_message},
{"role": "assistant", "content": ai_response},
])
# 2. Update active state
increment_turn_count(uid, session_id)
# 3. Update profile from chat (heuristic extraction)
update_profile_from_chat(uid, user_message)
# 4. Auto-summarize at interval
if turn_count > 0 and turn_count % AUTO_SUMMARIZE_INTERVAL == 0:
recent = load_recent_turns(uid, session_id, max_tokens=0) # get all
# Convert to dict format
all_turns = []
for turn in recent:
all_turns.append(turn if isinstance(turn, dict) else {"role": "assistant", "content": str(turn)})
all_turns.append({"role": "user", "content": user_message})
all_turns.append({"role": "assistant", "content": ai_response})
finalize_session(uid, session_id, all_turns)
except Exception as e:
logger.debug(f"Background memory update failed (non-fatal): {e}")
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 7. PRUNING & CLEANUP
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def prune_working_memory(uid: str, session_id: str, max_turns: int = 100) -> None:
"""Keep only the most recent turns in working memory to prevent bloat."""
try:
db = _get_firestore()
if db is None:
return
ref = db.collection("users").document(uid).collection(WORKING_COLLECTION).document(session_id)
doc = ref.get()
if not doc.exists:
return
data = doc.to_dict() or {}
turns = data.get("turns", [])
if len(turns) > max_turns:
pruned = turns[-max_turns:]
ref.update({"turns": pruned, "pruned_at": datetime.now(timezone.utc).isoformat()})
except Exception as e:
logger.debug(f"Failed to prune working memory: {e}")
def prune_old_sessions(uid: str, max_sessions: int = 50) -> None:
"""Delete oldest session summaries beyond max_sessions threshold."""
try:
db = _get_firestore()
if db is None:
return
docs = (
db.collection("users").document(uid).collection(SESSION_COLLECTION)
.order_by("created_at", direction="DESCENDING")
.offset(max_sessions)
.get()
)
for doc in docs:
doc.reference.delete()
except Exception as e:
logger.debug(f"Failed to prune old sessions: {e}")
def clear_session(uid: str, session_id: str) -> None:
"""Clear all working memory for a session."""
try:
db = _get_firestore()
if db is None:
return
batch = db.batch()
# Clear stored turns
ref1 = db.collection("users").document(uid).collection(WORKING_COLLECTION).document(session_id)
batch.delete(ref1)
# Reset active state if it matches this session
state_ref = db.collection("users").document(uid).collection(WORKING_COLLECTION).document("active_state")
state_doc = state_ref.get()
if state_doc.exists and state_doc.to_dict().get("session_id") == session_id:
batch.delete(state_ref)
batch.commit()
except Exception as e:
logger.debug(f"Failed to clear session: {e}")
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 8. MEMORY AVAILABILITY CHECK
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
def is_memory_available() -> bool:
"""Check if memory system is operational."""
return _has_firestore()
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 9. TIMING & HEALTH MONITORING
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
_TIMING_LOG_ENABLED: bool = True
def _time_ms() -> int:
"""Return current monotonic time in milliseconds."""
return int(time.monotonic() * 1000)
def log_timing(func_name: str, start_ms: int) -> None:
"""Log the elapsed time of a function call if timing is enabled."""
if not _TIMING_LOG_ENABLED:
return
elapsed = _time_ms() - start_ms
logger.info(f"TIMING [{func_name}] {elapsed}ms")
def check_memory_health(uid: str) -> dict:
"""Verify that all three memory stores are writable and readable.
Returns a dict with per-store results:
{
'firestore_available': bool,
'profile_writable': {'ok': bool, 'latency_ms': int, 'error': str | None},
'active_state_writable': {...},
'session_summary_writable': {...},
}
"""
now = _time_ms()
result: dict = {
"firestore_available": _has_firestore(),
"profile_writable": {"ok": False, "latency_ms": 0, "error": None},
"active_state_writable": {"ok": False, "latency_ms": 0, "error": None},
"session_summary_writable": {"ok": False, "latency_ms": 0, "error": None},
}
if not result["firestore_available"]:
for key in ("profile_writable", "active_state_writable", "session_summary_writable"):
result[key]["error"] = "Firestore not initialized"
result["_elapsed_ms"] = _time_ms() - now
return result
db = firebase_admin.firestore.client()
test_prefix = f"_health_check_test_{int(time.time())}"
profile_ref = db.collection("users").document(uid).collection("tutorMemory").document("profile")
active_ref = db.collection("users").document(uid).collection("tutorMemory").document("working").collection("state").document("active_state")
session_ref = (
db.collection("users")
.document(uid)
.collection("tutorMemory")
.document("sessions")
.collection("items")
.document(f"{test_prefix}")
)
# Test profile write
try:
t0 = _time_ms()
profile_ref.set({"stable_facts": {"test_fact": "health_check_ok"}}, merge=True)
readback = profile_ref.get()
facts = readback.to_dict().get("stable_facts", {}) if readback.exists else {}
latency = _time_ms() - t0
if facts.get("test_fact") == "health_check_ok":
result["profile_writable"]["ok"] = True
else:
result["profile_writable"]["error"] = "Write verification failed"
result["profile_writable"]["latency_ms"] = latency
# Cleanup
profile_ref.update({"stable_facts.test_fact": firestore.DELETE_FIELD})
except Exception as e:
result["profile_writable"]["error"] = str(e)
result["profile_writable"]["latency_ms"] = _time_ms() - t0
# Test active state write
try:
t0 = _time_ms()
active_ref.set({"active_topic": "health_check_test", "turn_count": 0}, merge=True)
readback = active_ref.get()
data = readback.to_dict() if readback.exists else {}
latency = _time_ms() - t0
if data.get("active_topic") == "health_check_test":
result["active_state_writable"]["ok"] = True
else:
result["active_state_writable"]["error"] = "Write verification failed"
result["active_state_writable"]["latency_ms"] = latency
# Cleanup
active_ref.update({"active_topic": firestore.DELETE_FIELD, "turn_count": firestore.DELETE_FIELD})
except Exception as e:
result["active_state_writable"]["error"] = str(e)
result["active_state_writable"]["latency_ms"] = _time_ms() - t0
# Test session summary write
try:
t0 = _time_ms()
session_ref.set({
"concepts_covered": ["health_check_test"],
"key_insights": "health check",
"timestamp": firestore.SERVER_TIMESTAMP,
})
readback = session_ref.get()
data = readback.to_dict() if readback.exists else {}
latency = _time_ms() - t0
if data.get("key_insights") == "health check":
result["session_summary_writable"]["ok"] = True
else:
result["session_summary_writable"]["error"] = "Write verification failed"
result["session_summary_writable"]["latency_ms"] = latency
# Cleanup
session_ref.delete()
except Exception as e:
result["session_summary_writable"]["error"] = str(e)
result["session_summary_writable"]["latency_ms"] = _time_ms() - t0
result["_elapsed_ms"] = _time_ms() - now
logger.info(f"MEMORY_HEALTH check for uid={uid}: profile={result['profile_writable']['ok']}, "
f"active={result['active_state_writable']['ok']}, "
f"session={result['session_summary_writable']['ok']}, "
f"elapsed={result['_elapsed_ms']}ms")
return result
|