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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
20
from fastapi import FastAPI, Request, Depends, status, UploadFile, File, Form
Timothy J. Baek's avatar
Timothy J. Baek committed
21
from fastapi.staticfiles import StaticFiles
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
22
from fastapi.responses import JSONResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
23
24
from fastapi import HTTPException
from fastapi.middleware.cors import CORSMiddleware
25
from sqlalchemy import text
26
from starlette.exceptions import HTTPException as StarletteHTTPException
Timothy J. Baek's avatar
Timothy J. Baek committed
27
from starlette.middleware.base import BaseHTTPMiddleware
28
29
from starlette.middleware.sessions import SessionMiddleware
from starlette.responses import StreamingResponse, Response, RedirectResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
30

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

Timothy J. Baek's avatar
Timothy J. Baek committed
32
from apps.socket.main import sio, app as socket_app
33
34
35
36
37
38
39
40
41
42
from apps.ollama.main import (
    app as ollama_app,
    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
43

Timothy J. Baek's avatar
Timothy J. Baek committed
44
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
45
46
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
47
48
49
50
51
from apps.webui.main import (
    app as webui_app,
    get_pipe_models,
    generate_function_chat_completion,
)
Michael Poluektov's avatar
Michael Poluektov committed
52
from apps.webui.internal.db import Session
Timothy J. Baek's avatar
Timothy J. Baek committed
53

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

Timothy J. Baek's avatar
Timothy J. Baek committed
55
from pydantic import BaseModel
Michael Poluektov's avatar
Michael Poluektov committed
56
from typing import List, Optional
Timothy J. Baek's avatar
Timothy J. Baek committed
57

58
from apps.webui.models.auths import Auths
Michael Poluektov's avatar
Michael Poluektov committed
59
from apps.webui.models.models import Models
Timothy J. Baek's avatar
Timothy J. Baek committed
60
from apps.webui.models.tools import Tools
Timothy J. Baek's avatar
Timothy J. Baek committed
61
from apps.webui.models.functions import Functions
62
from apps.webui.models.users import Users
Timothy J. Baek's avatar
Timothy J. Baek committed
63
64

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

66
67
68
69
70
from utils.utils import (
    get_admin_user,
    get_verified_user,
    get_current_user,
    get_http_authorization_cred,
71
72
    get_password_hash,
    create_token,
73
)
Timothy J. Baek's avatar
Timothy J. Baek committed
74
75
76
77
78
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
79
80
81
from utils.misc import (
    get_last_user_message,
    add_or_update_system_message,
82
    parse_duration,
Timothy J. Baek's avatar
Timothy J. Baek committed
83
)
Timothy J. Baek's avatar
Timothy J. Baek committed
84

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

87
88
from config import (
    WEBUI_NAME,
89
    WEBUI_URL,
90
    WEBUI_AUTH,
91
92
93
94
    ENV,
    VERSION,
    CHANGELOG,
    FRONTEND_BUILD_DIR,
95
96
    CACHE_DIR,
    STATIC_DIR,
Timothy J. Baek's avatar
Timothy J. Baek committed
97
    DEFAULT_LOCALE,
98
99
    ENABLE_OPENAI_API,
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
Timothy J. Baek committed
100
    ENABLE_MODEL_FILTER,
101
    MODEL_FILTER_LIST,
102
103
    GLOBAL_LOG_LEVEL,
    SRC_LOG_LEVELS,
Timothy J. Baek's avatar
Timothy J. Baek committed
104
    WEBHOOK_URL,
105
    ENABLE_ADMIN_EXPORT,
106
    WEBUI_BUILD_HASH,
Timothy J. Baek's avatar
Timothy J. Baek committed
107
108
    TASK_MODEL,
    TASK_MODEL_EXTERNAL,
Timothy J. Baek's avatar
Timothy J. Baek committed
109
    TITLE_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
110
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
111
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
112
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
113
    SAFE_MODE,
114
    OAUTH_PROVIDERS,
115
116
117
    ENABLE_OAUTH_SIGNUP,
    OAUTH_MERGE_ACCOUNTS_BY_EMAIL,
    WEBUI_SECRET_KEY,
118
    WEBUI_SESSION_COOKIE_SAME_SITE,
119
    WEBUI_SESSION_COOKIE_SECURE,
Timothy J. Baek's avatar
Timothy J. Baek committed
120
    AppConfig,
121
)
Michael Poluektov's avatar
Michael Poluektov committed
122

Timothy J. Baek's avatar
Timothy J. Baek committed
123
from constants import ERROR_MESSAGES, WEBHOOK_MESSAGES, TASKS
124
from utils.webhook import post_webhook
125

Timothy J. Baek's avatar
Timothy J. Baek committed
126
127
128
129
130
if SAFE_MODE:
    print("SAFE MODE ENABLED")
    Functions.deactivate_all_functions()


131
132
133
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
134

135

Timothy J. Baek's avatar
Timothy J. Baek committed
136
137
138
139
140
141
142
143
144
145
146
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
147
print(
Timothy J. Baek's avatar
Timothy J. Baek committed
148
    rf"""
Timothy J. Baek's avatar
Timothy J. Baek committed
149
150
151
152
153
154
155
156
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __   \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \   \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |   \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|    \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

      
157
v{VERSION} - building the best open-source AI user interface.
158
{f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
Timothy J. Baek's avatar
Timothy J. Baek committed
159
160
161
162
https://github.com/open-webui/open-webui
"""
)

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

164
def run_migrations():
Timothy J. Baek's avatar
Timothy J. Baek committed
165
166
167
168
169
170
171
172
    try:
        from alembic.config import Config
        from alembic import command

        alembic_cfg = Config("alembic.ini")
        command.upgrade(alembic_cfg, "head")
    except Exception as e:
        print(f"Error: {e}")
173
174


175
176
@asynccontextmanager
async def lifespan(app: FastAPI):
177
    run_migrations()
178
179
180
181
182
183
    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
184

185
app.state.config = AppConfig()
186
187
188
189

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

190
191
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
192

193
app.state.config.WEBHOOK_URL = WEBHOOK_URL
Timothy J. Baek's avatar
Timothy J. Baek committed
194
195
196
197


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
198
app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
Timothy J. Baek's avatar
Timothy J. Baek committed
199
200
201
app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
202
203
204
app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
)
Timothy J. Baek's avatar
Timothy J. Baek committed
205
206
207
app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
208
209
210

