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

13
from fastapi import FastAPI, Request, Depends, status
Timothy J. Baek's avatar
Timothy J. Baek committed
14
from fastapi.staticfiles import StaticFiles
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
15
from fastapi.responses import JSONResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
16
17
18
from fastapi import HTTPException
from fastapi.middleware.wsgi import WSGIMiddleware
from fastapi.middleware.cors import CORSMiddleware
19
from starlette.exceptions import HTTPException as StarletteHTTPException
Timothy J. Baek's avatar
Timothy J. Baek committed
20
from starlette.middleware.base import BaseHTTPMiddleware
21
from starlette.responses import StreamingResponse, Response
Timothy J. Baek's avatar
Timothy J. Baek committed
22

23
24
from apps.ollama.main import app as ollama_app, get_all_models as get_ollama_models
from apps.openai.main import app as openai_app, get_all_models as get_openai_models
Timothy J. Baek's avatar
Timothy J. Baek committed
25

Timothy J. Baek's avatar
Timothy J. Baek committed
26
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
27
28
from apps.images.main import app as images_app
from apps.rag.main import app as rag_app
29
from apps.webui.main import app as webui_app
Timothy J. Baek's avatar
Timothy J. Baek committed
30

Timothy J. Baek's avatar
Timothy J. Baek committed
31
import asyncio
Timothy J. Baek's avatar
Timothy J. Baek committed
32
from pydantic import BaseModel
33
from typing import List, Optional
Timothy J. Baek's avatar
Timothy J. Baek committed
34

