Skip to content

Commit 28b9207

Browse files
committed
Updated README
1 parent b3b0993 commit 28b9207

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

safe_infer_chatbot_app/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ Then open your browser to `http://localhost:8501`
5151
```bash
5252
export PEBBLO_API_KEY="pebblo-api-key"
5353
export PROXIMA_HOST="http://your-proxima-host"
54+
export MODEL="model-name"
55+
export X_PEBBLO_USER="user-email"
56+
export MODEL_NAME="model-display-name"
5457
```
5558

5659
4. **Run the application**:
@@ -66,31 +69,26 @@ Then open your browser to `http://localhost:8501`
6669

6770
- `PROXIMA_HOST`: Base URL for the SafeInfer API (default: `http://localhost`)
6871
- `PEBBLO_API_KEY`: Pebblo API Key
72+
- `MODEL`: Model Name
73+
- `MODEL_NAME`: Model Display Name
74+
- `X_PEBBLO_USER`: User Email
6975

7076
### API Configuration
7177

7278
The application automatically configures the following endpoints:
7379
- **Responses**: `{PROXIMA_HOST}/safe_infer/llm/v1/responses`
7480
- **Health Check**: `{PROXIMA_HOST}/safe_infer/healthz`
7581

76-
### Available Models
77-
78-
- `gpt-4o-mini`: Faster, more cost-effective model
79-
- `gpt-4o`: Full GPT-4o model with enhanced capabilities
80-
8182
## 📖 Usage Guide
8283

8384
### Starting a Conversation
8485

85-
1. **Select a Model**: Choose your preferred model from the sidebar
86-
2. **Enter API Key** (if required): Add your API key in the configuration section
87-
3. **Test Connection**: Use the "Test API Connection" button to verify connectivity
88-
4. **Start Chatting**: Type your message and click "Send" or press Enter
86+
1. **Test Connection**: Use the "Test API Connection" button to verify connectivity
87+
2. **Start Chatting**: Type your message and click "Send" or press Enter
8988

9089
### Chat Features
9190

9291
- **Send Messages**: Type in the text area and click "🚀 Send"
93-
- **Regenerate Responses**: Click "🔄 Regenerate Last Response" to get a new AI response
9492
- **Clear History**: Use "Clear Chat History" to start fresh
9593
- **Export Chat**: Download your conversation as a JSON file
9694

0 commit comments

Comments
 (0)