app.state.MODELS = {}

Timothy J. Baek's avatar
Timothy J. Baek committed
211
212
origins = ["*"]

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
214
215
216
217
218
219
220
##################################
#
# ChatCompletion Middleware
#
##################################


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
221
222
223
224
225
226
227
228
async def get_body_and_model_and_user(request):
    # Read the original request body
    body = await request.body()
    body_str = body.decode("utf-8")
    body = json.loads(body_str) if body_str else {}

    model_id = body["model"]
    if model_id not in app.state.MODELS:
229
        raise Exception("Model not found")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
    model = app.state.MODELS[model_id]

    user = get_current_user(
        request,
        get_http_authorization_cred(request.headers.get("Authorization")),
    )

    return body, model, user


def get_task_model_id(default_model_id):
    # Set the task model
    task_model_id = default_model_id
    # Check if the user has a custom task model and use that model
    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

    return task_model_id


def get_filter_function_ids(model):
    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_global_filter_functions()]
    if "info" in model and "meta" in model["info"]:
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
        filter_ids = list(set(filter_ids))

    enabled_filter_ids = [
        function.id
        for function in Functions.get_functions_by_type("filter", active_only=True)
    ]

    filter_ids = [
        filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
    ]

    filter_ids.sort(key=get_priority)
    return filter_ids


Timothy J. Baek's avatar
Timothy J. Baek committed
285
async def get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
286
287
288
289
290
291
292
    messages,
    files,
    tool_id,
    template,
    task_model_id,
    user,
    __event_emitter__=None,
Timothy J. Baek's avatar
Timothy J. Baek committed
293
    __event_call__=None,
Timothy J. Baek's avatar
Timothy J. Baek committed
294
):
Timothy J. Baek's avatar
Timothy J. Baek committed
295
296
297
    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
298

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
299
300
301
302
303
    user_message = get_last_user_message(messages)
    prompt = (
        "History:\n"
        + "\n".join(
            [
Timothy J. Baek's avatar
Timothy J. Baek committed
304
                f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
305
306
307
308
309
310
311
312
                for message in messages[::-1][:4]
            ]
        )
        + f"\nQuery: {user_message}"
    )

    print(prompt)

Timothy J. Baek's avatar
Timothy J. Baek committed
313
314
315
316
317
318
319
    payload = {
        "model": task_model_id,
        "messages": [
            {"role": "system", "content": content},
            {"role": "user", "content": f"Query: {prompt}"},
        ],
        "stream": False,
Timothy J. Baek's avatar
Timothy J. Baek committed
320
        "task": TASKS.FUNCTION_CALLING,
Timothy J. Baek's avatar
Timothy J. Baek committed
321
322
    }

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
323
324
325
326
327
    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        raise e

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

Timothy J. Baek's avatar
Timothy J. Baek committed
330
    response = None
Timothy J. Baek's avatar
Timothy J. Baek committed
331
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
332
        response = await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
333
334
        content = None

Timothy J. Baek's avatar
Timothy J. Baek committed
335
336
337
338
339
340
341
342
343
344
        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
345

Michael Poluektov's avatar
Michael Poluektov committed
346
347
348
        if content is None:
            return None, None, False

Timothy J. Baek's avatar
Timothy J. Baek committed
349
        # Parse the function response
