main.py 66.6 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,
107
108
    ENABLE_OPENAI_API,
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
Timothy J. Baek committed
109
    ENABLE_MODEL_FILTER,
110
    MODEL_FILTER_LIST,
111
112
    GLOBAL_LOG_LEVEL,
    SRC_LOG_LEVELS,
Timothy J. Baek's avatar
Timothy J. Baek committed
113
    WEBHOOK_URL,
114
    ENABLE_ADMIN_EXPORT,
115
    WEBUI_BUILD_HASH,
Timothy J. Baek's avatar
Timothy J. Baek committed
116
117
    TASK_MODEL,
    TASK_MODEL_EXTERNAL,
Timothy J. Baek's avatar
Timothy J. Baek committed
118
    TITLE_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
119
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
120
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
121
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
122
    SAFE_MODE,
123
    OAUTH_PROVIDERS,
124
125
126
    ENABLE_OAUTH_SIGNUP,
    OAUTH_MERGE_ACCOUNTS_BY_EMAIL,
    WEBUI_SECRET_KEY,
127
    WEBUI_SESSION_COOKIE_SAME_SITE,
128
    WEBUI_SESSION_COOKIE_SECURE,
Timothy J. Baek's avatar
Timothy J. Baek committed
129
    AppConfig,
130
131
    BACKEND_DIR,
    DATABASE_URL,
132
)
133
134
from constants import ERROR_MESSAGES, WEBHOOK_MESSAGES
from utils.webhook import post_webhook
135

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


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

145

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

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

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

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


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

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

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

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

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


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
207
app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
Timothy J. Baek's avatar
Timothy J. Baek committed
208
209
210
app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
211
212
213
app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
)
Timothy J. Baek's avatar
Timothy J. Baek committed
214
215
216
app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
217
218
219

app.state.MODELS = {}

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

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

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


Timothy J. Baek's avatar
Timothy J. Baek committed
230
231
232
async def get_function_call_response(
    messages, files, tool_id, template, task_model_id, user
):
Timothy J. Baek's avatar
Timothy J. Baek committed
233
234
235
    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
236

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

    print(prompt)

Timothy J. Baek's avatar
Timothy J. Baek committed
251
252
253
254
255
256
257
258
259
    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
260
261
262
263
264
    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        raise e

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

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

        content = None

Timothy J. Baek's avatar
Timothy J. Baek committed
273
274
275
276
277
278
279
280
281
282
        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
283
284
285

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

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

299
300
301
302
303
304
                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
305
306
307
                if hasattr(toolkit_module, "valves") and hasattr(
                    toolkit_module, "Valves"
                ):
Timothy J. Baek's avatar
Timothy J. Baek committed
308
                    valves = Tools.get_tool_valves_by_id(tool_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
309
                    toolkit_module.valves = toolkit_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
310
                        **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
311
312
                    )

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

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
329
330
331
332
333
334
335
336
337
338
339
                        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__}
340
341
342
343
344
345
346
                    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
347
348
349
350
351
352
353
                    if "__files__" in sig.parameters:
                        # Call the function with the '__files__' parameter included
                        params = {
                            **params,
                            "__files__": files,
                        }

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

361
362
363
364
365
366
367
                    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
