main.py 66.8 KB
Newer Older
1
import base64
2
import uuid
3
import subprocess
4
from contextlib import asynccontextmanager
5
6
7

from authlib.integrations.starlette_client import OAuth
from authlib.oidc.core import UserInfo
Timothy J. Baek's avatar
Timothy J. Baek committed
8
9
10
from bs4 import BeautifulSoup
import json
import markdown
11
import time
Timothy J. Baek's avatar
Timothy J. Baek committed
12
13
import os
import sys
14
import logging
Timothy J. Baek's avatar
Timothy J. Baek committed
15
import aiohttp
16
import requests
17
import mimetypes
Timothy J. Baek's avatar
Timothy J. Baek committed
18
19
import shutil
import os
Timothy J. Baek's avatar
Timothy J. Baek committed
20
import uuid
Timothy J. Baek's avatar
Timothy J. Baek committed
21
import inspect
Timothy J. Baek's avatar
Timothy J. Baek committed
22
import asyncio
Timothy J. Baek's avatar
Timothy J. Baek committed
23

Timothy J. Baek's avatar
Timothy J. Baek committed
24
from fastapi.concurrency import run_in_threadpool
Timothy J. Baek's avatar
Timothy J. Baek committed
25
from fastapi import FastAPI, Request, Depends, status, UploadFile, File, Form
Timothy J. Baek's avatar
Timothy J. Baek committed
26
from fastapi.staticfiles import StaticFiles
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
27
from fastapi.responses import JSONResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
28
29
30
from fastapi import HTTPException
from fastapi.middleware.wsgi import WSGIMiddleware
from fastapi.middleware.cors import CORSMiddleware
31
from sqlalchemy import text
32
from starlette.exceptions import HTTPException as StarletteHTTPException
Timothy J. Baek's avatar
Timothy J. Baek committed
33
from starlette.middleware.base import BaseHTTPMiddleware
34
35
from starlette.middleware.sessions import SessionMiddleware
from starlette.responses import StreamingResponse, Response, RedirectResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
36

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