Michael Poluektov's avatar
Michael Poluektov committed
350
351
352
        print(f"content: {content}")
        result = json.loads(content)
        print(result)
Timothy J. Baek's avatar
Timothy J. Baek committed
353

Michael Poluektov's avatar
Michael Poluektov committed
354
        citation = None
355

Michael Poluektov's avatar
Michael Poluektov committed
356
357
        if "name" not in result:
            return None, None, False
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
358

Michael Poluektov's avatar
Michael Poluektov committed
359
360
361
362
363
364
        # Call the function
        if tool_id in webui_app.state.TOOLS:
            toolkit_module = webui_app.state.TOOLS[tool_id]
        else:
            toolkit_module, _ = load_toolkit_module_by_id(tool_id)
            webui_app.state.TOOLS[tool_id] = toolkit_module
365

Michael Poluektov's avatar
Michael Poluektov committed
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
        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)

        if hasattr(toolkit_module, "valves") and hasattr(toolkit_module, "Valves"):
            valves = Tools.get_tool_valves_by_id(tool_id)
            toolkit_module.valves = toolkit_module.Valves(**(valves if valves else {}))

        function = getattr(toolkit_module, result["name"])
        function_result = None
        try:
            # Get the signature of the function
            sig = inspect.signature(function)
            params = result["parameters"]

            # Extra parameters to be passed to the function
            extra_params = {
                "__model__": model,
                "__id__": tool_id,
                "__messages__": messages,
                "__files__": files,
                "__event_emitter__": __event_emitter__,
                "__event_call__": __event_call__,
            }

            # Add extra params in contained in function signature
            for key, value in extra_params.items():
                if key in sig.parameters:
                    params[key] = value

            if "__user__" in sig.parameters:
                # Call the function with the '__user__' parameter included
                __user__ = {
                    "id": user.id,
                    "email": user.email,
                    "name": user.name,
                    "role": user.role,
                }

                try:
                    if hasattr(toolkit_module, "UserValves"):
                        __user__["valves"] = toolkit_module.UserValves(
                            **Tools.get_user_valves_by_id_and_user_id(tool_id, user.id)
                        )
Timothy J. Baek's avatar
Timothy J. Baek committed
412
413
414
                except Exception as e:
                    print(e)

Michael Poluektov's avatar
Michael Poluektov committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
                params = {**params, "__user__": __user__}

            if inspect.iscoroutinefunction(function):
                function_result = await function(**params)
            else:
                function_result = function(**params)

            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"]}],
                }
        except Exception as e:
            print(e)

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

Timothy J. Baek's avatar
Timothy J. Baek committed
437
    return None, None, False
Timothy J. Baek's avatar
Timothy J. Baek committed
438
439


Timothy J. Baek's avatar
Timothy J. Baek committed
440
441
442
async def chat_completion_functions_handler(
    body, model, user, __event_emitter__, __event_call__
):
443
444
445
446
447
    skip_files = None

    filter_ids = get_filter_function_ids(model)
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
Michael Poluektov's avatar
Michael Poluektov committed
448
449
        if not filter:
            continue
Timothy J. Baek's avatar
Timothy J. Baek committed
450

Michael Poluektov's avatar
Michael Poluektov committed
451
452
453
454
455
        if filter_id in webui_app.state.FUNCTIONS:
            function_module = webui_app.state.FUNCTIONS[filter_id]
        else:
            function_module, _, _ = load_function_module_by_id(filter_id)
            webui_app.state.FUNCTIONS[filter_id] = function_module
456

Michael Poluektov's avatar
Michael Poluektov committed
457
458
459
        # Check if the function has a file_handler variable
        if hasattr(function_module, "file_handler"):
            skip_files = function_module.file_handler
460

Michael Poluektov's avatar
Michael Poluektov committed
461
462
463
464
465
466
        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 {})
            )

Michael Poluektov's avatar
Michael Poluektov committed
467
468
469
        if not hasattr(function_module, "inlet"):
            continue

Michael Poluektov's avatar
Michael Poluektov committed
470
        try:
Michael Poluektov's avatar
Michael Poluektov committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
            inlet = function_module.inlet

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

            # Extra parameters to be passed to the function
            extra_params = {
                "__model__": model,
                "__id__": filter_id,
                "__event_emitter__": __event_emitter__,
                "__event_call__": __event_call__,
            }

            # Add extra params in contained in function signature
            for key, value in extra_params.items():
                if key in sig.parameters:
                    params[key] = value

            if "__user__" in sig.parameters:
                __user__ = {
                    "id": user.id,
                    "email": user.email,
                    "name": user.name,
                    "role": user.role,
Michael Poluektov's avatar
Michael Poluektov committed
496
497
                }

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

Michael Poluektov's avatar
Michael Poluektov committed
508
                params = {**params, "__user__": __user__}
Michael Poluektov's avatar
Michael Poluektov committed
509

