main.py 72.3 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
import shutil
Timothy J. Baek's avatar
Timothy J. Baek committed
16
import inspect
Timothy J. Baek's avatar
Timothy J. Baek committed
17

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

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

Michael Poluektov's avatar
Michael Poluektov committed
30
from apps.socket.main import app as socket_app, get_event_emitter, get_event_call
31
32
33
34
35
36
37
38
39
40
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
41

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

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

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

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

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

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

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

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

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

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


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

134

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

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

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

163
def run_migrations():
Timothy J. Baek's avatar
Timothy J. Baek committed
164
165
166
167
168
169
170
171
    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}")
172
173


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

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

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

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

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


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

app.state.MODELS = {}

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

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

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


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
220
221
222
223
224
225
226
227
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:
228
        raise Exception("Model not found")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
229
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
    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
284
async def get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
285
286
287
288
289
290
291
    messages,
    files,
    tool_id,
    template,
    task_model_id,
    user,
    __event_emitter__=None,
Timothy J. Baek's avatar
Timothy J. Baek committed
292
    __event_call__=None,
Timothy J. Baek's avatar
Timothy J. Baek committed
293
):
Timothy J. Baek's avatar
Timothy J. Baek committed
294
295
296
    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
297

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

    print(prompt)

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

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

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

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

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

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

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

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

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

Michael Poluektov's avatar
Michael Poluektov committed
358
359
360
361
362
363
        # 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
364

Michael Poluektov's avatar
Michael Poluektov committed
365
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
        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
411
412
413
                except Exception as e:
                    print(e)

Michael Poluektov's avatar
Michael Poluektov committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
                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
433
434
    except Exception as e:
        print(f"Error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
435

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


Timothy J. Baek's avatar
Timothy J. Baek committed
439
440
441
async def chat_completion_functions_handler(
    body, model, user, __event_emitter__, __event_call__
):
442
443
444
445
446
    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
447
448
        if not filter:
            continue
Timothy J. Baek's avatar
Timothy J. Baek committed
449

Michael Poluektov's avatar
Michael Poluektov committed
450
451
452
453
454
        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
455

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

Michael Poluektov's avatar
Michael Poluektov committed
460
461
462
463
464
465
        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
466
467
468
        if not hasattr(function_module, "inlet"):
            continue

Michael Poluektov's avatar
Michael Poluektov committed
469
        try:
Michael Poluektov's avatar
Michael Poluektov committed
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
            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
495
496
                }

Michael Poluektov's avatar
Michael Poluektov committed
497
498
499
500
501
                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
502
                            )
Michael Poluektov's avatar
Michael Poluektov committed
503
504
505
                        )
                except Exception as e:
                    print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
506

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

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

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

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

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

524

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

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

531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
    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
546
                    __event_emitter__=__event_emitter__,
Timothy J. Baek's avatar
Timothy J. Baek committed
547
                    __event_call__=__event_call__,
548
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
                )

                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)},
                )

Michael Poluektov's avatar
Michael Poluektov committed
620
621
622
623
624
625
626
627
628
            metadata = {
                "chat_id": body.pop("chat_id", None),
                "message_id": body.pop("id", None),
                "session_id": body.pop("session_id", None),
                "valves": body.pop("valves", None),
            }

            __event_emitter__ = get_event_emitter(metadata)
            __event_call__ = get_event_call(metadata)
Timothy J. Baek's avatar
Timothy J. Baek committed
629

630
631
632
633
634
635
636
637
            # 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
638
                body, flags = await chat_completion_functions_handler(
Timothy J. Baek's avatar
Timothy J. Baek committed
639
                    body, model, user, __event_emitter__, __event_call__
Timothy J. Baek's avatar
Timothy J. Baek committed
640
                )
641
642
643
644
            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
645
                )
646
647

            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
