Spaces:
Running on Zero
Running on Zero
File size: 30,236 Bytes
725c26b 0941f3a 725c26b cde716a 9338abc 725c26b cde716a 0941f3a 725c26b 9338abc 725c26b 9338abc 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b cde716a 725c26b 0941f3a 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b 4379a1a 725c26b e4a01ce 725c26b 0941f3a 725c26b 4379a1a 725c26b f9ae0da | 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 | from __future__ import annotations
import json
import os
import re
import traceback
from dataclasses import dataclass
from pathlib import Path
from typing import Any
import spaces
import faiss
import gradio as gr
import numpy as np
from google import genai
from rank_bm25 import BM25Okapi
from sentence_transformers import CrossEncoder, SentenceTransformer
# =============================================================================
# Configuration
# =============================================================================
BASE_DIR = Path(__file__).resolve().parent
ARTIFACT_DIR = BASE_DIR / "artifacts"
INDEX_PATH = ARTIFACT_DIR / "research_index.faiss"
CHUNKS_PATH = ARTIFACT_DIR / "chunks.json"
RETRIEVAL_TEXTS_PATH = ARTIFACT_DIR / "retrieval_texts.json"
CONFIG_PATH = ARTIFACT_DIR / "index_config.json"
GEMINI_MODEL = os.getenv("GEMINI_MODEL", "gemini-2.5-flash")
TOP_K = 8
FAISS_K = 50
BM25_K = 20
MAX_HISTORY_MESSAGES = 6
QUERY_EXPANSIONS = {
"gan": "generative adversarial network",
"gans": "generative adversarial networks",
"cnn": "convolutional neural network",
"llm": "large language model",
"llms": "large language models",
"lora": "low-rank adaptation",
"grpo": "group relative policy optimization",
"rnn": "recurrent neural network",
"lstm": "long short-term memory",
}
FOLLOW_UP_TERMS = {
"he",
"him",
"his",
"it",
"its",
"they",
"them",
"their",
"this",
"that",
"these",
"those",
"former",
"latter",
}
FOLLOW_UP_PHRASES = (
"what about",
"how about",
"tell me more",
"more about",
"what methods",
"what results",
"what were",
"how did",
"why did",
"which one",
"that project",
"that paper",
"the thesis",
"the project",
"the paper",
)
@spaces.GPU(duration=10)
def zerogpu_registration() -> str:
"""
Register one ZeroGPU function for Hugging Face Spaces.
The actual RAG pipeline runs on CPU because Gemini handles
language generation remotely.
"""
return "ZeroGPU registered"
# =============================================================================
# Data structure
# =============================================================================
@dataclass
class Chunk:
text: str
source: str
file_type: str
chunk_id: str
page: int | None = None
document_type: str | None = None
page_header: str | None = None
repository: str | None = None
relative_path: str | None = None
section: str | None = None
# =============================================================================
# Load saved artifacts
# =============================================================================
def require_file(path: Path) -> None:
if not path.exists():
raise FileNotFoundError(
f"Required artifact is missing: {path}\n"
"Run the notebook artifact-saving section first."
)
for required_path in (
INDEX_PATH,
CHUNKS_PATH,
RETRIEVAL_TEXTS_PATH,
CONFIG_PATH,
):
require_file(required_path)
with CONFIG_PATH.open("r", encoding="utf-8") as file:
index_config = json.load(file)
EMBEDDING_MODEL_NAME = index_config["embedding_model"]
RERANKER_MODEL_NAME = index_config["reranker_model"]
QUERY_INSTRUCTION = index_config["query_instruction"]
index = faiss.read_index(str(INDEX_PATH))
with CHUNKS_PATH.open("r", encoding="utf-8") as file:
chunks = [
Chunk(**item)
for item in json.load(file)
]
with RETRIEVAL_TEXTS_PATH.open("r", encoding="utf-8") as file:
retrieval_texts: list[str] = json.load(file)
if index.ntotal != len(chunks):
raise ValueError(
f"FAISS contains {index.ntotal} vectors, "
f"but chunks.json contains {len(chunks)} chunks."
)
if len(chunks) != len(retrieval_texts):
raise ValueError(
"chunks.json and retrieval_texts.json contain "
"different numbers of records."
)
if index.d != index_config["embedding_dimension"]:
raise ValueError(
"The FAISS embedding dimension does not match index_config.json."
)
# Load retrieval models once when the app starts.
embedding_model = SentenceTransformer(
EMBEDDING_MODEL_NAME,
device="cpu",
)
reranker = CrossEncoder(
RERANKER_MODEL_NAME,
device="cpu",
)
def tokenize_for_bm25(text: str) -> list[str]:
"""
Tokenize text while preserving technical terms and filenames.
"""
return re.findall(
r"\b[a-zA-Z0-9][a-zA-Z0-9_.+-]*\b",
text.lower(),
)
bm25 = BM25Okapi(
[
tokenize_for_bm25(text)
for text in retrieval_texts
]
)
# =============================================================================
# Query processing
# =============================================================================
def expand_query(query: str) -> str:
"""
Append full forms of common technical abbreviations.
"""
words = re.findall(
r"\b[\w-]+\b",
query.lower(),
)
expansions = [
QUERY_EXPANSIONS[word]
for word in words
if word in QUERY_EXPANSIONS
]
if not expansions:
return query
unique_expansions = list(
dict.fromkeys(expansions)
)
return query + " " + " ".join(unique_expansions)
def encode_query(query: str) -> np.ndarray:
"""
Encode a query for semantic retrieval using the same
instruction used when building the index.
"""
instructed_query = (
QUERY_INSTRUCTION
+ query.strip()
)
query_embedding = embedding_model.encode(
[instructed_query],
normalize_embeddings=True,
)
return np.asarray(
query_embedding,
dtype="float32",
)
# =============================================================================
# FAISS and BM25 retrieval
# =============================================================================
def retrieve_faiss_candidates(
query: str,
top_k: int = FAISS_K,
) -> list[dict[str, Any]]:
"""
Retrieve semantic candidates from FAISS.
"""
if top_k <= 0:
raise ValueError("top_k must be positive")
search_k = min(
top_k,
index.ntotal,
)
scores, indices = index.search(
encode_query(query),
search_k,
)
results = []
for rank, (score, chunk_index) in enumerate(
zip(scores[0], indices[0]),
start=1,
):
if chunk_index < 0:
continue
results.append(
{
"chunk_index": int(chunk_index),
"faiss_score": float(score),
"faiss_rank": rank,
}
)
return results
def retrieve_bm25_candidates(
query: str,
top_k: int = BM25_K,
) -> list[dict[str, Any]]:
"""
Retrieve keyword candidates from BM25.
"""
if top_k <= 0:
raise ValueError("top_k must be positive")
query_tokens = tokenize_for_bm25(query)
if not query_tokens:
return []
scores = bm25.get_scores(query_tokens)
top_indices = np.argsort(
scores
)[::-1][:top_k]
results = []
for rank, chunk_index in enumerate(
top_indices,
start=1,
):
score = float(scores[chunk_index])
if score <= 0:
continue
results.append(
{
"chunk_index": int(chunk_index),
"bm25_score": score,
"bm25_rank": rank,
}
)
return results
def merge_candidates(
faiss_results: list[dict[str, Any]],
bm25_results: list[dict[str, Any]],
) -> list[dict[str, Any]]:
"""
Merge FAISS and BM25 candidates by chunk index.
"""
merged: dict[int, dict[str, Any]] = {}
for result in faiss_results:
chunk_index = result["chunk_index"]
merged[chunk_index] = {
"chunk_index": chunk_index,
"faiss_score": result["faiss_score"],
"faiss_rank": result["faiss_rank"],
"bm25_score": None,
"bm25_rank": None,
"retrieved_by": {"faiss"},
}
for result in bm25_results:
chunk_index = result["chunk_index"]
if chunk_index not in merged:
merged[chunk_index] = {
"chunk_index": chunk_index,
"faiss_score": None,
"faiss_rank": None,
"bm25_score": result["bm25_score"],
"bm25_rank": result["bm25_rank"],
"retrieved_by": {"bm25"},
}
else:
merged[chunk_index]["bm25_score"] = (
result["bm25_score"]
)
merged[chunk_index]["bm25_rank"] = (
result["bm25_rank"]
)
merged[chunk_index]["retrieved_by"].add(
"bm25"
)
merged_results = list(
merged.values()
)
for result in merged_results:
result["retrieved_by"] = sorted(
result["retrieved_by"]
)
return merged_results
def retrieve_hybrid_candidates(
query: str,
faiss_k: int = FAISS_K,
bm25_k: int = BM25_K,
) -> list[dict[str, Any]]:
"""
Retrieve and combine FAISS and BM25 candidates.
"""
faiss_results = retrieve_faiss_candidates(
query=query,
top_k=faiss_k,
)
bm25_results = retrieve_bm25_candidates(
query=query,
top_k=bm25_k,
)
return merge_candidates(
faiss_results=faiss_results,
bm25_results=bm25_results,
)
def enrich_candidates(
candidates: list[dict[str, Any]],
) -> list[dict[str, Any]]:
"""
Attach chunk text and metadata to retrieval candidates.
"""
enriched_results = []
for candidate in candidates:
chunk_index = candidate["chunk_index"]
chunk = chunks[chunk_index]
enriched_results.append(
{
**candidate,
"text": chunk.text,
"retrieval_text": retrieval_texts[
chunk_index
],
"source": chunk.source,
"file_type": chunk.file_type,
"page": chunk.page,
"document_type": chunk.document_type,
"page_header": chunk.page_header,
"repository": chunk.repository,
"relative_path": chunk.relative_path,
"section": chunk.section,
"chunk_id": chunk.chunk_id,
}
)
return enriched_results
def rerank_candidates(
query: str,
candidates: list[dict[str, Any]],
top_k: int = TOP_K,
) -> list[dict[str, Any]]:
"""
Rerank hybrid candidates using the cross-encoder.
"""
if top_k <= 0:
raise ValueError("top_k must be positive")
if not candidates:
return []
query_chunk_pairs = [
[
query,
candidate["retrieval_text"],
]
for candidate in candidates
]
reranker_scores = reranker.predict(
query_chunk_pairs,
show_progress_bar=False,
)
reranked_results = []
for candidate, score in zip(
candidates,
reranker_scores,
):
result = candidate.copy()
result["reranker_score"] = float(score)
reranked_results.append(result)
reranked_results.sort(
key=lambda result: result[
"reranker_score"
],
reverse=True,
)
return reranked_results[:top_k]
def retrieve_with_reranking(
query: str,
top_k: int = TOP_K,
faiss_k: int = FAISS_K,
bm25_k: int = BM25_K,
) -> list[dict[str, Any]]:
"""
Run query expansion, hybrid retrieval, and reranking.
"""
search_query = expand_query(query)
hybrid_candidates = retrieve_hybrid_candidates(
query=search_query,
faiss_k=faiss_k,
bm25_k=bm25_k,
)
enriched_candidates = enrich_candidates(
hybrid_candidates
)
return rerank_candidates(
query=query,
candidates=enriched_candidates,
top_k=top_k,
)
# =============================================================================
# Source formatting and context construction
# =============================================================================
def format_source_location(
result: dict[str, Any],
) -> str:
"""
Format source metadata for the LLM context.
"""
if result.get("repository"):
location = (
f"GitHub repository: "
f"{result['repository']}"
)
if result.get("relative_path"):
location += (
f", file: "
f"{result['relative_path']}"
)
if result.get("section"):
location += (
f", section: "
f"{result['section']}"
)
return location
location = result.get(
"source",
"Unknown source",
)
if result.get("page") is not None:
location += (
f", page {result['page']}"
)
if result.get("document_type"):
location += (
f", {result['document_type']}"
)
return location
def build_context(
results: list[dict[str, Any]],
) -> str:
"""
Build numbered source blocks for answer generation.
"""
context_parts = []
for source_number, result in enumerate(
results,
start=1,
):
location = format_source_location(
result
)
context_parts.append(
f"[Source {source_number}: "
f"{location}]\n"
f"{result['text']}"
)
return "\n\n".join(context_parts)
def format_source(
source: dict[str, Any],
) -> str:
"""
Create a readable public source label.
"""
if source.get("repository"):
location = (
f"GitHub: "
f"{source['repository']}"
)
if source.get("relative_path"):
location += (
f" / "
f"{source['relative_path']}"
)
if source.get("section"):
location += (
f" — "
f"{source['section']}"
)
return location
location = source.get(
"source",
"Unknown source",
)
if source.get("page") is not None:
location += (
f", page {source['page']}"
)
return location
def format_sources(
sources: list[dict[str, Any]],
) -> str:
"""
Format unique sources as Markdown.
"""
if not sources:
return ""
lines = ["### Sources"]
seen_locations = set()
for source in sources:
location = format_source(source)
if location in seen_locations:
continue
seen_locations.add(location)
lines.append(f"- {location}")
return "\n".join(lines)
# =============================================================================
# Conversation history
# =============================================================================
def remove_source_section(text: str) -> str:
"""
Remove the displayed source list from a previous response.
"""
if not text:
return ""
marker = "\n\n---\n\n### Sources"
return text.split(marker, 1)[0].strip()
def extract_message_text(content: Any) -> str:
"""
Extract plain text from Gradio message content.
Gradio normally provides strings for this app, but this function
safely handles a few structured-content cases.
"""
if isinstance(content, str):
return content.strip()
if isinstance(content, dict):
for key in ("text", "content", "value"):
value = content.get(key)
if isinstance(value, str):
return value.strip()
if isinstance(content, (list, tuple)):
parts = [
extract_message_text(item)
for item in content
]
return " ".join(
part for part in parts if part
).strip()
return ""
def normalize_chat_history(
history: Any,
) -> list[dict[str, str]]:
"""
Normalize Gradio history to message dictionaries.
Supports:
- Gradio message dictionaries
- Older tuple/list pairs: (user_message, assistant_message)
"""
if not history:
return []
normalized: list[dict[str, str]] = []
for item in history:
if isinstance(item, dict):
role = str(
item.get("role", "")
).strip().lower()
content = extract_message_text(
item.get("content", "")
)
if role == "assistant":
content = remove_source_section(content)
if role in {"user", "assistant"} and content:
normalized.append(
{
"role": role,
"content": content,
}
)
elif (
isinstance(item, (list, tuple))
and len(item) == 2
):
user_message = extract_message_text(item[0])
assistant_message = extract_message_text(item[1])
if user_message:
normalized.append(
{
"role": "user",
"content": user_message,
}
)
if assistant_message:
normalized.append(
{
"role": "assistant",
"content": remove_source_section(
assistant_message
),
}
)
return normalized
def format_chat_history(
history: Any,
max_messages: int = MAX_HISTORY_MESSAGES,
) -> str:
"""
Convert recent normalized history into readable conversation text.
"""
messages = normalize_chat_history(history)
if not messages:
return ""
recent_messages = messages[-max_messages:]
return "\n".join(
f"{message['role'].capitalize()}: {message['content']}"
for message in recent_messages
)
def get_last_user_message(
history: Any,
) -> str:
"""
Return the most recent user message from the prior conversation.
"""
messages = normalize_chat_history(history)
for message in reversed(messages):
if message["role"] == "user":
return message["content"]
return ""
def is_follow_up_question(
question: str,
history: Any,
) -> bool:
"""
Detect questions that likely depend on earlier conversation context.
"""
if not normalize_chat_history(history):
return False
normalized_question = question.lower().strip()
words = set(
re.findall(r"\b[\w'-]+\b", normalized_question)
)
if words & FOLLOW_UP_TERMS:
return True
if any(
phrase in normalized_question
for phrase in FOLLOW_UP_PHRASES
):
return True
# Very short questions often omit the subject.
return len(words) <= 6
def fallback_follow_up_query(
question: str,
history: Any,
) -> str:
"""
Build a deterministic retrieval query if the LLM rewrite fails.
"""
previous_user_message = get_last_user_message(history)
if not previous_user_message:
return question
return (
f"Milad Saeedi portfolio context: "
f"{previous_user_message}. "
f"Follow-up question: {question}"
)
# =============================================================================
# Gemini generation
# =============================================================================
if not os.getenv("GEMINI_API_KEY"):
raise RuntimeError(
"GEMINI_API_KEY is not configured. Add it as a private Secret "
"in the Hugging Face Space settings."
)
gemini_client = genai.Client()
def generate_answer(
prompt: str,
model_name: str = GEMINI_MODEL,
) -> str:
"""
Generate a response using the Gemini API.
"""
interaction = gemini_client.interactions.create(
model=model_name,
input=prompt,
)
answer = interaction.output_text
if not answer:
raise RuntimeError(
"Gemini returned an empty response."
)
return answer.strip()
def rewrite_question_with_history(
question: str,
history,
model_name: str = GEMINI_MODEL,
) -> str:
"""
Rewrite only context-dependent follow-ups as standalone queries.
Standalone questions are returned unchanged.
"""
if not is_follow_up_question(
question=question,
history=history,
):
return question
history_text = format_chat_history(history)
if not history_text:
return question
prompt = f"""
Rewrite the latest portfolio question as one precise, standalone search query.
Rules:
1. Resolve pronouns and references using the recent conversation.
2. Preserve the exact subject being discussed, such as Milad Saeedi's thesis,
paper, GitHub project, method, result, or skill.
3. Include "Milad Saeedi" when needed for clarity.
4. Do not answer the question.
5. Do not add facts that are not in the conversation.
6. Return only one rewritten search query.
Recent conversation:
{history_text}
Latest follow-up question:
{question}
Standalone search query:
""".strip()
fallback_query = fallback_follow_up_query(
question=question,
history=history,
)
try:
rewritten = generate_answer(
prompt=prompt,
model_name=model_name,
).strip()
if not rewritten:
return fallback_query
# Avoid accidental full answers or excessively long rewrites.
if len(rewritten.split()) > 60:
return fallback_query
print(
f"Follow-up rewrite: {question!r} -> {rewritten!r}"
)
return rewritten
except Exception:
traceback.print_exc()
return fallback_query
def build_prompt(
question: str,
results: list[dict[str, Any]],
history=None,
) -> str:
"""
Build the grounded answer-generation prompt.
"""
context = build_context(results)
history_text = format_chat_history(history)
if not history_text:
history_text = "No previous conversation."
return f"""
You are ResearchGPT, a research and portfolio assistant for Milad Saeedi.
Use only the retrieved context as factual evidence.
Citation requirements:
1. Every paragraph containing a factual claim must include at least one citation.
2. Use citations exactly in this format: [Source 1], [Source 2], etc.
3. Place citations immediately after the sentence or claim they support.
4. Use only source numbers that appear in the retrieved context.
5. Do not create a separate source list; the application adds it automatically.
6. Do not omit citations in summaries, lists, or conclusions.
Additional instructions:
1. Answer the latest question directly.
2. Use conversation history only to resolve follow-up references.
3. Do not treat conversation history as factual evidence.
4. Do not invent publications, methods, results, skills, projects, or experience.
5. If the retrieved context is insufficient, say so clearly.
6. Avoid unsupported praise or subjective claims.
7. Contact information may be provided only when explicitly requested.
8. Synthesize the evidence instead of copying long passages.
Recent conversation:
{history_text}
Retrieved context:
{context}
Latest question:
{question}
Write a grounded answer with inline citations:
""".strip()
def has_inline_citations(answer: str) -> bool:
"""
Check whether an answer contains at least one [Source N] citation.
"""
return bool(
re.search(r"\[Source\s+\d+\]", answer)
)
def answer_question(
question: str,
history=None,
top_k: int = TOP_K,
faiss_k: int = FAISS_K,
bm25_k: int = BM25_K,
model_name: str = GEMINI_MODEL,
) -> tuple[str, list[dict[str, Any]]]:
"""
Retrieve evidence and generate a grounded answer.
"""
question = question.strip()
if not question:
return "Please enter a question.", []
retrieval_query = rewrite_question_with_history(
question=question,
history=history,
model_name=model_name,
)
results = retrieve_with_reranking(
query=retrieval_query,
top_k=top_k,
faiss_k=faiss_k,
bm25_k=bm25_k,
)
if not results:
return (
"I could not find relevant information in the knowledge base.",
[],
)
answer = generate_answer(
prompt=build_prompt(
question=question,
results=results,
history=history,
),
model_name=model_name,
)
# Retry once if Gemini omitted the required inline citations.
if not has_inline_citations(answer):
retry_prompt = f"""
Revise the answer below by adding accurate inline citations.
Requirements:
- Every factual paragraph must contain at least one citation.
- Use only [Source 1] through [Source {len(results)}].
- Use the retrieved context to determine which citation supports each claim.
- Do not invent facts.
- Do not add a separate source list.
- Return only the revised answer.
Retrieved context:
{build_context(results)}
Original answer:
{answer}
""".strip()
answer = generate_answer(
prompt=retry_prompt,
model_name=model_name,
)
return answer, results
# =============================================================================
# Gradio application
# =============================================================================
def research_chat(
message: str,
history,
) -> str:
"""
Answer one Gradio message using the RAG pipeline.
"""
message = message.strip()
print(
f"History messages received: "
f"{len(normalize_chat_history(history))}"
)
if not message:
return "Please enter a question."
try:
answer, sources = answer_question(
question=message,
history=history,
top_k=TOP_K,
faiss_k=FAISS_K,
bm25_k=BM25_K,
model_name=GEMINI_MODEL,
)
response = answer
sources_markdown = format_sources(
sources
)
if sources_markdown:
response += (
f"\n\n---\n\n"
f"{sources_markdown}"
)
return response
except Exception as error:
traceback.print_exc()
error_text = str(error).lower()
if any(
term in error_text
for term in (
"quota",
"rate limit",
"resource_exhausted",
"too many requests",
"429",
)
):
return (
"The Gemini API usage limit has temporarily been reached. "
"Please wait a minute and try again."
)
if any(
term in error_text
for term in (
"timeout",
"timed out",
"connection",
"service unavailable",
"503",
)
):
return (
"The AI service is temporarily unavailable or taking too long "
"to respond. Please try again shortly."
)
return (
"ResearchGPT could not process this question because of a temporary "
"service error. Please try again shortly."
)
with gr.Blocks(
title="ResearchGPT — Milad Saeedi",
) as demo:
gr.Markdown(
"""
# ResearchGPT — Milad Saeedi
Explore Milad Saeedi's PhD research, publications, machine-learning
projects, technical skills, and selected GitHub repositories.
Answers are generated from retrieved portfolio documents and include
supporting sources.
"""
)
gr.Markdown(
"""
> **API notice:** This portfolio demo uses the Gemini API. Free-tier
> rate limits or temporary quota restrictions may occasionally cause
> delayed responses or temporary errors. If that happens, please wait
> briefly and try again.
"""
)
chatbot = gr.Chatbot(
placeholder=(
"Ask about Milad's research, PhD thesis, publications, "
"technical skills, or GitHub projects."
),
height=550,
)
gr.ChatInterface(
fn=research_chat,
chatbot=chatbot,
examples=[
"What is Milad Saeedi's thesis about?",
"Summarize Milad Saeedi's research.",
"What are the main contributions of his PhD thesis?",
"Tell me about his geospatial modeling experience.",
"Which projects involve computer vision?",
"Summarize his GitHub GAN projects.",
"What experience does he have with LoRA and GRPO?",
"What did his research show about spatial cross-validation?",
"How can I contact Milad?",
"How does Milad's ResearchGPT RAG system work?",
"How does Səraw support retail site selection?",
"How does Milad's Blender AI Copilot use agentic AI?",
"What capabilities does his multimodal reasoning agent have?",
"How does his multi-agent system select EV charging sites?",
"How did he use XGBoost for demand forecasting?",
],
cache_examples=False,
save_history=True,
flagging_mode="never",
)
gr.Markdown(
"""
---
**Powered by:** Hybrid retrieval · BGE embeddings · FAISS · BM25 ·
Cross-encoder reranking · Gemini · Grounded answer generation
*This application is a portfolio demonstration. Responses depend on the
available documents and Gemini API availability.*
"""
)
if __name__ == "__main__":
demo.queue().launch(server_name="0.0.0.0", server_port=7860) |