from apps.socket.main import app as socket_app
39
40
41
42
43
44
45
46
47
48
49
from apps.ollama.main import (
    app as ollama_app,
    OpenAIChatCompletionForm,
    get_all_models as get_ollama_models,
    generate_openai_chat_completion as generate_ollama_chat_completion,
)
from apps.openai.main import (
    app as openai_app,
    get_all_models as get_openai_models,
    generate_chat_completion as generate_openai_chat_completion,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
50

Timothy J. Baek's avatar
Timothy J. Baek committed
51
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
52
53
from apps.images.main import app as images_app
from apps.rag.main import app as rag_app
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
54
55
56
57
58
from apps.webui.main import (
    app as webui_app,
    get_pipe_models,
    generate_function_chat_completion,
)
59
from apps.webui.internal.db import Session, SessionLocal
Timothy J. Baek's avatar
Timothy J. Baek committed
60

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

Timothy J. Baek's avatar
Timothy J. Baek committed
62
from pydantic import BaseModel
Timothy J. Baek's avatar
Timothy J. Baek committed
63
from typing import List, Optional, Iterator, Generator, Union
Timothy J. Baek's avatar
Timothy J. Baek committed
64

65
from apps.webui.models.auths import Auths
66
from apps.webui.models.models import Models, ModelModel
Timothy J. Baek's avatar
Timothy J. Baek committed
67
from apps.webui.models.tools import Tools
Timothy J. Baek's avatar
Timothy J. Baek committed
68
from apps.webui.models.functions import Functions
69
from apps.webui.models.users import Users
Timothy J. Baek's avatar
Timothy J. Baek committed
70
71

from apps.webui.utils import load_toolkit_module_by_id, load_function_module_by_id
Timothy J. Baek's avatar
Timothy J. Baek committed
72

73
74
75
76
77
from utils.utils import (
    get_admin_user,
    get_verified_user,
    get_current_user,
    get_http_authorization_cred,
78
79
    get_password_hash,
    create_token,
80
)
Timothy J. Baek's avatar
Timothy J. Baek committed
81
82
83
84
85
from utils.task import (
    title_generation_template,
    search_query_generation_template,
    tools_function_calling_generation_template,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
86
87
88
89
from utils.misc import (
    get_last_user_message,
    add_or_update_system_message,
    stream_message_template,
90
    parse_duration,
Timothy J. Baek's avatar
Timothy J. Baek committed
91
)
Timothy J. Baek's avatar
Timothy J. Baek committed
92

Timothy J. Baek's avatar
Timothy J. Baek committed
93
from apps.rag.utils import get_rag_context, rag_template
Timothy J. Baek's avatar
Timothy J. Baek committed
94

95
from config import (
96
    CONFIG_DATA,
97
    WEBUI_NAME,
98
    WEBUI_URL,
99
    WEBUI_AUTH,
100
101
102
103
    ENV,
    VERSION,
    CHANGELOG,
    FRONTEND_BUILD_DIR,
Timothy J. Baek's avatar
Timothy J. Baek committed
104
    UPLOAD_DIR,
105
106
    CACHE_DIR,
    STATIC_DIR,
Timothy J. Baek's avatar
Timothy J. Baek committed
107
    DEFAULT_LOCALE,
108
109
    ENABLE_OPENAI_API,
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
Timothy J. Baek committed
110
    ENABLE_MODEL_FILTER,
111
    MODEL_FILTER_LIST,
112
113
    GLOBAL_LOG_LEVEL,
    SRC_LOG_LEVELS,
Timothy J. Baek's avatar
Timothy J. Baek committed
114
    WEBHOOK_URL,
115
    ENABLE_ADMIN_EXPORT,
116
    WEBUI_BUILD_HASH,
Timothy J. Baek's avatar
Timothy J. Baek committed
117
118
    TASK_MODEL,
    TASK_MODEL_EXTERNAL,
Timothy J. Baek's avatar
Timothy J. Baek committed
119
    TITLE_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
120
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
121
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
122
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
123
    SAFE_MODE,
124
    OAUTH_PROVIDERS,
125
126
127
    ENABLE_OAUTH_SIGNUP,
    OAUTH_MERGE_ACCOUNTS_BY_EMAIL,
    WEBUI_SECRET_KEY,
128
    WEBUI_SESSION_COOKIE_SAME_SITE,
129
    WEBUI_SESSION_COOKIE_SECURE,
Timothy J. Baek's avatar
Timothy J. Baek committed
130
    AppConfig,
131
132
    BACKEND_DIR,
    DATABASE_URL,
133
)
134
135
from constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
from utils.webhook import post_webhook
136

Timothy J. Baek's avatar
Timothy J. Baek committed
137
138
139
140
141
if SAFE_MODE:
    print("SAFE MODE ENABLED")
    Functions.deactivate_all_functions()


142
143
144
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
145

146

Timothy J. Baek's avatar
Timothy J. Baek committed
147
148
149
150
151
152
153
154
155
156
157
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
158
print(
Timothy J. Baek's avatar
Timothy J. Baek committed
159
    rf"""
Timothy J. Baek's avatar
Timothy J. Baek committed
160
161
162
163
164
165
166
167
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __   \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \   \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |   \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|    \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

      
168
v{VERSION} - building the best open-source AI user interface.
169
{f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
Timothy J. Baek's avatar
Timothy J. Baek committed
170
171
172
173
https://github.com/open-webui/open-webui
"""
)

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

175
def run_migrations():
176
177
    env = os.environ.copy()
    env["DATABASE_URL"] = DATABASE_URL
178
179
180
    migration_task = subprocess.run(
        ["alembic", f"-c{BACKEND_DIR}/alembic.ini", "upgrade", "head"], env=env
    )
181
182
    if migration_task.returncode > 0:
        raise ValueError("Error running migrations")
183
184


185
186
@asynccontextmanager
async def lifespan(app: FastAPI):
187
    run_migrations()
188
189
190
191
192
193
    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
194

195
app.state.config = AppConfig()
196
197
198
199

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

200
201
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
202

203
app.state.config.WEBHOOK_URL = WEBHOOK_URL
Timothy J. Baek's avatar
Timothy J. Baek committed
204
205
206
207


app.state.config.TASK_MODEL = TASK_MODEL
app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
Timothy J. Baek's avatar
Timothy J. Baek committed
208
app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
Timothy J. Baek's avatar
Timothy J. Baek committed
209
210
211
app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
212
213
214
app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
)
Timothy J. Baek's avatar
Timothy J. Baek committed
215
216
217
app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
218
219
220

app.state.MODELS = {}

Timothy J. Baek's avatar
Timothy J. Baek committed
221
222
origins = ["*"]

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
224
225
226
227
228
229
230
##################################
#
# ChatCompletion Middleware
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
231
232
233
async def get_function_call_response(
    messages, files, tool_id, template, task_model_id, user
):
Timothy J. Baek's avatar
Timothy J. Baek committed
234
235
236
    tool = Tools.get_tool_by_id(tool_id)
    tools_specs = json.dumps(tool.specs, indent=2)
    content = tools_function_calling_generation_template(template, tools_specs)
Timothy J. Baek's avatar
Timothy J. Baek committed
237

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
238
239
240
241
242
    user_message = get_last_user_message(messages)
    prompt = (
        "History:\n"
        + "\n".join(
            [
Timothy J. Baek's avatar
Timothy J. Baek committed
243
                f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
244
245
246
247
248
249
250
251
                for message in messages[::-1][:4]
            ]
        )
        + f"\nQuery: {user_message}"
    )

    print(prompt)

Timothy J. Baek's avatar
Timothy J. Baek committed
252
253
254
255
256
257
258
259
260
    payload = {
        "model": task_model_id,
        "messages": [
            {"role": "system", "content": content},
            {"role": "user", "content": f"Query: {prompt}"},
        ],
        "stream": False,
    }

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
261
262
263
264
265
    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        raise e

Timothy J. Baek's avatar
Timothy J. Baek committed
266
    model = app.state.MODELS[task_model_id]
Timothy J. Baek's avatar
Timothy J. Baek committed
267

Timothy J. Baek's avatar
Timothy J. Baek committed
268
    response = None
Timothy J. Baek's avatar
Timothy J. Baek committed
269
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
270
        response = await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
271
272
273

        content = None

Timothy J. Baek's avatar
Timothy J. Baek committed
274
275
276
277
278
279
280
281
282
283
        if hasattr(response, "body_iterator"):
            async for chunk in response.body_iterator:
                data = json.loads(chunk.decode("utf-8"))
                content = data["choices"][0]["message"]["content"]

            # Cleanup any remaining background tasks if necessary
            if response.background is not None:
                await response.background()
        else:
            content = response["choices"][0]["message"]["content"]
Timothy J. Baek's avatar
Timothy J. Baek committed
284
285
286

        # Parse the function response
        if content is not None:
Timothy J. Baek's avatar
Timothy J. Baek committed
287
            print(f"content: {content}")
Timothy J. Baek's avatar
Timothy J. Baek committed
288
289
290
            result = json.loads(content)
            print(result)

Timothy J. Baek's avatar
Timothy J. Baek committed
291
            citation = None
Timothy J. Baek's avatar
Timothy J. Baek committed
292
293
294
295
296
            # Call the function
            if "name" in result:
                if tool_id in webui_app.state.TOOLS:
                    toolkit_module = webui_app.state.TOOLS[tool_id]
                else:
297
                    toolkit_module, frontmatter = load_toolkit_module_by_id(tool_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
298
299
                    webui_app.state.TOOLS[tool_id] = toolkit_module

300
301
302
303
304
305
                file_handler = False
                # check if toolkit_module has file_handler self variable
                if hasattr(toolkit_module, "file_handler"):
                    file_handler = True
                    print("file_handler: ", file_handler)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
306
307
308
                if hasattr(toolkit_module, "valves") and hasattr(
                    toolkit_module, "Valves"
                ):
Timothy J. Baek's avatar
Timothy J. Baek committed
309
                    valves = Tools.get_tool_valves_by_id(tool_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
310
                    toolkit_module.valves = toolkit_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
311
                        **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
312
313
                    )

Timothy J. Baek's avatar
Timothy J. Baek committed
314
315
316
                function = getattr(toolkit_module, result["name"])
                function_result = None
                try:
Timothy J. Baek's avatar
Timothy J. Baek committed
317
318
                    # Get the signature of the function
                    sig = inspect.signature(function)
319
320
                    params = result["parameters"]

Timothy J. Baek's avatar
Timothy J. Baek committed
321
322
                    if "__user__" in sig.parameters:
                        # Call the function with the '__user__' parameter included
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
323
324
325
326
327
                        __user__ = {
                            "id": user.id,
                            "email": user.email,
                            "name": user.name,
                            "role": user.role,
328
329
                        }

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
330
331
332
333
334
335
336
337
338
339
340
                        try:
                            if hasattr(toolkit_module, "UserValves"):
                                __user__["valves"] = toolkit_module.UserValves(
                                    **Tools.get_user_valves_by_id_and_user_id(
                                        tool_id, user.id
                                    )
                                )
                        except Exception as e:
                            print(e)

                        params = {**params, "__user__": __user__}
341
342
343
344
345
346
347
                    if "__messages__" in sig.parameters:
                        # Call the function with the '__messages__' parameter included
                        params = {
                            **params,
                            "__messages__": messages,
                        }

Timothy J. Baek's avatar
Timothy J. Baek committed
348
349
350
351
352
353
354
                    if "__files__" in sig.parameters:
                        # Call the function with the '__files__' parameter included
                        params = {
                            **params,
                            "__files__": files,
                        }

355
356
357
358
359
360
361
                    if "__model__" in sig.parameters:
                        # Call the function with the '__model__' parameter included
                        params = {
                            **params,
                            "__model__": model,
                        }

362
363
364
365
366
367
368
                    if "__id__" in sig.parameters:
                        # Call the function with the '__id__' parameter included
                        params = {
                            **params,
                            "__id__": tool_id,
                        }

Timothy J. Baek's avatar
Timothy J. Baek committed
369
370
371
372
                    if inspect.iscoroutinefunction(function):
                        function_result = await function(**params)
                    else:
                        function_result = function(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
373
374
375
376
377
378
379

                    if hasattr(toolkit_module, "citation") and toolkit_module.citation:
                        citation = {
                            "source": {"name": f"TOOL:{tool.name}/{result['name']}"},
                            "document": [function_result],
                            "metadata": [{"source": result["name"]}],
                        }
Timothy J. Baek's avatar
Timothy J. Baek committed
380
381
382
383
                except Exception as e:
                    print(e)

                # Add the function result to the system prompt
384
                if function_result is not None:
Timothy J. Baek's avatar
Timothy J. Baek committed
385
                    return function_result, citation, file_handler
Timothy J. Baek's avatar
Timothy J. Baek committed
386
387
    except Exception as e:
        print(f"Error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
388

Timothy J. Baek's avatar
Timothy J. Baek committed
389
    return None, None, False
Timothy J. Baek's avatar
Timothy J. Baek committed
390
391
392


class ChatCompletionMiddleware(BaseHTTPMiddleware):
Timothy J. Baek's avatar
Timothy J. Baek committed
393
    async def dispatch(self, request: Request, call_next):
394
        data_items = []
395

Timothy J. Baek's avatar
Timothy J. Baek committed
396
397
398
        show_citations = False
        citations = []

Timothy J. Baek's avatar
Timothy J. Baek committed
399
400
401
        if request.method == "POST" and any(
            endpoint in request.url.path
            for endpoint in ["/ollama/api/chat", "/chat/completions"]
402
        ):
403
            log.debug(f"request.url.path: {request.url.path}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
404

Timothy J. Baek's avatar
Timothy J. Baek committed
405
406
407
408
            # Read the original request body
            body = await request.body()
            body_str = body.decode("utf-8")
            data = json.loads(body_str) if body_str else {}
Timothy J. Baek's avatar
Timothy J. Baek committed
409

Timothy J. Baek's avatar
Timothy J. Baek committed
410
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
411
                request,
412
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
413
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
414
415
            # Flag to skip RAG completions if file_handler is present in tools/functions
            skip_files = False
Timothy J. Baek's avatar
Timothy J. Baek committed
416
417
418
            if data.get("citations"):
                show_citations = True
                del data["citations"]
Timothy J. Baek's avatar
Timothy J. Baek committed
419
420
421

            model_id = data["model"]
            if model_id not in app.state.MODELS:
Timothy J. Baek's avatar
Timothy J. Baek committed
422
423
424
425
                raise HTTPException(
                    status_code=status.HTTP_404_NOT_FOUND,
                    detail="Model not found",
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
426
427
            model = app.state.MODELS[model_id]

428
429
430
431
432
433
434
435
            def get_priority(function_id):
                function = Functions.get_function_by_id(function_id)
                if function is not None and hasattr(function, "valves"):
                    return (function.valves if function.valves else {}).get(
                        "priority", 0
                    )
                return 0

Timothy J. Baek's avatar
Timothy J. Baek committed
436
            filter_ids = [
Timothy J. Baek's avatar
Timothy J. Baek committed
437
438
                function.id for function in Functions.get_global_filter_functions()
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
439
            if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
440
                filter_ids.extend(model["info"]["meta"].get("filterIds", []))
Timothy J. Baek's avatar
Timothy J. Baek committed
441
442
                filter_ids = list(set(filter_ids))

Timothy J. Baek's avatar
Timothy J. Baek committed
443
            enabled_filter_ids = [
Timothy J. Baek's avatar
Timothy J. Baek committed
444
445
446
447
448
                function.id
                for function in Functions.get_functions_by_type(
                    "filter", active_only=True
                )
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
449
450
451
            filter_ids = [
                filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
452

453
            filter_ids.sort(key=get_priority)
Timothy J. Baek's avatar
Timothy J. Baek committed
454
455
456
457
458
459
            for filter_id in filter_ids:
                filter = Functions.get_function_by_id(filter_id)
                if filter:
                    if filter_id in webui_app.state.FUNCTIONS:
                        function_module = webui_app.state.FUNCTIONS[filter_id]
                    else:
460
461
                        function_module, function_type, frontmatter = (
                            load_function_module_by_id(filter_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
462
463
                        )
                        webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
Timothy J. Baek committed
464

Timothy J. Baek's avatar
Timothy J. Baek committed
465
466
467
                    # Check if the function has a file_handler variable
                    if hasattr(function_module, "file_handler"):
                        skip_files = function_module.file_handler
Timothy J. Baek's avatar
Timothy J. Baek committed
468

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
469
470
471
                    if hasattr(function_module, "valves") and hasattr(
                        function_module, "Valves"
                    ):
Timothy J. Baek's avatar
Timothy J. Baek committed
472
                        valves = Functions.get_function_valves_by_id(filter_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
473
                        function_module.valves = function_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
474
                            **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
475
476
                        )

Timothy J. Baek's avatar
Timothy J. Baek committed
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
                    try:
                        if hasattr(function_module, "inlet"):
                            inlet = function_module.inlet

                            # Get the signature of the function
                            sig = inspect.signature(inlet)
                            params = {"body": data}

                            if "__user__" in sig.parameters:
                                __user__ = {
                                    "id": user.id,
                                    "email": user.email,
                                    "name": user.name,
                                    "role": user.role,
                                }

                                try:
                                    if hasattr(function_module, "UserValves"):
                                        __user__["valves"] = function_module.UserValves(
                                            **Functions.get_user_valves_by_id_and_user_id(
                                                filter_id, user.id
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
498
                                            )
Timothy J. Baek's avatar
Timothy J. Baek committed
499
500
501
                                        )
                                except Exception as e:
                                    print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
502

Timothy J. Baek's avatar
Timothy J. Baek committed
503
                                params = {**params, "__user__": __user__}
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
504

Timothy J. Baek's avatar
Timothy J. Baek committed
505
506
507
508
509
                            if "__id__" in sig.parameters:
                                params = {
                                    **params,
                                    "__id__": filter_id,
                                }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
510

Timothy J. Baek's avatar
Timothy J. Baek committed
511
512
513
514
                            if inspect.iscoroutinefunction(inlet):
                                data = await inlet(**params)
                            else:
                                data = inlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
515

Timothy J. Baek's avatar
Timothy J. Baek committed
516
517
518
519
520
521
                    except Exception as e:
                        print(f"Error: {e}")
                        return JSONResponse(
                            status_code=status.HTTP_400_BAD_REQUEST,
                            content={"detail": str(e)},
                        )
Timothy J. Baek's avatar
Timothy J. Baek committed
522
523
524
525

            # Set the task model
            task_model_id = data["model"]
            # Check if the user has a custom task model and use that model
Timothy J. Baek's avatar
Timothy J. Baek committed
526
527
528
529
530
531
532
533
534
535
536
537
538
            if app.state.MODELS[task_model_id]["owned_by"] == "ollama":
                if (
                    app.state.config.TASK_MODEL
                    and app.state.config.TASK_MODEL in app.state.MODELS
                ):
                    task_model_id = app.state.config.TASK_MODEL
            else:
                if (
                    app.state.config.TASK_MODEL_EXTERNAL
                    and app.state.config.TASK_MODEL_EXTERNAL in app.state.MODELS
                ):
                    task_model_id = app.state.config.TASK_MODEL_EXTERNAL

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
539
            prompt = get_last_user_message(data["messages"])
Timothy J. Baek's avatar
Timothy J. Baek committed
540
541
542
            context = ""

            # If tool_ids field is present, call the functions
Timothy J. Baek's avatar
Timothy J. Baek committed
543
            if "tool_ids" in data:
Timothy J. Baek's avatar
Timothy J. Baek committed
544
                print(data["tool_ids"])
Timothy J. Baek's avatar
Timothy J. Baek committed
545
                for tool_id in data["tool_ids"]:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
546
                    print(tool_id)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
547
                    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
548
549
550
551
552
553
554
555
556
                        response, citation, file_handler = (
                            await get_function_call_response(
                                messages=data["messages"],
                                files=data.get("files", []),
                                tool_id=tool_id,
                                template=app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
                                task_model_id=task_model_id,
                                user=user,
                            )
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
557
                        )
Timothy J. Baek's avatar
Timothy J. Baek committed
558

559
                        print(file_handler)
560
                        if isinstance(response, str):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
561
                            context += ("\n" if context != "" else "") + response
562

Timothy J. Baek's avatar
Timothy J. Baek committed
563
564
565
566
                        if citation:
                            citations.append(citation)
                            show_citations = True

567
568
569
                        if file_handler:
                            skip_files = True

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
570
571
                    except Exception as e:
                        print(f"Error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
572
573
                del data["tool_ids"]

Timothy J. Baek's avatar
Timothy J. Baek committed
574
                print(f"tool_context: {context}")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
575

Timothy J. Baek's avatar
Timothy J. Baek committed
576
            # If files field is present, generate RAG completions
577
            # If skip_files is True, skip the RAG completions
Timothy J. Baek's avatar
Timothy J. Baek committed
578
            if "files" in data:
579
580
                if not skip_files:
                    data = {**data}
Timothy J. Baek's avatar
Timothy J. Baek committed
581
                    rag_context, rag_citations = get_rag_context(
582
583
584
585
586
587
588
589
590
591
                        files=data["files"],
                        messages=data["messages"],
                        embedding_function=rag_app.state.EMBEDDING_FUNCTION,
                        k=rag_app.state.config.TOP_K,
                        reranking_function=rag_app.state.sentence_transformer_rf,
                        r=rag_app.state.config.RELEVANCE_THRESHOLD,
                        hybrid_search=rag_app.state.config.ENABLE_RAG_HYBRID_SEARCH,
                    )
                    if rag_context:
                        context += ("\n" if context != "" else "") + rag_context
Timothy J. Baek's avatar
Timothy J. Baek committed
592

593
                    log.debug(f"rag_context: {rag_context}, citations: {citations}")
594

Timothy J. Baek's avatar
Timothy J. Baek committed
595
596
                    if rag_citations:
                        citations.extend(rag_citations)
Timothy J. Baek's avatar
Timothy J. Baek committed
597

Timothy J. Baek's avatar
Timothy J. Baek committed
598
                del data["files"]
Timothy J. Baek's avatar
Timothy J. Baek committed
599

Timothy J. Baek's avatar
Timothy J. Baek committed
600
601
            if show_citations and len(citations) > 0:
                data_items.append({"citations": citations})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
602

Timothy J. Baek's avatar
Timothy J. Baek committed
603
604
605
606
607
608
            if context != "":
                system_prompt = rag_template(
                    rag_app.state.config.RAG_TEMPLATE, context, prompt
                )
                print(system_prompt)
                data["messages"] = add_or_update_system_message(
609
                    system_prompt, data["messages"]
610
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
611

Timothy J. Baek's avatar
Timothy J. Baek committed
612
            modified_body_bytes = json.dumps(data).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
613
614
615
616
617
618
619
620
621
622
623
            # 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
624

Timothy J. Baek's avatar
Timothy J. Baek committed
625
            response = await call_next(request)
626
627
628
629
630
            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(
631
                        self.openai_stream_wrapper(response.body_iterator, data_items),
632
633
634
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
635
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
636
                    )
637
638

                return response
Timothy J. Baek's avatar
Timothy J. Baek committed
639
640
            else:
                return response
641

Timothy J. Baek's avatar
Timothy J. Baek committed
642
643
        # If it's not a chat completion request, just pass it through
        response = await call_next(request)
Timothy J. Baek's avatar
Timothy J. Baek committed
644
645
646
647
648
        return response

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

649
650
651
652
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

653
654
655
        async for data in original_generator:
            yield data

656
657
658
659
    async def ollama_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"{json.dumps(item)}\n"

660
661
662
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
664
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
665

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
666
667
668
669
670
671
##################################
#
# Pipeline Middleware
#
##################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
673
def filter_pipeline(payload, user):
674
    user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
Timothy J. Baek's avatar
Timothy J. Baek committed
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
    model_id = payload["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"])

    model = app.state.MODELS[model_id]

    if "pipeline" in model:
        sorted_filters.append(model)

    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/inlet",
                    headers=headers,
                    json={
                        "user": user,
                        "body": payload,
                    },
                )

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

            if r is not None:
                try:
                    res = r.json()
                except:
                    pass
Timothy J. Baek's avatar
Timothy J. Baek committed
727
728
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
729
730
731
732
733
734
735
736
737
738

            else:
                pass

    if "pipeline" not in app.state.MODELS[model_id]:
        if "chat_id" in payload:
            del payload["chat_id"]

        if "title" in payload:
            del payload["title"]
Timothy J. Baek's avatar
Timothy J. Baek committed
739

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
740
741
742
        if "task" in payload:
            del payload["task"]

Timothy J. Baek's avatar
Timothy J. Baek committed
743
744
745
    return payload


Timothy J. Baek's avatar
Timothy J. Baek committed
746
747
748
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
749
750
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
751
752
753
754
755
756
757
758
759
760
        ):
            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 {}

Timothy J. Baek's avatar
Timothy J. Baek committed
761
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
762
                request,
763
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
764
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
765
766
767
768
769
770
771
772

            try:
                data = filter_pipeline(data, user)
            except Exception as e:
                return JSONResponse(
                    status_code=e.args[0],
                    content={"detail": e.args[1]},
                )
773

Timothy J. Baek's avatar
Timothy J. Baek committed
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
            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
797
798
799
800
801
802
803
804
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

805

806
@app.middleware("http")
Jonathan Rohde's avatar
Jonathan Rohde committed
807
async def commit_session_after_request(request: Request, call_next):
808
    response = await call_next(request)
Jonathan Rohde's avatar
Jonathan Rohde committed
809
    log.debug("Commit session after request")
810
811
812
    Session.commit()
    return response

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
813

Timothy J. Baek's avatar
Timothy J. Baek committed
814
815
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
816
    if len(app.state.MODELS) == 0:
817
        await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
818
819
820
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
821
822
823
824
825
826
827
828
    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
829
830
831
832
833
834
@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
835

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

Timothy J. Baek's avatar
Timothy J. Baek committed
837
838
app.mount("/ws", socket_app)

839
app.mount("/ollama", ollama_app)
840
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
841

Timothy J. Baek's avatar
Timothy J. Baek committed
842
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
843
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
844
845
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
846
847
848
849
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

850

851
async def get_all_models():
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
852
    pipe_models = []
853
854
855
    openai_models = []
    ollama_models = []

856
    pipe_models = await get_pipe_models()
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
857

858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
    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"]
        ]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
876
    models = pipe_models + openai_models + ollama_models
877

878
    custom_models = Models.get_all_models()
879
880
881
    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
882
883
884
885
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
886
887
888
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
889
890
            owned_by = "openai"
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
891
892
893
894
                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
895
896
897
                    owned_by = model["owned_by"]
                    break

898
899
900
901
902
903
            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
904
                    "owned_by": owned_by,
905
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
906
                    "preset": True,
907
908
909
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
910
911
912
913
914
915
916
917
    app.state.MODELS = {model["id"]: model for model in models}

    webui_app.state.MODELS = app.state.MODELS

    return models


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

921
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
922
923
924
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
925
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
926
927
    ]

928
929
930
931
932
933
934
935
936
937
938
939
940
    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}


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
941
942
943
944
945
946
947
948
949
950
951
@app.post("/api/chat/completions")
async def generate_chat_completions(form_data: dict, user=Depends(get_verified_user)):
    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

    model = app.state.MODELS[model_id]

Timothy J. Baek's avatar
Timothy J. Baek committed
952
953
    pipe = model.get("pipe")
    if pipe:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
954
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
955
956
957
958
959
960
961
962
963
964
    if model["owned_by"] == "ollama":
        return await generate_ollama_chat_completion(form_data, user=user)
    else:
        return await generate_openai_chat_completion(form_data, user=user)


@app.post("/api/chat/completed")
async def chat_completed(form_data: dict, user=Depends(get_verified_user)):
    data = form_data
    model_id = data["model"]
Timothy J. Baek's avatar
Timothy J. Baek committed
965
966
967
968
969
970
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )
    model = app.state.MODELS[model_id]
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986

    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"]
            )
        )
    ]

Timothy J. Baek's avatar
Timothy J. Baek committed
987
988
989
    sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])
    if "pipeline" in model:
        sorted_filters = [model] + sorted_filters
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004

    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={
Timothy J. Baek's avatar
Timothy J. Baek committed
1005
1006
1007
1008
1009
1010
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
                        "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

1035
1036
1037
1038
1039
1040
    def get_priority(function_id):
        function = Functions.get_function_by_id(function_id)
        if function is not None and hasattr(function, "valves"):
            return (function.valves if function.valves else {}).get("priority", 0)
        return 0

Timothy J. Baek's avatar
Timothy J. Baek committed
1041
    filter_ids = [function.id for function in Functions.get_global_filter_functions()]
Timothy J. Baek's avatar
Timothy J. Baek committed
1042
    if "info" in model and "meta" in model["info"]:
1043
1044
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1045

Timothy J. Baek's avatar
Timothy J. Baek committed
1046
1047
1048
1049
1050
1051
1052
1053
    enabled_filter_ids = [
        function.id
        for function in Functions.get_functions_by_type("filter", active_only=True)
    ]
    filter_ids = [
        filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
    ]

1054
1055
    # Sort filter_ids by priority, using the get_priority function
    filter_ids.sort(key=get_priority)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1056

1057
1058
1059
1060
1061
1062
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
        if filter:
            if filter_id in webui_app.state.FUNCTIONS:
                function_module = webui_app.state.FUNCTIONS[filter_id]
            else:
1063
1064
1065
                function_module, function_type, frontmatter = (
                    load_function_module_by_id(filter_id)
                )
1066
                webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1067

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
            if hasattr(function_module, "valves") and hasattr(
                function_module, "Valves"
            ):
                valves = Functions.get_function_valves_by_id(filter_id)
                function_module.valves = function_module.Valves(
                    **(valves if valves else {})
                )

            try:
                if hasattr(function_module, "outlet"):
                    outlet = function_module.outlet

                    # Get the signature of the function
                    sig = inspect.signature(outlet)
                    params = {"body": data}

                    if "__user__" in sig.parameters:
                        __user__ = {
                            "id": user.id,
                            "email": user.email,
                            "name": user.name,
                            "role": user.role,
                        }

                        try:
                            if hasattr(function_module, "UserValves"):
                                __user__["valves"] = function_module.UserValves(
                                    **Functions.get_user_valves_by_id_and_user_id(
                                        filter_id, user.id
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1097
                                    )
1098
1099
1100
                                )
                        except Exception as e:
                            print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1101

1102
                        params = {**params, "__user__": __user__}
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1103

1104
1105
1106
1107
1108
                    if "__id__" in sig.parameters:
                        params = {
                            **params,
                            "__id__": filter_id,
                        }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1109

1110
1111
1112
1113
                    if inspect.iscoroutinefunction(outlet):
                        data = await outlet(**params)
                    else:
                        data = outlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
1114

1115
1116
1117
1118
1119
1120
            except Exception as e:
                print(f"Error: {e}")
                return JSONResponse(
                    status_code=status.HTTP_400_BAD_REQUEST,
                    content={"detail": str(e)},
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
1121

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
    return data


##################################
#
# Task Endpoints
#
##################################


# TODO: Refactor task API endpoints below into a separate file


Timothy J. Baek's avatar
Timothy J. Baek committed
1135
1136
1137
1138
1139
1140
1141
@app.get("/api/task/config")
async def get_task_config(user=Depends(get_verified_user)):
    return {
        "TASK_MODEL": app.state.config.TASK_MODEL,
        "TASK_MODEL_EXTERNAL": app.state.config.TASK_MODEL_EXTERNAL,
        "TITLE_GENERATION_PROMPT_TEMPLATE": app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE,
        "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE": app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1142
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1143
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1144
1145
1146
1147
1148
1149
1150
1151
    }


class TaskConfigForm(BaseModel):
    TASK_MODEL: Optional[str]
    TASK_MODEL_EXTERNAL: Optional[str]
    TITLE_GENERATION_PROMPT_TEMPLATE: str
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1152
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1153
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165


@app.post("/api/task/config/update")
async def update_task_config(form_data: TaskConfigForm, user=Depends(get_admin_user)):
    app.state.config.TASK_MODEL = form_data.TASK_MODEL
    app.state.config.TASK_MODEL_EXTERNAL = form_data.TASK_MODEL_EXTERNAL
    app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = (
        form_data.TITLE_GENERATION_PROMPT_TEMPLATE
    )
    app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
        form_data.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1166
1167
1168
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1169
1170
1171
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1172
1173
1174
1175
1176
1177

    return {
        "TASK_MODEL": app.state.config.TASK_MODEL,
        "TASK_MODEL_EXTERNAL": app.state.config.TASK_MODEL_EXTERNAL,
        "TITLE_GENERATION_PROMPT_TEMPLATE": app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE,
        "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE": app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1178
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1179
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1180
1181
1182
    }


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1183
@app.post("/api/task/title/completions")
Timothy J. Baek's avatar
Timothy J. Baek committed
1184
1185
async def generate_title(form_data: dict, user=Depends(get_verified_user)):
    print("generate_title")
Timothy J. Baek's avatar
Timothy J. Baek committed
1186

Timothy J. Baek's avatar
Timothy J. Baek committed
1187
1188
1189
1190
1191
1192
1193
    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

Timothy J. Baek's avatar
Timothy J. Baek committed
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
    if app.state.MODELS[model_id]["owned_by"] == "ollama":
        if app.state.config.TASK_MODEL:
            task_model_id = app.state.config.TASK_MODEL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id
    else:
        if app.state.config.TASK_MODEL_EXTERNAL:
            task_model_id = app.state.config.TASK_MODEL_EXTERNAL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id

    print(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1208
1209
1210
1211
1212
    model = app.state.MODELS[model_id]

    template = app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1213
1214
1215
1216
1217
1218
        template,
        form_data["prompt"],
        {
            "name": user.name,
            "location": user.info.get("location") if user.info else None,
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 50,
        "chat_id": form_data.get("chat_id", None),
        "title": True,
    }

1230
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1231
1232
1233
1234
1235
1236
1237
1238

    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        return JSONResponse(
            status_code=e.args[0],
            content={"detail": e.args[1]},
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
1239

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1240
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1241
1242


Timothy J. Baek's avatar
Timothy J. Baek committed
1243
1244
1245
1246
@app.post("/api/task/query/completions")
async def generate_search_query(form_data: dict, user=Depends(get_verified_user)):
    print("generate_search_query")

Timothy J. Baek's avatar
Timothy J. Baek committed
1247
1248
1249
1250
1251
1252
    if len(form_data["prompt"]) < app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD:
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail=f"Skip search query generation for short prompts (< {app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD} characters)",
        )

Timothy J. Baek's avatar
Timothy J. Baek committed
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
    if app.state.MODELS[model_id]["owned_by"] == "ollama":
        if app.state.config.TASK_MODEL:
            task_model_id = app.state.config.TASK_MODEL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id
    else:
        if app.state.config.TASK_MODEL_EXTERNAL:
            task_model_id = app.state.config.TASK_MODEL_EXTERNAL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id

    print(model_id)
    model = app.state.MODELS[model_id]

    template = app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE

    content = search_query_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1279
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1280
1281
1282
1283
1284
1285
1286
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
        "task": True,
    }

    print(payload)

    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        return JSONResponse(
            status_code=e.args[0],
            content={"detail": e.args[1]},
        )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1300
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330


@app.post("/api/task/emoji/completions")
async def generate_emoji(form_data: dict, user=Depends(get_verified_user)):
    print("generate_emoji")

    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
    if app.state.MODELS[model_id]["owned_by"] == "ollama":
        if app.state.config.TASK_MODEL:
            task_model_id = app.state.config.TASK_MODEL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id
    else:
        if app.state.config.TASK_MODEL_EXTERNAL:
            task_model_id = app.state.config.TASK_MODEL_EXTERNAL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id

    print(model_id)
    model = app.state.MODELS[model_id]

    template = '''
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1331
Your task is to reflect the speaker's likely facial expression through a fitting emoji. Interpret emotions from the message and reflect their facial expression using fitting, diverse emojis (e.g., 😊, 😢, 😡, 😱).
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1332
1333
1334
1335
1336

Message: """{{prompt}}"""
'''

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1337
1338
1339
1340
1341
1342
        template,
        form_data["prompt"],
        {
            "name": user.name,
            "location": user.info.get("location") if user.info else None,
        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1343
1344
1345
1346
1347
1348
1349
1350
1351
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 4,
        "chat_id": form_data.get("chat_id", None),
        "task": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
1352
1353
    }

1354
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1355
1356
1357
1358
1359
1360
1361
1362

    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        return JSONResponse(
            status_code=e.args[0],
            content={"detail": e.args[1]},
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
1363

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1364
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1365
1366


Timothy J. Baek's avatar
Timothy J. Baek committed
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
@app.post("/api/task/tools/completions")
async def get_tools_function_calling(form_data: dict, user=Depends(get_verified_user)):
    print("get_tools_function_calling")

    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
    if app.state.MODELS[model_id]["owned_by"] == "ollama":
        if app.state.config.TASK_MODEL:
            task_model_id = app.state.config.TASK_MODEL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id
    else:
        if app.state.config.TASK_MODEL_EXTERNAL:
            task_model_id = app.state.config.TASK_MODEL_EXTERNAL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id

    print(model_id)
    template = app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1394
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1395
        context, citation, file_handler = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1396
1397
1398
1399
1400
1401
            form_data["messages"],
            form_data.get("files", []),
            form_data["tool_id"],
            template,
            model_id,
            user,
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1402
1403
1404
1405
1406
1407
1408
        )
        return context
    except Exception as e:
        return JSONResponse(
            status_code=e.args[0],
            content={"detail": e.args[1]},
        )
Timothy J. Baek's avatar
Timothy J. Baek committed
1409
1410


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1411
1412
1413
1414
1415
##################################
#
# Pipelines Endpoints
#
##################################
1416
1417


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1418
# TODO: Refactor pipelines API endpoints below into a separate file
1419
1420


1421
1422
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1423
1424
1425
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1426
1427
1428
1429
1430
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442

    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
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
@app.post("/api/pipelines/upload")
async def upload_pipeline(
    urlIdx: int = Form(...), file: UploadFile = File(...), user=Depends(get_admin_user)
):
    print("upload_pipeline", urlIdx, file.filename)
    # Check if the uploaded file is a python file
    if not file.filename.endswith(".py"):
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail="Only Python (.py) files are allowed.",
        )

    upload_folder = f"{CACHE_DIR}/pipelines"
    os.makedirs(upload_folder, exist_ok=True)
    file_path = os.path.join(upload_folder, file.filename)

    try:
        # Save the uploaded file
        with open(file_path, "wb") as buffer:
            shutil.copyfileobj(file.file, buffer)

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

        headers = {"Authorization": f"Bearer {key}"}

        with open(file_path, "rb") as f:
            files = {"file": f}
            r = requests.post(f"{url}/pipelines/upload", headers=headers, files=files)

        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,
        )
    finally:
        # Ensure the file is deleted after the upload is completed or on failure
        if os.path.exists(file_path):
            os.remove(file_path)