Michael Poluektov's avatar
Michael Poluektov committed
510
511
512
513
            if inspect.iscoroutinefunction(inlet):
                body = await inlet(**params)
            else:
                body = inlet(**params)
Michael Poluektov's avatar
Michael Poluektov committed
514
515
516
517

        except Exception as e:
            print(f"Error: {e}")
            raise e
Timothy J. Baek's avatar
Timothy J. Baek committed
518

519
520
521
    if skip_files:
        if "files" in body:
            del body["files"]
Timothy J. Baek's avatar
Timothy J. Baek committed
522

523
    return body, {}
Timothy J. Baek's avatar
Timothy J. Baek committed
524

525

Michael Poluektov's avatar
Michael Poluektov committed
526
async def chat_completion_tools_handler(body, user, __event_emitter__, __event_call__):
527
    skip_files = None
Timothy J. Baek's avatar
Timothy J. Baek committed
528

529
530
    contexts = []
    citations = None
Timothy J. Baek's avatar
Timothy J. Baek committed
531

532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
    task_model_id = get_task_model_id(body["model"])

    # If tool_ids field is present, call the functions
    if "tool_ids" in body:
        print(body["tool_ids"])
        for tool_id in body["tool_ids"]:
            print(tool_id)
            try:
                response, citation, file_handler = await get_function_call_response(
                    messages=body["messages"],
                    files=body.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
Timothy J. Baek committed
547
                    __event_emitter__=__event_emitter__,
Timothy J. Baek's avatar
Timothy J. Baek committed
548
                    __event_call__=__event_call__,
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
                )

                print(file_handler)
                if isinstance(response, str):
                    contexts.append(response)

                if citation:
                    if citations is None:
                        citations = [citation]
                    else:
                        citations.append(citation)

                if file_handler:
                    skip_files = True

            except Exception as e:
                print(f"Error: {e}")
        del body["tool_ids"]
        print(f"tool_contexts: {contexts}")

    if skip_files:
        if "files" in body:
            del body["files"]

    return body, {
        **({"contexts": contexts} if contexts is not None else {}),
        **({"citations": citations} if citations is not None else {}),
    }