368
369
370
371
                    if inspect.iscoroutinefunction(function):
                        function_result = await function(**params)
                    else:
                        function_result = function(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
372
373
374
375
376
377
378

                    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
379
380
381
382
                except Exception as e:
                    print(e)

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

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


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

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
404
405
406
407
            # 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
408

Timothy J. Baek's avatar
Timothy J. Baek committed
409
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
410
                request,
411
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
412
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
413
414
            # 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
415
416
417
            if data.get("citations"):
                show_citations = True
                del data["citations"]
Timothy J. Baek's avatar
Timothy J. Baek committed
418
419
420

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

427
428
429
430
431
432
433
434
            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
435
436
437
438
439
440
            filter_ids = [
                function.id
                for function in Functions.get_functions_by_type(
                    "filter", active_only=True
                )
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
441
            # Check if the model has any filters
Timothy J. Baek's avatar
Timothy J. Baek committed
442
            if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
443
444
445
                filter_ids.extend(model["info"]["meta"].get("filterIds", []))
                filter_ids = list(set(filter_ids))

446
            filter_ids.sort(key=get_priority)
Timothy J. Baek's avatar
Timothy J. Baek committed
447
448
449
450
451
452
            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:
453
454
                        function_module, function_type, frontmatter = (
                            load_function_module_by_id(filter_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
455
456
                        )
                        webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
Timothy J. Baek committed
457

Timothy J. Baek's avatar
Timothy J. Baek committed
458
459
460
                    # 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
461

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
462
463
464
                    if hasattr(function_module, "valves") and hasattr(
                        function_module, "Valves"
                    ):
Timothy J. Baek's avatar
Timothy J. Baek committed
465
                        valves = Functions.get_function_valves_by_id(filter_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
466
                        function_module.valves = function_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
467
                            **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
468
469
                        )

Timothy J. Baek's avatar
Timothy J. Baek committed
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
                    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
491
                                            )
Timothy J. Baek's avatar
Timothy J. Baek committed
492
493
494
                                        )
                                except Exception as e:
                                    print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
495

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

Timothy J. Baek's avatar
Timothy J. Baek committed
498
499
500
501
502
                            if "__id__" in sig.parameters:
                                params = {
                                    **params,
                                    "__id__": filter_id,
                                }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
503

Timothy J. Baek's avatar
Timothy J. Baek committed
504
505
506
507
                            if inspect.iscoroutinefunction(inlet):
                                data = await inlet(**params)
                            else:
                                data = inlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
508

Timothy J. Baek's avatar
Timothy J. Baek committed
509
510
511
512
513
514
                    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
515
516
517
518

            # 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
519
520
521
522
523
524
525
526
527
528
529
530
531
            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
532
            prompt = get_last_user_message(data["messages"])
Timothy J. Baek's avatar
Timothy J. Baek committed
533
534
535
            context = ""

            # If tool_ids field is present, call the functions
Timothy J. Baek's avatar
Timothy J. Baek committed
536
            if "tool_ids" in data:
Timothy J. Baek's avatar
Timothy J. Baek committed
537
                print(data["tool_ids"])
Timothy J. Baek's avatar
Timothy J. Baek committed
538
                for tool_id in data["tool_ids"]:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
539
                    print(tool_id)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
540
                    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
541
542
543
544
545
546
547
548
549
                        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
550
                        )
Timothy J. Baek's avatar
Timothy J. Baek committed
551

552
                        print(file_handler)
553
                        if isinstance(response, str):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
554
                            context += ("\n" if context != "" else "") + response
555

Timothy J. Baek's avatar
Timothy J. Baek committed
556
557
558
559
                        if citation:
                            citations.append(citation)
                            show_citations = True