Timothy J. Baek's avatar
Timothy J. Baek committed
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
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
1586
@app.get("/api/pipelines")
1587
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1588
1589
1590
    r = None
    try:
        urlIdx
1591

Timothy J. Baek's avatar
Timothy J. Baek committed
1592
1593
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1594

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1598
1599
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1600

Timothy J. Baek's avatar
Timothy J. Baek committed
1601
1602
1603
1604
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1605

Timothy J. Baek's avatar
Timothy J. Baek committed
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
        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
1619
1620


Timothy J. Baek's avatar
Timothy J. Baek committed
1621
1622
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
1623
1624
1625
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1626
):
1627
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1628
1629
    r = None
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1630

Timothy J. Baek's avatar
Timothy J. Baek committed
1631
1632
        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
1633

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1637
1638
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1639

Timothy J. Baek's avatar
Timothy J. Baek committed
1640
1641
1642
1643
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
1644

Timothy J. Baek's avatar
Timothy J. Baek committed
1645
        detail = "Pipeline not found"
1646

Timothy J. Baek's avatar
Timothy J. Baek committed
1647
1648
1649
1650
1651
1652
1653
        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
1654
1655

        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1656
1657
            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
1658
1659
1660
1661
        )


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
1662
async def get_pipeline_valves_spec(
1663
1664
1665
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1666
):
1667
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1668

