Spaces:
Sleeping
Sleeping
update: README.txt
Browse files
README.md
CHANGED
@@ -1 +1,117 @@
|
|
1 |
# Nurse LLM
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
# Nurse LLM
|
2 |
+
|
3 |
+
```
|
4 |
+
/your_path/MALI_Nurse/
|
5 |
+
βββ cli.py
|
6 |
+
βββ main.py
|
7 |
+
βββ README.md
|
8 |
+
βββ llm/
|
9 |
+
β βββ __init__.py
|
10 |
+
β βββ client.py
|
11 |
+
β βββ llm.py
|
12 |
+
βββ .env
|
13 |
+
```
|
14 |
+
|
15 |
+
## Quick Start
|
16 |
+
|
17 |
+
### Prerequisites
|
18 |
+
|
19 |
+
- Python 3.10
|
20 |
+
|
21 |
+
### Installation
|
22 |
+
|
23 |
+
1. Clone the repository:
|
24 |
+
|
25 |
+
```sh
|
26 |
+
git clone https://github.com/yourusername/MALI_Nurse.git
|
27 |
+
cd MALI_Nurse
|
28 |
+
```
|
29 |
+
2. Install the required packages:
|
30 |
+
|
31 |
+
```sh
|
32 |
+
pip install -r requirements.txt
|
33 |
+
```
|
34 |
+
|
35 |
+
Alternatively, you can use Poetry for dependency management:
|
36 |
+
|
37 |
+
```sh
|
38 |
+
poetry install
|
39 |
+
```
|
40 |
+
3. Set up your environment variables in a `.env` file:
|
41 |
+
|
42 |
+
```env
|
43 |
+
TYPHOON_API_KEY=your_typhoon_api_key
|
44 |
+
```
|
45 |
+
|
46 |
+
### Running the CLI
|
47 |
+
|
48 |
+
To start the CLI, run:
|
49 |
+
|
50 |
+
```sh
|
51 |
+
python cli.py
|
52 |
+
```
|
53 |
+
|
54 |
+
### Running the API
|
55 |
+
|
56 |
+
To start the FastAPI server, run:
|
57 |
+
|
58 |
+
```sh
|
59 |
+
uvicorn main:app --reload
|
60 |
+
```
|
61 |
+
|
62 |
+
The server will be available at `http://127.0.0.1:8000`.
|
63 |
+
|
64 |
+
### API Endpoints
|
65 |
+
|
66 |
+
- `GET /history`: Retrieve chat history
|
67 |
+
- `GET /ehr`: Retrieve EHR data
|
68 |
+
- `GET /status`: Get current prompt status
|
69 |
+
- `POST /debug`: Toggle debug mode
|
70 |
+
- `POST /reset`: Reset chat history and EHR data
|
71 |
+
- `POST /nurse_response`: Get a response from the nurse LLM
|
72 |
+
|
73 |
+
### Example Request
|
74 |
+
|
75 |
+
To get a response from the nurse LLM, send a POST request to `/nurse_response` with a JSON body:
|
76 |
+
|
77 |
+
```json
|
78 |
+
{
|
79 |
+
"user_input": "Your question here"
|
80 |
+
}
|
81 |
+
```
|
82 |
+
|
83 |
+
### CLI Commands
|
84 |
+
|
85 |
+
The CLI provides several commands to interact with the Nurse LLM. Below are the available commands:
|
86 |
+
|
87 |
+
- `start`: Start the CLI session.
|
88 |
+
- `help`: Display help information about the CLI commands.
|
89 |
+
- `exit`: Exit the CLI session.
|
90 |
+
|
91 |
+
### Example Usage
|
92 |
+
|
93 |
+
To start the CLI session, simply run:
|
94 |
+
|
95 |
+
```sh
|
96 |
+
python cli.py
|
97 |
+
```
|
98 |
+
|
99 |
+
Once the CLI is running, you can use the following commands:
|
100 |
+
|
101 |
+
- To start interacting with the nurse LLM:
|
102 |
+
|
103 |
+
```sh
|
104 |
+
start
|
105 |
+
```
|
106 |
+
|
107 |
+
- To display help information:
|
108 |
+
|
109 |
+
```sh
|
110 |
+
help
|
111 |
+
```
|
112 |
+
|
113 |
+
- To exit the CLI session:
|
114 |
+
|
115 |
+
```sh
|
116 |
+
exit
|
117 |
+
```
|