35
from apps.webui.models.models import Models, ModelModel
36
37
38
39
40
41
from utils.utils import (
    get_admin_user,
    get_verified_user,
    get_current_user,
    get_http_authorization_cred,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
42
from apps.rag.utils import rag_messages
Timothy J. Baek's avatar
Timothy J. Baek committed
43

44
from config import (
45
    CONFIG_DATA,
46
    WEBUI_NAME,
47
    WEBUI_URL,
48
    WEBUI_AUTH,
49
50
51
52
    ENV,
    VERSION,
    CHANGELOG,
    FRONTEND_BUILD_DIR,
53
54
    CACHE_DIR,
    STATIC_DIR,
55
56
    ENABLE_OPENAI_API,
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
Timothy J. Baek committed
57
    ENABLE_MODEL_FILTER,
58
    MODEL_FILTER_LIST,
59
60
    GLOBAL_LOG_LEVEL,
    SRC_LOG_LEVELS,
Timothy J. Baek's avatar
Timothy J. Baek committed
61
    WEBHOOK_URL,
62
    ENABLE_ADMIN_EXPORT,
63
    RAG_WEB_SEARCH_ENABLED,
64
    AppConfig,
65
    WEBUI_BUILD_HASH,
66
)
67
68
from constants import ERROR_MESSAGES

69
70
71
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
72

73

Timothy J. Baek's avatar
Timothy J. Baek committed
74
75
76
77
78
79
80
81
82
83
84
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
85
print(
Timothy J. Baek's avatar
Timothy J. Baek committed
86
    rf"""
Timothy J. Baek's avatar
Timothy J. Baek committed
87
88
89
90
91
92
93
94
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __   \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \   \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |   \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|    \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

      
95
v{VERSION} - building the best open-source AI user interface.
96
{f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
Timothy J. Baek's avatar
Timothy J. Baek committed
97
98
99
100
https://github.com/open-webui/open-webui
"""
)

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

102
103
104
105
106
107
108
109
@asynccontextmanager
async def lifespan(app: FastAPI):
    yield


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

111
app.state.config = AppConfig()
112
113
114
115

app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API

116
117
app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
Timothy J. Baek's avatar
Timothy J. Baek committed
118

119

120
app.state.config.WEBHOOK_URL = WEBHOOK_URL
Timothy J. Baek's avatar
Timothy J. Baek committed
121

Timothy J. Baek's avatar
Timothy J. Baek committed
122
123
124

app.state.MODELS = {}

Timothy J. Baek's avatar
Timothy J. Baek committed
125
126
origins = ["*"]

Timothy J. Baek's avatar
Timothy J. Baek committed
127
# Custom middleware to add security headers
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
128
129
130
131
132
133
# class SecurityHeadersMiddleware(BaseHTTPMiddleware):
#     async def dispatch(self, request: Request, call_next):
#         response: Response = await call_next(request)
#         response.headers["Cross-Origin-Opener-Policy"] = "same-origin"
#         response.headers["Cross-Origin-Embedder-Policy"] = "require-corp"
#         return response
Timothy J. Baek's avatar
Timothy J. Baek committed
134
135


Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
136
# app.add_middleware(SecurityHeadersMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
137
138


Timothy J. Baek's avatar
Timothy J. Baek committed
139
140
class RAGMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
141
142
        return_citations = False

143
        if request.method == "POST" and (
144
145
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
146
        ):
147
            log.debug(f"request.url.path: {request.url.path}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
148

Timothy J. Baek's avatar
Timothy J. Baek committed
149
150
151
152
153
154
155
            # 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 {}

156
157
158
159
            return_citations = data.get("citations", False)
            if "citations" in data:
                del data["citations"]

Timothy J. Baek's avatar
Timothy J. Baek committed
160
161
162
            # 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
163
                data = {**data}
164
                data["messages"], citations = rag_messages(
Timothy J. Baek's avatar
Timothy J. Baek committed
165
166
                    docs=data["docs"],
                    messages=data["messages"],
Jun Siang Cheah's avatar
Jun Siang Cheah committed
167
                    template=rag_app.state.config.RAG_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
168
                    embedding_function=rag_app.state.EMBEDDING_FUNCTION,
169
                    k=rag_app.state.config.TOP_K,
Timothy J. Baek's avatar
Timothy J. Baek committed
170
                    reranking_function=rag_app.state.sentence_transformer_rf,
Jun Siang Cheah's avatar
Jun Siang Cheah committed
171
172
                    r=rag_app.state.config.RELEVANCE_THRESHOLD,
                    hybrid_search=rag_app.state.config.ENABLE_RAG_HYBRID_SEARCH,
Timothy J. Baek's avatar
Timothy J. Baek committed
173
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
174
175
                del data["docs"]

176
177
178
                log.debug(
                    f"data['messages']: {data['messages']}, citations: {citations}"
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
179

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

Timothy J. Baek's avatar
Timothy J. Baek committed
182
183
184
185
186
187
188
189
190
191
192
193
            # 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
194
195

        response = await call_next(request)
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

        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
211
212
213
214
215
        return response

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

216
217
218
219
220
221
222
223
224
225
    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
226
227
228
229

app.add_middleware(RAGMiddleware)


Timothy J. Baek's avatar
Timothy J. Baek committed
230
231
232
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
233
234
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
235
236
237
238
239
240
241
242
243
244
245
        ):
            log.debug(f"request.url.path: {request.url.path}")

            # 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 {}

            model_id = data["model"]
246
            filters = [
Timothy J. Baek's avatar
Timothy J. Baek committed
247
248
249
                model
                for model in app.state.MODELS.values()
                if "pipeline" in model
Timothy J. Baek's avatar
Timothy J. Baek committed
250
                and "type" in model["pipeline"]
251
                and model["pipeline"]["type"] == "filter"
252
253
254
                and (
                    model["pipeline"]["pipelines"] == ["*"]
                    or any(
255
256
                        model_id == target_model_id
                        for target_model_id in model["pipeline"]["pipelines"]
257
258
                    )
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
259
            ]
260
            sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])
Timothy J. Baek's avatar
Timothy J. Baek committed
261

262
            user = None
263
            if len(sorted_filters) > 0:
264
265
266
267
268
269
270
271
272
273
                try:
                    user = get_current_user(
                        get_http_authorization_cred(
                            request.headers.get("Authorization")
                        )
                    )
                    user = {"id": user.id, "name": user.name, "role": user.role}
                except:
                    pass

274
            for filter in sorted_filters:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
275
                r = None
Timothy J. Baek's avatar
Timothy J. Baek committed
276
                try:
277
                    urlIdx = filter["urlIdx"]
Timothy J. Baek's avatar
Timothy J. Baek committed
278
279
280
281
282
283
284

                    url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
                    key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]

                    if key != "":
                        headers = {"Authorization": f"Bearer {key}"}
                        r = requests.post(
Timothy J. Baek's avatar
Timothy J. Baek committed
285
                            f"{url}/{filter['id']}/filter/inlet",
Timothy J. Baek's avatar
Timothy J. Baek committed
286
287
                            headers=headers,
                            json={
288
                                "user": user,
Timothy J. Baek's avatar
Timothy J. Baek committed
289
290
291
292
293
294
295
296
                                "body": data,
                            },
                        )

                        r.raise_for_status()
                        data = r.json()
                except Exception as e:
                    # Handle connection error here
297
                    print(f"Connection error: {e}")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311

                    if r is not None:
                        try:
                            res = r.json()
                            if "detail" in res:
                                return JSONResponse(
                                    status_code=r.status_code,
                                    content=res,
                                )
                        except:
                            pass

                    else:
                        pass
Timothy J. Baek's avatar
Timothy J. Baek committed
312

313
314
315
            if "chat_id" in data:
                del data["chat_id"]

Timothy J. Baek's avatar
Timothy J. Baek committed
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
            modified_body_bytes = json.dumps(data).encode("utf-8")
            # 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"
                ],
            ]

        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(PipelineMiddleware)


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
339
340
341
342
343
344
345
346
347
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
348
349
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
350
351
352
353
354
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
355
356
357
358
359
360
361
362
    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
