main.py 9.62 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
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
29
30
from apps.images.main import app as images_app
from apps.rag.main import app as rag_app
31
from apps.web.main import app as webui_app
Timothy J. Baek's avatar
Timothy J. Baek committed
32

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

Timothy J. Baek's avatar
Timothy J. Baek committed
37
38

from utils.utils import get_admin_user
Timothy J. Baek's avatar
Timothy J. Baek committed
39
from apps.rag.utils import rag_messages
Timothy J. Baek's avatar
Timothy J. Baek committed
40

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

60
61
62
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
63

64

Timothy J. Baek's avatar
Timothy J. Baek committed
65
66
67
68
69
70
71
72
73
74
75
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
print(
    f"""
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __   \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \   \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |   \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|    \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
93
app.state.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
94
app.state.MODEL_FILTER_LIST = MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
95

Timothy J. Baek's avatar
Timothy J. Baek committed
96
97
app.state.WEBHOOK_URL = WEBHOOK_URL

Timothy J. Baek's avatar
Timothy J. Baek committed
98
99
origins = ["*"]

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
108
109
110
111
112
113
114
115
116
117
            # 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
118
119
                data = {**data}
                data["messages"] = rag_messages(
Timothy J. Baek's avatar
Timothy J. Baek committed
120
121
122
123
124
125
126
127
                    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
128
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
129
130
                del data["docs"]

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
135
136
137
138
139
140
141
142
143
144
145
146
            # 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
147
148
149
150
151
152
153
154
155
156
157

        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
158
159
160
161
162
163
164
165
166
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
167
168
169
170
171
172
173
174
175
176
@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
177
178
@app.on_event("startup")
async def on_startup():
179
180
    if ENABLE_LITELLM:
        asyncio.create_task(start_litellm_background())
Timothy J. Baek's avatar
Timothy J. Baek committed
181
182


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

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

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

193

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

    default_locale = "en-US"
199
200
201
202
    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
203
204
    return {
        "status": True,
205
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
206
        "version": VERSION,
207
        "default_locale": default_locale,
Timothy J. Baek's avatar
Timothy J. Baek committed
208
209
        "images": images_app.state.ENABLED,
        "default_models": webui_app.state.DEFAULT_MODELS,
210
        "default_prompt_suggestions": webui_app.state.DEFAULT_PROMPT_SUGGESTIONS,
211
        "trusted_header_auth": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
212
        "admin_export_enabled": ENABLE_ADMIN_EXPORT,
Timothy J. Baek's avatar
Timothy J. Baek committed
213
214
215
    }


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


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


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

Timothy J. Baek's avatar
Timothy J. Baek committed
236
    ollama_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
237
    ollama_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
238

Timothy J. Baek's avatar
Timothy J. Baek committed
239
    openai_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
240
    openai_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
241

Timothy J. Baek's avatar
Timothy J. Baek committed
242
    litellm_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
243
244
    litellm_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST

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


Timothy J. Baek's avatar
Timothy J. Baek committed
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
@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,
    }


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


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


285
286
287
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
288
289
290
291
292
293
294
295
296
297
        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:
298
299
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
300
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
301
302
        )

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

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

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

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

321
322
323
324
325
326
327
328
329
330
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."
    )
331
332
333
334


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