648
                body, flags = await chat_completion_tools_handler(
Michael Poluektov's avatar
Michael Poluektov committed
649
                    body, user, __event_emitter__, __event_call__
Timothy J. Baek's avatar
Timothy J. Baek committed
650
                )
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670

                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"])
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687

                # Workaround for Ollama 2.0+ system prompt issue
                # TODO: replace with add_or_update_system_message
                if model["owned_by"] == "ollama":
                    body["messages"] = prepend_to_first_user_message_content(
                        rag_template(
                            rag_app.state.config.RAG_TEMPLATE, context_string, prompt
                        ),
                        body["messages"],
                    )
                else:
                    body["messages"] = add_or_update_system_message(
                        rag_template(
                            rag_app.state.config.RAG_TEMPLATE, context_string, prompt
                        ),
                        body["messages"],
                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
688

689
690
691
692
            # If there are citations, add them to the data_items
            if len(citations) > 0:
                data_items.append({"citations": citations})

Michael Poluektov's avatar
Michael Poluektov committed
693
            body["metadata"] = metadata
694
            modified_body_bytes = json.dumps(body).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
695
696
697
698
699
700
701
702
703
704
705
            # 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
706

Timothy J. Baek's avatar
Timothy J. Baek committed
707
            response = await call_next(request)
708
709
710
711
712
            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(
713
                        self.openai_stream_wrapper(response.body_iterator, data_items),
714
715
716
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
717
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
718
                    )
719
720

                return response
Timothy J. Baek's avatar
Timothy J. Baek committed
721
722
            else:
                return response
723

Timothy J. Baek's avatar
Timothy J. Baek committed
724
725
        # 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
726
727
728
729
730
        return response

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

731
732
733
734
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

735
736
737
        async for data in original_generator:
            yield data

738
739
740
741
    async def ollama_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"{json.dumps(item)}\n"

742
743
744
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
746
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
747

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
748
749
750
751
752
753
##################################
#
# Pipeline Middleware
#
##################################

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

755
def get_sorted_filters(model_id):
Timothy J. Baek's avatar
Timothy J. Baek committed
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
    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"])
771
772
773
774
775
776
777
    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
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809

    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:
810
                res = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
811
812
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
813
814
815
816

    return payload


Timothy J. Baek's avatar
Timothy J. Baek committed
817
818
819
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
820
821
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
822
823
824
825
826
827
828
829
830
831
        ):
            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
832
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
833
                request,
834
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
835
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
836
837
838
839
840
841
842
843

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

Timothy J. Baek's avatar
Timothy J. Baek committed
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
            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
868
869
870
871
872
873
874
875
876
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


877
@app.middleware("http")
Jonathan Rohde's avatar
Jonathan Rohde committed
878
async def commit_session_after_request(request: Request, call_next):
879
    response = await call_next(request)
Jonathan Rohde's avatar
Jonathan Rohde committed
880
    log.debug("Commit session after request")
881
882
883
    Session.commit()
    return response

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

Timothy J. Baek's avatar
Timothy J. Baek committed
885
886
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
887
888
889
890
891
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
892
893
894
895
896
897
898
899
    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
900
901
902
903
904
905
@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
906

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

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

910
app.mount("/ollama", ollama_app)
911
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
912

Timothy J. Baek's avatar
Timothy J. Baek committed
913
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
914
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
915
916
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
917
918
919
920
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

921

Timothy J. Baek's avatar
Timothy J. Baek committed
922
async def get_all_models():
Timothy J. Baek's avatar
Timothy J. Baek committed
923
    # TODO: Optimize this function
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
924
    pipe_models = []
925
926
927
    openai_models = []
    ollama_models = []

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
928
929
    pipe_models = await get_pipe_models()

930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
    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
948
    models = pipe_models + openai_models + ollama_models
949

Timothy J. Baek's avatar
Timothy J. Baek committed
950
951
952
953
954
955
956
957
    global_action_ids = [
        function.id for function in Functions.get_global_action_functions()
    ]
    enabled_action_ids = [
        function.id
        for function in Functions.get_functions_by_type("action", active_only=True)
    ]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
958
    custom_models = Models.get_all_models()
959
960
961
    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
962
963
964
965
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
966
967
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
Timothy J. Baek's avatar
Timothy J. Baek committed
968

Timothy J. Baek's avatar
Timothy J. Baek committed
969
                    action_ids = []
Timothy J. Baek's avatar
Timothy J. Baek committed
970
971
972
                    if "info" in model and "meta" in model["info"]:
                        action_ids.extend(model["info"]["meta"].get("actionIds", []))