560
561
562
                        if file_handler:
                            skip_files = True

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
563
564
                    except Exception as e:
                        print(f"Error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
565
566
                del data["tool_ids"]

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

Timothy J. Baek's avatar
Timothy J. Baek committed
569
            # If files field is present, generate RAG completions
570
            # If skip_files is True, skip the RAG completions
Timothy J. Baek's avatar
Timothy J. Baek committed
571
            if "files" in data:
572
573
                if not skip_files:
                    data = {**data}
Timothy J. Baek's avatar
Timothy J. Baek committed
574
                    rag_context, rag_citations = get_rag_context(
575
576
577
578
579
580
581
582
583
584
                        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
585

586
                    log.debug(f"rag_context: {rag_context}, citations: {citations}")
587

Timothy J. Baek's avatar
Timothy J. Baek committed
588
589
                    if rag_citations:
                        citations.extend(rag_citations)
Timothy J. Baek's avatar
Timothy J. Baek committed
590

Timothy J. Baek's avatar
Timothy J. Baek committed
591
                del data["files"]
Timothy J. Baek's avatar
Timothy J. Baek committed
592

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

Timothy J. Baek's avatar
Timothy J. Baek committed
596
597
598
599
600
601
            if context != "":
                system_prompt = rag_template(
                    rag_app.state.config.RAG_TEMPLATE, context, prompt
                )
                print(system_prompt)
                data["messages"] = add_or_update_system_message(
602
                    system_prompt, data["messages"]
603
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
604

Timothy J. Baek's avatar
Timothy J. Baek committed
605
            modified_body_bytes = json.dumps(data).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
606
607
608
609
610
611
612
613
614
615
616
            # 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
617

Timothy J. Baek's avatar
Timothy J. Baek committed
618
            response = await call_next(request)
619
620
621
622
623
            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(
624
                        self.openai_stream_wrapper(response.body_iterator, data_items),
625
626
627
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
628
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
629
                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
630
631
            else:
                return response
632

Timothy J. Baek's avatar
Timothy J. Baek committed
633
634
        # 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
635
636
637
638
639
        return response

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

640
641
642
643
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

644
645
646
        async for data in original_generator:
            yield data

647
648
649
650
    async def ollama_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"{json.dumps(item)}\n"

651
652
653
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
655
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
656

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
657
658
659
660
661
662
##################################
#
# Pipeline Middleware
#
##################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
664
def filter_pipeline(payload, user):
665
    user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
Timothy J. Baek's avatar
Timothy J. Baek committed
666
667
668
669
670
671
672
673
674
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
    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
718
719
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
720
721
722
723
724
725
726
727
728
729

            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
730

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
731
732
733
        if "task" in payload:
            del payload["task"]

Timothy J. Baek's avatar
Timothy J. Baek committed
734
735
736
    return payload


Timothy J. Baek's avatar
Timothy J. Baek committed
737
738
739
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
740
741
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
742
743
744
745
746
747
748
749
750
751
        ):
            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
752
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
753
                request,
754
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
755
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
756
757
758
759
760
761
762
763

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

Timothy J. Baek's avatar
Timothy J. Baek committed
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
            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
788
789
790
791
792
793
794
795
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

796
@app.middleware("http")
Jonathan Rohde's avatar
Jonathan Rohde committed
797
async def commit_session_after_request(request: Request, call_next):
798
    response = await call_next(request)
Jonathan Rohde's avatar
Jonathan Rohde committed
799
    log.debug("Commit session after request")
800
801
802
    Session.commit()
    return response

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

Timothy J. Baek's avatar
Timothy J. Baek committed
804
805
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
806
    if len(app.state.MODELS) == 0:
807
        await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
808
809
810
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
811
812
813
814
815
816
817
818
    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
819
820
821
822
823
824
@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
825

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

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

829
app.mount("/ollama", ollama_app)
830
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
831

Timothy J. Baek's avatar
Timothy J. Baek committed
832
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
833
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
834
835
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
836
837
838
839
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

840

841
async def get_all_models():
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
842
    pipe_models = []
843
844
845
    openai_models = []
    ollama_models = []

846
    pipe_models = await get_pipe_models()
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
847

848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
    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
866
    models = pipe_models + openai_models + ollama_models
867

868
    custom_models = Models.get_all_models()
869
870
871
    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
872
873
874
875
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
876
877
878
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
879
880
            owned_by = "openai"
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
881
882
883
884
                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
885
886
887
                    owned_by = model["owned_by"]
                    break

888
889
890
891
892
893
            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
894
                    "owned_by": owned_by,
895
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
896
                    "preset": True,
897
898
899
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
900
901
902
903
904
905
906
907
    app.state.MODELS = {model["id"]: model for model in models}

    webui_app.state.MODELS = app.state.MODELS

    return models


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

911
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
912
913
914
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
915
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
916
917
    ]

918
919
920
921
922
923
924
925
926
927
928
929
930
    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
931
932
933
934
935
936
937
938
939
940
941
942
@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]
    print(model)

Timothy J. Baek's avatar
Timothy J. Baek committed
943
944
    pipe = model.get("pipe")
    if pipe:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
945
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
946
947
948
949
950
951
952
953
954
955
    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
956
957
958
959
960
961
    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
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977

    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
978
979
980
    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
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995

    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
996
997
998
999
1000
1001
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
                        "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

1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
    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

    filter_ids = [
        function.id
        for function in Functions.get_functions_by_type("filter", active_only=True)
    ]
Timothy J. Baek's avatar
Timothy J. Baek committed
1036
    # Check if the model has any filters
Timothy J. Baek's avatar
Timothy J. Baek committed
1037
    if "info" in model and "meta" in model["info"]:
1038
1039
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1040

1041
1042
    # 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
1043

1044
1045
1046
1047
1048
1049
    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:
1050
1051
1052
                function_module, function_type, frontmatter = (
                    load_function_module_by_id(filter_id)
                )
1053
                webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1054

1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
            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
1084
                                    )
1085
1086
1087
                                )
                        except Exception as e:
                            print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1088

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