async def chat_completion_files_handler(body):
    contexts = []
    citations = None

    if "files" in body:
        files = body["files"]
        del body["files"]

        contexts, citations = get_rag_context(
            files=files,
            messages=body["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,
        )

        log.debug(f"rag_contexts: {contexts}, citations: {citations}")

    return body, {
        **({"contexts": contexts} if contexts is not None else {}),
        **({"citations": citations} if citations is not None else {}),
    }


class ChatCompletionMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and any(
            endpoint in request.url.path
            for endpoint in ["/ollama/api/chat", "/chat/completions"]
        ):
            log.debug(f"request.url.path: {request.url.path}")

            try:
                body, model, user = await get_body_and_model_and_user(request)
            except Exception as e:
                return JSONResponse(
                    status_code=status.HTTP_400_BAD_REQUEST,
                    content={"detail": str(e)},
                )

Timothy J. Baek's avatar
Timothy J. Baek committed
621
622
623
624
625
            # Extract session_id, chat_id and message_id from the request body
            session_id = None
            if "session_id" in body:
                session_id = body["session_id"]
                del body["session_id"]
626
627
628
629
630
631
632
633
634
            chat_id = None
            if "chat_id" in body:
                chat_id = body["chat_id"]
                del body["chat_id"]
            message_id = None
            if "id" in body:
                message_id = body["id"]
                del body["id"]

Timothy J. Baek's avatar
Timothy J. Baek committed
635
636
637
638
639
640
641
642
643
644
645
            async def __event_emitter__(data):
                await sio.emit(
                    "chat-events",
                    {
                        "chat_id": chat_id,
                        "message_id": message_id,
                        "data": data,
                    },
                    to=session_id,
                )

Timothy J. Baek's avatar
Timothy J. Baek committed
646
647
648
649
650
651
652
653
            async def __event_call__(data):
                response = await sio.call(
                    "chat-events",
                    {"chat_id": chat_id, "message_id": message_id, "data": data},
                    to=session_id,
                )
                return response

654
655
656
657
658
659
660
661
            # Initialize data_items to store additional data to be sent to the client
            data_items = []

            # Initialize context, and citations
            contexts = []
            citations = []

            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
662
                body, flags = await chat_completion_functions_handler(
Timothy J. Baek's avatar
Timothy J. Baek committed
663
                    body, model, user, __event_emitter__, __event_call__
Timothy J. Baek's avatar
Timothy J. Baek committed
664
                )
665
666
667
668
            except Exception as e:
                return JSONResponse(
                    status_code=status.HTTP_400_BAD_REQUEST,
                    content={"detail": str(e)},
Timothy J. Baek's avatar
Timothy J. Baek committed
669
                )
670
671

            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
672
                body, flags = await chat_completion_tools_handler(
Michael Poluektov's avatar
Michael Poluektov committed
673
                    body, user, __event_emitter__, __event_call__
Timothy J. Baek's avatar
Timothy J. Baek committed
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

                contexts.extend(flags.get("contexts", []))
                citations.extend(flags.get("citations", []))
            except Exception as e:
                print(e)
                pass

            try:
                body, flags = await chat_completion_files_handler(body)

                contexts.extend(flags.get("contexts", []))
                citations.extend(flags.get("citations", []))
            except Exception as e:
                print(e)
                pass

            # If context is not empty, insert it into the messages
            if len(contexts) > 0:
                context_string = "/n".join(contexts).strip()
                prompt = get_last_user_message(body["messages"])
                body["messages"] = add_or_update_system_message(
                    rag_template(
                        rag_app.state.config.RAG_TEMPLATE, context_string, prompt
                    ),
                    body["messages"],
700
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
701

702
703
704
705
706
            # If there are citations, add them to the data_items
            if len(citations) > 0:
                data_items.append({"citations": citations})

            modified_body_bytes = json.dumps(body).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
707
708
709
710
711
712
713
714
715
716
717
            # 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
718

Timothy J. Baek's avatar
Timothy J. Baek committed
719
            response = await call_next(request)
720
721
722
723
724
            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(
725
                        self.openai_stream_wrapper(response.body_iterator, data_items),
726
727
728
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
729
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
730
                    )
731
732

                return response
Timothy J. Baek's avatar
Timothy J. Baek committed
733
734
            else:
                return response
735

Timothy J. Baek's avatar
Timothy J. Baek committed
736
737
        # 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
738
739
740
741
742
        return response

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

743
744
745
746
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

747
748
749
        async for data in original_generator:
            yield data

750
751
752
753
    async def ollama_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"{json.dumps(item)}\n"

754
755
756
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
758
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
759

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
760
761
762
763
764
765
##################################
#
# Pipeline Middleware
#
##################################

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

767
def get_sorted_filters(model_id):
Timothy J. Baek's avatar
Timothy J. Baek committed
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
    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"])
783
784
785
786
787
788
789
    return sorted_filters


def filter_pipeline(payload, user):
    user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
    model_id = payload["model"]
    sorted_filters = get_sorted_filters(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821

    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:
822
                res = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
823
824
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
825

826
827
    if "pipeline" not in app.state.MODELS[model_id] and "task" in payload:
        del payload["task"]
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
828

Timothy J. Baek's avatar
Timothy J. Baek committed
829
830
831
    return payload


Timothy J. Baek's avatar
Timothy J. Baek committed
832
833
834
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
835
836
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
837
838
839
840
841
842
843
844
845
846
        ):
            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
847
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
848
                request,
849
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
850
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
851
852
853
854
855
856
857
858

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

Timothy J. Baek's avatar
Timothy J. Baek committed
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
            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
883
884
885
886
887
888
889
890
891
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


892
@app.middleware("http")
Jonathan Rohde's avatar
Jonathan Rohde committed
893
async def commit_session_after_request(request: Request, call_next):
894
    response = await call_next(request)
Jonathan Rohde's avatar
Jonathan Rohde committed
895
    log.debug("Commit session after request")
896
897
898
    Session.commit()
    return response

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

Timothy J. Baek's avatar
Timothy J. Baek committed
900
901
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
902
903
904
905
906
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
907
908
909
910
911
912
913
914
    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
915
916
917
918
919
920
@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
921

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

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

925
app.mount("/ollama", ollama_app)
926
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
927

Timothy J. Baek's avatar
Timothy J. Baek committed
928
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
929
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
930
931
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
932
933
934
935
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

936

Timothy J. Baek's avatar
Timothy J. Baek committed
937
async def get_all_models():
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
938
    pipe_models = []
939
940
941
    openai_models = []
    ollama_models = []

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
942
943
    pipe_models = await get_pipe_models()

944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
    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
962
    models = pipe_models + openai_models + ollama_models
963

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
964
    custom_models = Models.get_all_models()
965
966
967
    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
968
969
970
971
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
972
973
974
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
975
            owned_by = "openai"
Timothy J. Baek's avatar
Timothy J. Baek committed
976
977
            pipe = None

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
978
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
979
980
981
982
                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
983
                    owned_by = model["owned_by"]
Timothy J. Baek's avatar
Timothy J. Baek committed
984
985
                    if "pipe" in model:
                        pipe = model["pipe"]
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
986
987
                    break

988
989
990
991
992
993
            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
994
                    "owned_by": owned_by,
995
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
996
                    "preset": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
997
                    **({"pipe": pipe} if pipe is not None else {}),
998
999
1000
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
    app.state.MODELS = {model["id"]: model for model in models}
    webui_app.state.MODELS = app.state.MODELS

    return models


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

1011
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
1012
1013
1014
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
1015
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
1016
1017
    ]

1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
    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
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
@app.post("/api/chat/completions")
async def generate_chat_completions(form_data: dict, user=Depends(get_verified_user)):
    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

    model = app.state.MODELS[model_id]

Timothy J. Baek's avatar
Timothy J. Baek committed
1042
1043
    pipe = model.get("pipe")
    if pipe:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1044
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
    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
1055
1056
1057
1058
1059
1060
    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
1061

1062
    sorted_filters = get_sorted_filters(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1063
1064
    if "pipeline" in model:
        sorted_filters = [model] + sorted_filters
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079

    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
1080
1081
1082
1083
1084
1085
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
                        "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

1110
    async def __event_emitter__(event_data):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1111
1112
1113
1114
1115
        await sio.emit(
            "chat-events",
            {
                "chat_id": data["chat_id"],
                "message_id": data["id"],
1116
                "data": event_data,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1117
1118
1119
1120
            },
            to=data["session_id"],
        )

1121
    async def __event_call__(event_data):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1122
1123
        response = await sio.call(
            "chat-events",
1124
            {"chat_id": data["chat_id"], "message_id": data["id"], "data": event_data},
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1125
1126
1127
1128
            to=data["session_id"],
        )
        return response

1129
1130
1131
1132
1133
1134
    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
1135
    filter_ids = [function.id for function in Functions.get_global_filter_functions()]
Timothy J. Baek's avatar
Timothy J. Baek committed
1136
    if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
1137
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
1138
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1139

Timothy J. Baek's avatar
Timothy J. Baek committed
1140
1141
1142
1143
1144
1145
1146
1147
    enabled_filter_ids = [
        function.id
        for function in Functions.get_functions_by_type("filter", active_only=True)
    ]
    filter_ids = [
        filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
    ]

1148
1149
    # 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
1150

1151
1152
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
Michael Poluektov's avatar
Michael Poluektov committed
1153
1154
        if not filter:
            continue
1155

Michael Poluektov's avatar
Michael Poluektov committed
1156
1157
1158
1159
1160
        if filter_id in webui_app.state.FUNCTIONS:
            function_module = webui_app.state.FUNCTIONS[filter_id]
        else:
            function_module, _, _ = load_function_module_by_id(filter_id)
            webui_app.state.FUNCTIONS[filter_id] = function_module
1161

Michael Poluektov's avatar
Michael Poluektov committed
1162
1163
1164
1165
1166
        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 {})
            )
1167

Michael Poluektov's avatar
Michael Poluektov committed
1168
1169
        if not hasattr(function_module, "outlet"):
            continue
Michael Poluektov's avatar
Michael Poluektov committed
1170
        try:
Michael Poluektov's avatar
Michael Poluektov committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
            outlet = function_module.outlet

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

            # Extra parameters to be passed to the function
            extra_params = {
                "__model__": model,
                "__id__": filter_id,
                "__event_emitter__": __event_emitter__,
                "__event_call__": __event_call__,
            }

            # Add extra params in contained in function signature
            for key, value in extra_params.items():
                if key in sig.parameters:
                    params[key] = value

            if "__user__" in sig.parameters:
                __user__ = {
                    "id": user.id,
                    "email": user.email,
                    "name": user.name,
                    "role": user.role,
Michael Poluektov's avatar
Michael Poluektov committed
1196
1197
                }

Michael Poluektov's avatar
Michael Poluektov committed
1198
1199
1200
1201
1202
                try:
                    if hasattr(function_module, "UserValves"):
                        __user__["valves"] = function_module.UserValves(
                            **Functions.get_user_valves_by_id_and_user_id(
                                filter_id, user.id
Michael Poluektov's avatar
Michael Poluektov committed
1203
                            )
Michael Poluektov's avatar
Michael Poluektov committed
1204
1205
1206
                        )
                except Exception as e:
                    print(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
1207

Michael Poluektov's avatar
Michael Poluektov committed
1208
                params = {**params, "__user__": __user__}
Michael Poluektov's avatar
Michael Poluektov committed
1209

Michael Poluektov's avatar
Michael Poluektov committed
1210
1211
1212
1213
            if inspect.iscoroutinefunction(outlet):
                data = await outlet(**params)
            else:
                data = outlet(**params)
Michael Poluektov's avatar
Michael Poluektov committed
1214
1215
1216
1217
1218
1219
1220

        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
1221

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
    return data


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


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


Timothy J. Baek's avatar
Timothy J. Baek committed
1235
1236
1237
1238
1239
1240
1241
@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
1242
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1243
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1244
1245
1246
1247
1248
1249
1250
1251
    }


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
1252
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1253
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265


@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
1266
1267
1268
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1269
1270
1271
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1272
1273
1274
1275
1276
1277

    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
1278
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1279
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1280
1281
1282
    }


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1287
1288
1289
1290
1291
1292
1293
    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