Timothy J. Baek's avatar
Timothy J. Baek committed
973
                    model["action_ids"] = action_ids
974
        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
            pipe = None
Timothy J. Baek's avatar
Timothy J. Baek committed
977
            action_ids = []
Timothy J. Baek's avatar
Timothy J. Baek committed
978

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

                    if "info" in model and "meta" in model["info"]:
                        action_ids.extend(model["info"]["meta"].get("actionIds", []))
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
990
991
                    break

992
993
994
995
996
997
            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
998
                    "owned_by": owned_by,
999
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1000
                    "preset": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
1001
                    **({"pipe": pipe} if pipe is not None else {}),
Timothy J. Baek's avatar
Timothy J. Baek committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
                    "action_ids": action_ids,
                }
            )

    for model in models:
        action_ids = []
        if "action_ids" in model:
            action_ids = model["action_ids"]
            del model["action_ids"]

        action_ids = action_ids + global_action_ids
        action_ids = list(set(action_ids))
        action_ids = [
            action_id for action_id in action_ids if action_id in enabled_action_ids
        ]

        model["actions"] = []
        for action_id in action_ids:
            action = Functions.get_function_by_id(action_id)
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053

            if action_id in webui_app.state.FUNCTIONS:
                function_module = webui_app.state.FUNCTIONS[action_id]
            else:
                function_module, _, _ = load_function_module_by_id(action_id)
                webui_app.state.FUNCTIONS[action_id] = function_module

            if hasattr(function_module, "actions"):
                actions = function_module.actions
                model["actions"].extend(
                    [
                        {
                            "id": f"{action_id}.{_action['id']}",
                            "name": _action.get(
                                "name", f"{action.name} ({_action['id']})"
                            ),
                            "description": action.meta.description,
                            "icon_url": _action.get(
                                "icon_url", action.meta.manifest.get("icon_url", None)
                            ),
                        }
                        for _action in actions
                    ]
                )
            else:
                model["actions"].append(
                    {
                        "id": action_id,
                        "name": action.name,
                        "description": action.meta.description,
                        "icon_url": action.meta.manifest.get("icon_url", None),
                    }
                )
1054

Timothy J. Baek's avatar
Timothy J. Baek committed
1055
1056
1057
1058
1059
1060
1061
1062
1063
    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
1064

1065
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
1066
1067
1068
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
1069
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
1070
1071
    ]

1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
    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
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
@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
fix  
Timothy J. Baek committed
1095
1096
1097
1098
1099
1100
    # `task` field is used to determine the type of the request, e.g. `title_generation`, `query_generation`, etc.
    task = None
    if "task" in form_data:
        task = form_data["task"]
        del form_data["task"]

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1101
1102
1103
1104
1105
    if task:
        if "metadata" in form_data:
            form_data["metadata"]["task"] = task
        else:
            form_data["metadata"] = {"task": task}
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1106

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1107
    if model.get("pipe"):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1108
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1109
    if model["owned_by"] == "ollama":
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1110
        print("generate_ollama_chat_completion")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1111
1112
1113
1114
1115
1116
1117
1118
1119
        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
1120
1121
1122
1123
1124
1125
    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
1126

1127
    sorted_filters = get_sorted_filters(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1128
1129
    if "pipeline" in model:
        sorted_filters = [model] + sorted_filters
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144

    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
1145
1146
1147
1148
1149
1150
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
                        "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,
                        )
Michael Poluektov's avatar
Michael Poluektov committed
1169
                except Exception:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1170
1171
1172
1173
1174
                    pass

            else:
                pass

Michael Poluektov's avatar
Michael Poluektov committed
1175
    __event_emitter__ = get_event_emitter(
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1176
1177
1178
1179
1180
1181
        {
            "chat_id": data["chat_id"],
            "message_id": data["id"],
            "session_id": data["session_id"],
        }
    )
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1182

Michael Poluektov's avatar
Michael Poluektov committed
1183
    __event_call__ = get_event_call(
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1184
1185
1186
1187
1188
1189
        {
            "chat_id": data["chat_id"],
            "message_id": data["id"],
            "session_id": data["session_id"],
        }
    )
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1190

