main.py 9.63 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
from bs4 import BeautifulSoup
import json
import markdown
4
import time
Timothy J. Baek's avatar
Timothy J. Baek committed
5
6
import os
import sys
7
import logging
Timothy J. Baek's avatar
Timothy J. Baek committed
8
import aiohttp
9
import requests
Timothy J. Baek's avatar
Timothy J. Baek committed
10

11
from fastapi import FastAPI, Request, Depends, status
Timothy J. Baek's avatar
Timothy J. Baek committed
12
13
14
15
from fastapi.staticfiles import StaticFiles
from fastapi import HTTPException
from fastapi.middleware.wsgi import WSGIMiddleware
from fastapi.middleware.cors import CORSMiddleware
16
from starlette.exceptions import HTTPException as StarletteHTTPException
Timothy J. Baek's avatar
Timothy J. Baek committed
17
from starlette.middleware.base import BaseHTTPMiddleware
Timothy J. Baek's avatar
Timothy J. Baek committed
18

Timothy J. Baek's avatar
Timothy J. Baek committed
19

Timothy J. Baek's avatar
Timothy J. Baek committed
20
from apps.ollama.main import app as ollama_app
21
from apps.openai.main import app as openai_app
Timothy J. Baek's avatar
Timothy J. Baek committed
22