1091
1092
1093
1094
1095
                    if "__id__" in sig.parameters:
                        params = {
                            **params,
                            "__id__": filter_id,
                        }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1096

1097
1098
1099
1100
                    if inspect.iscoroutinefunction(outlet):
                        data = await outlet(**params)
                    else:
                        data = outlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
1101

1102
1103
1104
1105
1106
1107
            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
1108

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
    return data


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


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


Timothy J. Baek's avatar
Timothy J. Baek committed
1122
1123
1124
1125
1126
1127
1128
@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
1129
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1130
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1131
1132
1133
1134
1135
1136
1137
1138
    }


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
1139
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1140
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152


@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
1153
1154
1155
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1156
1157
1158
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1159
1160
1161
1162
1163
1164

    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
1165
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1166
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1167
1168
1169
    }


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1174
1175
1176
1177
1178
1179
1180
    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
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
    # 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
1195
1196
1197
1198
1199
    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
1200
1201
1202
1203
1204
1205
        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
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
    )

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

1217
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1218
1219
1220
1221
1222
1223
1224
1225

    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
1226

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1227
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1228
1229


Timothy J. Baek's avatar
Timothy J. Baek committed
1230
1231
1232
1233
@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
1234
1235
1236
1237
1238
1239
    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
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
    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
1266
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1267
1268
1269
1270
1271
1272
1273
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
        "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
1287
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317


@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
1318
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
1319
1320
1321
1322
1323

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

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1324
1325
1326
1327
1328
1329
        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
1330
1331
1332
1333
1334
1335
1336
1337
1338
    )

    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
1339
1340
    }

1341
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1342
1343
1344
1345
1346
1347
1348
1349

    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
1350

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1351
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1352
1353


Timothy J. Baek's avatar
Timothy J. Baek committed
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
@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
1381
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1382
        context, citation, file_handler = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1383
1384
1385
1386
1387
1388
            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
1389
1390
1391
1392
1393
1394
1395
        )
        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
1396
1397


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1398
1399
1400
1401
1402
##################################
#
# Pipelines Endpoints
#
##################################
1403
1404


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1405
# TODO: Refactor pipelines API endpoints below into a separate file
1406
1407


1408
1409
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1410
1411
1412
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1413
1414
1415
1416
1417
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429

    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
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
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
@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
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
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
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
1573
@app.get("/api/pipelines")
1574
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1575
1576
1577
    r = None
    try:
        urlIdx
1578

Timothy J. Baek's avatar
Timothy J. Baek committed
1579
1580
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1581

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1585
1586
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1587

Timothy J. Baek's avatar
Timothy J. Baek committed
1588
1589
1590
1591
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1592

Timothy J. Baek's avatar
Timothy J. Baek committed
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
        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
1606
1607


Timothy J. Baek's avatar
Timothy J. Baek committed
1608
1609
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
1610
1611
1612
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1613
):
1614
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1615
1616
    r = None
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1617

Timothy J. Baek's avatar
Timothy J. Baek committed
1618
1619
        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
1620

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1624
1625
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1626

Timothy J. Baek's avatar
Timothy J. Baek committed
1627
1628
1629
1630
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
1631

Timothy J. Baek's avatar
Timothy J. Baek committed
1632
        detail = "Pipeline not found"
1633

Timothy J. Baek's avatar
Timothy J. Baek committed
1634
1635
1636
1637
1638
1639
1640
        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
1641
1642

        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1643
1644
            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
1645
1646
1647
1648
        )


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
1649
async def get_pipeline_valves_spec(
1650
1651
1652
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1653
):
1654
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1655

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1661
1662
        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
1663

Timothy J. Baek's avatar
Timothy J. Baek committed
1664
1665
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1666

Timothy J. Baek's avatar
Timothy J. Baek committed
1667
1668
1669
1670
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1671

Timothy J. Baek's avatar
Timothy J. Baek committed
1672
1673
1674
1675
1676
1677
1678
1679
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1680

Timothy J. Baek's avatar
Timothy J. Baek committed
1681
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1682
1683
            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
1684
1685
1686
1687
1688
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1689
1690
1691
1692
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1693
):
1694
    models = await get_all_models()
Timothy J. Baek's avatar
Timothy J. Baek committed
1695

Timothy J. Baek's avatar
Timothy J. Baek committed
1696
1697
1698
1699
    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
1700