1294
1295
    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
1296
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1297
1298

    print(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1299
1300
1301
1302

    template = app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1303
1304
1305
1306
1307
1308
        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
1309
1310
1311
1312
1313
1314
1315
1316
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 50,
        "chat_id": form_data.get("chat_id", None),
Timothy J. Baek's avatar
Timothy J. Baek committed
1317
        "task": TASKS.TITLE_GENERATION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1318
1319
    }

1320
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1321
1322
1323
1324
1325
1326
1327
1328

    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
1329

1330
1331
1332
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1333
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1334
1335


Timothy J. Baek's avatar
Timothy J. Baek committed
1336
1337
1338
1339
@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
1340
1341
1342
1343
1344
1345
    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
1346
1347
1348
1349
1350
1351
1352
1353
1354
    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
1355
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1356
1357
1358
1359
1360
1361

    print(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
1362
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1363
1364
1365
1366
1367
1368
1369
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
Timothy J. Baek committed
1370
        "task": TASKS.QUERY_GENERATION,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
    }

    print(payload)

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

1383
1384
1385
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1386
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401


@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
1402
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1403
1404
1405
1406

    print(model_id)

    template = '''
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1407
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
1408
1409
1410
1411
1412

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

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1413
1414
1415
1416
1417
1418
        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
1419
1420
1421
1422
1423
1424
1425
1426
    )

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

1430
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1431
1432
1433
1434
1435
1436
1437
1438

    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
1439

1440
1441
1442
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1443
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1444
1445


Timothy J. Baek's avatar
Timothy J. Baek committed
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
@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
1459
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1460
1461
1462
1463

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

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1464
    try:
Michael Poluektov's avatar
Michael Poluektov committed
1465
        context, _, _ = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1466
1467
1468
1469
1470
1471
            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
1472
1473
1474
1475
1476
1477
1478
        )
        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
1479
1480


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1481
1482
1483
1484
1485
##################################
#
# Pipelines Endpoints
#
##################################
1486
1487


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1488
# TODO: Refactor pipelines API endpoints below into a separate file
1489
1490


1491
1492
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1493
1494
1495
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1496
1497
1498
1499
1500
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512

    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
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
@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)

Michael Poluektov's avatar
Michael Poluektov committed
1529
    r = None
Timothy J. Baek's avatar
Timothy J. Baek committed
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
    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"
Michael Poluektov's avatar
Michael Poluektov committed
1553
        status_code = status.HTTP_404_NOT_FOUND
Timothy J. Baek's avatar
Timothy J. Baek committed
1554
        if r is not None:
Michael Poluektov's avatar
Michael Poluektov committed
1555
            status_code = r.status_code
Timothy J. Baek's avatar
Timothy J. Baek committed
1556
1557
1558
1559
1560
1561
1562
1563
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass

        raise HTTPException(
Michael Poluektov's avatar
Michael Poluektov committed
1564
            status_code=status_code,
Timothy J. Baek's avatar
Timothy J. Baek committed
1565
1566
1567
1568
1569
1570
1571
1572
            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
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
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
1659
@app.get("/api/pipelines")
1660
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1661
1662
1663
1664
    r = None
    try:
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1665

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1669
1670
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1671

Timothy J. Baek's avatar
Timothy J. Baek committed
1672
1673
1674
1675
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1676

Timothy J. Baek's avatar
Timothy J. Baek committed
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
        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
1690
1691


Timothy J. Baek's avatar
Timothy J. Baek committed
1692
1693
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
1694
1695
1696
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1697
1698
1699
1700
):
    models = await get_all_models()
    r = None
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1701

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1705
1706
        headers = {"Authorization": f"Bearer {key}"}
        r = requests.get(f"{url}/{pipeline_id}/valves", headers=headers)
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}")
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
Timothy J. Baek's avatar
Timothy J. Baek committed
1725
1726

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


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
1733
async def get_pipeline_valves_spec(
1734
1735
1736
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1737
):
Timothy J. Baek's avatar
Timothy J. Baek committed
1738
1739
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1740
1741
1742
1743
    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
1744

Timothy J. Baek's avatar
Timothy J. Baek committed
1745
1746
        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
1747

Timothy J. Baek's avatar
Timothy J. Baek committed
1748
1749
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1750

Timothy J. Baek's avatar
Timothy J. Baek committed
1751
1752
1753
1754
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1755

Timothy J. Baek's avatar
Timothy J. Baek committed
1756
1757
1758
1759
1760
1761
1762
1763
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1764

Timothy J. Baek's avatar
Timothy J. Baek committed
1765
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1766
1767
            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
1768
1769
1770
1771
1772
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1773
1774
1775
1776
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1777
1778
1779
):
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1780
1781
1782
1783
    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
1784

Timothy J. Baek's avatar
Timothy J. Baek committed
1785
1786
1787
1788
1789
1790
        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
1791

Timothy J. Baek's avatar
Timothy J. Baek committed
1792
1793
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1794

Timothy J. Baek's avatar
Timothy J. Baek committed
1795
1796
1797
1798
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1799

Timothy J. Baek's avatar
Timothy J. Baek committed
1800
        detail = "Pipeline not found"
1801

Timothy J. Baek's avatar
Timothy J. Baek committed
1802
1803
1804
1805
1806
1807
1808
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1809

Timothy J. Baek's avatar
Timothy J. Baek committed
1810
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1811
            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
1812
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1813
1814
1815
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1816
1817
1818
1819
1820
1821
1822
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1823
1824
1825
1826
@app.get("/api/config")
async def get_app_config():
    return {
        "status": True,
1827
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1828
        "version": VERSION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1829
        "default_locale": str(DEFAULT_LOCALE),
1830
1831
        "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
1832
        "features": {
1833
1834
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1835
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
Timothy J. Baek committed
1836
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
1837
            "enable_image_generation": images_app.state.config.ENABLED,
1838
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
1839
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
1840
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1841
1842
1843
1844
1845
1846
1847
1848
1849
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
1850
1851
1852
1853
1854
1855
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1856
1857
1858
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1859
1860
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
1861
    return {
1862
1863
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1864
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1865
1866
1867
1868
1869
1870
1871
1872


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
1873
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
1874
1875
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1876
1877
    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
1878

1879
    return {
1880
1881
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1882
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1883
1884


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1885
1886
1887
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
1888
1889
1890
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
1891
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
1892
1893
1894
1895
1896
1897
1898
1899
1900
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
1901
1902
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
1903
    return {"url": app.state.config.WEBHOOK_URL}
1904
1905


1906
1907
1908
1909
1910
1911
1912
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1913
1914
@app.get("/api/changelog")
async def get_app_changelog():
1915
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
1916
1917


1918
1919
1920
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
1921
        async with aiohttp.ClientSession(trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1922
1923
1924
1925
1926
1927
1928
1929
1930
            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:
1931
1932
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1933
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
1934
1935
        )

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

1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
############################
# 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(
1957
1958
1959
1960
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
1961
        https_only=WEBUI_SESSION_COOKIE_SECURE,
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
    )


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


1973
1974
1975
1976
1977
1978
# 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
1979
@app.get("/oauth/{provider}/callback")
1980
async def oauth_callback(provider: str, request: Request, response: Response):
1981
1982
1983
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
1984
1985
1986
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
1987
        log.warning(f"OAuth callback error: {e}")
1988
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1989
1990
1991
1992
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
1993
        log.warning(f"OAuth callback failed, sub is missing: {user_data}")
1994
1995
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"
1996
1997
1998
    email = user_data.get("email", "").lower()
    # We currently mandate that email addresses are provided
    if not email:
1999
        log.warning(f"OAuth callback failed, email is missing: {user_data}")
2000
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2001
2002
2003
2004
2005
2006

    # 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
2007
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
2008
            # Check if the user exists by email
2009
            user = Users.get_user_by_email(email)
2010
2011
2012
2013
2014
2015
2016
            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:
2017
2018
2019
2020
2021
            # 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)

2022
2023
            picture_claim = webui_app.state.config.OAUTH_PICTURE_CLAIM
            picture_url = user_data.get(picture_claim, "")
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
            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:
2039
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
2040
2041
2042
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
Sergey Mihaylin's avatar
Sergey Mihaylin committed
2043
            username_claim = webui_app.state.config.OAUTH_USERNAME_CLAIM
2044
2045
2046
2047
2048
            role = (
                "admin"
                if Users.get_num_users() == 0
                else webui_app.state.config.DEFAULT_USER_ROLE
            )
2049
            user = Auths.insert_new_auth(
2050
                email=email,
2051
2052
2053
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
Sergey Mihaylin's avatar
Sergey Mihaylin committed
2054
                name=user_data.get(username_claim, "User"),
2055
                profile_image_url=picture_url,
2056
                role=role,
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
                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:
2071
2072
2073
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
2074
2075
2076
2077
2078
2079

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

2080
2081
2082
    # Set the cookie token
    response.set_cookie(
        key="token",
2083
        value=jwt_token,
2084
2085
2086
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

2087
2088
2089
2090
2091
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


2092
2093
2094
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2095
2096
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
2097
2098
2099
2100
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2101
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2102
2103
    }

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

2105
2106
2107
2108
2109
2110
2111
@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>
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2112
    <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/static/favicon.png</Image>
2113
2114
2115
2116
2117
2118
2119
    <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
2120
2121
2122
2123
2124
@app.get("/health")
async def healthcheck():
    return {"status": True}


2125
@app.get("/health/db")
2126
async def healthcheck_with_db():
2127
    Session.execute(text("SELECT 1;")).all()
2128
2129
2130
    return {"status": True}


2131
2132
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2133

2134
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2135
    mimetypes.add_type("text/javascript", ".js")
2136
2137
2138
2139
2140
2141
2142
2143
2144
    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."
    )