Timothy J. Baek's avatar
Timothy J. Baek committed
1669
1670
1671
1672
    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
1673

Timothy J. Baek's avatar
Timothy J. Baek committed
1674
1675
        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
1676

Timothy J. Baek's avatar
Timothy J. Baek committed
1677
1678
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1679

Timothy J. Baek's avatar
Timothy J. Baek committed
1680
1681
1682
1683
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1684

Timothy J. Baek's avatar
Timothy J. Baek committed
1685
1686
1687
1688
1689
1690
1691
1692
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1693

Timothy J. Baek's avatar
Timothy J. Baek committed
1694
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1695
1696
            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
1697
1698
1699
1700
1701
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1702
1703
1704
1705
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1706
):
1707
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1708

Timothy J. Baek's avatar
Timothy J. Baek committed
1709
1710
1711
1712
    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
1713

Timothy J. Baek's avatar
Timothy J. Baek committed
1714
1715
1716
1717
1718
1719
        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
1720

Timothy J. Baek's avatar
Timothy J. Baek committed
1721
1722
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1723

Timothy J. Baek's avatar
Timothy J. Baek committed
1724
1725
1726
1727
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1728

Timothy J. Baek's avatar
Timothy J. Baek committed
1729
        detail = "Pipeline not found"
1730

