Spaces:
Sleeping
Sleeping
File size: 39,622 Bytes
eabfc15 c8d306a eabfc15 c8d306a eabfc15 9741310 eabfc15 c8d306a eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 9741310 eabfc15 |
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 |
import os
# Ensure Streamlit and ML caches write to a writable location (e.g., on HF Spaces)
os.environ["HOME"] = "/tmp"
os.environ["STREAMLIT_BROWSER_GATHER_USAGE_STATS"] = "false"
# Explicitly redirect all Streamlit-managed directories to /tmp to avoid permission errors
_streamlit_base = "/tmp/.streamlit"
os.environ["STREAMLIT_GLOBAL_DATA_DIR"] = _streamlit_base
os.environ["STREAMLIT_DATA_DIR"] = os.path.join(_streamlit_base, "data")
os.environ["STREAMLIT_CONFIG_DIR"] = _streamlit_base
os.environ["STREAMLIT_CACHE_DIR"] = os.path.join(_streamlit_base, "cache")
os.environ["STREAMLIT_HOME"] = "/tmp"
os.environ["XDG_CACHE_HOME"] = "/tmp/.cache"
os.environ["HF_HOME"] = "/tmp/hf"
os.environ["TRANSFORMERS_CACHE"] = "/tmp/hf/transformers"
os.environ["SENTENCE_TRANSFORMERS_HOME"] = "/tmp/hf/sentence-transformers"
os.environ["TORCH_HOME"] = "/tmp/torch"
# Create the cache directories
for _d in [
os.environ["XDG_CACHE_HOME"],
os.environ["HF_HOME"],
os.environ["TRANSFORMERS_CACHE"],
os.environ["SENTENCE_TRANSFORMERS_HOME"],
os.environ["TORCH_HOME"],
os.environ.get("STREAMLIT_GLOBAL_DATA_DIR", _streamlit_base),
os.environ.get("STREAMLIT_DATA_DIR"),
os.environ.get("STREAMLIT_CACHE_DIR"),
os.environ.get("STREAMLIT_CONFIG_DIR"),
]:
try:
os.makedirs(_d, exist_ok=True)
except Exception:
pass
import streamlit as st
from dotenv import load_dotenv, find_dotenv
from langchain.prompts import PromptTemplate
from langchain.schema.runnable import RunnablePassthrough
from langchain_core.runnables import RunnableLambda
from langchain_groq import ChatGroq
import time
from src.vector_store import build_or_load_vectorstore
from src.ingestion import load_data_subset, preprocess_dataframe, df_to_documents, load_hf_dataset
from src.retriever import build_advanced_retriever
from src.config import DATA_PATH, FAISS_INDEX_PATH, GROQ_API_KEY, GEMINI_API_KEY, ANTHROPIC_API_KEY, GROQ_MODEL, GEMINI_MODEL, ANTHROPIC_MODEL
load_dotenv(find_dotenv())
# Initialize global vectorstore reference to avoid NameError before it is set
vectorstore = None
# PAGE CONFIG - Must be first Streamlit command
st.set_page_config(
page_title="Research Assistant",
page_icon="π€",
layout="wide",
initial_sidebar_state="expanded" # Start with sidebar expanded
)
# ENHANCED CUSTOM CSS - ChatGPT-like styling
st.markdown("""
<style>
/* Hide Streamlit branding */
#MainMenu {visibility: hidden;}
footer {visibility: hidden;}
/* Make sure header is visible for sidebar toggle */
header {visibility: visible !important;}
/* Style the sidebar toggle button to be more visible */
[data-testid="collapsedControl"] {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%) !important;
border-radius: 0 8px 8px 0 !important;
padding: 8px !important;
margin-top: 60px !important;
box-shadow: 0 4px 12px rgba(102, 126, 234, 0.4) !important;
}
[data-testid="collapsedControl"]:hover {
box-shadow: 0 6px 20px rgba(102, 126, 234, 0.6) !important;
transform: translateX(2px);
}
/* Overall app styling */
.stApp {
background: linear-gradient(180deg, #0f1419 0%, #1a1f2e 100%);
}
/* Main chat container */
.main .block-container {
padding-top: 2rem;
padding-bottom: 2rem;
max-width: 900px;
margin: 0 auto;
}
/* Chat input styling - Fixed at bottom like ChatGPT */
.stChatInputContainer {
background: transparent;
border: none;
padding: 1rem 0;
}
.stChatInput > div {
background: rgba(255, 255, 255, 0.05);
border: 1px solid rgba(255, 255, 255, 0.1);
border-radius: 24px;
padding: 12px 20px;
backdrop-filter: blur(10px);
transition: all 0.3s ease;
}
.stChatInput > div:hover {
background: rgba(255, 255, 255, 0.08);
border-color: rgba(255, 255, 255, 0.2);
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3);
}
.stChatInput > div:focus-within {
background: rgba(255, 255, 255, 0.1);
border-color: #10a37f;
box-shadow: 0 0 0 3px rgba(16, 163, 127, 0.1);
}
/* User messages - Right aligned with gradient */
[data-testid="stChatMessage"]:has([data-testid*="user"]) {
background: transparent;
justify-content: flex-end;
}
[data-testid="stChatMessage"]:has([data-testid*="user"]) [data-testid="stChatMessageContent"] {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border-radius: 18px;
padding: 14px 18px;
margin-left: auto;
max-width: 75%;
color: white;
box-shadow: 0 4px 12px rgba(102, 126, 234, 0.3);
}
/* Bot messages - Left aligned with subtle styling */
[data-testid="stChatMessage"]:not(:has([data-testid*="user"])) {
background: transparent;
justify-content: flex-start;
}
[data-testid="stChatMessage"]:not(:has([data-testid*="user"])) [data-testid="stChatMessageContent"] {
background: rgba(255, 255, 255, 0.03);
border: 1px solid rgba(255, 255, 255, 0.08);
border-radius: 18px;
padding: 14px 18px;
margin-right: auto;
max-width: 85%;
color: #e8e8e8;
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
backdrop-filter: blur(10px);
}
/* Avatar styling */
[data-testid="stChatMessage"] [data-testid="stAvatar"] {
width: 36px;
height: 36px;
border-radius: 50%;
border: 2px solid rgba(255, 255, 255, 0.1);
}
/* User avatar - gradient border */
[data-testid="stChatMessage"]:has([data-testid*="user"]) [data-testid="stAvatar"] {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border: 2px solid transparent;
box-shadow: 0 2px 8px rgba(102, 126, 234, 0.4);
}
/* Bot avatar - themed */
[data-testid="stChatMessage"]:not(:has([data-testid*="user"])) [data-testid="stAvatar"] {
background: linear-gradient(135deg, #10a37f 0%, #0d8a6a 100%);
border: 2px solid rgba(16, 163, 127, 0.3);
box-shadow: 0 2px 8px rgba(16, 163, 127, 0.3);
}
/* Sidebar styling */
[data-testid="stSidebar"] {
background: rgba(15, 20, 25, 0.95);
border-right: 1px solid rgba(255, 255, 255, 0.08);
backdrop-filter: blur(20px);
}
[data-testid="stSidebar"] .stButton button {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
border: none;
border-radius: 12px;
color: white;
padding: 10px 20px;
font-weight: 600;
transition: all 0.3s ease;
}
[data-testid="stSidebar"] .stButton button:hover {
transform: translateY(-2px);
box-shadow: 0 6px 20px rgba(102, 126, 234, 0.4);
}
/* Expander styling */
.streamlit-expanderHeader {
background: rgba(255, 255, 255, 0.03);
border-radius: 12px;
border: 1px solid rgba(255, 255, 255, 0.08);
color: #b4b4b4;
padding: 12px 16px;
transition: all 0.3s ease;
}
.streamlit-expanderHeader:hover {
background: rgba(255, 255, 255, 0.06);
border-color: rgba(255, 255, 255, 0.15);
}
.streamlit-expanderContent {
background: rgba(255, 255, 255, 0.02);
border: 1px solid rgba(255, 255, 255, 0.05);
border-top: none;
border-radius: 0 0 12px 12px;
}
/* Divider styling */
hr {
border: none;
height: 1px;
background: linear-gradient(90deg, transparent, rgba(255, 255, 255, 0.1), transparent);
margin: 2rem 0;
}
/* Info boxes */
.stAlert {
background: rgba(16, 163, 127, 0.1);
border: 1px solid rgba(16, 163, 127, 0.3);
border-radius: 12px;
color: #a8e6cf;
}
/* Scrollbar styling */
::-webkit-scrollbar {
width: 8px;
height: 8px;
}
/* Thinking indicator animation */
.thinking {
display: flex;
align-items: center;
color: #a8a8a8 !important;
font-style: italic;
animation: thinking-pulse 2s ease-in-out infinite;
}
.thinking::after {
content: "...";
animation: thinking-dots 1.5s steps(4, end) infinite;
margin-left: 4px;
}
@keyframes thinking-pulse {
0%, 100% { opacity: 0.7; }
50% { opacity: 1; }
}
@keyframes thinking-dots {
0%, 20% { content: ""; }
40% { content: "."; }
60% { content: ".."; }
80%, 100% { content: "..."; }
}
/* Processing status indicators */
.status-indicator {
display: flex;
align-items: center;
gap: 8px;
padding: 8px 12px;
background: rgba(16, 163, 127, 0.1);
border: 1px solid rgba(16, 163, 127, 0.3);
border-radius: 8px;
margin-bottom: 10px;
color: #a8e6cf;
font-size: 14px;
}
.spinner {
width: 16px;
height: 16px;
border: 2px solid rgba(16, 163, 127, 0.3);
border-top: 2px solid #10a37f;
border-radius: 50%;
animation: spin 1s linear infinite;
}
@keyframes spin {
0% { transform: rotate(0deg); }
100% { transform: rotate(360deg); }
}
::-webkit-scrollbar-track {
background: rgba(255, 255, 255, 0.02);
}
::-webkit-scrollbar-thumb {
background: rgba(255, 255, 255, 0.15);
border-radius: 10px;
}
::-webkit-scrollbar-thumb:hover {
background: rgba(255, 255, 255, 0.25);
}
/* Typography improvements */
h1, h2, h3 {
color: #f0f0f0;
font-weight: 600;
}
p {
line-height: 1.7;
color: #d4d4d4;
}
/* Slider styling */
.stSlider > div > div > div > div {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
}
/* Checkbox styling */
.stCheckbox > label > div[data-testid="stMarkdownContainer"] > p {
color: #d4d4d4;
}
/* Thinking animation */
@keyframes pulse {
0%, 100% { opacity: 0.6; }
50% { opacity: 1; }
}
.thinking {
animation: pulse 1.5s ease-in-out infinite;
color: #10a37f;
font-style: italic;
}
/* Welcome message styling */
.welcome-message {
background: linear-gradient(135deg, rgba(16, 163, 127, 0.1) 0%, rgba(102, 126, 234, 0.1) 100%);
border: 1px solid rgba(16, 163, 127, 0.3);
border-radius: 16px;
padding: 24px;
margin: 20px 0;
text-align: center;
box-shadow: 0 4px 16px rgba(16, 163, 127, 0.1);
}
.welcome-message h2 {
background: linear-gradient(135deg, #10a37f 0%, #667eea 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
margin-bottom: 12px;
}
/* Suggestion chips */
.suggestion-chip {
display: inline-block;
background: rgba(255, 255, 255, 0.05);
border: 1px solid rgba(255, 255, 255, 0.1);
border-radius: 20px;
padding: 8px 16px;
margin: 6px;
color: #b4b4b4;
cursor: pointer;
transition: all 0.3s ease;
}
.suggestion-chip:hover {
background: rgba(16, 163, 127, 0.15);
border-color: rgba(16, 163, 127, 0.4);
color: #10a37f;
transform: translateY(-2px);
}
</style>
""", unsafe_allow_html=True)
# Title with emoji and clean design
col1, col2, col3 = st.columns([1, 6, 1])
with col2:
st.markdown("<h1 style='text-align: center; margin-bottom: 0;'>π€ Research Assistant</h1>", unsafe_allow_html=True)
st.markdown("<p style='text-align: center; color: #888; margin-top: 0;'>Powered by Multi-LLM RAG + FAISS</p>", unsafe_allow_html=True)
# Sidebar controls with improved organization
with st.sidebar:
st.markdown("### βοΈ Configuration")
with st.expander("π Dataset Info", expanded=False):
index_repo = os.environ.get("HF_DATASET_REPO_ID", "Wasifjafri/research-paper-vdb")
index_dir = os.environ.get("FAISS_INDEX_REMOTE_DIR", "faiss_index")
source_ds = os.environ.get("HF_SOURCE_DATASET", "")
st.markdown(f"""
**Vector index:** downloaded from `{index_repo}/{index_dir}` (HF dataset)
Rebuild (optional) requires a papers dataset set via env:
- `HF_SOURCE_DATASET` = `<owner>/<dataset>` (e.g., `CShorten/ML-ArXiv-Papers`)
If not set, the app will skip rebuilding and just use the packaged FAISS index.
Current HF_SOURCE_DATASET: `{source_ds or 'not set'}`
""")
st.markdown("---")
with st.expander("π Retrieval Settings", expanded=False):
base_k = st.slider("Initial fetch", 4, 30, 20, 1, help="Number of documents to initially retrieve")
rerank_k = st.slider("Final docs", 1, 12, 8, 1, help="Number of documents after reranking")
dynamic = st.checkbox("Dynamic k", True, help="Adjust retrieval size dynamically")
use_rerank = st.checkbox("Use reranking", True, help="Apply reranking for better relevance")
with st.expander("π§ Advanced Filters"):
primary_category = st.text_input("Category filter", "", help="Filter by arXiv category") or None
col1, col2 = st.columns(2)
with col1:
year_min = st.number_input("Min year", value=0, step=1)
with col2:
year_max = st.number_input("Max year", value=0, step=1)
if year_min == 0:
year_min = None
if year_max == 0:
year_max = None
st.markdown("---")
with st.expander("π Index Management", expanded=False):
subset_size = st.number_input("Dataset size", 1000, 100000, 10000, 1000)
rebuild = st.button("π¨ Rebuild Index", use_container_width=True)
st.markdown("---")
with st.expander("π€ LLM Provider", expanded=False):
# Determine default provider based on available API keys
if ANTHROPIC_API_KEY:
default_provider = "Anthropic (Claude)"
elif GEMINI_API_KEY:
default_provider = "Gemini"
elif GROQ_API_KEY:
default_provider = "Groq"
else:
default_provider = "Gemini"
available_providers = ["Anthropic (Claude)", "Gemini", "Groq"]
try:
default_index = available_providers.index(default_provider)
except ValueError:
default_index = 0
provider = st.selectbox("Provider", available_providers, index=default_index)
if provider == "Anthropic (Claude)":
ui_anthropic_model = st.selectbox(
"Model",
[
"claude-sonnet-4-5-20250929",
"claude-opus-4-1-20250805",
"claude-opus-4-20250514",
"claude-sonnet-4-20250514",
"claude-3-7-sonnet-20250219",
"claude-3-5-haiku-20241022",
"claude-3-haiku-20240307"
],
index=3
)
ui_gemini_model = None
ui_groq_model = None
elif provider == "Gemini":
ui_gemini_model = st.text_input("Model", GEMINI_MODEL)
ui_groq_model = None
ui_anthropic_model = None
else:
ui_groq_model = st.text_input("Model", GROQ_MODEL)
ui_gemini_model = None
ui_anthropic_model = None
# Stats at bottom
st.markdown("---")
try:
if 'vectorstore' in locals():
index_stats = vectorstore.index.ntotal if hasattr(vectorstore, 'index') else "Unknown"
st.metric("π Embeddings", f"{index_stats:,}" if isinstance(index_stats, int) else index_stats)
except:
pass
# Build or load vectorstore
from typing import Optional
def _load_df_from_hf(num_records: int, dataset_name: Optional[str] = None):
"""Load dataset from Hugging Face when rebuilding is explicitly requested.
Only used for index rebuilds; normal path downloads the ready-made FAISS index.
"""
ds_name = dataset_name or os.environ.get("HF_SOURCE_DATASET")
if not ds_name:
st.error("β Rebuild requested but HF_SOURCE_DATASET is not set. Set it to a dataset like 'CShorten/ML-ArXiv-Papers'.")
st.stop()
try:
with st.spinner(f"π Loading papers from Hugging Face dataset: {ds_name}..."):
df = load_hf_dataset(num_records=num_records, dataset_name=ds_name)
return preprocess_dataframe(df)
except Exception as e:
st.error(f"β Failed to load dataset '{ds_name}': {e}")
st.info("π‘ If the dataset is private, add your HF token as a secret and set HF_SOURCE_DATASET.")
st.stop()
# Default path: try to download+load the FAISS index from HF dataset repo
if not rebuild:
try:
vectorstore = build_or_load_vectorstore([], force_rebuild=False)
except Exception as e:
st.error(
"β Could not download or load the remote FAISS index from Hugging Face."
)
st.info(
"π‘ Verify that your deployment can access the internet and that HF_DATASET_REPO_ID/FAISS_INDEX_REMOTE_DIR point to a repository containing index.faiss and index.pkl."
)
st.info(
"π If the dataset is private, configure the HF_TOKEN secret so the app can authenticate with the Hugging Face Hub."
)
st.exception(e)
st.stop()
else:
# Rebuild only when explicitly requested and a source dataset is configured
with st.spinner("π¨ Rebuilding vector index from source dataset..."):
df = _load_df_from_hf(num_records=int(subset_size))
docs = df_to_documents(df)
vectorstore = build_or_load_vectorstore(
docs,
force_rebuild=True,
chunk_method="semantic",
chunk_size=1000,
chunk_overlap=125
)
def make_llm(provider_name: str):
if provider_name == "Anthropic (Claude)":
if not ANTHROPIC_API_KEY:
st.error("β ANTHROPIC_API_KEY not set")
st.stop()
try:
from langchain_anthropic import ChatAnthropic
return ChatAnthropic(
model=ui_anthropic_model or ANTHROPIC_MODEL,
temperature=0.7,
max_tokens=2048,
api_key=ANTHROPIC_API_KEY,
)
except Exception as e:
st.error(f"β Claude initialization failed: {e}")
st.stop()
if provider_name == "Gemini":
if not GEMINI_API_KEY:
st.error("β GEMINI_API_KEY not set")
st.stop()
try:
from langchain_google_genai import ChatGoogleGenerativeAI
return ChatGoogleGenerativeAI(
model=ui_gemini_model or GEMINI_MODEL,
temperature=0.7,
max_output_tokens=1024,
api_key=GEMINI_API_KEY,
)
except Exception as e:
st.error(f"β Gemini initialization failed: {e}")
st.stop()
if not GROQ_API_KEY:
st.error("β No valid LLM provider configured")
st.stop()
return ChatGroq(
model=ui_groq_model or GROQ_MODEL,
temperature=0.7,
max_tokens=1024,
groq_api_key=GROQ_API_KEY,
)
llm = make_llm(provider)
# Relevance checking prompt
relevance_check_prompt = """You are a research paper relevance checker. Your task is to determine if the retrieved documents are relevant to the user's question.
Retrieved Documents:
{context}
User Question: {question}
Instructions:
- Carefully analyze whether the retrieved documents contain information that can answer the user's question
- Consider if the documents discuss the topic, concepts, or methods mentioned in the question
- Respond with ONLY one word: "RELEVANT" or "IRRELEVANT"
- Be strict: if the documents are only tangentially related or don't actually address the question, respond "IRRELEVANT"
Response:"""
relevance_prompt = PromptTemplate(template=relevance_check_prompt, input_variables=["context", "question"])
# IMPROVED PROMPT
prompt_template = """You are a knowledgeable and helpful research assistant specializing in arXiv papers. You MUST ONLY answer questions based on the provided research papers context.
Context from Research Papers:
{context}
User Question: {question}
CRITICAL RULES:
- ONLY use information from the provided research papers context above
- DO NOT use your general knowledge or training data
- If the context doesn't contain relevant information, you MUST respond with: "I couldn't find relevant information about this topic in the available research papers. The retrieved documents don't address your question. Please try different search terms or the database may not contain papers on this specific topic."
Instructions:
- Analyze the user's question and provide a thorough, well-structured response BASED ONLY ON THE CONTEXT
- Be conversational and descriptive - explain concepts clearly with sufficient detail
- Use multiple paragraphs when needed to fully address the question
**For paper listing requests** (e.g., "find papers", "list papers", "show papers"):
Format as a structured list with detailed summaries:
**Paper #[Number]: [Title]**
- **Authors:** [Author names]
- **Year:** [Publication year]
- **ArXiv ID:** [ID if available]
- **Category:** [Research category]
- **Summary:** [3-4 sentences explaining the paper's objectives, methodology, key contributions, and findings based on the context]
**For specific questions** (e.g., "What is...", "Explain...", "How does...", "What is the purpose of..."):
- Provide a comprehensive, multi-paragraph answer that fully addresses the question USING ONLY THE CONTEXT
- Start with a clear overview or direct answer from the papers
- Elaborate with details, context, and explanations from the research papers
- Discuss relevant methodologies, findings, implications, or technical details found in the papers
- Cite sources naturally throughout (e.g., "According to the research by [Authors] (Year)...")
- Use clear transitions between ideas
- Conclude with key takeaways or significance when appropriate
**General Guidelines:**
- Write in a natural, conversational tone similar to ChatGPT
- Aim for depth and clarity - don't give one-liner responses
- Break complex information into digestible paragraphs
- Use examples and analogies when helpful from the context
- NEVER invent or hallucinate information not in the context
- Always prioritize being helpful, informative, and thorough - but ONLY based on the provided context
Answer:"""
prompt = PromptTemplate(template=prompt_template, input_variables=["context", "question"])
def _format_metadata(metadata):
"""Format metadata in a clean, readable way."""
if not metadata:
return ""
meta_lines = []
if metadata.get("title"):
meta_lines.append(f"π {metadata['title']}")
if metadata.get("id"):
meta_lines.append(f"π {metadata['id']}")
if metadata.get("authors") and metadata["authors"] != "N/A":
authors = metadata['authors']
if len(authors) > 100:
authors = authors[:100] + "..."
meta_lines.append(f"π₯ {authors}")
if metadata.get("year"):
meta_lines.append(f"π
{metadata['year']}")
if metadata.get("primary_category") and metadata["primary_category"] != "N/A":
meta_lines.append(f"π·οΈ {metadata['primary_category']}")
return " β’ ".join(meta_lines)
def format_docs(docs):
"""Format documents with clear structure and metadata."""
if not docs:
return "No relevant documents found in the database."
formatted_chunks = []
for idx, doc in enumerate(docs, start=1):
meta_str = _format_metadata(doc.metadata)
content = doc.page_content.strip()
if len(content) > 1000:
content = content[:1000] + "..."
formatted_chunk = f"[Document {idx}]\n{meta_str}\n\n{content}"
formatted_chunks.append(formatted_chunk)
return "\n\n" + "="*80 + "\n\n".join(formatted_chunks)
def build_chain():
"""Build the RAG chain with improved retrieval."""
retriever = build_advanced_retriever(
vectorstore,
base_k=base_k,
rerank_k=rerank_k,
primary_category=primary_category,
year_min=year_min,
year_max=year_max,
dynamic=dynamic,
use_rerank=use_rerank,
)
def retrieval_with_logging(q):
try:
docs = retriever.get_relevant_documents(q)
return format_docs(docs)
except Exception as e:
return f"Error retrieving documents: {e}"
retrieval_runnable = RunnableLambda(retrieval_with_logging)
chain = {"context": retrieval_runnable, "question": RunnablePassthrough()} | prompt | llm
return chain, retriever
# Initialize session state
if "messages" not in st.session_state:
st.session_state["messages"] = []
st.session_state["show_welcome"] = True
# Welcome message with suggestions
if st.session_state.get("show_welcome", False):
st.markdown("""
<div class="welcome-message">
<h2>π Welcome to Research Assistant!</h2>
<p>I'm your AI-powered research companion. Ask me anything about Machine Learning papers!</p>
<div style="margin-top: 20px;">
<span class="suggestion-chip">π Find papers on transformers</span>
<span class="suggestion-chip">π‘ Explain attention mechanism</span>
<span class="suggestion-chip">π Compare CNN vs RNN</span>
<span class="suggestion-chip">π― Latest in reinforcement learning</span>
</div>
</div>
""", unsafe_allow_html=True)
st.session_state["show_welcome"] = False
# Helper functions
def is_casual_conversation(query_text):
"""Check if the query is a greeting or casual conversation."""
query_lower = query_text.lower().strip()
greetings = ["hi", "hello", "hey", "good morning", "good afternoon", "good evening",
"hola", "greetings", "howdy", "yo", "sup", "what's up", "whats up"]
casual_patterns = [
"how are you", "how r u", "how do you do", "what's up", "whats up",
"who are you", "what are you", "what is your name", "your name",
"what can you do", "help me", "can you help", "thank you", "thanks",
"bye", "goodbye", "see you", "nice to meet you", "pleasure"
]
if query_lower in greetings:
return True
for pattern in casual_patterns:
if pattern in query_lower:
return True
return False
def get_casual_response(query_text):
"""Generate appropriate response for casual conversation."""
query_lower = query_text.lower().strip()
if any(word in query_lower for word in ["hi", "hello", "hey", "hola", "howdy", "yo"]):
return "Hello! π I'm your AI Research Assistant for Machine Learning papers. How can I help you today?"
if "good morning" in query_lower:
return "Good morning! βοΈ Ready to explore some ML research? What interests you today?"
if "good afternoon" in query_lower:
return "Good afternoon! π€οΈ Let's dive into some research! What would you like to learn about?"
if "good evening" in query_lower:
return "Good evening! π I'm here to help with ML research. What topic interests you?"
if any(phrase in query_lower for phrase in ["how are you", "how r u", "how do you do"]):
return "I'm doing great, thanks! π Ready to help you explore ML research. What's on your mind?"
if any(phrase in query_lower for phrase in ["who are you", "what are you", "your name"]):
return "I'm an AI Research Assistant specialized in Machine Learning! π€ I help you find papers, explain concepts, and answer research questions. What would you like to know?"
if any(phrase in query_lower for phrase in ["what can you do", "help me", "can you help"]):
return """I can help you with:
π **Finding research papers** on specific ML topics
π **Explaining ML concepts** from published research
π‘ **Answering questions** about techniques and methods
π **Exploring** the latest ML research developments
Try asking:
- "Find papers on deep learning"
- "What is transfer learning?"
- "Explain adversarial training"
What interests you?"""
if any(word in query_lower for word in ["thank you", "thanks", "thx"]):
return "You're welcome! π Happy to help! Let me know if you have other questions."
if any(word in query_lower for word in ["bye", "goodbye", "see you"]):
return "Goodbye! π Come back anytime for ML research help. Happy learning!"
return "I'm here to help with Machine Learning research! π Ask me about any ML topics or papers."
# Chat input - Process new query first (before displaying messages)
query = st.chat_input("π¬ Ask me anything about ML research...")
if query:
# Add message to session state immediately
st.session_state["messages"].append({
"query": query,
"answer": None,
"context": [],
"processing": True
})
# Force rerun to show the user message immediately
st.rerun()
# Display chat history
for i, msg in enumerate(st.session_state["messages"]):
# Show user message
st.chat_message("user", avatar="π€").write(msg["query"])
# Show assistant response if available
if msg.get("answer") is not None:
with st.chat_message("assistant", avatar="π€"):
st.write(msg["answer"])
if msg.get("context") and len(msg["context"]) > 0:
with st.expander(f"π View {len(msg['context'])} Retrieved Documents", expanded=False):
for idx, doc in enumerate(msg["context"], 1):
st.markdown(f"**π Document {idx}**")
st.caption(_format_metadata(doc.metadata))
st.text_area(
f"Content {idx}",
doc.page_content[:800] + ("..." if len(doc.page_content) > 800 else ""),
height=150,
key=f"doc_{i}_{idx}",
disabled=True
)
if idx < len(msg["context"]):
st.markdown("---")
elif msg.get("processing", False):
# Process this message now - show thinking indicator and generate response
with st.chat_message("assistant", avatar="π€"):
# Show immediate thinking indicator
status_container = st.container()
with status_container:
st.markdown(
'<div class="status-indicator"><div class="spinner"></div>π Searching research papers</div>',
unsafe_allow_html=True
)
# Process the response
if is_casual_conversation(msg["query"]):
# Handle casual conversation
time.sleep(0.5) # Brief pause for better UX
casual_response = get_casual_response(msg["query"])
# Clear status and show response
status_container.empty()
response_placeholder = st.empty()
# Smooth streaming effect
full_response = ""
words = casual_response.split()
for word in words:
full_response += word + " "
response_placeholder.markdown(full_response)
time.sleep(0.02)
# Update session state
st.session_state["messages"][i]["answer"] = casual_response
st.session_state["messages"][i]["processing"] = False
st.rerun()
else:
# Research question - full RAG pipeline
try:
rag_chain, adv_retriever = build_chain()
# Update status
status_container.empty()
with status_container:
st.markdown(
'<div class="status-indicator"><div class="spinner"></div>π§ Analyzing documents</div>',
unsafe_allow_html=True
)
docs = adv_retriever.get_relevant_documents(msg["query"])
answer_text = ""
if not docs:
answer_text = """I couldn't find any relevant research papers in the database that match your query.
**π‘ Suggestions:**
- Try using broader or different search terms
- Check the spelling of technical terms
- The database may not contain papers on this specific topic
- Consider rebuilding the index with more data
The current database focuses on ArXiv ML papers, but may not cover all research areas comprehensively."""
else:
# Check relevance
formatted_context = format_docs(docs)
relevance_check_chain = {"context": RunnablePassthrough(), "question": RunnablePassthrough()} | relevance_prompt | llm
relevance_result = relevance_check_chain.invoke({"context": formatted_context, "question": msg["query"]})
relevance_text = relevance_result.content if hasattr(relevance_result, "content") else str(relevance_result)
if "IRRELEVANT" in relevance_text.strip().upper():
answer_text = f"""I found {len(docs)} documents in the database, but they don't contain relevant information about your question.
**π Retrieved topics:**
- {docs[0].metadata.get('title', 'Various topics') if docs else 'N/A'}
**π‘ Suggestions:**
- Try rephrasing with different keywords
- Use more specific technical terms
- Search for related concepts or broader topics
- The database may not have papers specifically on this topic
I can only provide answers based on the ArXiv papers in the database."""
else:
# Update status for generation
status_container.empty()
with status_container:
st.markdown(
'<div class="status-indicator"><div class="spinner"></div>βοΈ Generating response</div>',
unsafe_allow_html=True
)
answer = rag_chain.invoke(msg["query"])
answer_text = answer.content if hasattr(answer, "content") else str(answer)
# Clear status and display response with streaming
status_container.empty()
# Stream response
import re
response_placeholder = st.empty()
parts = re.split(r'(\n\n|(?<=[.!?])\s+)', answer_text)
full_response = ""
for part in parts:
full_response += part
response_placeholder.markdown(full_response)
time.sleep(0.03)
# Update session state
st.session_state["messages"][i]["answer"] = answer_text
st.session_state["messages"][i]["context"] = docs
st.session_state["messages"][i]["processing"] = False
# Show retrieved documents
if docs:
with st.expander(f"π View {len(docs)} Retrieved Documents", expanded=False):
for idx, doc in enumerate(docs, 1):
st.markdown(f"**π Document {idx}**")
st.caption(_format_metadata(doc.metadata))
st.text_area(
f"Content {idx}",
doc.page_content[:800] + ("..." if len(doc.page_content) > 800 else ""),
height=150,
key=f"new_doc_{i}_{idx}",
disabled=True
)
if idx < len(docs):
st.markdown("---")
st.rerun()
except Exception as e:
# Handle errors
status_container.empty()
msg_err = str(e)
if "models/" in msg_err and "not found" in msg_err.lower():
answer_text = "β οΈ Selected model not found. Try a different model in the sidebar."
else:
answer_text = f"β οΈ An error occurred: {e}\n\nPlease try again or rebuild the index."
st.error(answer_text)
st.session_state["messages"][i]["answer"] = answer_text
st.session_state["messages"][i]["processing"] = False
st.rerun()
# Footer with tips - only show if there are messages
if len(st.session_state["messages"]) > 0:
st.markdown("---")
with st.expander("π‘ Tips for Better Results", expanded=False):
col1, col2 = st.columns(2)
with col1:
st.markdown("""
**π― Asking Better Questions**
β
Use specific ML terminology
β
Mention techniques or methods
β
Ask for comparisons
β
Reference specific problems
**Examples:**
- "Papers on transformer architecture"
- "Compare CNNs vs Vision Transformers"
- "Explain BERT training methodology"
""")
with col2:
st.markdown("""
**π Understanding Responses**
β
All answers from actual papers
β
View source documents anytime
β
Check relevance of results
β
Adjust settings if needed
**β‘ Advanced Tips:**
- Use sidebar filters (year, category)
- Adjust retrieval settings
- Try different LLM providers
- Rebuild index for fresh data
""")
# Add a "Clear Chat" button at the bottom of sidebar
with st.sidebar:
st.markdown("---")
if st.button("ποΈ Clear Chat History", use_container_width=True):
st.session_state["messages"] = []
st.session_state["show_welcome"] = True
st.rerun() |