Spaces:
Build error
Build error
File size: 34,717 Bytes
a6e61d1 0d8686f 3901e99 a4bbccc abf7d79 a6e61d1 abf7d79 a6e61d1 abf7d79 3901e99 abf7d79 a6e61d1 0d8686f 3901e99 abf7d79 3901e99 abf7d79 3901e99 abf7d79 3901e99 cc5237b 3901e99 cc5237b 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 0d8686f 3901e99 5b39df4 3901e99 0d8686f 3901e99 5b39df4 3901e99 0d8686f 3901e99 0d8686f 3901e99 0d8686f 3901e99 0d8686f 3901e99 0d8686f 3901e99 5b39df4 3901e99 0d8686f 3901e99 82681f8 3901e99 82681f8 3901e99 0d8686f 3901e99 5b39df4 3901e99 0d8686f 3901e99 0d8686f 3901e99 0d8686f 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 0d8686f 3901e99 abf7d79 3901e99 5b39df4 3901e99 5b39df4 7fc2e0c 3901e99 7fc2e0c 3901e99 7fc2e0c 3901e99 7fc2e0c 3901e99 5b39df4 3901e99 5b39df4 3901e99 5b39df4 3901e99 abf7d79 3901e99 abf7d79 3901e99 abf7d79 b2bd3fa abf7d79 3901e99 0d8686f 3901e99 0d8686f 3901e99 0d8686f cc5237b 0d8686f 3901e99 4a6edcf cc5237b 4a6edcf | 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 | from huggingface_hub import InferenceClient
from config import BASE_MODEL, MY_MODEL, HF_TOKEN
from src.eligibility_api import EligibilityAPI
import re
import json
class SchoolChatbot:
"""
This class is extra scaffolding around a model. Modify this class to specify how the model recieves prompts and generates responses.
Example usage:
chatbot = SchoolChatbot()
response = chatbot.get_response("What schools offer Spanish programs?")
"""
def __init__(self):
"""
Initialize the chatbot with a HF model ID and conversation state
"""
model_id = MY_MODEL if MY_MODEL else BASE_MODEL # define MY_MODEL in config.py if you create a new model in the HuggingFace Hub
self.client = InferenceClient(model=model_id, token=HF_TOKEN)
self.eligibility_api = EligibilityAPI()
self.conversation_state = {}
self.reset_state()
def reset_state(self):
"""Reset the conversation state to default values"""
self.conversation_state = {
"address": None, # User's address information
"grade": None, # Grade/age of the child
"language": None, # Language preference
"waiting_for": None, # What we're waiting for the user to provide
"last_question": None, # Last question we asked the user
"last_school_results": None, # Last school results we found
"context": {} # Additional context for the conversation
}
def save_to_context(self, key, value):
"""Save a value to the conversation context"""
self.conversation_state["context"][key] = value
def get_from_context(self, key, default=None):
"""Get a value from the conversation context"""
return self.conversation_state["context"].get(key, default)
def format_prompt(self, user_input, history=None):
"""
Format the user's input into a proper prompt with conversation history.
Args:
user_input (str): The user's question about Boston schools
history (list, optional): Previous conversation history
Returns:
str: A formatted prompt ready for the model
"""
context = """You are a helpful assistant that specializes in helping parents choose Boston Public Schools.
Answer clearly and accurately using the latest school registration rules, deadlines, and program information based *only* on the Key Facts provided below and the conversation history.
Always be professional, clear, and focused on helping parents make informed decisions about schools.
**Important:** If the user asks about specific programs (like language immersion, after-school activities, sports, etc.) or details not covered in the 'Key facts' below or the conversation history, state that you do not have that specific information and recommend checking the official BPS website (bostonpublicschools.org) or contacting a BPS Welcome Center at 617-635-9010.
Key facts:
- Registration is a 6-step process. Assistance is available in 10 languages via Welcome Centers or by calling 617-635-9010.
- Welcome Centers:
• Dorchester: 1216 Dorchester Ave | M/T/Th/F 9–5, W 12–5 | 617-635-8015
• East Boston (Umana): 312 Border St | M/T 9–5, W 12–5 (Jan only) | 617-635-9597
• Roslindale: 515 Hyde Park Ave | M/T/Th/F 9–5, W 12–5 | 617-635-8040
• Roxbury: 2300 Washington St | M/T/Th/F 9–5, W 12–5 | 617-635-9010
- School eligibility by grade (child must be age X by Sept 1, 2025): K0=3, K1=4, K2=5, Grade 1=6, ... Grade 12=17
- To view eligible schools, use the School Choice Tool: https://boston.explore.avela.org/
- Enter child's grade, address, zip, and primary language. Eligible schools marked with green stars.
- Home-Based plan assigns schools based on proximity + quality. Citywide and some regional options also available.
- Special admission schools require separate applications + ranking in the registration form.
- Required documents:
• Birth certificate/passport, immunization & physical exam, parent photo ID, 2 proofs of Boston residency
- Optional docs: IEP (if applicable), high school transcript (recommended)
- Pre-registration is optional but saves time: https://www.bostonpublicschools.org/pre-register
- Final registration requires appointment: schedule online, call 617-635-9010, or visit a Welcome Center
- Multilingual learners may need in-person language assessment at the Newcomers Assessment Counseling Center (NACC)
"""
# Add conversation history if provided
if history and len(history) > 0:
conversation = "\n\nConversation history:\n"
for user_msg, assistant_msg in history:
conversation += f"User: {user_msg}\nAssistant: {assistant_msg}\n"
context += conversation
# Add information we've collected about the user
user_info = "\n\nWhat I know about the user:\n"
address_state = self.conversation_state.get("address")
grade_state = self.conversation_state.get("grade")
language_state = self.conversation_state.get("language")
if address_state:
addr = address_state
address_str = f"{addr.get('streetAddress', '')}, {addr.get('city', '')}, {addr.get('state', '')} {addr.get('zipCode', '')}"
user_info += f"- Address: {address_str.strip()}\n"
if grade_state:
user_info += f"- Child's grade: {self.conversation_state.get('grade_display', 'Unknown')}\n"
if language_state:
user_info += f"- Language preference: {self.conversation_state.get('language_display', 'Unknown')}\n"
if any([address_state, grade_state, language_state]):
context += user_info
# Final formatted prompt
return f"{context}\n\nUser: {user_input}\nAssistant:"
def extract_address_info(self, user_input):
"""
Extract address information from user input using regex patterns.
Args:
user_input (str): The user's question or statement
Returns:
dict or None: Extracted address information or None if not found
"""
# If we're explicitly waiting for an address, be more lenient with parsing
if self.conversation_state.get("waiting_for") == "address":
# For direct address responses, we can be more lenient
simple_address_pattern = r'([0-9]+\s+[A-Za-z\s.]+)(?:,\s*|\s+)([A-Za-z\s]+)(?:,\s*|\s+)(?:MA|Massachusetts)(?:,\s*|\s+)(\d{5})'
simple_match = re.search(simple_address_pattern, user_input, re.IGNORECASE)
if simple_match:
return {
"streetAddress": simple_match.group(1).strip(),
"streetAddressLine2": "",
"city": simple_match.group(2).strip(),
"state": "MA",
"zipCode": simple_match.group(3).strip()
}
# Handle just the zip code case more aggressively
zip_only = re.search(r'(\d{5})', user_input)
if zip_only:
return {
"streetAddress": "",
"streetAddressLine2": "",
"city": "Boston",
"state": "MA",
"zipCode": zip_only.group(1).strip()
}
# Standard address patterns for regular queries
# Look for complete addresses with street, city, state, zip
address_pattern = r'(?:at|on|near|live(?:s)? (?:at|on|in|near))?\s*([0-9]+\s+[A-Za-z\s]+(?:Avenue|Ave|Street|St|Road|Rd|Boulevard|Blvd|Lane|Ln|Drive|Dr|Court|Ct|Place|Pl|Terrace|Ter|Way)[.,]?)\s*(?:in)?\s*([A-Za-z\s]+)[.,]?\s*(?:MA|Massachusetts)[.,]?\s*(\d{5})'
address_match = re.search(address_pattern, user_input, re.IGNORECASE)
if address_match:
return {
"streetAddress": address_match.group(1).strip(),
"streetAddressLine2": "",
"city": address_match.group(2).strip(),
"state": "MA",
"zipCode": address_match.group(3).strip()
}
# Look for just a Boston neighborhood and zip code
neighborhood_pattern = r'(?:in|near|from)\s+([A-Za-z\s]+(?:Plain|Hill|Square|Center|Bay|Park|Boston))\s*(?:area|neighborhood)?\s*(?:,\s*)?(?:\(?(?:zip(?:code)?)?\s*(\d{5})\)?)?'
neighborhood_match = re.search(neighborhood_pattern, user_input, re.IGNORECASE)
if neighborhood_match and neighborhood_match.group(2):
return {
"streetAddress": "",
"streetAddressLine2": "",
"city": "Boston",
"state": "MA",
"zipCode": neighborhood_match.group(2).strip()
}
# Look for just a zip code
zip_pattern = r'(?:zip(?:code)?)?\s*(\d{5})'
zip_match = re.search(zip_pattern, user_input, re.IGNORECASE)
if zip_match:
return {
"streetAddress": "",
"streetAddressLine2": "",
"city": "Boston",
"state": "MA",
"zipCode": zip_match.group(1).strip()
}
return None
def extract_grade_info(self, user_input):
"""
Extract grade level information from user input.
Args:
user_input (str): The user's question or statement
Returns:
str or None: Grade ID or None if not found
"""
# If we're explicitly waiting for a grade, be more lenient
if self.conversation_state.get("waiting_for") == "grade":
# For direct grade responses like "5" or "grade 5" or "fifth grade"
simple_grade_pattern = r'(?:grade\s*)?(\d{1,2})(?:th|st|nd|rd)?(?:\s*grade)?'
simple_match = re.search(simple_grade_pattern, user_input, re.IGNORECASE)
if simple_match:
grade = simple_match.group(1)
grade_options = self.eligibility_api.grade_options()
if grade in grade_options:
self.conversation_state["grade_display"] = f"Grade {grade}"
return grade_options.get(grade)
# Handle kindergarten responses more directly
if re.search(r'k(?:indergarten)?[\s-]*0', user_input, re.IGNORECASE):
self.conversation_state["grade_display"] = "Kindergarten 0 (K0)"
return self.eligibility_api.grade_options().get("K0")
if re.search(r'k(?:indergarten)?[\s-]*1', user_input, re.IGNORECASE):
self.conversation_state["grade_display"] = "Kindergarten 1 (K1)"
return self.eligibility_api.grade_options().get("K1")
if re.search(r'k(?:indergarten)?[\s-]*2|kindergarten', user_input, re.IGNORECASE):
self.conversation_state["grade_display"] = "Kindergarten 2 (K2)"
return self.eligibility_api.grade_options().get("K2")
# Define regex patterns for different grades
grade_patterns = {
"K0": r'\bK0\b|(?:3|three)[-\s]?year[-\s]?old|grade k0',
"K1": r'\bK1\b|(?:4|four)[-\s]?year[-\s]?old|pre[-\s]?k|grade k1',
"K2": r'\bK2\b|(?:5|five)[-\s]?year[-\s]?old|kindergarten|grade k2',
"1": r'\bgrade 1\b|(?:1st|first) grade|(?:6|six)[-\s]?year[-\s]?old',
"2": r'\bgrade 2\b|(?:2nd|second) grade|(?:7|seven)[-\s]?year[-\s]?old',
"3": r'\bgrade 3\b|(?:3rd|third) grade|(?:8|eight)[-\s]?year[-\s]?old',
"4": r'\bgrade 4\b|(?:4th|fourth) grade|(?:9|nine)[-\s]?year[-\s]?old',
"5": r'\bgrade 5\b|(?:5th|fifth) grade|(?:10|ten)[-\s]?year[-\s]?old',
"6": r'\bgrade 6\b|(?:6th|sixth) grade|(?:11|eleven)[-\s]?year[-\s]?old',
"7": r'\bgrade 7\b|(?:7th|seventh) grade|(?:12|twelve)[-\s]?year[-\s]?old',
"8": r'\bgrade 8\b|(?:8th|eighth) grade|(?:13|thirteen)[-\s]?year[-\s]?old',
"9": r'\bgrade 9\b|(?:9th|ninth) grade|(?:14|fourteen)[-\s]?year[-\s]?old|freshman',
"10": r'\bgrade 10\b|(?:10th|tenth) grade|(?:15|fifteen)[-\s]?year[-\s]?old|sophomore',
"11": r'\bgrade 11\b|(?:11th|eleventh) grade|(?:16|sixteen)[-\s]?year[-\s]?old|junior',
"12": r'\bgrade 12\b|(?:12th|twelfth) grade|(?:17|seventeen)[-\s]?year[-\s]?old|senior'
}
# Get the grade_options map from the API
grade_options = self.eligibility_api.grade_options()
# Check each pattern against the user input
for grade, pattern in grade_patterns.items():
if re.search(pattern, user_input, re.IGNORECASE):
# Save the human-readable grade for display
grade_display_map = {
"K0": "Kindergarten 0 (K0)",
"K1": "Kindergarten 1 (K1)",
"K2": "Kindergarten 2 (K2)"
}
self.conversation_state["grade_display"] = grade_display_map.get(grade, f"Grade {grade}")
return grade_options.get(grade)
# Default to K2 (kindergarten) if no grade is detected and we're not specifically asking
if self.conversation_state.get("waiting_for") != "grade":
return grade_options.get("K2")
return None
def extract_language_info(self, user_input):
"""
Extract language preference from user input.
Args:
user_input (str): The user's question or statement
Returns:
str: Language ID (defaults to English if not found)
"""
# Define patterns for language detection
language_mapping = {
"English": r'\benglish\b',
"Spanish": r'\bspanish\b|\bespañol\b',
"Arabic": r'\barabic\b|\bعربي\b',
"Mandarin": r'\bmandarin\b|\bchinese\b',
"Burmese": r'\bburmese\b',
"Cambodian": r'\bcambodian\b|\bkhmer\b',
"Cantonese": r'\bcantonese\b',
"Cape Verdean": r'\bcape verdean\b|\bcreole\b',
"French": r'\bfrench\b|\bfrançais\b',
"Greek": r'\bgreek\b',
"Haitian Creole": r'\bhaitian\b|\bhaitian creole\b',
"H'Mong": r"\bh[\'']?mong\b",
"Italian": r'\bitalian\b|\bitaliano\b',
"Korean": r'\bkorean\b',
"Portuguese": r'\bportuguese\b|\bportuguês\b',
"Russian": r'\brussian\b',
"Somali": r'\bsomali\b',
"Toishanese": r'\btoishanese\b',
"Vietnamese": r'\bvietnamese\b'
}
# If we're explicitly waiting for a language, be more lenient
if self.conversation_state.get("waiting_for") == "language":
# Check direct language responses with a simpler approach
user_input_lower = user_input.lower()
for language in language_mapping:
if language.lower() in user_input_lower:
self.conversation_state["language_display"] = language
return self.eligibility_api.language_options().get(language)
# Get language options from the API
language_options = self.eligibility_api.language_options()
# Check each language pattern against the user input
for language, pattern in language_mapping.items():
if re.search(pattern, user_input, re.IGNORECASE):
self.conversation_state["language_display"] = language
return language_options.get(language)
# Default to English if no language is detected and we're not specifically asking
if self.conversation_state.get("waiting_for") != "language":
self.conversation_state["language_display"] = "English"
return language_options.get("English")
return None
def is_asking_for_schools(self, user_input):
"""Check if the user is asking about eligible schools"""
school_inquiry_pattern = r'what schools|eligible schools|available schools|school(?:s)? (?:for|near|in|around)|find (?:a )?school|where (?:can|should) (?:I|we) send|list of schools'
return bool(re.search(school_inquiry_pattern, user_input, re.IGNORECASE))
def determine_missing_info(self):
"""Determine what information is missing for school eligibility search"""
missing = []
if not self.conversation_state.get("address"):
missing.append("address")
if not self.conversation_state.get("grade"):
missing.append("grade")
if not self.conversation_state.get("language"):
missing.append("language")
return missing
def handle_follow_up_question(self, user_input):
"""
Handle follow-up questions based on previous context.
Args:
user_input (str): The user's input
Returns:
str or None: Response if handled, None otherwise
"""
# Check if we're waiting for specific information
waiting_for = self.conversation_state.get("waiting_for")
if waiting_for == "address":
address = self.extract_address_info(user_input)
if address:
self.conversation_state["address"] = address
self.conversation_state["waiting_for"] = None
# If we have all info needed for school search, proceed
missing = self.determine_missing_info()
if not missing:
return self.search_eligible_schools()
else:
# Ask for the next piece of info
next_missing = missing[0]
self.conversation_state["waiting_for"] = next_missing
if next_missing == "grade":
return "Thank you for providing your address. What grade will your child be entering?"
elif next_missing == "language":
return "Thank you for providing your address. What is your preferred language?"
else:
return "I'm having trouble understanding your address. Please provide a Boston address with zip code, like '123 Main St, Boston, MA 02115'."
elif waiting_for == "grade":
grade_id = self.extract_grade_info(user_input)
if grade_id:
self.conversation_state["grade"] = grade_id
self.conversation_state["waiting_for"] = None
# If we have all info needed for school search, proceed
missing = self.determine_missing_info()
if not missing:
return self.search_eligible_schools()
else:
# Ask for the next piece of info
next_missing = missing[0]
self.conversation_state["waiting_for"] = next_missing
if next_missing == "address":
return f"Thank you for letting me know your child will be in {self.conversation_state.get('grade_display', 'that grade')}. What is your address or zip code in Boston?"
elif next_missing == "language":
return f"Thank you for letting me know your child will be in {self.conversation_state.get('grade_display', 'that grade')}. What is your preferred language?"
else:
return "I'm not sure I understood the grade level. Please specify if your child will be in K0 (3 years old), K1 (4 years old), K2 (kindergarten/5 years old), or grades 1-12."
elif waiting_for == "language":
language_id = self.extract_language_info(user_input)
if language_id:
self.conversation_state["language"] = language_id
self.conversation_state["waiting_for"] = None
# If we have all info needed for school search, proceed
missing = self.determine_missing_info()
if not missing:
return self.search_eligible_schools()
else:
# Ask for the next piece of info
next_missing = missing[0]
self.conversation_state["waiting_for"] = next_missing
if next_missing == "address":
return f"Thank you for selecting {self.conversation_state.get('language_display', 'your language')}. What is your address or zip code in Boston?"
elif next_missing == "grade":
return f"Thank you for selecting {self.conversation_state.get('language_display', 'your language')}. What grade will your child be entering?"
else:
return "I didn't recognize that language. Please choose from options like English, Spanish, Mandarin, etc."
# Check if it's a follow-up about previously found schools
# Use .get() for safer access to last_school_results
last_results = self.conversation_state.get("last_school_results")
if last_results and re.search(r'tell me more about|more information|details (about|on)|what about|where is', user_input, re.IGNORECASE):
# Try to identify which school they're asking about
schools = last_results # Use the retrieved value
target_school = None
# Check for school number references (e.g., "Tell me more about #3")
number_match = re.search(r'#?(\d+)', user_input)
if number_match and schools:
try:
index = int(number_match.group(1)) - 1
if 0 <= index < len(schools):
target_school = schools[index]
except:
pass
# If we didn't find a school by number, try to find it by name
if not target_school:
for school in schools:
school_name = school.get('name', '').lower()
if school_name and school_name in user_input.lower():
target_school = school
break
# If we found a school, get its details from en.data.json
if target_school:
school_id = target_school.get('id', '')
if school_id:
# Try to get full details from en.data.json
full_details = self.eligibility_api.get_full_school_details(school_id)
# If we got full details, format and return them
if full_details and isinstance(full_details, dict) and full_details.get('name'):
return self.format_school_details_response(full_details)
# Fallback to basic info if we couldn't get full details
return f"Here's more information about {target_school.get('name', 'the school')}:\n\nAddress: {target_school.get('address', 'Information not available')}\nReferenceID: {target_school.get('referenceId', 'N/A')}\n\nFor complete details and registration information, please visit https://boston.explore.avela.org/ or contact a BPS Welcome Center at 617-635-9010."
return None
def format_school_details_response(self, school_details):
"""Format a comprehensive school details response using full data from en.data.json"""
name = school_details.get('name') or school_details.get('school', 'Unknown School')
address = school_details.get('address', 'Information not available')
# Start with basic information
response = f"Here's detailed information about {name}:\n\n"
response += f"Address: {address}\n"
# Add grade span if available
if grade_span := school_details.get('grade_span'):
response += f"Grade Span: {grade_span}\n"
# Add phone if available
if phone := (school_details.get('phone_number') or school_details.get('phone')):
response += f"Phone: {phone}\n"
# Add website if available
if website := school_details.get('website'):
response += f"Website: {website}\n"
# Add school hours if available
if hours := (school_details.get('hours_of_operation') or school_details.get('hours')):
response += f"Hours: {hours}\n"
# Add programs/features if available (checking multiple possible fields)
programs = []
if special_programs := school_details.get('specialized_education_programs'):
if special_programs and special_programs.strip():
programs.append(f"Specialized Education Programs: {special_programs}")
if language_text := school_details.get('language_programming_text'):
if language_text and language_text.strip():
programs.append(f"Language Programs: {language_text}")
if unique_features := school_details.get('unique_features'):
if isinstance(unique_features, list) and unique_features:
programs.append("Unique Features: " + ", ".join([f.strip() for f in unique_features if f.strip()]))
elif isinstance(unique_features, str) and unique_features.strip():
programs.append(f"Unique Features: {unique_features}")
# Add programs if we found any
if programs:
response += "\nPrograms & Features:\n"
for program in programs:
response += f"- {program}\n"
# Add additional amenities section if available
amenities = []
if school_details.get('library') == 'Yes':
amenities.append('Library')
if school_details.get('music_room') == 'Yes':
amenities.append('Music Room')
if school_details.get('gymnasium') == 'Yes':
amenities.append('Gymnasium')
if school_details.get('outdoor_classrooms') == 'Yes':
amenities.append('Outdoor Classroom')
if school_details.get('science_lab') == 'Yes':
amenities.append('Science Lab')
if school_details.get('cafeteria') == 'Yes':
amenities.append('Cafeteria')
if amenities:
response += f"\nAmenities: {', '.join(amenities)}\n"
# Add mission statement if available
if mission := school_details.get('overview_mission_statement'):
if mission and len(mission) > 30: # Only include if substantial
response += f"\nMission Statement: {mission[:200]}{'...' if len(mission) > 200 else ''}\n"
# Add before/after school info
if before := school_details.get('before_school_program'):
if before and before.strip():
response += f"\nBefore School Program: {before}\n"
if after := school_details.get('after_school_program'):
if after and after.strip():
response += f"\nAfter School Program: {after}\n"
response += "\nFor complete details and registration information, please visit https://boston.explore.avela.org/ or contact a BPS Welcome Center at 617-635-9010."
return response
def search_eligible_schools(self):
"""Search for eligible schools using the information we have"""
try:
# First ensure we have all needed information using .get()
current_address = self.conversation_state.get("address")
current_grade = self.conversation_state.get("grade")
current_language = self.conversation_state.get("language")
if not all([current_address, current_grade, current_language]):
# Determine missing info using the updated method
missing = self.determine_missing_info()
return f"To find eligible schools, I still need your {', '.join(missing)}."
# Call the API to find eligible schools using the retrieved values
results = self.eligibility_api.find_eligible_schools(
grade_id=current_grade,
address=current_address,
language_id=current_language
)
# Process results
eligible_schools = results.get("schools", [])
self.conversation_state["last_school_results"] = eligible_schools
if eligible_schools:
schools_info = "Based on your location and student information, these schools are available:\n\n"
for i, school in enumerate(eligible_schools[:10], 1): # Limit to first 10 schools
schools_info += f"{i}. {school.get('name', 'Unknown School')}\n"
if school.get('address'):
schools_info += f" Address: {school.get('address')}\n"
schools_info += "\n"
# Add information about total eligible schools if more than 10
if len(eligible_schools) > 10:
schools_info += f"\nThere are {len(eligible_schools)} eligible schools in total. "
schools_info += "For more details, please visit: https://boston.explore.avela.org/\n\nYou can ask me for more information about any specific school by name or number (e.g., 'Tell me more about #3')."
return schools_info
else:
return "I couldn't find any eligible schools for your location and student information. Please verify your address is in Boston and try again, or visit https://boston.explore.avela.org/ directly."
except Exception as e:
print(f"API error: {e}")
return f"I apologize, but I encountered an error searching for schools: {str(e)}"
def get_response(self, user_input, history=None):
"""
Generate responses to user questions about Boston schools, with conversation state management.
Args:
user_input (str): The user's question about Boston schools
history (list, optional): Previous conversation history as [user_msg, assistant_msg] pairs
Returns:
str: The chatbot's response
Implementation tips:
- Use self.format_prompt() to format the user's input
- Use self.client to generate responses
"""
# Process direct responses to questions we've asked
follow_up_response = self.handle_follow_up_question(user_input)
if follow_up_response:
return follow_up_response
# Extract information from the user input to build our context
address = self.extract_address_info(user_input)
if address:
self.conversation_state["address"] = address
grade_id = self.extract_grade_info(user_input)
if grade_id:
self.conversation_state["grade"] = grade_id
language_id = self.extract_language_info(user_input)
if language_id:
self.conversation_state["language"] = language_id
# Check if user is asking about eligible schools
if self.is_asking_for_schools(user_input):
# Determine if we're missing any info needed for search
missing = self.determine_missing_info()
if not missing:
# We have all the info we need, proceed with search
return self.search_eligible_schools()
else:
# Ask for the first missing piece of information
first_missing = missing[0]
self.conversation_state["waiting_for"] = first_missing
if first_missing == "address":
return "To help you find eligible schools, I need your address or zip code in Boston. What is your address?"
elif first_missing == "grade":
return "To find schools that match your needs, I need to know what grade your child will be entering. Is your child in kindergarten (K0, K1, K2) or grades 1-12?"
elif first_missing == "language":
return "To find the right schools, I need to know your language preference. What language would you prefer?"
# Check if response is asking to reset or start over
if re.search(r'start over|reset|clear|new search|different (address|location|grade|child)', user_input, re.IGNORECASE):
self.reset_state()
return "I've reset our conversation. How can I help you with Boston Public Schools today?"
# --- Add Check for Unsupported Queries ---
unsupported_keywords = ['immersion', 'after-school', 'after school', 'sports', 'clubs', 'extracurricular', 'curriculum details', 'specific teacher']
input_lower = user_input.lower()
if any(keyword in input_lower for keyword in unsupported_keywords):
print("Detected unsupported query keyword. Returning standard message.")
return "I can help with general school eligibility, registration steps, and contact information. For specific details about programs like language immersion, sports, or after-school activities at individual schools, it's best to check the official BPS website (bostonpublicschools.org) or contact the school directly."
# --- End Check ---
# Default behavior: use the model
prompt = self.format_prompt(user_input, history)
try:
print("Generating response...")
response = self.client.text_generation(
prompt,
max_new_tokens=256, # Keep lower to avoid context length issues
stop=["User:", "Assistant:", "\nUser:"],
return_full_text=False
)
return response.strip()
except Exception as e:
print(f"API error: {e}")
return f"I apologize, but I encountered an error: {str(e)}"
|