1191
1192
1193
1194
1195
1196
    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
1197
    filter_ids = [function.id for function in Functions.get_global_filter_functions()]
Timothy J. Baek's avatar
Timothy J. Baek committed
1198
    if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
1199
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
1200
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1201

Timothy J. Baek's avatar
Timothy J. Baek committed
1202
1203
1204
1205
1206
1207
1208
1209
    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
    ]

1210
1211
    # 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
1212

1213
1214
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
Michael Poluektov's avatar
Michael Poluektov committed
1215
1216
        if not filter:
            continue
1217

Michael Poluektov's avatar
Michael Poluektov committed
1218
1219
1220
1221
1222
        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
1223

Michael Poluektov's avatar
Michael Poluektov committed
1224
1225
1226
1227
1228
        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 {})
            )
1229

Michael Poluektov's avatar
Michael Poluektov committed
1230
1231
        if not hasattr(function_module, "outlet"):
            continue
Michael Poluektov's avatar
Michael Poluektov committed
1232
        try:
Michael Poluektov's avatar
Michael Poluektov committed
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
            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
1258
1259
                }

Michael Poluektov's avatar
Michael Poluektov committed
1260
1261
1262
1263
1264
                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
1265
                            )
Michael Poluektov's avatar
Michael Poluektov committed
1266
1267
1268
                        )
                except Exception as e:
                    print(e)
Timothy J. Baek's avatar
Timothy J. Baek committed
1269

Michael Poluektov's avatar
Michael Poluektov committed
1270
                params = {**params, "__user__": __user__}
Michael Poluektov's avatar
Michael Poluektov committed
1271

Michael Poluektov's avatar
Michael Poluektov committed
1272
1273
1274
1275
            if inspect.iscoroutinefunction(outlet):
                data = await outlet(**params)
            else:
                data = outlet(**params)
Michael Poluektov's avatar
Michael Poluektov committed
1276
1277
1278
1279
1280
1281
1282

        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
1283

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1284
1285
1286
    return data


Timothy J. Baek's avatar
Timothy J. Baek committed
1287
@app.post("/api/chat/actions/{action_id}")
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1288
async def chat_action(action_id: str, form_data: dict, user=Depends(get_verified_user)):
1289
1290
1291
1292
1293
    if "." in action_id:
        action_id, sub_action_id = action_id.split(".")
    else:
        sub_action_id = None

Timothy J. Baek's avatar
Timothy J. Baek committed
1294
1295
1296
1297
1298
1299
    action = Functions.get_function_by_id(action_id)
    if not action:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Action not found",
        )
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1300

Timothy J. Baek's avatar
Timothy J. Baek committed
1301
1302
1303
1304
1305
1306
1307
1308
1309
    data = form_data
    model_id = 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]

Michael Poluektov's avatar
Michael Poluektov committed
1310
    __event_emitter__ = get_event_emitter(
Timothy J. Baek's avatar
Timothy J. Baek committed
1311
1312
1313
1314
1315
1316
        {
            "chat_id": data["chat_id"],
            "message_id": data["id"],
            "session_id": data["session_id"],
        }
    )
Michael Poluektov's avatar
Michael Poluektov committed
1317
    __event_call__ = get_event_call(
Timothy J. Baek's avatar
Timothy J. Baek committed
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
        {
            "chat_id": data["chat_id"],
            "message_id": data["id"],
            "session_id": data["session_id"],
        }
    )

    if action_id in webui_app.state.FUNCTIONS:
        function_module = webui_app.state.FUNCTIONS[action_id]
    else:
        function_module, _, _ = load_function_module_by_id(action_id)
        webui_app.state.FUNCTIONS[action_id] = function_module

    if hasattr(function_module, "valves") and hasattr(function_module, "Valves"):
        valves = Functions.get_function_valves_by_id(action_id)
        function_module.valves = function_module.Valves(**(valves if valves else {}))

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

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

            # Extra parameters to be passed to the function
            extra_params = {
                "__model__": model,
1346
                "__id__": sub_action_id if sub_action_id is not None else action_id,
Timothy J. Baek's avatar
Timothy J. Baek committed
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
                "__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,
                }

                try:
                    if hasattr(function_module, "UserValves"):
                        __user__["valves"] = function_module.UserValves(
                            **Functions.get_user_valves_by_id_and_user_id(
                                action_id, user.id
                            )
                        )
                except Exception as e:
                    print(e)

                params = {**params, "__user__": __user__}

            if inspect.iscoroutinefunction(action):
                data = await action(**params)
            else:
                data = action(**params)

        except Exception as e:
            print(f"Error: {e}")
            return JSONResponse(
                status_code=status.HTTP_400_BAD_REQUEST,
                content={"detail": str(e)},
            )

    return data


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
##################################
#
# Task Endpoints
#
##################################


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


