drbinna commited on
Commit
da5a177
Β·
verified Β·
1 Parent(s): 9acf5e3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +63 -8
README.md CHANGED
@@ -1,14 +1,69 @@
1
  ---
2
- title: Oru It RAG Assistant
3
- emoji: πŸ‘
4
- colorFrom: pink
5
- colorTo: green
6
  sdk: gradio
7
- sdk_version: 5.46.1
8
  app_file: app.py
9
  pinned: false
10
- license: mit
11
- short_description: 'Chat interface for common helpdesk ticket assistant '
 
 
 
 
 
 
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: ORU IT Helpdesk Assistant
3
+ emoji: πŸ›οΈ
4
+ colorFrom: blue
5
+ colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.44.0
8
  app_file: app.py
9
  pinned: false
10
+ license: apache-2.0
11
+ tags:
12
+ - education
13
+ - university
14
+ - helpdesk
15
+ - bedrock
16
+ - knowledge-base
17
+ short_description: AI-powered IT helpdesk for Oral Roberts University
18
  ---
19
 
20
+ # ORU IT Helpdesk Assistant
21
+
22
+ A powerful AI-powered helpdesk assistant for Oral Roberts University's Information Technology department. Built with Amazon Bedrock Knowledge Bases and S3 Vectors for cost-effective, scalable support.
23
+
24
+ ## πŸŽ“ About
25
+
26
+ This application provides instant, accurate answers to common IT questions for ORU students, faculty, and staff. It leverages:
27
+
28
+ - **Amazon Bedrock Knowledge Bases** for intelligent document retrieval
29
+ - **S3 Vectors** for cost-effective vector storage (up to 90% cost savings)
30
+ - **Amazon Nova Pro** for natural language generation
31
+ - **Gradio** for a professional, user-friendly interface
32
+
33
+ ## πŸ›οΈ Features
34
+
35
+ - **ORU-branded interface** with official university colors
36
+ - **Dual search modes**: AI-generated responses or source retrieval
37
+ - **Common question shortcuts** for frequently asked IT questions
38
+ - **Real-time status indicators** and error handling
39
+ - **Mobile-responsive design** for campus-wide access
40
+
41
+ ## βš™οΈ Configuration
42
+
43
+ This application requires AWS credentials and a configured Bedrock Knowledge Base.
44
+
45
+ ### Required Environment Variables
46
+ - `KNOWLEDGE_BASE_ID`: Your Amazon Bedrock Knowledge Base ID
47
+ - `AWS_REGION`: AWS region (e.g., us-east-1)
48
+ - `AWS_ACCESS_KEY_ID`: AWS access key
49
+ - `AWS_SECRET_ACCESS_KEY`: AWS secret key
50
+
51
+ ### Setup Instructions
52
+ 1. Configure your Amazon Bedrock Knowledge Base with ORU IT documentation
53
+ 2. Upload your IT knowledge base content to S3
54
+ 3. Set up the required environment variables in Hugging Face Spaces
55
+ 4. Test with sample queries
56
+
57
+ ## πŸ”’ Security
58
+
59
+ - All AWS credentials are stored as secure environment variables
60
+ - No sensitive information is logged or exposed
61
+ - Designed for internal university use
62
+
63
+ ## πŸ“ž Support
64
+
65
+ For technical support or questions about this application, contact the ORU IT department.
66
+
67
+ ---
68
+
69
+ **Powered by:** Amazon Bedrock β€’ S3 Vectors β€’ Gradio β€’ Hugging Face Spaces