Timothy J. Baek's avatar
Timothy J. Baek committed
1701
1702
1703
1704
1705
1706
        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
1707

Timothy J. Baek's avatar
Timothy J. Baek committed
1708
1709
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1710

Timothy J. Baek's avatar
Timothy J. Baek committed
1711
1712
1713
1714
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1715

Timothy J. Baek's avatar
Timothy J. Baek committed
1716
        detail = "Pipeline not found"
1717

Timothy J. Baek's avatar
Timothy J. Baek committed
1718
1719
1720
1721
1722
1723
1724
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1725

Timothy J. Baek's avatar
Timothy J. Baek committed
1726
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1727
            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
1728
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1729
1730
1731
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1732
1733
1734
1735
1736
1737
1738
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1739
1740
@app.get("/api/config")
async def get_app_config():
1741
    # Checking and Handling the Absence of 'ui' in CONFIG_DATA
1742
1743

    default_locale = "en-US"
1744
1745
1746
1747
    if "ui" in CONFIG_DATA:
        default_locale = CONFIG_DATA["ui"].get("default_locale", "en-US")

    # The Rest of the Function Now Uses the Variables Defined Above
Timothy J. Baek's avatar
Timothy J. Baek committed
1748
1749
    return {
        "status": True,
1750
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1751
        "version": VERSION,
1752
        "default_locale": default_locale,
1753
1754
        "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
1755
        "features": {
1756
1757
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1758
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
Timothy J. Baek committed
1759
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
1760
            "enable_image_generation": images_app.state.config.ENABLED,
1761
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
1762
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
1763
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1764
1765
1766
1767
1768
1769
1770
1771
1772
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
1773
1774
1775
1776
1777
1778
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1779
1780
1781
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1782
1783
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
1784
    return {
1785
1786
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1787
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1788
1789
1790
1791
1792
1793
1794
1795


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
1796
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
1797
1798
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1799
1800
    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
1801

1802
    return {
1803
1804
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1805
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1806
1807


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1808
1809
1810
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
1811
1812
1813
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
1814
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
1815
1816
1817
1818
1819
1820
1821
1822
1823
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
1824
1825
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
1826
    return {"url": app.state.config.WEBHOOK_URL}
1827
1828


1829
1830
1831
1832
1833
1834
1835
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1836
1837
@app.get("/api/changelog")
async def get_app_changelog():
1838
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
1839
1840


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

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

1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
############################
# 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(
1880
1881
1882
1883
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
1884
        https_only=WEBUI_SESSION_COOKIE_SECURE,
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
    )


@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)


1896
1897
1898
1899
1900
1901
# 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
1902
@app.get("/oauth/{provider}/callback")
1903
async def oauth_callback(provider: str, request: Request, response: Response):
1904
1905
1906
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
1907
1908
1909
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
1910
        log.warning(f"OAuth callback error: {e}")
1911
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1912
1913
1914
1915
    user_data: UserInfo = token["userinfo"]

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

    # 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
1930
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
1931
            # Check if the user exists by email
1932
            user = Users.get_user_by_email(email)
1933
1934
1935
1936
1937
1938
1939
            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:
1940
1941
1942
1943
1944
            # 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)

1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
            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:
1961
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
1962
1963
1964
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
1965
            user = Auths.insert_new_auth(
1966
                email=email,
1967
1968
1969
1970
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
                name=user_data.get("name", "User"),
1971
                profile_image_url=picture_url,
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
                role=webui_app.state.config.DEFAULT_USER_ROLE,
                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:
1987
1988
1989
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
1990
1991
1992
1993
1994
1995

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

1996
1997
1998
1999
2000
2001
2002
    # Set the cookie token
    response.set_cookie(
        key="token",
        value=token,
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

2003
2004
2005
2006
2007
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


2008
2009
2010
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2011
2012
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
2013
2014
2015
2016
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2017
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2018
2019
    }

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

2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
@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
2036
2037
2038
2039
2040
@app.get("/health")
async def healthcheck():
    return {"status": True}


2041
@app.get("/health/db")
2042
async def healthcheck_with_db():
2043
    Session.execute(text("SELECT 1;")).all()
2044
2045
2046
    return {"status": True}


2047
2048
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2049

2050
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2051
    mimetypes.add_type("text/javascript", ".js")
2052
2053
2054
2055
2056
2057
2058
2059
2060
    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."
    )