Timothy J. Baek's avatar
Timothy J. Baek committed
1401
1402
1403
1404
1405
1406
1407
@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
1408
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1409
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1410
1411
1412
1413
1414
1415
1416
1417
    }


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
1418
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1419
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431


@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
1432
1433
1434
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1435
1436
1437
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1438
1439
1440
1441
1442
1443

    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
1444
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1445
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1446
1447
1448
    }


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1453
1454
1455
1456
1457
1458
1459
    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
1460
1461
    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
1462
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1463
1464

    print(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1465
1466
1467
1468

    template = app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1469
1470
1471
1472
1473
1474
        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
1475
1476
1477
1478
1479
1480
1481
1482
    )

    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
fix  
Timothy J. Baek committed
1483
        "task": str(TASKS.TITLE_GENERATION),
Timothy J. Baek's avatar
Timothy J. Baek committed
1484
1485
    }

1486
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1487
1488
1489
1490
1491
1492
1493
1494

    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
1495

1496
1497
1498
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1499
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1500
1501


Timothy J. Baek's avatar
Timothy J. Baek committed
1502
1503
1504
1505
@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
1506
1507
1508
1509
1510
1511
    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
1512
1513
1514
1515
1516
1517
1518
1519
1520
    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
1521
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1522
1523
1524
1525
1526
1527

    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
1528
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1529
1530
1531
1532
1533
1534
1535
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1536
        "task": str(TASKS.QUERY_GENERATION),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
    }

    print(payload)

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

1549
1550
1551
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1552
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567


