""" Help tab functionality for the Gradio app """ import gradio as gr def create_help_tab(global_vars): """Create the Help tab with comprehensive documentation""" with gr.Tab("❓ Help", id="help"): gr.Markdown(""" # 🌏 TopEdu - User Guide Welcome to the TopEdu, a Southeast Asian University Requirements Assistant! This tool helps you navigate university admission requirements across Southeast Asian countries using advanced AI-powered document analysis. --- ## 🚀 Getting Started ### Step 1: Initialize the System 1. Go to the **🔧 Initialize** tab 2. Click **"Initialize All Systems"** 3. Wait for the success message 4. The system will set up AI models and document processing capabilities ### Step 2: Upload Documents 1. Navigate to the **📤 Upload Documents** tab 2. Select one or more PDF files containing university requirement information 3. Click **"Process Documents"** 4. Wait for processing completion ### Step 3: Query Documents 1. Go to the **🔍 Query Documents** tab 2. Type your question in the query box 3. Click **"Search Documents"** 4. Review the AI-generated answer and source references 5. Use example questions to explore different types of queries ### Step 4: Manage Documents 1. Visit the **🗂 Manage Documents** tab 2. View all uploaded documents and statistics 3. Delete individual documents or clear all documents as needed --- ## 📖 Features Overview ### 🤖 AI-Powered Analysis - Uses advanced SEA-LION AI models optimized for Southeast Asian contexts - Semantic search across your document collection - Contextual answers with source citations - Multi-language document support ### 📚 Document Management - Support for PDF documents - Intelligent text chunking for better search results - Metadata tracking (university, country, document type, language) - Easy document deletion and management ### 🌐 Regional Focus - Specialized for Southeast Asian universities - Supports multiple countries and languages - Culturally aware responses - Up-to-date admission requirement information --- ## 💡 Usage Tips ### Asking Better Questions - **Be Specific**: "What are the English proficiency requirements for Computer Science at NUS?" instead of "What are the requirements?" - **Include Context**: Mention specific programs, countries, or universities you're interested in - **Use Keywords**: Include terms like "admission", "requirements", "GPA", "test scores", etc. ### Document Upload Best Practices - **Quality Documents**: Upload official university brochures, requirement documents, or application guides - **Accurate Metadata**: Fill in all metadata fields correctly for better search results - **Regular Updates**: Replace outdated documents with current versions - **Organized Approach**: Upload documents systematically by country or university ### Managing Your Knowledge Base - **Regular Maintenance**: Remove outdated documents periodically - **Logical Organization**: Group related documents together - **Backup Important Queries**: Save important answers for future reference --- ## 🛠 Troubleshooting ### Common Issues **Problem**: "Please initialize systems first" error - **Solution**: Go to the Initialize tab and click "Initialize All Systems" **Problem**: Document upload fails - **Solution**: Ensure PDF files are not corrupted and contain text (not just images) **Problem**: No search results - **Solution**: Check if documents are uploaded and try different keywords **Problem**: Slow performance - **Solution**: Wait for processing to complete, avoid uploading too many large documents at once ### Technical Requirements - **File Format**: PDF documents only - **File Size**: Reasonable size limits (avoid extremely large files) - **Content**: Text-based PDFs work best (scanned images may not work well) - **Internet**: Required for AI model access --- ## 📊 Understanding Results ### Query Responses - **Answer**: AI-generated response based on your documents - **Sources**: Specific document chunks used to generate the answer - **Confidence**: Implied by the specificity and detail of the response - **Context**: Related information that might be helpful ### Document Statistics - **Total Documents**: Number of unique documents uploaded - **Total Chunks**: Number of text segments for searching - **Metadata**: Information about each document's origin and type --- ## 🌟 Best Practices for University Research ### Research Strategy 1. **Start Broad**: Upload general university information first 2. **Get Specific**: Add detailed program requirements 3. **Compare Options**: Query for comparisons between universities 4. **Verify Information**: Cross-reference with official university websites ### Question Types to Try - **Admission Requirements**: "What are the minimum GPA requirements for..." - **Test Scores**: "What IELTS/TOEFL scores are needed for..." - **Application Deadlines**: "When is the application deadline for..." - **Program Details**: "What courses are included in the... program at..." - **Scholarships**: "What scholarship opportunities are available for..." --- ## 🆘 Support & Feedback If you encounter issues or have suggestions for improvement: 1. **Check Documentation**: Review this help section first 2. **Try Different Approaches**: Rephrase your queries or check document formats 3. **Document Issues**: Note specific error messages or unexpected behavior 4. **Feature Requests**: Consider what additional functionality would be helpful --- ## 🔄 Version Information **Current Version**: Gradio-based Assistant **AI Models**: SEA-LION optimized for Southeast Asian contexts **Document Processing**: Advanced semantic chunking and embedding **Search Technology**: Vector similarity search with contextual ranking --- *Happy university hunting! 🎓 We hope this tool helps you find the perfect educational opportunity in Southeast Asia.* """)