363
364
365
366
367
368
@app.middleware("http")
async def update_embedding_function(request: Request, call_next):
    response = await call_next(request)
    if "/embedding/update" in request.url.path:
        webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION
    return response
Timothy J. Baek's avatar
Timothy J. Baek committed
369

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

371
app.mount("/ollama", ollama_app)
372
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
373

Timothy J. Baek's avatar
Timothy J. Baek committed
374
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
375
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
376
377
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
378
379
380
381
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

382

Timothy J. Baek's avatar
Timothy J. Baek committed
383
async def get_all_models():
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    openai_models = []
    ollama_models = []

    if app.state.config.ENABLE_OPENAI_API:
        openai_models = await get_openai_models()

        openai_models = openai_models["data"]

    if app.state.config.ENABLE_OLLAMA_API:
        ollama_models = await get_ollama_models()

        ollama_models = [
            {
                "id": model["model"],
                "name": model["name"],
                "object": "model",
                "created": int(time.time()),
                "owned_by": "ollama",
                "ollama": model,
            }
            for model in ollama_models["models"]
        ]

    models = openai_models + ollama_models
    custom_models = Models.get_all_models()

    for custom_model in custom_models:
        if custom_model.base_model_id == None:
            for model in models:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
413
414
415
416
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
417
418
419
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
420
421
            owned_by = "openai"
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
422
423
424
425
                if (
                    custom_model.base_model_id == model["id"]
                    or custom_model.base_model_id == model["id"].split(":")[0]
                ):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
426
427
428
                    owned_by = model["owned_by"]
                    break

429
430
431
432
433
434
            models.append(
                {
                    "id": custom_model.id,
                    "name": custom_model.name,
                    "object": "model",
                    "created": custom_model.created_at,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
435
                    "owned_by": owned_by,
436
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
437
                    "preset": True,
438
439
440
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
441
442
443
444
445
446
447
448
449
450
    app.state.MODELS = {model["id"]: model for model in models}

    webui_app.state.MODELS = app.state.MODELS

    return models


@app.get("/api/models")
async def get_models(user=Depends(get_verified_user)):
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
451

452
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
453
454
455
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
456
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
457
458
    ]

459
460
461
462
463
464
465
466
467
468
469
470
471
    if app.state.config.ENABLE_MODEL_FILTER:
        if user.role == "user":
            models = list(
                filter(
                    lambda model: model["id"] in app.state.config.MODEL_FILTER_LIST,
                    models,
                )
            )
            return {"data": models}

    return {"data": models}


472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
@app.post("/api/chat/completed")
async def chat_completed(form_data: dict, user=Depends(get_verified_user)):
    data = form_data
    model_id = data["model"]

    filters = [
        model
        for model in app.state.MODELS.values()
        if "pipeline" in model
        and "type" in model["pipeline"]
        and model["pipeline"]["type"] == "filter"
        and (
            model["pipeline"]["pipelines"] == ["*"]
            or any(
                model_id == target_model_id
                for target_model_id in model["pipeline"]["pipelines"]
            )
        )
    ]
    sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])

    for filter in sorted_filters:
        r = None
        try:
            urlIdx = filter["urlIdx"]

            url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
            key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]

            if key != "":
                headers = {"Authorization": f"Bearer {key}"}
                r = requests.post(
                    f"{url}/{filter['id']}/filter/outlet",
                    headers=headers,
                    json={
                        "user": {"id": user.id, "name": user.name, "role": user.role},
                        "body": data,
                    },
                )

                r.raise_for_status()
                data = r.json()
        except Exception as e:
            # Handle connection error here
            print(f"Connection error: {e}")

            if r is not None:
                try:
                    res = r.json()
                    if "detail" in res:
                        return JSONResponse(
                            status_code=r.status_code,
                            content=res,
                        )
                except:
                    pass

            else:
                pass

    return data


