abdibrahem commited on
Commit
c4f1d8e
Β·
1 Parent(s): cdee10f

Update readme file

Browse files
Files changed (1) hide show
  1. README.md +38 -74
README.md CHANGED
@@ -1,90 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
1
  # Healthcare AI Assistant
2
 
3
- A FastAPI-based AI assistant that handles healthcare appointment booking and queries in multiple languages.
4
 
5
  ## Features
6
 
7
- - Multi-language support (English and Arabic)
8
- - Appointment booking and cancellation
9
- - Sentiment analysis
10
- - Language detection
11
- - User-friendly responses
12
-
13
- ## Setup
14
-
15
- 1. Create a virtual environment:
16
- ```bash
17
- python -m venv venv
18
- source venv/bin/activate # On Windows: venv\Scripts\activate
19
- ```
20
 
21
- 2. Install dependencies:
22
- ```bash
23
- pip install -r requirements.txt
24
- ```
25
 
26
- 3. Set up environment variables:
27
- Create a `.env` file in the root directory with the following variables:
28
- ```
29
- API_BASE_URL=your_api_base_url
30
- API_KEY=your_api_key
31
- ```
32
 
33
- ## Running the Application
34
-
35
- Start the FastAPI server:
36
- ```bash
37
- uvicorn main:app --reload
38
- ```
39
-
40
- The API will be available at `http://localhost:8000`
41
 
42
- ## API Documentation
 
43
 
44
- Once the server is running, you can access:
45
- - Interactive API documentation: `http://localhost:8000/docs`
46
- - Alternative API documentation: `http://localhost:8000/redoc`
47
 
48
- ## API Endpoints
49
 
50
- ### POST /query
51
- Process a user query and return a response.
 
52
 
53
- Request body:
54
- ```json
55
- {
56
- "query": "string",
57
- "language": "string (optional)"
58
- }
59
- ```
60
 
61
- Response:
62
- ```json
63
- {
64
- "routing_info": {
65
- "endpoint": "string",
66
- "method": "string",
67
- "parameters": {}
68
- },
69
- "api_response": {},
70
- "user_friendly_response": "string",
71
- "detected_language": "string",
72
- "sentiment": {
73
- "compound": float,
74
- "pos": float,
75
- "neu": float,
76
- "neg": float
77
- }
78
- }
79
- ```
80
 
81
- ### GET /health
82
- Health check endpoint.
83
 
84
- Response:
85
- ```json
86
- {
87
- "status": "healthy",
88
- "service": "healthcare-ai-assistant"
89
- }
90
- ```
 
1
+ ---
2
+ title: Healthcare AI Assistant
3
+ emoji: πŸ₯
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: docker
7
+ sdk_version: 1.0.0
8
+ app_file: main.py
9
+ pinned: false
10
+ ---
11
+
12
  # Healthcare AI Assistant
13
 
14
+ A multilingual AI assistant for healthcare appointment management, built with FastAPI and LangChain.
15
 
16
  ## Features
17
 
18
+ - πŸ€– AI-powered appointment management
19
+ - 🌐 Multi-language support (English & Arabic)
20
+ - πŸ“… Smart appointment scheduling
21
+ - 🎯 Intent recognition
22
+ - πŸ’¬ Natural language processing
23
+ - πŸ” Sentiment analysis
24
+ - 🌍 Language detection
 
 
 
 
 
 
25
 
26
+ ## Technical Stack
 
 
 
27
 
28
+ - FastAPI for API endpoints
29
+ - LangChain for AI processing
30
+ - Ollama for LLM integration
31
+ - HuggingFace for language models
32
+ - Docker for containerization
 
33
 
34
+ ## API Endpoints
 
 
 
 
 
 
 
35
 
36
+ ### POST /query
37
+ Process user queries and return AI-generated responses.
38
 
39
+ ### GET /health
40
+ Health check endpoint for service monitoring.
 
41
 
42
+ ## Configuration
43
 
44
+ The service requires the following environment variables:
45
+ - `API_BASE_URL`: Base URL for the backend API
46
+ - `API_KEY`: Authentication key for API access
47
 
48
+ ## Deployment
 
 
 
 
 
 
49
 
50
+ This service is containerized using Docker and can be deployed on any platform that supports Docker containers.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
51
 
52
+ ## License
 
53
 
54
+ MIT License