Iyeoluwa Akinrinola
91 lines
2.2 KiB
Markdown
91 lines
2.2 KiB
Markdown
# OpenWebUI Backend Service
|
|
|
|
A backend service for OpenWebUI that provides OpenWebUI-compatible API endpoints for chat functionality and model switching.
|
|
|
|
## Features
|
|
|
|
- OpenWebUI-compatible API endpoints
|
|
- Ollama API proxy
|
|
- Chat functionality with model switching
|
|
- Support for multiple LLM models (gemma3, llama3.3, llama3.1, mistral, deepseek)
|
|
|
|
## Technology Stack
|
|
|
|
- **Backend**: FastAPI
|
|
- **Chat Models**: Ollama models via OpenWebUI
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
ai_service/
|
|
├── models/ # Model and chat services
|
|
│ ├── model_service.py
|
|
│ ├── chat_service.py
|
|
│ └── model_parameters.py
|
|
├── embeddings/ # Document processing for RAG
|
|
│ └── document_service.py
|
|
├── openwebui_api.py # OpenWebUI-compatible API endpoints
|
|
├── config.py # Configuration settings
|
|
├── api.py # FastAPI application
|
|
└── deploy.sh # Deployment script
|
|
run_ai_service.py # Script to run the service
|
|
deploy_ai_service.sh # Local deployment script
|
|
remote_deploy.sh # Remote deployment script
|
|
```
|
|
|
|
## Setup Instructions
|
|
|
|
1. Create a virtual environment:
|
|
```
|
|
python -m venv venv
|
|
source venv/bin/activate # On Windows: venv\Scripts\activate
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. Copy `.env.example` to `.env` and update the values:
|
|
```
|
|
cp ai_service/.env.example ai_service/.env
|
|
# Edit the .env file with appropriate values
|
|
```
|
|
|
|
4. Run the service:
|
|
```
|
|
python run_ai_service.py
|
|
```
|
|
|
|
## Deployment
|
|
|
|
To deploy the service:
|
|
|
|
1. Local deployment:
|
|
```
|
|
./deploy_ai_service.sh
|
|
```
|
|
|
|
2. Remote deployment:
|
|
```
|
|
./remote_deploy.sh [server_ip] [user] [port] [remote_dir]
|
|
```
|
|
|
|
## API Documentation
|
|
|
|
Once the service is running, you can access the API documentation at:
|
|
- Swagger UI: http://localhost:5252/docs
|
|
- ReDoc: http://localhost:5252/redoc
|
|
|
|
## OpenWebUI Configuration
|
|
|
|
To configure OpenWebUI to use this service as its backend:
|
|
|
|
1. Set the following environment variables in OpenWebUI:
|
|
```
|
|
OLLAMA_API_BASE_URL=http://your-server-ip:5252/ollama
|
|
OPENAI_API_BASE_URL=http://your-server-ip:5252/api
|
|
```
|
|
|
|
2. Restart OpenWebUI to apply the changes.
|