@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
1568
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1569
1570
1571
1572

    print(model_id)

    template = '''
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1573
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
1574
1575
1576
1577
1578

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

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1579
1580
1581
1582
1583
1584
        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
1585
1586
1587
1588
1589
1590
1591
1592
    )

    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
fix  
Timothy J. Baek committed
1593
        "task": str(TASKS.EMOJI_GENERATION),
Timothy J. Baek's avatar
Timothy J. Baek committed
1594
1595
    }

1596
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1597
1598
1599
1600
1601
1602
1603
1604

    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
1605

1606
1607
1608
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1609
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1610
1611


Timothy J. Baek's avatar
Timothy J. Baek committed
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
@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
1625
    model_id = get_task_model_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1626
1627
1628
1629

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

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1630
    try:
Michael Poluektov's avatar
Michael Poluektov committed
1631
        context, _, _ = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1632
1633
1634
1635
1636
1637
            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
1638
1639
1640
1641
1642
1643
1644
        )
        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
1645
1646


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1647
1648
1649
1650
1651
##################################
#
# Pipelines Endpoints
#
##################################
1652
1653


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1654
# TODO: Refactor pipelines API endpoints below into a separate file
1655
1656


1657
1658
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1659
1660
1661
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1662
1663
1664
1665
1666
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678

    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
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
@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
1695
    r = None
Timothy J. Baek's avatar
Timothy J. Baek committed
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
    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
1719
        status_code = status.HTTP_404_NOT_FOUND
Timothy J. Baek's avatar
Timothy J. Baek committed
1720
        if r is not None:
Michael Poluektov's avatar
Michael Poluektov committed
1721
            status_code = r.status_code
Timothy J. Baek's avatar
Timothy J. Baek committed
1722
1723
1724
1725
1726
1727
1728
1729
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass

        raise HTTPException(
Michael Poluektov's avatar
Michael Poluektov committed
1730
            status_code=status_code,
Timothy J. Baek's avatar
Timothy J. Baek committed
1731
1732
1733
1734
1735
1736
1737
1738
            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
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
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
1823
@app.get("/api/pipelines")
1824
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1825
1826
1827
1828
    r = None
    try:
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1829

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1833
1834
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1835

Timothy J. Baek's avatar
Timothy J. Baek committed
1836
1837
1838
1839
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1840

Timothy J. Baek's avatar
Timothy J. Baek committed
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
        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
1854
1855


Timothy J. Baek's avatar
Timothy J. Baek committed
1856
1857
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
1858
1859
1860
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1861
1862
1863
1864
1865
1866
):
    models = await get_all_models()
    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
1867

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1871
1872
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1873

Timothy J. Baek's avatar
Timothy J. Baek committed
1874
1875
1876
1877
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
1878

Timothy J. Baek's avatar
Timothy J. Baek committed
1879
        detail = "Pipeline not found"
1880

Timothy J. Baek's avatar
Timothy J. Baek committed
1881
1882
1883
1884
1885
1886
1887
        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
1888
1889

        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1890
1891
            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
1892
1893
1894
1895
        )


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
1896
async def get_pipeline_valves_spec(
1897
1898
1899
    urlIdx: Optional[int],
    pipeline_id: str,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1900
):
Timothy J. Baek's avatar
Timothy J. Baek committed
1901
1902
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1903
1904
1905
1906
    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
1907

Timothy J. Baek's avatar
Timothy J. Baek committed
1908
1909
        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
1910

Timothy J. Baek's avatar
Timothy J. Baek committed
1911
1912
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1913

Timothy J. Baek's avatar
Timothy J. Baek committed
1914
1915
1916
1917
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1918

Timothy J. Baek's avatar
Timothy J. Baek committed
1919
1920
1921
1922
1923
1924
1925
1926
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1927

Timothy J. Baek's avatar
Timothy J. Baek committed
1928
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1929
1930
            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
1931
1932
1933
1934
1935
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1936
1937
1938
1939
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1940
1941
1942
):
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1943
1944
1945
1946
    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
1947

Timothy J. Baek's avatar
Timothy J. Baek committed
1948
1949
1950
1951
1952
1953
        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
1954

Timothy J. Baek's avatar
Timothy J. Baek committed
1955
1956
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1957

Timothy J. Baek's avatar
Timothy J. Baek committed
1958
1959
1960
1961
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1962

Timothy J. Baek's avatar
Timothy J. Baek committed
1963
        detail = "Pipeline not found"
1964

Timothy J. Baek's avatar
Timothy J. Baek committed
1965
1966
1967
1968
1969
1970
1971
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1972

Timothy J. Baek's avatar
Timothy J. Baek committed
1973
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1974
            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
1975
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1976
1977
1978
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1979
1980
1981
1982
1983
1984
1985
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1986
1987
1988
1989
@app.get("/api/config")
async def get_app_config():
    return {
        "status": True,
1990
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1991
        "version": VERSION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1992
        "default_locale": str(DEFAULT_LOCALE),
1993
1994
        "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
1995
        "features": {
1996
1997
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1998
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
1999
            "enable_login_form": webui_app.state.config.ENABLE_LOGIN_FORM,
Timothy J. Baek's avatar
Timothy J. Baek committed
2000
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
2001
            "enable_image_generation": images_app.state.config.ENABLED,
2002
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
2003
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
2004
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
2005
2006
2007
2008
2009
2010
2011
2012
2013
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
2014
2015
2016
2017
2018
2019
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
2020
2021
2022
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
2023
2024
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
2025
    return {
2026
2027
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
2028
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
2029
2030
2031
2032
2033
2034
2035
2036


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
2037
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
2038
2039
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
2040
2041
    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
2042

2043
    return {
2044
2045
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
2046
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
2047
2048


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2049
2050
2051
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
2052
2053
2054
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
2055
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
2056
2057
2058
2059
2060
2061
2062
2063
2064
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
2065
2066
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
2067
    return {"url": app.state.config.WEBHOOK_URL}
2068
2069


2070
2071
2072
2073
2074
2075
2076
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
2077
2078
@app.get("/api/changelog")
async def get_app_changelog():
2079
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
2080
2081


2082
2083
2084
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
2085
        async with aiohttp.ClientSession(trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
2086
2087
2088
2089
2090
2091
2092
2093
2094
            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:
2095
2096
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
2097
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
2098
2099
        )

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

2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
############################
# 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"],
        },
Lukas's avatar
Lukas committed
2116
        redirect_uri=provider_config["redirect_uri"],
2117
2118
2119
2120
2121
    )

# SessionMiddleware is used by authlib for oauth
if len(OAUTH_PROVIDERS) > 0:
    app.add_middleware(
2122
2123
2124
2125
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
2126
        https_only=WEBUI_SESSION_COOKIE_SECURE,
2127
2128
2129
2130
2131
2132
2133
    )


@app.get("/oauth/{provider}/login")
async def oauth_login(provider: str, request: Request):
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
Lukas's avatar
Lukas committed
2134
    # If the provider has a custom redirect URL, use that, otherwise automatically generate one
Michael Poluektov's avatar
Michael Poluektov committed
2135
    redirect_uri = OAUTH_PROVIDERS[provider].get("redirect_uri") or request.url_for(
Lukas's avatar
Lukas committed
2136
2137
        "oauth_callback", provider=provider
    )
2138
2139
2140
    return await oauth.create_client(provider).authorize_redirect(request, redirect_uri)


2141
2142
2143
2144
2145
2146
# 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
2147
@app.get("/oauth/{provider}/callback")
2148
async def oauth_callback(provider: str, request: Request, response: Response):
2149
2150
2151
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
2152
2153
2154
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
2155
        log.warning(f"OAuth callback error: {e}")
2156
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2157
2158
2159
2160
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
2161
        log.warning(f"OAuth callback failed, sub is missing: {user_data}")
2162
2163
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"
2164
2165
2166
    email = user_data.get("email", "").lower()
    # We currently mandate that email addresses are provided
    if not email:
2167
        log.warning(f"OAuth callback failed, email is missing: {user_data}")
2168
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2169
2170
2171
2172
2173
2174

    # 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
2175
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
2176
            # Check if the user exists by email
2177
            user = Users.get_user_by_email(email)
2178
2179
2180
2181
2182
2183
2184
            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:
2185
2186
2187
2188
2189
            # 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)

2190
2191
            picture_claim = webui_app.state.config.OAUTH_PICTURE_CLAIM
            picture_url = user_data.get(picture_claim, "")
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
            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:
2207
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
2208
2209
2210
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
Sergey Mihaylin's avatar
Sergey Mihaylin committed
2211
            username_claim = webui_app.state.config.OAUTH_USERNAME_CLAIM
2212
2213
2214
2215
2216
            role = (
                "admin"
                if Users.get_num_users() == 0
                else webui_app.state.config.DEFAULT_USER_ROLE
            )
2217
            user = Auths.insert_new_auth(
2218
                email=email,
2219
2220
2221
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
Sergey Mihaylin's avatar
Sergey Mihaylin committed
2222
                name=user_data.get(username_claim, "User"),
2223
                profile_image_url=picture_url,
2224
                role=role,
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
                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:
2239
2240
2241
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
2242
2243
2244
2245
2246
2247

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

2248
2249
2250
    # Set the cookie token
    response.set_cookie(
        key="token",
2251
        value=jwt_token,
2252
2253
2254
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

2255
2256
2257
2258
2259
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


2260
2261
2262
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2263
2264
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
2265
2266
2267
2268
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2269
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2270
2271
    }

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

2273
2274
2275
2276
2277
2278
2279
@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
2280
    <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/static/favicon.png</Image>
2281
2282
2283
2284
2285
2286
2287
    <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
2288
2289
2290
2291
2292
@app.get("/health")
async def healthcheck():
    return {"status": True}


2293
@app.get("/health/db")
2294
async def healthcheck_with_db():
2295
    Session.execute(text("SELECT 1;")).all()
2296
2297
2298
    return {"status": True}


2299
2300
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2301

2302
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2303
    mimetypes.add_type("text/javascript", ".js")
2304
2305
2306
2307
2308
2309
2310
2311
2312
    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."
    )