vpingale07 commited on
Commit
c0f1f68
·
verified ·
1 Parent(s): c7f3c81

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -84
README.md CHANGED
@@ -1,84 +1,10 @@
1
- # Hospital Query Assistant
2
-
3
- This project implements a Hospital Query Assistant using AutoGen and GroqCloud API, with a Gradio-based user interface. The assistant helps users with queries about hospital services, appointments, and general medical information.
4
-
5
- ## Features
6
-
7
- - Natural language processing for hospital-related queries
8
- - Content moderation to ensure safe and appropriate responses
9
- - Token usage tracking
10
- - User-friendly chat interface
11
-
12
- ## Implementation Details
13
-
14
- ### Backend (`hospital_query_app.py`)
15
-
16
- The backend is implemented using AutoGen and the GroqCloud API. Key components include:
17
-
18
- 1. **AutoGen Agents**:
19
- - User Proxy Agent: Represents the user in the conversation.
20
- - Hospital Assistant Agent: Provides responses to user queries.
21
-
22
- 2. **Content Moderation**:
23
- - Uses the Mixtral-8x7b-32768 model to check for inappropriate content.
24
- - Ensures queries are safe and relevant before processing.
25
-
26
- 3. **Query Handling**:
27
- - Sanitizes user input to remove potential security risks.
28
- - Processes queries using the Hospital Assistant Agent.
29
- - Tracks token usage for each query.
30
-
31
- ### Frontend (`hospital_query_ui.py`)
32
-
33
- The frontend is built using Gradio, providing a web-based user interface. Features include:
34
-
35
- 1. **Chat Interface**:
36
- - Displays conversation history.
37
- - Allows users to input queries easily.
38
-
39
- 2. **Token Usage Display**:
40
- - Shows tokens used in the last query.
41
- - Displays total tokens used in the session.
42
-
43
- 3. **Clear Functionality**:
44
- - Allows users to reset the conversation and token counters.
45
-
46
- ## Setup and Installation
47
-
48
- 1. Clone the repository:
49
- ```
50
- git clone https://github.com/vpingale077/hospital-query-assistant.git
51
- ```
52
-
53
- 2. Install required dependencies:
54
- ```
55
- pip install -r requirements.txt
56
- ```
57
-
58
- 3. Set up environment variables:
59
- - Create a `.env` file in the project root.
60
- - Add your GroqCloud API key:
61
- ```
62
- GROQ_API_KEY=your_api_key_here
63
- ```
64
-
65
- 4. Run the application:
66
- ```
67
- python hospital_query_ui.py
68
- ```
69
-
70
- ## Usage
71
-
72
- 1. Launch the application using the command above.
73
- 2. Open the provided URL in your web browser.
74
- 3. Type your hospital-related query in the input box and press Enter.
75
- 4. View the assistant's response in the chat interface.
76
- 5. Check token usage information on the right side of the interface.
77
-
78
- ## Note
79
-
80
- This assistant is designed for general information purposes only and should not be used for personal medical advice or diagnoses.
81
-
82
- ## License
83
-
84
- [MIT License](LICENSE)
 
1
+ title: HospitalAssitant
2
+ emoji: 🐨
3
+ colorFrom: red
4
+ colorTo: yellow
5
+ sdk: gradio
6
+ sdk_version: 5.1.0
7
+ app_file: app.py
8
+ pinned: false
9
+ license: mit
10
+ short_description: Hospital Query Assistant using AutoGen and GroqCloud API