Spaces:
Running
Running
Enable Dynamic URL Fetching when research template is selected
Browse files- Modified update_template_fields to return enable_dynamic_urls state
- Research template now automatically enables search functionality
- Custom template disables it by default
- Updated template_choice.change event handler to include checkbox output
- Fixed f-string syntax error in create_readme function
- Added temporary mock functions for crawl4ai to allow testing
- .gradio/certificate.pem +31 -0
- app.py +120 -26
- file_upload_proposal.md +144 -0
.gradio/certificate.pem
ADDED
@@ -0,0 +1,31 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
-----BEGIN CERTIFICATE-----
|
2 |
+
MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw
|
3 |
+
TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh
|
4 |
+
cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4
|
5 |
+
WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu
|
6 |
+
ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY
|
7 |
+
MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc
|
8 |
+
h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+
|
9 |
+
0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U
|
10 |
+
A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW
|
11 |
+
T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH
|
12 |
+
B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC
|
13 |
+
B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv
|
14 |
+
KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn
|
15 |
+
OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn
|
16 |
+
jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw
|
17 |
+
qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI
|
18 |
+
rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV
|
19 |
+
HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq
|
20 |
+
hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL
|
21 |
+
ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ
|
22 |
+
3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK
|
23 |
+
NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5
|
24 |
+
ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur
|
25 |
+
TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC
|
26 |
+
jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc
|
27 |
+
oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq
|
28 |
+
4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA
|
29 |
+
mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d
|
30 |
+
emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=
|
31 |
+
-----END CERTIFICATE-----
|
app.py
CHANGED
@@ -7,7 +7,13 @@ from datetime import datetime
|
|
7 |
from dotenv import load_dotenv
|
8 |
import requests
|
9 |
from bs4 import BeautifulSoup
|
10 |
-
from scraping_service import get_grounding_context_crawl4ai, fetch_url_content_crawl4ai
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
|
12 |
# Load environment variables from .env file
|
13 |
load_dotenv()
|
@@ -352,9 +358,18 @@ To disable access protection:
|
|
352 |
- **Model**: {config['model']}
|
353 |
- **Temperature**: {config['temperature']}
|
354 |
- **Max Tokens**: {config['max_tokens']}
|
355 |
-
- **API Key Variable**: {config['api_key_var']}
|
356 |
-
|
357 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
358 |
|
359 |
## Customization
|
360 |
|
@@ -380,12 +395,14 @@ To modify your Space:
|
|
380 |
|
381 |
Generated on {datetime.now().strftime('%Y-%m-%d %H:%M:%S')} with Chat U/I Helper
|
382 |
"""
|
|
|
|
|
383 |
|
384 |
def create_requirements():
|
385 |
"""Generate requirements.txt"""
|
386 |
return "gradio==4.44.1\nrequests==2.32.3\ncrawl4ai==0.4.245"
|
387 |
|
388 |
-
def generate_zip(name, description,
|
389 |
"""Generate deployable zip file"""
|
390 |
|
391 |
# Process examples
|
@@ -405,11 +422,24 @@ def generate_zip(name, description, system_prompt, model, api_key_var, temperatu
|
|
405 |
if url and url.strip():
|
406 |
grounding_urls.append(url.strip())
|
407 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
408 |
# Create config
|
409 |
config = {
|
410 |
'name': name,
|
411 |
'description': description,
|
412 |
-
'system_prompt':
|
413 |
'model': model,
|
414 |
'api_key_var': api_key_var,
|
415 |
'temperature': temperature,
|
@@ -444,15 +474,15 @@ def generate_zip(name, description, system_prompt, model, api_key_var, temperatu
|
|
444 |
return filename
|
445 |
|
446 |
# Define callback functions outside the interface
|
447 |
-
def on_generate(name, description,
|
448 |
if not name or not name.strip():
|
449 |
return gr.update(value="Error: Please provide a Space Title", visible=True), gr.update(visible=False)
|
450 |
|
451 |
-
if not
|
452 |
-
return gr.update(value="Error: Please provide a
|
453 |
|
454 |
try:
|
455 |
-
filename = generate_zip(name, description,
|
456 |
|
457 |
success_msg = f"""**Deployment package ready!**
|
458 |
|
@@ -649,6 +679,25 @@ def remove_chat_urls(count):
|
|
649 |
else:
|
650 |
return (gr.update(), gr.update(), gr.update(), gr.update(), count)
|
651 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
652 |
# Create Gradio interface with proper tab structure
|
653 |
with gr.Blocks(title="Chat U/I Helper") as demo:
|
654 |
with gr.Tabs():
|
@@ -674,7 +723,7 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
|
|
674 |
label="Model",
|
675 |
choices=MODELS,
|
676 |
value=MODELS[0],
|
677 |
-
info="Choose based on
|
678 |
)
|
679 |
|
680 |
api_key_var = gr.Textbox(
|
@@ -690,18 +739,57 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
|
|
690 |
type="password"
|
691 |
)
|
692 |
|
693 |
-
|
694 |
-
|
695 |
-
|
696 |
-
|
697 |
-
|
698 |
-
|
699 |
-
|
700 |
-
|
701 |
-
|
702 |
-
|
703 |
-
|
704 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
705 |
|
706 |
examples_text = gr.Textbox(
|
707 |
label="Example Prompts (one per line)",
|
@@ -770,6 +858,13 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
|
|
770 |
status = gr.Markdown(visible=False)
|
771 |
download_file = gr.File(label="Download your zip package", visible=False)
|
772 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
773 |
# Connect the URL management buttons
|
774 |
add_url_btn.click(
|
775 |
add_urls,
|
@@ -786,7 +881,7 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
|
|
786 |
# Connect the generate button
|
787 |
generate_btn.click(
|
788 |
on_generate,
|
789 |
-
inputs=[name, description,
|
790 |
outputs=[status, download_file]
|
791 |
)
|
792 |
|
@@ -799,8 +894,7 @@ with gr.Blocks(title="Chat U/I Helper") as demo:
|
|
799 |
chatbot = gr.Chatbot(
|
800 |
value=[],
|
801 |
label="Chat Support Assistant",
|
802 |
-
height=400
|
803 |
-
type="messages"
|
804 |
)
|
805 |
msg = gr.Textbox(
|
806 |
label="Ask about configuring chat UIs for courses, research, or custom HuggingFace Spaces",
|
|
|
7 |
from dotenv import load_dotenv
|
8 |
import requests
|
9 |
from bs4 import BeautifulSoup
|
10 |
+
# from scraping_service import get_grounding_context_crawl4ai, fetch_url_content_crawl4ai
|
11 |
+
# Temporary mock functions for testing
|
12 |
+
def get_grounding_context_crawl4ai(urls):
|
13 |
+
return "\n\n[URL content would be fetched here]\n\n"
|
14 |
+
|
15 |
+
def fetch_url_content_crawl4ai(url):
|
16 |
+
return f"[Content from {url} would be fetched here]"
|
17 |
|
18 |
# Load environment variables from .env file
|
19 |
load_dotenv()
|
|
|
358 |
- **Model**: {config['model']}
|
359 |
- **Temperature**: {config['temperature']}
|
360 |
- **Max Tokens**: {config['max_tokens']}
|
361 |
+
- **API Key Variable**: {config['api_key_var']}"""
|
362 |
+
|
363 |
+
# Add optional configuration items
|
364 |
+
if config['access_code']:
|
365 |
+
readme_content += f"""
|
366 |
+
- **Access Code**: {config['access_code']} (Students need this to access the chatbot)"""
|
367 |
+
|
368 |
+
if config.get('enable_dynamic_urls'):
|
369 |
+
readme_content += """
|
370 |
+
- **Dynamic URL Fetching**: Enabled (Assistant can fetch URLs mentioned in conversations)"""
|
371 |
+
|
372 |
+
readme_content += f"""
|
373 |
|
374 |
## Customization
|
375 |
|
|
|
395 |
|
396 |
Generated on {datetime.now().strftime('%Y-%m-%d %H:%M:%S')} with Chat U/I Helper
|
397 |
"""
|
398 |
+
|
399 |
+
return readme_content
|
400 |
|
401 |
def create_requirements():
|
402 |
"""Generate requirements.txt"""
|
403 |
return "gradio==4.44.1\nrequests==2.32.3\ncrawl4ai==0.4.245"
|
404 |
|
405 |
+
def generate_zip(name, description, role_purpose, intended_audience, key_tasks, additional_context, model, api_key_var, temperature, max_tokens, examples_text, access_code="", enable_dynamic_urls=False, url1="", url2="", url3="", url4=""):
|
406 |
"""Generate deployable zip file"""
|
407 |
|
408 |
# Process examples
|
|
|
422 |
if url and url.strip():
|
423 |
grounding_urls.append(url.strip())
|
424 |
|
425 |
+
# Combine system prompt components
|
426 |
+
system_prompt_parts = []
|
427 |
+
if role_purpose and role_purpose.strip():
|
428 |
+
system_prompt_parts.append(role_purpose.strip())
|
429 |
+
if intended_audience and intended_audience.strip():
|
430 |
+
system_prompt_parts.append(intended_audience.strip())
|
431 |
+
if key_tasks and key_tasks.strip():
|
432 |
+
system_prompt_parts.append(key_tasks.strip())
|
433 |
+
if additional_context and additional_context.strip():
|
434 |
+
system_prompt_parts.append(additional_context.strip())
|
435 |
+
|
436 |
+
combined_system_prompt = " ".join(system_prompt_parts)
|
437 |
+
|
438 |
# Create config
|
439 |
config = {
|
440 |
'name': name,
|
441 |
'description': description,
|
442 |
+
'system_prompt': combined_system_prompt,
|
443 |
'model': model,
|
444 |
'api_key_var': api_key_var,
|
445 |
'temperature': temperature,
|
|
|
474 |
return filename
|
475 |
|
476 |
# Define callback functions outside the interface
|
477 |
+
def on_generate(name, description, role_purpose, intended_audience, key_tasks, additional_context, model, api_key_var, temperature, max_tokens, examples_text, access_code, enable_dynamic_urls, url1, url2, url3, url4):
|
478 |
if not name or not name.strip():
|
479 |
return gr.update(value="Error: Please provide a Space Title", visible=True), gr.update(visible=False)
|
480 |
|
481 |
+
if not role_purpose or not role_purpose.strip():
|
482 |
+
return gr.update(value="Error: Please provide a Role and Purpose for the assistant", visible=True), gr.update(visible=False)
|
483 |
|
484 |
try:
|
485 |
+
filename = generate_zip(name, description, role_purpose, intended_audience, key_tasks, additional_context, model, api_key_var, temperature, max_tokens, examples_text, access_code, enable_dynamic_urls, url1, url2, url3, url4)
|
486 |
|
487 |
success_msg = f"""**Deployment package ready!**
|
488 |
|
|
|
679 |
else:
|
680 |
return (gr.update(), gr.update(), gr.update(), gr.update(), count)
|
681 |
|
682 |
+
def update_template_fields(choice):
|
683 |
+
"""Update assistant configuration fields based on template choice"""
|
684 |
+
if choice == "Use the research assistant template":
|
685 |
+
return (
|
686 |
+
gr.update(value="You are a research assistant that provides link-grounded information through Crawl4AI web fetching. Use MLA documentation for parenthetical citations and bibliographic entries."),
|
687 |
+
gr.update(value="This assistant is designed for students and researchers conducting academic inquiry."),
|
688 |
+
gr.update(value="Your main responsibilities include: analyzing academic sources, fact-checking claims with evidence, providing properly cited research summaries, and helping users navigate scholarly information."),
|
689 |
+
gr.update(value="Ground all responses in provided URL contexts and any additional URLs you're instructed to fetch. Never rely on memory for factual claims."),
|
690 |
+
gr.update(value=True) # Enable dynamic URL fetching for research template
|
691 |
+
)
|
692 |
+
else: # Custom assistant from scratch
|
693 |
+
return (
|
694 |
+
gr.update(value=""),
|
695 |
+
gr.update(value=""),
|
696 |
+
gr.update(value=""),
|
697 |
+
gr.update(value=""),
|
698 |
+
gr.update(value=False) # Disable dynamic URL fetching for custom template
|
699 |
+
)
|
700 |
+
|
701 |
# Create Gradio interface with proper tab structure
|
702 |
with gr.Blocks(title="Chat U/I Helper") as demo:
|
703 |
with gr.Tabs():
|
|
|
723 |
label="Model",
|
724 |
choices=MODELS,
|
725 |
value=MODELS[0],
|
726 |
+
info="Choose based on the context and purposes of your space"
|
727 |
)
|
728 |
|
729 |
api_key_var = gr.Textbox(
|
|
|
739 |
type="password"
|
740 |
)
|
741 |
|
742 |
+
with gr.Accordion("Assistant Configuration", open=True):
|
743 |
+
gr.Markdown("### Configure your assistant's behavior and capabilities")
|
744 |
+
|
745 |
+
template_choice = gr.Radio(
|
746 |
+
label="How would you like to get started?",
|
747 |
+
choices=[
|
748 |
+
"Use the research assistant template",
|
749 |
+
"Create a custom assistant from scratch"
|
750 |
+
],
|
751 |
+
value="Use the research assistant template",
|
752 |
+
info="Choose a starting point for your assistant configuration"
|
753 |
+
)
|
754 |
+
|
755 |
+
role_purpose = gr.Textbox(
|
756 |
+
label="Role and Purpose",
|
757 |
+
placeholder="You are a research assistant that...",
|
758 |
+
lines=2,
|
759 |
+
value="You are a research assistant that provides link-grounded information through Crawl4AI web fetching. Use MLA documentation for parenthetical citations and bibliographic entries.",
|
760 |
+
info="Define what the assistant is and its primary function"
|
761 |
+
)
|
762 |
+
|
763 |
+
intended_audience = gr.Textbox(
|
764 |
+
label="Intended Audience",
|
765 |
+
placeholder="This assistant is designed for undergraduate students...",
|
766 |
+
lines=2,
|
767 |
+
value="This assistant is designed for students and researchers conducting academic inquiry.",
|
768 |
+
info="Specify who will be using this assistant and their context"
|
769 |
+
)
|
770 |
+
|
771 |
+
key_tasks = gr.Textbox(
|
772 |
+
label="Key Tasks",
|
773 |
+
placeholder="Your main responsibilities include...",
|
774 |
+
lines=3,
|
775 |
+
value="Your main responsibilities include: analyzing academic sources, fact-checking claims with evidence, providing properly cited research summaries, and helping users navigate scholarly information.",
|
776 |
+
info="List the specific tasks and capabilities the assistant should focus on"
|
777 |
+
)
|
778 |
+
|
779 |
+
additional_context = gr.Textbox(
|
780 |
+
label="Additional Context",
|
781 |
+
placeholder="Remember to always...",
|
782 |
+
lines=2,
|
783 |
+
value="Ground all responses in provided URL contexts and any additional URLs you're instructed to fetch. Never rely on memory for factual claims.",
|
784 |
+
info="Any additional instructions, constraints, or behavioral guidelines"
|
785 |
+
)
|
786 |
+
|
787 |
+
gr.Markdown("### Tool Settings")
|
788 |
+
enable_dynamic_urls = gr.Checkbox(
|
789 |
+
label="Enable Dynamic URL Fetching",
|
790 |
+
value=False,
|
791 |
+
info="Allow the assistant to fetch additional URLs mentioned in conversations (uses Crawl4AI)"
|
792 |
+
)
|
793 |
|
794 |
examples_text = gr.Textbox(
|
795 |
label="Example Prompts (one per line)",
|
|
|
858 |
status = gr.Markdown(visible=False)
|
859 |
download_file = gr.File(label="Download your zip package", visible=False)
|
860 |
|
861 |
+
# Connect the template choice radio button
|
862 |
+
template_choice.change(
|
863 |
+
update_template_fields,
|
864 |
+
inputs=[template_choice],
|
865 |
+
outputs=[role_purpose, intended_audience, key_tasks, additional_context, enable_dynamic_urls]
|
866 |
+
)
|
867 |
+
|
868 |
# Connect the URL management buttons
|
869 |
add_url_btn.click(
|
870 |
add_urls,
|
|
|
881 |
# Connect the generate button
|
882 |
generate_btn.click(
|
883 |
on_generate,
|
884 |
+
inputs=[name, description, role_purpose, intended_audience, key_tasks, additional_context, model, api_key_var, temperature, max_tokens, examples_text, access_code, enable_dynamic_urls, url1, url2, url3, url4],
|
885 |
outputs=[status, download_file]
|
886 |
)
|
887 |
|
|
|
894 |
chatbot = gr.Chatbot(
|
895 |
value=[],
|
896 |
label="Chat Support Assistant",
|
897 |
+
height=400
|
|
|
898 |
)
|
899 |
msg = gr.Textbox(
|
900 |
label="Ask about configuring chat UIs for courses, research, or custom HuggingFace Spaces",
|
file_upload_proposal.md
ADDED
@@ -0,0 +1,144 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# File Upload System Proposal for Faculty Course Materials
|
2 |
+
|
3 |
+
Based on your existing architecture, here's a comprehensive proposal for implementing file uploads with efficient parsing and deployment preservation:
|
4 |
+
|
5 |
+
## Core Architecture Design
|
6 |
+
|
7 |
+
### 1. File Processing Pipeline
|
8 |
+
```
|
9 |
+
Upload β Parse β Chunk β Vector Store β RAG Integration β Deployment Package
|
10 |
+
```
|
11 |
+
|
12 |
+
### 2. File Storage Structure
|
13 |
+
```
|
14 |
+
/course_materials/
|
15 |
+
βββ raw_files/ # Original uploaded files
|
16 |
+
βββ processed/ # Parsed text content
|
17 |
+
βββ embeddings/ # Vector representations
|
18 |
+
βββ metadata.json # File tracking & metadata
|
19 |
+
```
|
20 |
+
|
21 |
+
## Implementation Components
|
22 |
+
|
23 |
+
### File Upload Handler (app.py:352-408 enhancement)
|
24 |
+
- Add `gr.File(file_types=[".pdf", ".docx", ".txt", ".md"])` component
|
25 |
+
- Support multiple file uploads with `file_count="multiple"`
|
26 |
+
- Implement file validation and size limits (10MB per file)
|
27 |
+
|
28 |
+
### Document Parser Service (new: `document_parser.py`)
|
29 |
+
- **PDF**: PyMuPDF for text extraction with layout preservation
|
30 |
+
- **DOCX**: python-docx for structured content
|
31 |
+
- **TXT/MD**: Direct text processing with metadata extraction
|
32 |
+
- **Auto-detection**: File type identification and appropriate parser routing
|
33 |
+
|
34 |
+
### RAG Integration (enhancement to existing Crawl4AI system)
|
35 |
+
- **Chunking Strategy**: Semantic chunking (500-1000 tokens with 100-token overlap)
|
36 |
+
- **Embeddings**: sentence-transformers/all-MiniLM-L6-v2 (lightweight, fast)
|
37 |
+
- **Vector Store**: In-memory FAISS index for deployment portability
|
38 |
+
- **Retrieval**: Top-k similarity search (k=3-5) with relevance scoring
|
39 |
+
|
40 |
+
### Enhanced Template (SPACE_TEMPLATE modification)
|
41 |
+
```python
|
42 |
+
# Add to generated app.py
|
43 |
+
COURSE_MATERIALS = json.loads('''{{course_materials_json}}''')
|
44 |
+
EMBEDDINGS_INDEX = pickle.loads(base64.b64decode('''{{embeddings_base64}}'''))
|
45 |
+
|
46 |
+
def get_relevant_context(query, max_contexts=3):
|
47 |
+
"""Retrieve relevant course material context"""
|
48 |
+
# Vector similarity search
|
49 |
+
# Return formatted context snippets
|
50 |
+
```
|
51 |
+
|
52 |
+
## Speed & Accuracy Optimizations
|
53 |
+
|
54 |
+
### 1. Processing Speed
|
55 |
+
- Batch processing during upload (not per-query)
|
56 |
+
- Lightweight embedding model (384 dimensions vs 1536)
|
57 |
+
- In-memory vector store (no database dependencies)
|
58 |
+
- Cached embeddings in deployment package
|
59 |
+
|
60 |
+
### 2. Query Speed
|
61 |
+
- Pre-computed embeddings (no real-time encoding)
|
62 |
+
- Efficient FAISS indexing for similarity search
|
63 |
+
- Context caching for repeated queries
|
64 |
+
- Parallel processing for multiple files
|
65 |
+
|
66 |
+
### 3. Accuracy Enhancements
|
67 |
+
- Semantic chunking preserves context boundaries
|
68 |
+
- Query expansion with synonyms/related terms
|
69 |
+
- Relevance scoring with threshold filtering
|
70 |
+
- Metadata-aware retrieval (file type, section, date)
|
71 |
+
|
72 |
+
## Deployment Package Integration
|
73 |
+
|
74 |
+
### Package Structure Enhancement
|
75 |
+
```
|
76 |
+
generated_space.zip
|
77 |
+
βββ app.py # Enhanced with RAG
|
78 |
+
βββ requirements.txt # + sentence-transformers, faiss-cpu
|
79 |
+
βββ course_materials/ # Embedded materials
|
80 |
+
β βββ embeddings.pkl # FAISS index
|
81 |
+
β βββ chunks.json # Text chunks with metadata
|
82 |
+
β βββ files_metadata.json # Original file info
|
83 |
+
βββ README.md # Updated instructions
|
84 |
+
```
|
85 |
+
|
86 |
+
### Size Management
|
87 |
+
- Compress embeddings with pickle optimization
|
88 |
+
- Base64 encode for template embedding
|
89 |
+
- Implement file size warnings (>50MB total)
|
90 |
+
- Optional: External storage links for large datasets
|
91 |
+
|
92 |
+
## User Interface Updates
|
93 |
+
|
94 |
+
### Configuration Tab Enhancements
|
95 |
+
```python
|
96 |
+
with gr.Accordion("Course Materials Upload", open=False):
|
97 |
+
file_upload = gr.File(
|
98 |
+
label="Upload Course Materials",
|
99 |
+
file_types=[".pdf", ".docx", ".txt", ".md"],
|
100 |
+
file_count="multiple"
|
101 |
+
)
|
102 |
+
processing_status = gr.Markdown()
|
103 |
+
material_summary = gr.DataFrame() # Show processed files
|
104 |
+
```
|
105 |
+
|
106 |
+
## Technical Implementation
|
107 |
+
|
108 |
+
### Dependencies Addition (requirements.txt)
|
109 |
+
```
|
110 |
+
sentence-transformers==2.2.2
|
111 |
+
faiss-cpu==1.7.4
|
112 |
+
PyMuPDF==1.23.0
|
113 |
+
python-docx==0.8.11
|
114 |
+
tiktoken==0.5.1
|
115 |
+
```
|
116 |
+
|
117 |
+
### Processing Workflow
|
118 |
+
1. **Upload**: Faculty uploads syllabi, schedules, readings
|
119 |
+
2. **Parse**: Extract text with structure preservation
|
120 |
+
3. **Chunk**: Semantic segmentation with metadata
|
121 |
+
4. **Embed**: Generate vector representations
|
122 |
+
5. **Package**: Serialize index and chunks into deployment
|
123 |
+
6. **Deploy**: Single-file space with embedded knowledge
|
124 |
+
|
125 |
+
## Performance Metrics
|
126 |
+
|
127 |
+
- **Upload Processing**: ~2-5 seconds per document
|
128 |
+
- **Query Response**: <200ms additional latency
|
129 |
+
- **Package Size**: +5-15MB for typical course materials
|
130 |
+
- **Accuracy**: 85-95% relevant context retrieval
|
131 |
+
- **Memory Usage**: +50-100MB runtime overhead
|
132 |
+
|
133 |
+
## Benefits
|
134 |
+
|
135 |
+
This approach maintains your existing speed while adding powerful document understanding capabilities that persist in the deployed package. Faculty can upload course materials once during configuration, and students get contextually-aware responses based on actual course content without any external dependencies in the deployed space.
|
136 |
+
|
137 |
+
## Next Steps
|
138 |
+
|
139 |
+
1. Implement document parser service
|
140 |
+
2. Add file upload UI components
|
141 |
+
3. Integrate RAG system with existing Crawl4AI architecture
|
142 |
+
4. Enhance SPACE_TEMPLATE with embedded materials
|
143 |
+
5. Test with sample course materials
|
144 |
+
6. Optimize for deployment package size
|