23
24
25
26
27
from apps.litellm.main import (
    app as litellm_app,
    start_litellm_background,
    shutdown_litellm_background,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
28
29


Timothy J. Baek's avatar
Timothy J. Baek committed
30
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
31
32
from apps.images.main import app as images_app
from apps.rag.main import app as rag_app
33
from apps.web.main import app as webui_app
Timothy J. Baek's avatar
Timothy J. Baek committed
34

Timothy J. Baek's avatar
Timothy J. Baek committed
35
import asyncio
Timothy J. Baek's avatar
Timothy J. Baek committed
36
37
from pydantic import BaseModel
from typing import List
Timothy J. Baek's avatar
Timothy J. Baek committed
38

Timothy J. Baek's avatar
Timothy J. Baek committed
39
40

from utils.utils import get_admin_user
Timothy J. Baek's avatar
Timothy J. Baek committed
41
from apps.rag.utils import rag_messages
Timothy J. Baek's avatar
Timothy J. Baek committed
42

43
from config import (
44
    CONFIG_DATA,
45
46
47
48
49
    WEBUI_NAME,
    ENV,
    VERSION,
    CHANGELOG,
    FRONTEND_BUILD_DIR,
50
51
    CACHE_DIR,
    STATIC_DIR,
52
    ENABLE_LITELLM,
Timothy J. Baek's avatar
Timothy J. Baek committed
53
    ENABLE_MODEL_FILTER,
54
    MODEL_FILTER_LIST,
55
56
    GLOBAL_LOG_LEVEL,
    SRC_LOG_LEVELS,
Timothy J. Baek's avatar
Timothy J. Baek committed
57
    WEBHOOK_URL,
58
    ENABLE_ADMIN_EXPORT,
59
)
60
61
from constants import ERROR_MESSAGES

62
63
64
logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MAIN"])
Timothy J. Baek's avatar
Timothy J. Baek committed
65

66

Timothy J. Baek's avatar
Timothy J. Baek committed
67
68
69
70
71
72
73
74
75
76
77
class SPAStaticFiles(StaticFiles):
    async def get_response(self, path: str, scope):
        try:
            return await super().get_response(path, scope)
        except (HTTPException, StarletteHTTPException) as ex:
            if ex.status_code == 404:
                return await super().get_response("index.html", scope)
            else:
                raise ex


Timothy J. Baek's avatar
Timothy J. Baek committed
78
print(
Timothy J. Baek's avatar
Timothy J. Baek committed
79
    rf"""
Timothy J. Baek's avatar
Timothy J. Baek committed
80
81
82
83
84
85
86
87
88
89
90
91
92
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __   \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \   \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |   \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|    \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

      
v{VERSION} - building the best open-source AI user interface.      
https://github.com/open-webui/open-webui
"""
)

93
app = FastAPI(docs_url="/docs" if ENV == "dev" else None, redoc_url=None)
Timothy J. Baek's avatar
Timothy J. Baek committed
94

Timothy J. Baek's avatar
Timothy J. Baek committed
95
app.state.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
96
app.state.MODEL_FILTER_LIST = MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
97

Timothy J. Baek's avatar
Timothy J. Baek committed
98
99
app.state.WEBHOOK_URL = WEBHOOK_URL

Timothy J. Baek's avatar
Timothy J. Baek committed
100
101
origins = ["*"]

Timothy J. Baek's avatar
Timothy J. Baek committed
102

Timothy J. Baek's avatar
Timothy J. Baek committed
103
104
class RAGMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
105
106
107
        if request.method == "POST" and (
            "/api/chat" in request.url.path or "/chat/completions" in request.url.path
        ):
108
            log.debug(f"request.url.path: {request.url.path}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
109

Timothy J. Baek's avatar
Timothy J. Baek committed
110
111
112
113
114
115
116
117
118
119
            # Read the original request body
            body = await request.body()
            # Decode body to string
            body_str = body.decode("utf-8")
            # Parse string to JSON
            data = json.loads(body_str) if body_str else {}

            # Example: Add a new key-value pair or modify existing ones
            # data["modified"] = True  # Example modification
            if "docs" in data:
Timothy J. Baek's avatar
Timothy J. Baek committed
120
121
                data = {**data}
                data["messages"] = rag_messages(
Timothy J. Baek's avatar
Timothy J. Baek committed
122
123
124
125
126
127
128
129
                    docs=data["docs"],
                    messages=data["messages"],
                    template=rag_app.state.RAG_TEMPLATE,
                    embedding_function=rag_app.state.EMBEDDING_FUNCTION,
                    k=rag_app.state.TOP_K,
                    reranking_function=rag_app.state.sentence_transformer_rf,
                    r=rag_app.state.RELEVANCE_THRESHOLD,
                    hybrid_search=rag_app.state.ENABLE_RAG_HYBRID_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
130
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
131
132
                del data["docs"]

133
                log.debug(f"data['messages']: {data['messages']}")
Timothy J. Baek's avatar
Timothy J. Baek committed
134

Timothy J. Baek's avatar
Timothy J. Baek committed
135
136
            modified_body_bytes = json.dumps(data).encode("utf-8")

Timothy J. Baek's avatar
Timothy J. Baek committed
137
138
139
140
141
142
143
144
145
146
147
148
            # Replace the request body with the modified one
            request._body = modified_body_bytes

            # Set custom header to ensure content-length matches new body length
            request.headers.__dict__["_list"] = [
                (b"content-length", str(len(modified_body_bytes)).encode("utf-8")),
                *[
                    (k, v)
                    for k, v in request.headers.raw
                    if k.lower() != b"content-length"
                ],
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
149
150
151
152
153
154
155
156
157
158
159

        response = await call_next(request)
        return response

    async def _receive(self, body: bytes):
        return {"type": "http.request", "body": body, "more_body": False}


app.add_middleware(RAGMiddleware)


Timothy J. Baek's avatar
Timothy J. Baek committed
160
161
162
163
164
165
166
167
168
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
169
170
171
172
173
174
175
176
177
178
@app.middleware("http")
async def check_url(request: Request, call_next):
    start_time = int(time.time())
    response = await call_next(request)
    process_time = int(time.time()) - start_time
    response.headers["X-Process-Time"] = str(process_time)

    return response


Timothy J. Baek's avatar
Timothy J. Baek committed
179
180
@app.on_event("startup")
async def on_startup():
181
182
    if ENABLE_LITELLM:
        asyncio.create_task(start_litellm_background())
Timothy J. Baek's avatar
Timothy J. Baek committed
183
184


185
app.mount("/api/v1", webui_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
186
187
app.mount("/litellm/api", litellm_app)

188
app.mount("/ollama", ollama_app)
189
app.mount("/openai/api", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
190

Timothy J. Baek's avatar
Timothy J. Baek committed
191
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
192
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
193
194
app.mount("/rag/api/v1", rag_app)

195

Timothy J. Baek's avatar
Timothy J. Baek committed
196
197
@app.get("/api/config")
async def get_app_config():
198
    # Checking and Handling the Absence of 'ui' in CONFIG_DATA
199
200

    default_locale = "en-US"
201
202
203
204
    if "ui" in CONFIG_DATA:
        default_locale = CONFIG_DATA["ui"].get("default_locale", "en-US")

    # The Rest of the Function Now Uses the Variables Defined Above
Timothy J. Baek's avatar
Timothy J. Baek committed
205
206
    return {
        "status": True,
207
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
208
        "version": VERSION,
209
        "default_locale": default_locale,
Timothy J. Baek's avatar
Timothy J. Baek committed
210
211
        "images": images_app.state.ENABLED,
        "default_models": webui_app.state.DEFAULT_MODELS,
212
        "default_prompt_suggestions": webui_app.state.DEFAULT_PROMPT_SUGGESTIONS,
213
        "trusted_header_auth": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
214
        "admin_export_enabled": ENABLE_ADMIN_EXPORT,
Timothy J. Baek's avatar
Timothy J. Baek committed
215
216
217
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
218
219
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
220
    return {
Timothy J. Baek's avatar
Timothy J. Baek committed
221
        "enabled": app.state.ENABLE_MODEL_FILTER,
222
223
        "models": app.state.MODEL_FILTER_LIST,
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
224
225
226
227
228
229
230
231


class ModelFilterConfigForm(BaseModel):
    enabled: bool
    models: List[str]


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
232
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
233
234
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
Timothy J. Baek committed
235
    app.state.ENABLE_MODEL_FILTER = form_data.enabled
236
    app.state.MODEL_FILTER_LIST = form_data.models
Timothy J. Baek's avatar
Timothy J. Baek committed
237

Timothy J. Baek's avatar
Timothy J. Baek committed
238
    ollama_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
239
    ollama_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
240

Timothy J. Baek's avatar
Timothy J. Baek committed
241
    openai_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
242
    openai_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
243

Timothy J. Baek's avatar
Timothy J. Baek committed
244
    litellm_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
245
246
    litellm_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST

247
    return {
Timothy J. Baek's avatar
Timothy J. Baek committed
248
        "enabled": app.state.ENABLE_MODEL_FILTER,
249
250
        "models": app.state.MODEL_FILTER_LIST,
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
251
252


Timothy J. Baek's avatar
Timothy J. Baek committed
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
        "url": app.state.WEBHOOK_URL,
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
    app.state.WEBHOOK_URL = form_data.url

    webui_app.state.WEBHOOK_URL = app.state.WEBHOOK_URL

    return {
        "url": app.state.WEBHOOK_URL,
    }


275
276
277
278
279
280
281
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
282
283
@app.get("/api/changelog")
async def get_app_changelog():
284
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
285
286


287
288
289
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
290
291
292
293
294
295
296
297
298
299
        async with aiohttp.ClientSession() as session:
            async with session.get(
                "https://api.github.com/repos/open-webui/open-webui/releases/latest"
            ) as response:
                response.raise_for_status()
                data = await response.json()
                latest_version = data["tag_name"]

                return {"current": VERSION, "latest": latest_version[1:]}
    except aiohttp.ClientError as e:
300
301
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
302
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
303
304
        )

Timothy J. Baek's avatar
Timothy J. Baek committed
305

306
307
308
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
309
310
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
311
312
313
314
315
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "theme_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
316
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
317
318
    }

Timothy J. Baek's avatar
Timothy J. Baek committed
319

320
321
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
322

323
324
325
326
327
328
329
330
331
332
if os.path.exists(FRONTEND_BUILD_DIR):
    app.mount(
        "/",
        SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
        name="spa-static-files",
    )
else:
    log.warning(
        f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
    )
333
334
335
336


@app.on_event("shutdown")
async def shutdown_event():
337
338
    if ENABLE_LITELLM:
        await shutdown_litellm_background()