535
536
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
537
538
539
540
    responses = await get_openai_models(raw=True)

    print(responses)
    urlIdxs = [idx for idx, response in enumerate(responses) if "pipelines" in response]
541
542
543
544
545
546
547
548
549
550
551
552

    return {
        "data": [
            {
                "url": openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx],
                "idx": urlIdx,
            }
            for urlIdx in urlIdxs
        ]
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
class AddPipelineForm(BaseModel):
    url: str
    urlIdx: int


@app.post("/api/pipelines/add")
async def add_pipeline(form_data: AddPipelineForm, user=Depends(get_admin_user)):

    r = None
    try:
        urlIdx = form_data.urlIdx

        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]

        headers = {"Authorization": f"Bearer {key}"}
        r = requests.post(
            f"{url}/pipelines/add", headers=headers, json={"url": form_data.url}
        )

        r.raise_for_status()
        data = r.json()

        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")

        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass

        raise HTTPException(
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
        )


class DeletePipelineForm(BaseModel):
    id: str
    urlIdx: int


@app.delete("/api/pipelines/delete")
async def delete_pipeline(form_data: DeletePipelineForm, user=Depends(get_admin_user)):

    r = None
    try:
        urlIdx = form_data.urlIdx

        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]

        headers = {"Authorization": f"Bearer {key}"}
        r = requests.delete(
            f"{url}/pipelines/delete", headers=headers, json={"id": form_data.id}
        )

        r.raise_for_status()
        data = r.json()

        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")

        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass

        raise HTTPException(
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
        )


Timothy J. Baek's avatar
Timothy J. Baek committed
639
@app.get("/api/pipelines")
640
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
641
642
643
    r = None
    try:
        urlIdx
644

Timothy J. Baek's avatar
Timothy J. Baek committed
645
646
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
647

Timothy J. Baek's avatar
Timothy J. Baek committed
648
649
        headers = {"Authorization": f"Bearer {key}"}
        r = requests.get(f"{url}/pipelines", headers=headers)
650

Timothy J. Baek's avatar
Timothy J. Baek committed
651
652
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
653

Timothy J. Baek's avatar
Timothy J. Baek committed
654
655
656
657
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
658

Timothy J. Baek's avatar
Timothy J. Baek committed
659
660
661
662
663
664
665
666
667
668
669
670
671
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass

        raise HTTPException(
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
672
673


Timothy J. Baek's avatar
Timothy J. Baek committed
674
675
676
677
678
679
680
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
    urlIdx: Optional[int], pipeline_id: str, user=Depends(get_admin_user)
):
    models = await get_all_models()
    r = None
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
681

Timothy J. Baek's avatar
Timothy J. Baek committed
682
683
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
Timothy J. Baek's avatar
Timothy J. Baek committed
684

Timothy J. Baek's avatar
Timothy J. Baek committed
685
686
        headers = {"Authorization": f"Bearer {key}"}
        r = requests.get(f"{url}/{pipeline_id}/valves", headers=headers)
Timothy J. Baek's avatar
Timothy J. Baek committed
687

Timothy J. Baek's avatar
Timothy J. Baek committed
688
689
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
690

Timothy J. Baek's avatar
Timothy J. Baek committed
691
692
693
694
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
695

Timothy J. Baek's avatar
Timothy J. Baek committed
696
        detail = "Pipeline not found"
697

Timothy J. Baek's avatar
Timothy J. Baek committed
698
699
700
701
702
703
704
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
Timothy J. Baek's avatar
Timothy J. Baek committed
705
706

        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
707
708
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
709
710
711
712
        )


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
713
714
715
async def get_pipeline_valves_spec(
    urlIdx: Optional[int], pipeline_id: str, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
Timothy J. Baek committed
716
717
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
718
719
720
721
    r = None
    try:
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
Timothy J. Baek's avatar
Timothy J. Baek committed
722

Timothy J. Baek's avatar
Timothy J. Baek committed
723
724
        headers = {"Authorization": f"Bearer {key}"}
        r = requests.get(f"{url}/{pipeline_id}/valves/spec", headers=headers)
Timothy J. Baek's avatar
Timothy J. Baek committed
725

Timothy J. Baek's avatar
Timothy J. Baek committed
726
727
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
728

Timothy J. Baek's avatar
Timothy J. Baek committed
729
730
731
732
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
733

Timothy J. Baek's avatar
Timothy J. Baek committed
734
735
736
737
738
739
740
741
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
742

Timothy J. Baek's avatar
Timothy J. Baek committed
743
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
744
745
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
746
747
748
749
750
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
751
752
753
754
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
755
756
757
):
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
758
759
760
761
    r = None
    try:
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
Timothy J. Baek's avatar
Timothy J. Baek committed
762

