Create app.py

app.py

@@ -0,0 +1,603 @@
+import gradio as gr
+import boto3
+import json
+import os
+from botocore.exceptions import ClientError, NoCredentialsError
+import time
+
+# Configuration - These will be set via Hugging Face Spaces environment variables
+KNOWLEDGE_BASE_ID = os.environ.get("KNOWLEDGE_BASE_ID", "PLEASE_SET_IN_SPACES_SETTINGS")
+AWS_REGION = os.environ.get("AWS_REGION", "us-east-1")
+MODEL_ARN = f"arn:aws:bedrock:{AWS_REGION}::foundation-model/amazon.nova-pro-v1:0"
+
+# Check if running in demo mode (no credentials set)
+DEMO_MODE = KNOWLEDGE_BASE_ID == "PLEASE_SET_IN_SPACES_SETTINGS"
+
+# Initialize AWS clients
+bedrock_agent = None
+initialization_error = None
+
+if not DEMO_MODE:
+    try:
+        bedrock_agent = boto3.client(
+            'bedrock-agent-runtime',
+            region_name=AWS_REGION,
+            aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID'),
+            aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY')
+        )
+        print(f"✅ AWS Bedrock client initialized in region: {AWS_REGION}")
+    except Exception as e:
+        print(f"❌ Error initializing AWS client: {e}")
+        initialization_error = str(e)
+else:
+    print("🚧 Running in DEMO MODE - Configure environment variables to enable AWS integration")
+
+def search_knowledge_base(query, search_type="generate"):
+    """
+    Search the ORU IT Knowledge Base using Amazon Bedrock
+    """
+    
+    if not query.strip():
+        return "Please enter a question!", "", "error"
+    
+    # Demo mode response
+    if DEMO_MODE:
+        demo_response = f"""
+## 🚧 Demo Mode Active
+
+**Your Query:** "{query}"
+
+**Demo Response:** This is a demonstration of the ORU IT Helpdesk Assistant interface. 
+
+To enable full functionality:
+1. Configure your Amazon Bedrock Knowledge Base
+2. Set up environment variables in Hugging Face Spaces settings
+3. Upload your ORU IT documentation to the knowledge base
+
+**Expected Response:** Once configured, this system would search through ORU's IT knowledge base and provide accurate, contextual answers to questions like:
+- Password reset procedures
+- Software installation guides
+- Network troubleshooting steps
+- Campus system access instructions
+
+**Cost Savings:** Using S3 Vectors provides up to 90% cost savings compared to traditional vector databases.
+        """
+        
+        demo_sources = """
+**Demo Sources:**
+- password_authentication_001_student_password_change.txt
+- mobile_applications_002_oru_app_experience_fix.txt  
+- software_applications_003_word_mac_view_only_fix.txt
+
+*These would be the actual ORU IT knowledge base documents that contain the answer.*
+        """
+        
+        return demo_response, demo_sources, "demo"
+    
+    if not bedrock_agent:
+        error_msg = f"❌ AWS Bedrock client not initialized."
+        if initialization_error:
+            error_msg += f" Error: {initialization_error}"
+        return error_msg, "", "error"
+    
+    try:
+        if search_type == "generate":
+            # Use RetrieveAndGenerate for full responses
+            response = bedrock_agent.retrieve_and_generate(
+                input={
+                    'text': query
+                },
+                retrieveAndGenerateConfiguration={
+                    'type': 'KNOWLEDGE_BASE',
+                    'knowledgeBaseConfiguration': {
+                        'knowledgeBaseId': KNOWLEDGE_BASE_ID,
+                        'modelArn': MODEL_ARN,
+                        'retrievalConfiguration': {
+                            'vectorSearchConfiguration': {
+                                'numberOfResults': 5
+                            }
+                        }
+                    }
+                }
+            )
+            
+            # Extract the generated response
+            generated_text = response.get('output', {}).get('text', 'No response generated.')
+            
+            # Extract sources/citations
+            sources_info = []
+            citations = response.get('citations', [])
+            
+            for i, citation in enumerate(citations, 1):
+                retrieved_refs = citation.get('retrievedReferences', [])
+                for j, ref in enumerate(retrieved_refs, 1):
+                    content = ref.get('content', {}).get('text', 'No content available')
+                    location = ref.get('location', {}).get('s3Location', {}).get('uri', 'Unknown source')
+                    sources_info.append(f"**Source {i}.{j}:**\n{content[:300]}{'...' if len(content) > 300 else ''}\n*From: {location}*\n")
+            
+            sources_text = "\n".join(sources_info) if sources_info else "No sources found."
+            
+            return generated_text, sources_text, "success"
+            
+        else:  # retrieve only
+            # Use Retrieve for sources only
+            response = bedrock_agent.retrieve(
+                knowledgeBaseId=KNOWLEDGE_BASE_ID,
+                retrievalQuery={
+                    'text': query
+                },
+                retrievalConfiguration={
+                    'vectorSearchConfiguration': {
+                        'numberOfResults': 5
+                    }
+                }
+            )
+            
+            # Extract retrieved results
+            retrieval_results = response.get('retrievalResults', [])
+            
+            if not retrieval_results:
+                return "No relevant sources found.", "", "warning"
+            
+            sources_info = []
+            for i, result in enumerate(retrieval_results, 1):
+                content = result.get('content', {}).get('text', 'No content available')
+                score = result.get('score', 0)
+                location = result.get('location', {}).get('s3Location', {}).get('uri', 'Unknown source')
+                
+                sources_info.append(
+                    f"**Source {i} (Confidence: {score:.2f}):**\n"
+                    f"{content[:400]}{'...' if len(content) > 400 else ''}\n"
+                    f"*From: {location}*\n"
+                )
+            
+            sources_text = "\n".join(sources_info)
+            response_text = f"Found {len(retrieval_results)} relevant sources from the ORU IT Knowledge Base:"
+            
+            return response_text, sources_text, "success"
+            
+    except ClientError as e:
+        error_code = e.response['Error']['Code']
+        error_message = e.response['Error']['Message']
+        return f"❌ AWS Error ({error_code}): {error_message}", "", "error"
+        
+    except NoCredentialsError:
+        return "❌ AWS credentials not found. Please configure your credentials in Spaces settings.", "", "error"
+        
+    except Exception as e:
+        return f"❌ Unexpected error: {str(e)}", "", "error"
+
+def format_response(query, search_type):
+    """Process the query and return formatted response"""
+    
+    if not query.strip():
+        return (
+            "Please enter your IT question above and click 'Get AI Answer' or 'Show Sources'.",
+            "",
+            "Enter a question to get started!"
+        )
+    
+    # Perform the search
+    response_text, sources_text, status = search_knowledge_base(query, search_type)
+    
+    # Format the final response based on search type and status
+    if status == "demo":
+        formatted_response = response_text
+        status_msg = "🚧 Demo Mode - Configure AWS credentials to enable full functionality"
+    elif search_type == "generate":
+        if status == "success":
+            formatted_response = f"## 🤖 AI Assistant Response\n\n{response_text}"
+            status_msg = "✅ Response generated successfully from ORU IT Knowledge Base!"
+        else:
+            formatted_response = response_text
+            status_msg = "❌ Error generating response"
+    else:
+        if status == "success":
+            formatted_response = f"## 📚 Retrieved Sources\n\n{response_text}"
+            status_msg = "✅ Sources retrieved successfully from ORU IT Knowledge Base!"
+        else:
+            formatted_response = response_text
+            status_msg = "❌ Error retrieving sources"
+    
+    return formatted_response, sources_text, status_msg
+
+# Sample queries for ORU IT scenarios
+SAMPLE_QUERIES = [
+    "How do I change my student password?",
+    "My ORU app isn't showing the right tiles",
+    "Word is showing view only mode on my Mac", 
+    "How do I set up multi-factor authentication?",
+    "I can't edit Microsoft Word documents",
+    "How do I connect to ORU WiFi network?",
+    "My ORU email isn't syncing to my phone",
+    "How do I access Vision portal from off-campus?",
+    "VPN connection keeps dropping",
+    "Can't print to campus printers from my laptop",
+    "How do I reset my Z-number password?",
+    "Microsoft Teams isn't working properly"
+]
+
+# Custom CSS with ORU Brand Colors
+custom_css = """
+:root {
+    --oru-primary-blue: #041E41;
+    --oru-primary-tan: #C4B282;
+    --oru-secondary-tan: #E9DFBB;
+    --oru-accent-blue: #7BAFD4;
+    --oru-accent-tan: #C39236;
+}
+
+.gradio-container {
+    max-width: 1200px !important;
+    font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+}
+
+/* Header styling */
+.oru-header {
+    background: linear-gradient(135deg, var(--oru-primary-blue) 0%, var(--oru-accent-blue) 100%);
+    color: white;
+    padding: 30px;
+    text-align: center;
+    border-radius: 15px;
+    margin-bottom: 25px;
+    box-shadow: 0 8px 25px rgba(4, 30, 65, 0.2);
+}
+
+.oru-header h1 {
+    font-size: 2.5rem;
+    margin-bottom: 10px;
+    text-shadow: 2px 2px 4px rgba(0,0,0,0.3);
+}
+
+.oru-header p {
+    font-size: 1.1rem;
+    opacity: 0.95;
+    margin: 8px 0;
+}
+
+/* Button styling */
+.gradio-button {
+    border-radius: 8px !important;
+    font-weight: 600 !important;
+    transition: all 0.3s ease !important;
+    border: none !important;
+}
+
+.gradio-button.primary {
+    background: linear-gradient(45deg, var(--oru-primary-blue), var(--oru-accent-blue)) !important;
+    color: white !important;
+}
+
+.gradio-button.primary:hover {
+    transform: translateY(-2px) !important;
+    box-shadow: 0 6px 20px rgba(4, 30, 65, 0.3) !important;
+}
+
+.gradio-button.secondary {
+    background: linear-gradient(45deg, var(--oru-accent-tan), var(--oru-primary-tan)) !important;
+    color: white !important;
+}
+
+.gradio-button.secondary:hover {
+    transform: translateY(-2px) !important;
+    box-shadow: 0 6px 20px rgba(195, 146, 54, 0.3) !important;
+}
+
+/* Small sample buttons */
+.gradio-button[size="sm"] {
+    background: var(--oru-secondary-tan) !important;
+    color: var(--oru-primary-blue) !important;
+    border: 1px solid var(--oru-primary-tan) !important;
+    font-size: 14px !important;
+    padding: 8px 12px !important;
+}
+
+.gradio-button[size="sm"]:hover {
+    background: var(--oru-primary-tan) !important;
+    color: white !important;
+    transform: translateY(-1px) !important;
+}
+
+/* Input styling */
+.gradio-textbox textarea, .gradio-textbox input {
+    border: 2px solid var(--oru-secondary-tan) !important;
+    border-radius: 8px !important;
+    font-size: 16px !important;
+}
+
+.gradio-textbox textarea:focus, .gradio-textbox input:focus {
+    border-color: var(--oru-accent-blue) !important;
+    box-shadow: 0 0 0 3px rgba(123, 175, 212, 0.2) !important;
+}
+
+/* Output styling */
+.output-markdown h2 {
+    color: var(--oru-primary-blue) !important;
+    border-bottom: 3px solid var(--oru-accent-blue) !important;
+    padding-bottom: 10px !important;
+    margin-top: 20px !important;
+}
+
+.output-markdown h3 {
+    color: var(--oru-accent-tan) !important;
+}
+
+.output-markdown {
+    line-height: 1.6 !important;
+}
+
+/* Status messages */
+.status-success {
+    background: linear-gradient(45deg, #d4edda, var(--oru-secondary-tan)) !important;
+    border: 2px solid var(--oru-primary-tan) !important;
+    color: var(--oru-primary-blue) !important;
+    padding: 15px !important;
+    border-radius: 10px !important;
+    font-weight: 600 !important;
+}
+
+.status-error {
+    background: linear-gradient(45deg, #f8d7da, #fde2e4) !important;
+    border: 2px solid #dc3545 !important;
+    color: #721c24 !important;
+    padding: 15px !important;
+    border-radius: 10px !important;
+    font-weight: 600 !important;
+}
+
+/* Demo mode styling */
+.status-demo {
+    background: linear-gradient(45deg, #fff3cd, var(--oru-secondary-tan)) !important;
+    border: 2px solid var(--oru-accent-tan) !important;
+    color: var(--oru-primary-blue) !important;
+    padding: 15px !important;
+    border-radius: 10px !important;
+    font-weight: 600 !important;
+}
+
+/* Configuration panel */
+.config-panel {
+    background: linear-gradient(45deg, var(--oru-secondary-tan), #f8f9fa) !important;
+    padding: 20px !important;
+    border-radius: 10px !important;
+    border: 1px solid var(--oru-primary-tan) !important;
+}
+
+/* Accordion styling */
+.gradio-accordion {
+    border: 1px solid var(--oru-primary-tan) !important;
+    border-radius: 10px !important;
+}
+
+.gradio-accordion summary {
+    background: var(--oru-secondary-tan) !important;
+    color: var(--oru-primary-blue) !important;
+    font-weight: 600 !important;
+    padding: 15px !important;
+}
+
+/* Sample queries section */
+.sample-queries {
+    background: linear-gradient(45deg, var(--oru-secondary-tan), #ffffff) !important;
+    padding: 20px !important;
+    border-radius: 10px !important;
+    border: 1px solid var(--oru-primary-tan) !important;
+    margin-top: 15px !important;
+}
+
+.sample-queries h3 {
+    color: var(--oru-primary-blue) !important;
+    margin-bottom: 15px !important;
+    font-size: 1.2rem !important;
+}
+
+/* Source citations styling */
+.output-markdown strong {
+    color: var(--oru-accent-tan) !important;
+}
+
+.output-markdown em {
+    color: var(--oru-primary-blue) !important;
+    font-style: italic !important;
+}
+"""
+
+# Create the Gradio interface
+with gr.Blocks(css=custom_css, title="ORU IT Helpdesk Assistant") as app:
+    
+    # Header with ORU Branding
+    gr.HTML("""
+    <div class="oru-header">
+        <h1>🏛️ Oral Roberts University</h1>
+        <h2 style="font-size: 2rem; margin: 15px 0; font-weight: 600;">IT Helpdesk Assistant</h2>
+        <p style="font-size: 18px; margin: 10px 0;">Powered by Amazon Bedrock Knowledge Bases & S3 Vectors</p>
+        <p style="font-size: 16px; opacity: 0.95; margin: 5px 0;">Get instant answers to your IT questions • Available 24/7</p>
+        <div style="margin-top: 20px; padding: 10px; background: rgba(255,255,255,0.1); border-radius: 8px; display: inline-block;">
+            <span style="font-size: 14px; opacity: 0.9;">🔍 Search • 📚 Retrieve Sources • ⚡ Instant Responses</span>
+        </div>
+    </div>
+    """)
+    
+    with gr.Row():
+        with gr.Column(scale=2):
+            # Input section
+            query_input = gr.Textbox(
+                label="🔍 Ask your IT question:",
+                placeholder="e.g., How do I change my password?",
+                lines=2,
+                max_lines=4
+            )
+            
+            with gr.Row():
+                search_btn = gr.Button(
+                    "🤖 Get AI Answer", 
+                    variant="primary", 
+                    scale=2,
+                    elem_classes=["primary"]
+                )
+                retrieve_btn = gr.Button(
+                    "📚 Show Sources", 
+                    variant="secondary", 
+                    scale=1,
+                    elem_classes=["secondary"]
+                )
+            
+            # Sample queries with ORU styling
+            gr.HTML("""
+            <div class="sample-queries">
+                <h3>💡 Try These Common ORU IT Questions:</h3>
+                <p style="color: #041E41; margin-bottom: 15px; font-size: 14px;">
+                    Click any question below to auto-fill the search box ⬆️
+                </p>
+            </div>
+            """)
+            
+            with gr.Column():
+                for i in range(0, len(SAMPLE_QUERIES), 2):
+                    with gr.Row():
+                        if i < len(SAMPLE_QUERIES):
+                            sample_btn1 = gr.Button(
+                                SAMPLE_QUERIES[i], 
+                                size="sm",
+                                elem_classes=["sample-query-btn"]
+                            )
+                            sample_btn1.click(lambda x=SAMPLE_QUERIES[i]: x, outputs=query_input)
+                        if i + 1 < len(SAMPLE_QUERIES):
+                            sample_btn2 = gr.Button(
+                                SAMPLE_QUERIES[i + 1], 
+                                size="sm",
+                                elem_classes=["sample-query-btn"]
+                            )
+                            sample_btn2.click(lambda x=SAMPLE_QUERIES[i + 1]: x, outputs=query_input)
+        
+        with gr.Column(scale=3):
+            # Output section
+            status_output = gr.HTML(label="Status")
+            response_output = gr.Markdown(label="Response")
+            sources_output = gr.Markdown(label="Sources", visible=True)
+    
+    # Configuration info with ORU branding
+    with gr.Accordion("🔧 System Configuration", open=False):
+        gr.HTML(f"""
+        <div class="config-panel">
+            <h3 style="color: #041E41; margin-bottom: 15px; font-size: 1.3rem;">📊 Knowledge Base Configuration</h3>
+            <div style="display: grid; grid-template-columns: 1fr 1fr; gap: 15px;">
+                <div>
+                    <p><strong style="color: #C39236;">Knowledge Base ID:</strong><br>
+                    <code style="background: #E9DFBB; padding: 5px; border-radius: 3px; color: #041E41;">{KNOWLEDGE_BASE_ID}</code></p>
+                    <p><strong style="color: #C39236;">AWS Region:</strong><br>
+                    <code style="background: #E9DFBB; padding: 5px; border-radius: 3px; color: #041E41;">{AWS_REGION}</code></p>
+                </div>
+                <div>
+                    <p><strong style="color: #C39236;">AI Model:</strong><br>
+                    <span style="color: #041E41;">Amazon Nova Pro</span></p>
+                    <p><strong style="color: #C39236;">Connection Status:</strong><br>
+                    <span style="color: {'#28a745' if bedrock_agent else ('#f39c12' if DEMO_MODE else '#dc3545')}; font-weight: 600;">
+                    {'✅ Connected & Ready' if bedrock_agent else ('🚧 Demo Mode - Configure AWS' if DEMO_MODE else '❌ Connection Error')}
+                    </span></p>
+                </div>
+            </div>
+            <div style="margin-top: 15px; padding: 10px; background: rgba(123, 175, 212, 0.1); border-radius: 5px; border-left: 4px solid #7BAFD4;">
+                <small style="color: #041E41;"><strong>💡 Tip:</strong> This system uses ORU's IT knowledge base to provide accurate, up-to-date answers to common technical questions.</small>
+            </div>
+        </div>
+        """)
+    
+    # Setup instructions for Hugging Face Spaces
+    with gr.Accordion("📋 Hugging Face Spaces Configuration", open=False):
+        gr.Markdown(f"""
+        ## 🚀 Configure This Space for ORU IT:
+        
+        ### Current Status:
+        - **Demo Mode:** {'🚧 Active' if DEMO_MODE else '✅ Disabled - AWS configured'}
+        - **Knowledge Base ID:** `{KNOWLEDGE_BASE_ID}`
+        - **AWS Region:** `{AWS_REGION}`
+        
+        ### ⚙️ Required Environment Variables:
+        To enable full functionality, add these in your **Space Settings > Variables and secrets**:
+        
+        ```bash
+        KNOWLEDGE_BASE_ID=YOUR_ACTUAL_KNOWLEDGE_BASE_ID
+        AWS_REGION=us-east-1
+        AWS_ACCESS_KEY_ID=your_aws_access_key
+        AWS_SECRET_ACCESS_KEY=your_aws_secret_key
+        ```
+        
+        ### 📝 Setup Steps:
+        
+        1. **Get Your Knowledge Base ID:**
+           - Go to AWS Bedrock Console
+           - Navigate to Knowledge Bases
+           - Find your "ORU IT Helpdesk Knowledge Base"
+           - Copy the Knowledge Base ID
+        
+        2. **Configure AWS Credentials:**
+           - Use an IAM user with Bedrock permissions
+           - Required permissions: `bedrock:InvokeModel`, `bedrock:Retrieve`, `bedrock:RetrieveAndGenerate`
+        
+        3. **Add to Hugging Face Spaces:**
+           - Go to your Space settings
+           - Click "Variables and secrets"
+           - Add each environment variable as a "Secret"
+           - The Space will automatically restart with new configuration
+        
+        4. **Test the Integration:**
+           - Once configured, the "🚧 Demo Mode" status will change to "✅ Connected"
+           - Test with sample queries to verify everything works
+        
+        ### 🔒 Security Best Practices:
+        - ✅ Use IAM user with minimal required permissions
+        - ✅ Store credentials as Secrets (not Variables) in Spaces
+        - ✅ Monitor AWS CloudTrail for API usage
+        - ✅ Regularly rotate access keys
+        
+        ### 💰 Cost Optimization:
+        - S3 Vectors provides up to 90% cost savings vs traditional vector databases
+        - Monitor your AWS Bedrock usage in the AWS console
+        - Consider setting up billing alerts
+        """)
+    
+    # Event handlers
+    search_btn.click(
+        fn=lambda query: format_response(query, "generate"),
+        inputs=[query_input],
+        outputs=[response_output, sources_output, status_output]
+    )
+    
+    retrieve_btn.click(
+        fn=lambda query: format_response(query, "retrieve"),
+        inputs=[query_input],
+        outputs=[response_output, sources_output, status_output]
+    )
+    
+    # Allow Enter key to trigger search
+    query_input.submit(
+        fn=lambda query: format_response(query, "generate"),
+        inputs=[query_input],
+        outputs=[response_output, sources_output, status_output]
+    )
+
+# Launch configuration
+if __name__ == "__main__":
+    print("🏛️ Starting ORU IT Helpdesk Assistant...")
+    print("🎓 Oral Roberts University - Information Technology")
+    print(f"📚 Knowledge Base ID: {KNOWLEDGE_BASE_ID}")
+    print(f"🌍 AWS Region: {AWS_REGION}")
+    print(f"🚧 Demo Mode: {'Active' if DEMO_MODE else 'Disabled'}")
+    print("=" * 50)
+    if DEMO_MODE:
+        print("🔧 Configuration needed:")
+        print("   □ Set KNOWLEDGE_BASE_ID environment variable")
+        print("   □ Set AWS_ACCESS_KEY_ID environment variable")
+        print("   □ Set AWS_SECRET_ACCESS_KEY environment variable")
+        print("   □ Verify Bedrock model access is enabled")
+    else:
+        print("✅ Configuration looks good!")
+        print("🔧 Checklist:")
+        print("   ✅ Environment variables configured")
+        print("   □ Test with sample queries")
+        print("   □ Verify knowledge base content")
+    print("=" * 50)
+    print("🚀 Ready to serve ORU students, faculty, and staff!")
+    
+    app.launch()