Timothy J. Baek's avatar
Timothy J. Baek committed
1731
1732
1733
1734
1735
1736
1737
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1738

Timothy J. Baek's avatar
Timothy J. Baek committed
1739
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1740
            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
1741
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1742
1743
1744
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1745
1746
1747
1748
1749
1750
1751
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1752
1753
1754
1755
@app.get("/api/config")
async def get_app_config():
    return {
        "status": True,
1756
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1757
        "version": VERSION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1758
        "default_locale": str(DEFAULT_LOCALE),
1759
1760
        "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
1761
        "features": {
1762
1763
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1764
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
Timothy J. Baek committed
1765
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
1766
            "enable_image_generation": images_app.state.config.ENABLED,
1767
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
1768
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
1769
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1770
1771
1772
1773
1774
1775
1776
1777
1778
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
1779
1780
1781
1782
1783
1784
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1785
1786
1787
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1788
1789
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
1790
    return {
1791
1792
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1793
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1794
1795
1796
1797
1798
1799
1800
1801


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
1802
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
1803
1804
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1805
1806
    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
1807

1808
    return {
1809
1810
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1811
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1812
1813


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1814
1815
1816
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
1817
1818
1819
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
1820
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
1821
1822
1823
1824
1825
1826
1827
1828
1829
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
1830
1831
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
1832
    return {"url": app.state.config.WEBHOOK_URL}
1833
1834


1835
1836
1837
1838
1839
1840
1841
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1842
1843
@app.get("/api/changelog")
async def get_app_changelog():
1844
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
1845
1846


1847
1848
1849
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
1850
        async with aiohttp.ClientSession(trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1851
1852
1853
1854
1855
1856
1857
1858
1859
            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:
1860
1861
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1862
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
1863
1864
        )

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

1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
############################
# OAuth Login & Callback
############################

oauth = OAuth()

for provider_name, provider_config in OAUTH_PROVIDERS.items():
    oauth.register(
        name=provider_name,
        client_id=provider_config["client_id"],
        client_secret=provider_config["client_secret"],
        server_metadata_url=provider_config["server_metadata_url"],
        client_kwargs={
            "scope": provider_config["scope"],
        },
    )

# SessionMiddleware is used by authlib for oauth
if len(OAUTH_PROVIDERS) > 0:
    app.add_middleware(
1886
1887
1888
1889
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
1890
        https_only=WEBUI_SESSION_COOKIE_SECURE,
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
    )


@app.get("/oauth/{provider}/login")
async def oauth_login(provider: str, request: Request):
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    redirect_uri = request.url_for("oauth_callback", provider=provider)
    return await oauth.create_client(provider).authorize_redirect(request, redirect_uri)


1902
1903
1904
1905
1906
1907
# OAuth login logic is as follows:
# 1. Attempt to find a user with matching subject ID, tied to the provider
# 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
#    - This is considered insecure in general, as OAuth providers do not always verify email addresses
# 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
#    - Email addresses are considered unique, so we fail registration if the email address is alreayd taken
1908
@app.get("/oauth/{provider}/callback")
1909
async def oauth_callback(provider: str, request: Request, response: Response):
1910
1911
1912
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
1913
1914
1915
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
1916
        log.warning(f"OAuth callback error: {e}")
1917
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1918
1919
1920
1921
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
1922
        log.warning(f"OAuth callback failed, sub is missing: {user_data}")
1923
1924
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"
1925
1926
1927
    email = user_data.get("email", "").lower()
    # We currently mandate that email addresses are provided
    if not email:
1928
        log.warning(f"OAuth callback failed, email is missing: {user_data}")
1929
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1930
1931
1932
1933
1934
1935

    # Check if the user exists
    user = Users.get_user_by_oauth_sub(provider_sub)

    if not user:
        # If the user does not exist, check if merging is enabled
1936
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
1937
            # Check if the user exists by email
1938
            user = Users.get_user_by_email(email)
1939
1940
1941
1942
1943
1944
1945
            if user:
                # Update the user with the new oauth sub
                Users.update_user_oauth_sub_by_id(user.id, provider_sub)

    if not user:
        # If the user does not exist, check if signups are enabled
        if ENABLE_OAUTH_SIGNUP.value:
1946
1947
1948
1949
1950
            # Check if an existing user with the same email already exists
            existing_user = Users.get_user_by_email(user_data.get("email", "").lower())
            if existing_user:
                raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)

1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
            picture_url = user_data.get("picture", "")
            if picture_url:
                # Download the profile image into a base64 string
                try:
                    async with aiohttp.ClientSession() as session:
                        async with session.get(picture_url) as resp:
                            picture = await resp.read()
                            base64_encoded_picture = base64.b64encode(picture).decode(
                                "utf-8"
                            )
                            guessed_mime_type = mimetypes.guess_type(picture_url)[0]
                            if guessed_mime_type is None:
                                # assume JPG, browsers are tolerant enough of image formats
                                guessed_mime_type = "image/jpeg"
                            picture_url = f"data:{guessed_mime_type};base64,{base64_encoded_picture}"
                except Exception as e:
1967
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
1968
1969
1970
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
1971
1972
1973
1974
1975
            role = (
                "admin"
                if Users.get_num_users() == 0
                else webui_app.state.config.DEFAULT_USER_ROLE
            )
1976
            user = Auths.insert_new_auth(
1977
                email=email,
1978
1979
1980
1981
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
                name=user_data.get("name", "User"),
1982
                profile_image_url=picture_url,
1983
                role=role,
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
                oauth_sub=provider_sub,
            )

            if webui_app.state.config.WEBHOOK_URL:
                post_webhook(
                    webui_app.state.config.WEBHOOK_URL,
                    WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
                    {
                        "action": "signup",
                        "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
                        "user": user.model_dump_json(exclude_none=True),
                    },
                )
        else:
1998
1999
2000
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
2001
2002
2003
2004
2005
2006

    jwt_token = create_token(
        data={"id": user.id},
        expires_delta=parse_duration(webui_app.state.config.JWT_EXPIRES_IN),
    )

2007
2008
2009
    # Set the cookie token
    response.set_cookie(
        key="token",
2010
        value=jwt_token,
2011
2012
2013
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

2014
2015
2016
2017
2018
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


2019
2020
2021
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2022
2023
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
2024
2025
2026
2027
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2028
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2029
2030
    }

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

2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
@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
2047
2048
2049
2050
2051
@app.get("/health")
async def healthcheck():
    return {"status": True}


2052
@app.get("/health/db")
2053
async def healthcheck_with_db():
2054
    Session.execute(text("SELECT 1;")).all()
2055
2056
2057
    return {"status": True}


2058
2059
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2060

2061
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2062
    mimetypes.add_type("text/javascript", ".js")
2063
2064
2065
2066
2067
2068
2069
2070
2071
    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."
    )