Timothy J. Baek's avatar
Timothy J. Baek committed
763
764
765
766
767
768
        headers = {"Authorization": f"Bearer {key}"}
        r = requests.post(
            f"{url}/{pipeline_id}/valves/update",
            headers=headers,
            json={**form_data},
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
769

Timothy J. Baek's avatar
Timothy J. Baek committed
770
771
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
772

Timothy J. Baek's avatar
Timothy J. Baek committed
773
774
775
776
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
777

Timothy J. Baek's avatar
Timothy J. Baek committed
778
        detail = "Pipeline not found"
779

Timothy J. Baek's avatar
Timothy J. Baek committed
780
781
782
783
784
785
786
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
787

Timothy J. Baek's avatar
Timothy J. Baek committed
788
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
789
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
Timothy J. Baek's avatar
Timothy J. Baek committed
790
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
791
792
793
        )


Timothy J. Baek's avatar
Timothy J. Baek committed
794
795
@app.get("/api/config")
async def get_app_config():
796
    # Checking and Handling the Absence of 'ui' in CONFIG_DATA
797
798

    default_locale = "en-US"
799
800
801
802
    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
803
804
    return {
        "status": True,
805
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
806
        "version": VERSION,
807
        "default_locale": default_locale,
808
809
        "default_models": webui_app.state.config.DEFAULT_MODELS,
        "default_prompt_suggestions": webui_app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
810
        "features": {
811
812
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
813
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
814
            "enable_web_search": RAG_WEB_SEARCH_ENABLED,
815
            "enable_image_generation": images_app.state.config.ENABLED,
816
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
817
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
818
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
819
820
821
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
822
823
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
824
    return {
825
826
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
827
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
828
829
830
831
832
833
834
835


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
836
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
837
838
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
839
840
    app.state.config.ENABLE_MODEL_FILTER = form_data.enabled
    app.state.config.MODEL_FILTER_LIST = form_data.models
Timothy J. Baek's avatar
Timothy J. Baek committed
841

842
    return {
843
844
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
845
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
846
847


Timothy J. Baek's avatar
Timothy J. Baek committed
848
849
850
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
851
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
852
853
854
855
856
857
858
859
860
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
861
862
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
Timothy J. Baek's avatar
Timothy J. Baek committed
863
864

    return {
865
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
866
867
868
    }


869
870
871
872
873
874
875
876
877
878
879
880
881
@app.get("/api/community_sharing", response_model=bool)
async def get_community_sharing_status(request: Request, user=Depends(get_admin_user)):
    return webui_app.state.config.ENABLE_COMMUNITY_SHARING


@app.get("/api/community_sharing/toggle", response_model=bool)
async def toggle_community_sharing(request: Request, user=Depends(get_admin_user)):
    webui_app.state.config.ENABLE_COMMUNITY_SHARING = (
        not webui_app.state.config.ENABLE_COMMUNITY_SHARING
    )
    return webui_app.state.config.ENABLE_COMMUNITY_SHARING


882
883
884
885
886
887
888
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
889
890
@app.get("/api/changelog")
async def get_app_changelog():
891
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
892
893


894
895
896
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
897
898
899
900
901
902
903
904
905
906
        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:
907
908
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
909
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
910
911
        )

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

913
914
915
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
916
917
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
918
919
920
921
922
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "theme_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
923
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
924
925
    }

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

927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
@app.get("/opensearch.xml")
async def get_opensearch_xml():
    xml_content = rf"""
    <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
    <ShortName>{WEBUI_NAME}</ShortName>
    <Description>Search {WEBUI_NAME}</Description>
    <InputEncoding>UTF-8</InputEncoding>
    <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/favicon.png</Image>
    <Url type="text/html" method="get" template="{WEBUI_URL}/?q={"{searchTerms}"}"/>
    <moz:SearchForm>{WEBUI_URL}</moz:SearchForm>
    </OpenSearchDescription>
    """
    return Response(content=xml_content, media_type="application/xml")


Timothy J. Baek's avatar
Timothy J. Baek committed
942
943
944
945
946
@app.get("/health")
async def healthcheck():
    return {"status": True}


947
948
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
949

950
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
951
    mimetypes.add_type("text/javascript", ".js")
952
953
954
955
956
957
958
959
960
    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."
    )