main.py 11 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
18
from starlette.responses import StreamingResponse
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
        return_citations = False

107
108
109
        if request.method == "POST" and (
            "/api/chat" in request.url.path or "/chat/completions" in request.url.path
        ):
110
            log.debug(f"request.url.path: {request.url.path}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
111

Timothy J. Baek's avatar
Timothy J. Baek committed
112
113
114
115
116
117
118
            # 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 {}

119
120
121
122
            return_citations = data.get("citations", False)
            if "citations" in data:
                del data["citations"]

Timothy J. Baek's avatar
Timothy J. Baek committed
123
124
125
            # 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
126
                data = {**data}
127
                data["messages"], citations = rag_messages(
Timothy J. Baek's avatar
Timothy J. Baek committed
128
129
130
131
132
133
134
135
                    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
136
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
137
138
                del data["docs"]

139
140
141
                log.debug(
                    f"data['messages']: {data['messages']}, citations: {citations}"
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
142

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

Timothy J. Baek's avatar
Timothy J. Baek committed
145
146
147
148
149
150
151
152
153
154
155
156
            # 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
157
158

        response = await call_next(request)
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

        if return_citations:
            # Inject the citations into the response
            if isinstance(response, StreamingResponse):
                # If it's a streaming response, inject it as SSE event or NDJSON line
                content_type = response.headers.get("Content-Type")
                if "text/event-stream" in content_type:
                    return StreamingResponse(
                        self.openai_stream_wrapper(response.body_iterator, citations),
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
                        self.ollama_stream_wrapper(response.body_iterator, citations),
                    )

Timothy J. Baek's avatar
Timothy J. Baek committed
174
175
176
177
178
        return response

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

179
180
181
182
183
184
185
186
187
188
    async def openai_stream_wrapper(self, original_generator, citations):
        yield f"data: {json.dumps({'citations': citations})}\n\n"
        async for data in original_generator:
            yield data

    async def ollama_stream_wrapper(self, original_generator, citations):
        yield f"{json.dumps({'citations': citations})}\n"
        async for data in original_generator:
            yield data

Timothy J. Baek's avatar
Timothy J. Baek committed
189
190
191
192

app.add_middleware(RAGMiddleware)


Timothy J. Baek's avatar
Timothy J. Baek committed
193
194
195
196
197
198
199
200
201
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
202
203
204
205
206
207
208
209
210
211
@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
212
213
@app.on_event("startup")
async def on_startup():
214
215
    if ENABLE_LITELLM:
        asyncio.create_task(start_litellm_background())
Timothy J. Baek's avatar
Timothy J. Baek committed
216
217


218
app.mount("/api/v1", webui_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
219
220
app.mount("/litellm/api", litellm_app)

221
app.mount("/ollama", ollama_app)
222
app.mount("/openai/api", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
223

Timothy J. Baek's avatar
Timothy J. Baek committed
224
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
225
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
226
227
app.mount("/rag/api/v1", rag_app)

228

Timothy J. Baek's avatar
Timothy J. Baek committed
229
230
@app.get("/api/config")
async def get_app_config():
231
    # Checking and Handling the Absence of 'ui' in CONFIG_DATA
232
233

    default_locale = "en-US"
234
235
236
237
    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
238
239
    return {
        "status": True,
240
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
241
        "version": VERSION,
242
        "default_locale": default_locale,
Timothy J. Baek's avatar
Timothy J. Baek committed
243
244
        "images": images_app.state.ENABLED,
        "default_models": webui_app.state.DEFAULT_MODELS,
245
        "default_prompt_suggestions": webui_app.state.DEFAULT_PROMPT_SUGGESTIONS,
246
        "trusted_header_auth": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
247
        "admin_export_enabled": ENABLE_ADMIN_EXPORT,
Timothy J. Baek's avatar
Timothy J. Baek committed
248
249
250
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
251
252
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
253
    return {
Timothy J. Baek's avatar
Timothy J. Baek committed
254
        "enabled": app.state.ENABLE_MODEL_FILTER,
255
256
        "models": app.state.MODEL_FILTER_LIST,
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
257
258
259
260
261
262
263
264


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
265
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
266
267
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
Timothy J. Baek committed
268
    app.state.ENABLE_MODEL_FILTER = form_data.enabled
269
    app.state.MODEL_FILTER_LIST = form_data.models
Timothy J. Baek's avatar
Timothy J. Baek committed
270

Timothy J. Baek's avatar
Timothy J. Baek committed
271
    ollama_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
272
    ollama_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
273

Timothy J. Baek's avatar
Timothy J. Baek committed
274
    openai_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
275
    openai_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
276

Timothy J. Baek's avatar
Timothy J. Baek committed
277
    litellm_app.state.ENABLE_MODEL_FILTER = app.state.ENABLE_MODEL_FILTER
278
279
    litellm_app.state.MODEL_FILTER_LIST = app.state.MODEL_FILTER_LIST

280
    return {
Timothy J. Baek's avatar
Timothy J. Baek committed
281
        "enabled": app.state.ENABLE_MODEL_FILTER,
282
283
        "models": app.state.MODEL_FILTER_LIST,
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
284
285


Timothy J. Baek's avatar
Timothy J. Baek committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
@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,
    }


308
309
310
311
312
313
314
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
315
316
@app.get("/api/changelog")
async def get_app_changelog():
317
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
318
319


320
321
322
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
323
324
325
326
327
328
329
330
331
332
        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:
333
334
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
335
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
336
337
        )

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

339
340
341
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
342
343
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
344
345
346
347
348
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "theme_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
349
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
350
351
    }

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

353
354
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
355

356
357
358
359
360
361
362
363
364
365
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."
    )
366
367
368
369


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