main.py 69.2 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
8
9
from bs4 import BeautifulSoup
import json
import markdown
10
import time
Timothy J. Baek's avatar
Timothy J. Baek committed
11
12
import os
import sys
13
import logging
Timothy J. Baek's avatar
Timothy J. Baek committed
14
import aiohttp
15
import requests
16
import mimetypes
Timothy J. Baek's avatar
Timothy J. Baek committed
17
18
import shutil
import os
Timothy J. Baek's avatar
Timothy J. Baek committed
19
import uuid
Timothy J. Baek's avatar
Timothy J. Baek committed
20
import inspect
Timothy J. Baek's avatar
Timothy J. Baek committed
21
import asyncio
Timothy J. Baek's avatar
Timothy J. Baek committed
22

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

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
49
from apps.audio.main import app as audio_app
Timothy J. Baek's avatar
Timothy J. Baek committed
50
51
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
52
53
54
55
56
from apps.webui.main import (
    app as webui_app,
    get_pipe_models,
    generate_function_chat_completion,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
57

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

Timothy J. Baek's avatar
Timothy J. Baek committed
59
from pydantic import BaseModel
Timothy J. Baek's avatar
Timothy J. Baek committed
60
from typing import List, Optional, Iterator, Generator, Union
Timothy J. Baek's avatar
Timothy J. Baek committed
61

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

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

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

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
132
133
134
135
136
if SAFE_MODE:
    print("SAFE MODE ENABLED")
    Functions.deactivate_all_functions()


137
138
139
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
140

141

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

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

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

170
171
172
173
174
175
176
177
@asynccontextmanager
async def lifespan(app: FastAPI):
    yield


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

179
app.state.config = AppConfig()
180
181
182
183

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

184
185
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
186

187
app.state.config.WEBHOOK_URL = WEBHOOK_URL
Timothy J. Baek's avatar
Timothy J. Baek committed
188
189
190
191


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
192
app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
Timothy J. Baek's avatar
Timothy J. Baek committed
193
194
195
app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
    SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
196
197
198
app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
)
Timothy J. Baek's avatar
Timothy J. Baek committed
199
200
201
app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
)
Timothy J. Baek's avatar
Timothy J. Baek committed
202
203
204

app.state.MODELS = {}

Timothy J. Baek's avatar
Timothy J. Baek committed
205
206
origins = ["*"]

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
208
209
210
211
212
213
214
##################################
#
# ChatCompletion Middleware
#
##################################


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
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:
        raise "Model not found"
    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
279
async def get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
280
281
282
283
284
285
286
287
    messages,
    files,
    tool_id,
    template,
    task_model_id,
    user,
    model,
    __event_emitter__=None,
Timothy J. Baek's avatar
Timothy J. Baek committed
288
):
Timothy J. Baek's avatar
Timothy J. Baek committed
289
290
291
    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
292

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

    print(prompt)

Timothy J. Baek's avatar
Timothy J. Baek committed
307
308
309
310
311
312
313
    payload = {
        "model": task_model_id,
        "messages": [
            {"role": "system", "content": content},
            {"role": "user", "content": f"Query: {prompt}"},
        ],
        "stream": False,
Michael Poluektov's avatar
Michael Poluektov committed
314
        "function": True,
Timothy J. Baek's avatar
Timothy J. Baek committed
315
316
    }

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
317
318
319
320
321
    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        raise e

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

Timothy J. Baek's avatar
Timothy J. Baek committed
324
    response = None
Timothy J. Baek's avatar
Timothy J. Baek committed
325
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
326
        response = await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
327
328
329

        content = None

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

        # Parse the function response
        if content is not None:
Timothy J. Baek's avatar
Timothy J. Baek committed
343
            print(f"content: {content}")
Timothy J. Baek's avatar
Timothy J. Baek committed
344
345
346
            result = json.loads(content)
            print(result)

Timothy J. Baek's avatar
Timothy J. Baek committed
347
            citation = None
Timothy J. Baek's avatar
Timothy J. Baek committed
348
349
350
351
352
            # Call the function
            if "name" in result:
                if tool_id in webui_app.state.TOOLS:
                    toolkit_module = webui_app.state.TOOLS[tool_id]
                else:
353
                    toolkit_module, frontmatter = load_toolkit_module_by_id(tool_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
354
355
                    webui_app.state.TOOLS[tool_id] = toolkit_module

356
357
358
359
360
361
                file_handler = False
                # check if toolkit_module has file_handler self variable
                if hasattr(toolkit_module, "file_handler"):
                    file_handler = True
                    print("file_handler: ", file_handler)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
362
363
364
                if hasattr(toolkit_module, "valves") and hasattr(
                    toolkit_module, "Valves"
                ):
Timothy J. Baek's avatar
Timothy J. Baek committed
365
                    valves = Tools.get_tool_valves_by_id(tool_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
366
                    toolkit_module.valves = toolkit_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
367
                        **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
368
369
                    )

Timothy J. Baek's avatar
Timothy J. Baek committed
370
371
372
                function = getattr(toolkit_module, result["name"])
                function_result = None
                try:
Timothy J. Baek's avatar
Timothy J. Baek committed
373
374
                    # Get the signature of the function
                    sig = inspect.signature(function)
375
376
                    params = result["parameters"]

Timothy J. Baek's avatar
Timothy J. Baek committed
377
378
                    if "__user__" in sig.parameters:
                        # Call the function with the '__user__' parameter included
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
379
380
381
382
383
                        __user__ = {
                            "id": user.id,
                            "email": user.email,
                            "name": user.name,
                            "role": user.role,
384
385
                        }

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
386
387
388
389
390
391
392
393
394
395
396
                        try:
                            if hasattr(toolkit_module, "UserValves"):
                                __user__["valves"] = toolkit_module.UserValves(
                                    **Tools.get_user_valves_by_id_and_user_id(
                                        tool_id, user.id
                                    )
                                )
                        except Exception as e:
                            print(e)

                        params = {**params, "__user__": __user__}
397
398
399
400
401
402
403
                    if "__messages__" in sig.parameters:
                        # Call the function with the '__messages__' parameter included
                        params = {
                            **params,
                            "__messages__": messages,
                        }

Timothy J. Baek's avatar
Timothy J. Baek committed
404
405
406
407
408
409
410
                    if "__files__" in sig.parameters:
                        # Call the function with the '__files__' parameter included
                        params = {
                            **params,
                            "__files__": files,
                        }

411
412
413
414
415
416
417
                    if "__model__" in sig.parameters:
                        # Call the function with the '__model__' parameter included
                        params = {
                            **params,
                            "__model__": model,
                        }

418
419
420
421
422
423
424
                    if "__id__" in sig.parameters:
                        # Call the function with the '__id__' parameter included
                        params = {
                            **params,
                            "__id__": tool_id,
                        }

Timothy J. Baek's avatar
Timothy J. Baek committed
425
426
427
428
                    if "__event_emitter__" in sig.parameters:
                        # Call the function with the '__event_emitter__' parameter included
                        params = {
                            **params,
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
429
                            "__event_emitter__": __event_emitter__,
Timothy J. Baek's avatar
Timothy J. Baek committed
430
431
                        }

Timothy J. Baek's avatar
Timothy J. Baek committed
432
433
434
435
                    if inspect.iscoroutinefunction(function):
                        function_result = await function(**params)
                    else:
                        function_result = function(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
436
437
438
439
440
441
442

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
452
    return None, None, False
Timothy J. Baek's avatar
Timothy J. Baek committed
453
454


Timothy J. Baek's avatar
Timothy J. Baek committed
455
async def chat_completion_functions_handler(body, model, user, __event_emitter__):
456
457
458
459
460
461
462
463
464
465
466
    skip_files = None

    filter_ids = get_filter_function_ids(model)
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
        if filter:
            if filter_id in webui_app.state.FUNCTIONS:
                function_module = webui_app.state.FUNCTIONS[filter_id]
            else:
                function_module, function_type, frontmatter = (
                    load_function_module_by_id(filter_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
467
                )
468
                webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
Timothy J. Baek committed
469

470
471
472
            # Check if the function has a file_handler variable
            if hasattr(function_module, "file_handler"):
                skip_files = function_module.file_handler
473

474
475
476
477
478
479
            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 {})
Timothy J. Baek's avatar
Timothy J. Baek committed
480
481
                )

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
            try:
                if hasattr(function_module, "inlet"):
                    inlet = function_module.inlet

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

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

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

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

                    if "__id__" in sig.parameters:
                        params = {
                            **params,
                            "__id__": filter_id,
                        }

                    if "__model__" in sig.parameters:
                        params = {
                            **params,
                            "__model__": model,
                        }
Timothy J. Baek's avatar
Timothy J. Baek committed
521
522
523
524
525
                    if "__event_emitter__" in sig.parameters:
                        params = {
                            **params,
                            "__event_emitter__": __event_emitter__,
                        }
526
527
528

                    if inspect.iscoroutinefunction(inlet):
                        body = await inlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
529
                    else:
530
                        body = inlet(**params)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
531

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

536
537
538
    if skip_files:
        if "files" in body:
            del body["files"]
Timothy J. Baek's avatar
Timothy J. Baek committed
539

540
    return body, {}
Timothy J. Baek's avatar
Timothy J. Baek committed
541

542

Timothy J. Baek's avatar
Timothy J. Baek committed
543
async def chat_completion_tools_handler(body, model, user, __event_emitter__):
544
    skip_files = None
Timothy J. Baek's avatar
Timothy J. Baek committed
545

546
547
    contexts = []
    citations = None
Timothy J. Baek's avatar
Timothy J. Baek committed
548

549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
    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,
                    model=model,
Timothy J. Baek's avatar
Timothy J. Baek committed
565
                    __event_emitter__=__event_emitter__,
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
                )

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

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

                if file_handler:
                    skip_files = True

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

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

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


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

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

        contexts, citations = get_rag_context(
            files=files,
            messages=body["messages"],
            embedding_function=rag_app.state.EMBEDDING_FUNCTION,
            k=rag_app.state.config.TOP_K,
            reranking_function=rag_app.state.sentence_transformer_rf,
            r=rag_app.state.config.RELEVANCE_THRESHOLD,
            hybrid_search=rag_app.state.config.ENABLE_RAG_HYBRID_SEARCH,
        )

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

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


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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
638
639
640
641
642
            # Extract session_id, chat_id and message_id from the request body
            session_id = None
            if "session_id" in body:
                session_id = body["session_id"]
                del body["session_id"]
643
644
645
646
647
648
649
650
651
            chat_id = None
            if "chat_id" in body:
                chat_id = body["chat_id"]
                del body["chat_id"]
            message_id = None
            if "id" in body:
                message_id = body["id"]
                del body["id"]

Timothy J. Baek's avatar
Timothy J. Baek committed
652
653
654
655
656
657
658
659
660
661
662
            async def __event_emitter__(data):
                await sio.emit(
                    "chat-events",
                    {
                        "chat_id": chat_id,
                        "message_id": message_id,
                        "data": data,
                    },
                    to=session_id,
                )

663
664
665
666
667
668
669
670
            # 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
671
672
673
                body, flags = await chat_completion_functions_handler(
                    body, model, user, __event_emitter__
                )
674
675
676
677
            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
678
                )
679
680

            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
681
682
683
                body, flags = await chat_completion_tools_handler(
                    body, model, user, __event_emitter__
                )
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708

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

            try:
                body, flags = await chat_completion_files_handler(body)

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

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

711
712
713
714
715
            # If there are citations, add them to the data_items
            if len(citations) > 0:
                data_items.append({"citations": citations})

            modified_body_bytes = json.dumps(body).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
716
717
718
719
720
721
722
723
724
725
726
            # 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
727

Timothy J. Baek's avatar
Timothy J. Baek committed
728
            response = await call_next(request)
729
730
731
732
733
            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(
734
                        self.openai_stream_wrapper(response.body_iterator, data_items),
735
736
737
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
738
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
739
                    )
740
741

                return response
Timothy J. Baek's avatar
Timothy J. Baek committed
742
743
            else:
                return response
744

Timothy J. Baek's avatar
Timothy J. Baek committed
745
746
        # 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
747
748
749
750
751
        return response

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

752
753
754
755
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

756
757
758
        async for data in original_generator:
            yield data

759
760
761
762
    async def ollama_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"{json.dumps(item)}\n"

763
764
765
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
767
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
768

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
769
770
771
772
773
774
##################################
#
# Pipeline Middleware
#
##################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
776
def filter_pipeline(payload, user):
777
    user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
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
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
    model_id = payload["model"]
    filters = [
        model
        for model in app.state.MODELS.values()
        if "pipeline" in model
        and "type" in model["pipeline"]
        and model["pipeline"]["type"] == "filter"
        and (
            model["pipeline"]["pipelines"] == ["*"]
            or any(
                model_id == target_model_id
                for target_model_id in model["pipeline"]["pipelines"]
            )
        )
    ]
    sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])

    model = app.state.MODELS[model_id]

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

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

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

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

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

            if r is not None:
                try:
                    res = r.json()
                except:
                    pass
Timothy J. Baek's avatar
Timothy J. Baek committed
830
831
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
832
833
834
835

            else:
                pass

836
837
838
839
    keep_extras = (
        "pipeline" in app.state.MODELS[model_id] or "pipe" in app.state.MODELS[model_id]
    )
    if not keep_extras:
Michael Poluektov's avatar
Michael Poluektov committed
840
841
842
        for key in ["title", "task", "function"]:
            if key in payload:
                del payload[key]
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
843

Timothy J. Baek's avatar
Timothy J. Baek committed
844
845
846
    return payload


Timothy J. Baek's avatar
Timothy J. Baek committed
847
848
849
class PipelineMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        if request.method == "POST" and (
850
851
            "/ollama/api/chat" in request.url.path
            or "/chat/completions" in request.url.path
Timothy J. Baek's avatar
Timothy J. Baek committed
852
853
854
855
856
857
858
859
860
861
        ):
            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
862
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
863
                request,
864
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
865
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
866
867
868
869
870
871
872
873

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

Timothy J. Baek's avatar
Timothy J. Baek committed
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
            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
898
899
900
901
902
903
904
905
906
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


Timothy J. Baek's avatar
Timothy J. Baek committed
907
908
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
909
910
911
912
913
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
914
915
916
917
918
919
920
921
    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
922
923
924
925
926
927
@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
928

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

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

932
app.mount("/ollama", ollama_app)
933
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
934

Timothy J. Baek's avatar
Timothy J. Baek committed
935
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
936
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
937
938
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
939
940
941
942
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

943

Timothy J. Baek's avatar
Timothy J. Baek committed
944
async def get_all_models():
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
945
    pipe_models = []
946
947
948
    openai_models = []
    ollama_models = []

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
949
950
    pipe_models = await get_pipe_models()

951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    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
969
    models = pipe_models + openai_models + ollama_models
970

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
971
    custom_models = Models.get_all_models()
972
973
974
    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
975
976
977
978
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
979
980
981
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
982
983
            owned_by = "openai"
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
984
985
986
987
                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
988
989
990
                    owned_by = model["owned_by"]
                    break

991
992
993
994
995
996
            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
997
                    "owned_by": owned_by,
998
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
999
                    "preset": True,
1000
1001
1002
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
    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
1013

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

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

    model = app.state.MODELS[model_id]

Timothy J. Baek's avatar
Timothy J. Baek committed
1045
1046
    pipe = model.get("pipe")
    if pipe:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1047
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
    if model["owned_by"] == "ollama":
        return await generate_ollama_chat_completion(form_data, user=user)
    else:
        return await generate_openai_chat_completion(form_data, user=user)


@app.post("/api/chat/completed")
async def chat_completed(form_data: dict, user=Depends(get_verified_user)):
    data = form_data
    model_id = data["model"]
Timothy J. Baek's avatar
Timothy J. Baek committed
1058
1059
1060
1061
1062
1063
    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
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079

    filters = [
        model
        for model in app.state.MODELS.values()
        if "pipeline" in model
        and "type" in model["pipeline"]
        and model["pipeline"]["type"] == "filter"
        and (
            model["pipeline"]["pipelines"] == ["*"]
            or any(
                model_id == target_model_id
                for target_model_id in model["pipeline"]["pipelines"]
            )
        )
    ]

Timothy J. Baek's avatar
Timothy J. Baek committed
1080
1081
1082
    sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])
    if "pipeline" in model:
        sorted_filters = [model] + sorted_filters
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097

    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
1098
1099
1100
1101
1102
1103
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
                        "body": data,
                    },
                )

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

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

            else:
                pass

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
    async def __event_emitter__(data):
        await sio.emit(
            "chat-events",
            {
                "chat_id": data["chat_id"],
                "message_id": data["id"],
                "data": data,
            },
            to=data["session_id"],
        )

1139
1140
1141
1142
1143
1144
    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
1145
    filter_ids = [function.id for function in Functions.get_global_filter_functions()]
Timothy J. Baek's avatar
Timothy J. Baek committed
1146
    if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
1147
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
1148
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1149

Timothy J. Baek's avatar
Timothy J. Baek committed
1150
1151
1152
1153
1154
1155
1156
1157
    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
    ]

1158
1159
    # 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
1160

1161
1162
1163
1164
1165
1166
    for filter_id in filter_ids:
        filter = Functions.get_function_by_id(filter_id)
        if filter:
            if filter_id in webui_app.state.FUNCTIONS:
                function_module = webui_app.state.FUNCTIONS[filter_id]
            else:
1167
1168
1169
                function_module, function_type, frontmatter = (
                    load_function_module_by_id(filter_id)
                )
1170
                webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1171

1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
            if hasattr(function_module, "valves") and hasattr(
                function_module, "Valves"
            ):
                valves = Functions.get_function_valves_by_id(filter_id)
                function_module.valves = function_module.Valves(
                    **(valves if valves else {})
                )

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

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

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

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

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

1208
1209
1210
1211
1212
                    if "__id__" in sig.parameters:
                        params = {
                            **params,
                            "__id__": filter_id,
                        }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1213

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1214
1215
1216
1217
1218
1219
                    if "__model__" in sig.parameters:
                        params = {
                            **params,
                            "__model__": model,
                        }

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1220
1221
1222
1223
1224
1225
                    if "__event_emitter__" in sig.parameters:
                        params = {
                            **params,
                            "__event_emitter__": __event_emitter__,
                        }

1226
1227
1228
1229
                    if inspect.iscoroutinefunction(outlet):
                        data = await outlet(**params)
                    else:
                        data = outlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
1230

1231
1232
1233
1234
1235
1236
            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
1237

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
    return data


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


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


Timothy J. Baek's avatar
Timothy J. Baek committed
1251
1252
1253
1254
1255
1256
1257
@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
1258
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1259
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1260
1261
1262
1263
1264
1265
1266
1267
    }


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
1268
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1269
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281


@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
1282
1283
1284
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1285
1286
1287
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1288
1289
1290
1291
1292
1293

    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
1294
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1295
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1296
1297
1298
    }


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1303
1304
1305
1306
1307
1308
1309
    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
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
    # Check if the user has a custom task model
    # If the user has a custom task model, use that model
    if app.state.MODELS[model_id]["owned_by"] == "ollama":
        if app.state.config.TASK_MODEL:
            task_model_id = app.state.config.TASK_MODEL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id
    else:
        if app.state.config.TASK_MODEL_EXTERNAL:
            task_model_id = app.state.config.TASK_MODEL_EXTERNAL
            if task_model_id in app.state.MODELS:
                model_id = task_model_id

    print(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
1324
1325
1326
1327
1328
    model = app.state.MODELS[model_id]

    template = app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1329
1330
1331
1332
1333
1334
        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
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
    )

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

1346
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1347
1348
1349
1350
1351
1352
1353
1354

    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
1355

1356
1357
1358
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1359
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1360
1361


Timothy J. Baek's avatar
Timothy J. Baek committed
1362
1363
1364
1365
@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
1366
1367
1368
1369
1370
1371
    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
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
    model_id = form_data["model"]
    if model_id not in app.state.MODELS:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="Model not found",
        )

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

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

    template = app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE

    content = search_query_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1398
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1399
1400
1401
1402
1403
1404
1405
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
        "task": True,
    }

    print(payload)

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

1419
1420
1421
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1422
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452


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

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

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

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

    template = '''
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1453
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
1454
1455
1456
1457
1458

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

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1459
1460
1461
1462
1463
1464
        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
1465
1466
1467
1468
1469
1470
1471
1472
1473
    )

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

1476
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1477
1478
1479
1480
1481
1482
1483
1484

    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
1485

1486
1487
1488
    if "chat_id" in payload:
        del payload["chat_id"]

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1489
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1490
1491


Timothy J. Baek's avatar
Timothy J. Baek committed
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
@app.post("/api/task/tools/completions")
async def get_tools_function_calling(form_data: dict, user=Depends(get_verified_user)):
    print("get_tools_function_calling")

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

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

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

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1519
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1520
        context, citation, file_handler = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1521
1522
1523
1524
1525
1526
            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
1527
1528
1529
1530
1531
1532
1533
        )
        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
1534
1535


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1536
1537
1538
1539
1540
##################################
#
# Pipelines Endpoints
#
##################################
1541
1542


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1543
# TODO: Refactor pipelines API endpoints below into a separate file
1544
1545


1546
1547
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1548
1549
1550
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1551
1552
1553
1554
1555
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567

    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
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
@app.post("/api/pipelines/upload")
async def upload_pipeline(
    urlIdx: int = Form(...), file: UploadFile = File(...), user=Depends(get_admin_user)
):
    print("upload_pipeline", urlIdx, file.filename)
    # Check if the uploaded file is a python file
    if not file.filename.endswith(".py"):
        raise HTTPException(
            status_code=status.HTTP_400_BAD_REQUEST,
            detail="Only Python (.py) files are allowed.",
        )

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

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

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

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

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

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

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

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

        raise HTTPException(
            status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
            detail=detail,
        )
    finally:
        # Ensure the file is deleted after the upload is completed or on failure
        if os.path.exists(file_path):
            os.remove(file_path)


Timothy J. Baek's avatar
Timothy J. Baek committed
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
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
1711
@app.get("/api/pipelines")
1712
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1713
1714
1715
    r = None
    try:
        urlIdx
1716

Timothy J. Baek's avatar
Timothy J. Baek committed
1717
1718
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1719

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

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

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
        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
1744
1745


Timothy J. Baek's avatar
Timothy J. Baek committed
1746
1747
1748
1749
1750
1751
1752
@app.get("/api/pipelines/{pipeline_id}/valves")
async def get_pipeline_valves(
    urlIdx: Optional[int], pipeline_id: str, user=Depends(get_admin_user)
):
    models = await get_all_models()
    r = None
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1753

Timothy J. Baek's avatar
Timothy J. Baek committed
1754
1755
        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
1756

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1760
1761
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1762

Timothy J. Baek's avatar
Timothy J. Baek committed
1763
1764
1765
1766
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
1767

Timothy J. Baek's avatar
Timothy J. Baek committed
1768
        detail = "Pipeline not found"
1769

Timothy J. Baek's avatar
Timothy J. Baek committed
1770
1771
1772
1773
1774
1775
1776
        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
1777
1778

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


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1790
1791
1792
1793
    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
1794

Timothy J. Baek's avatar
Timothy J. Baek committed
1795
1796
        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
1797

Timothy J. Baek's avatar
Timothy J. Baek committed
1798
1799
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1800

Timothy J. Baek's avatar
Timothy J. Baek committed
1801
1802
1803
1804
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1805

Timothy J. Baek's avatar
Timothy J. Baek committed
1806
1807
1808
1809
1810
1811
1812
1813
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1814

Timothy J. Baek's avatar
Timothy J. Baek committed
1815
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1816
1817
            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
1818
1819
1820
1821
1822
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1823
1824
1825
1826
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1827
1828
1829
):
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1830
1831
1832
1833
    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
1834

Timothy J. Baek's avatar
Timothy J. Baek committed
1835
1836
1837
1838
1839
1840
        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
1841

Timothy J. Baek's avatar
Timothy J. Baek committed
1842
1843
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1844

Timothy J. Baek's avatar
Timothy J. Baek committed
1845
1846
1847
1848
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1849

Timothy J. Baek's avatar
Timothy J. Baek committed
1850
        detail = "Pipeline not found"
1851

Timothy J. Baek's avatar
Timothy J. Baek committed
1852
1853
1854
1855
1856
1857
1858
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1859

Timothy J. Baek's avatar
Timothy J. Baek committed
1860
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1861
            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
1862
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1863
1864
1865
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1866
1867
1868
1869
1870
1871
1872
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1873
1874
1875
1876
@app.get("/api/config")
async def get_app_config():
    return {
        "status": True,
1877
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1878
        "version": VERSION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1879
        "default_locale": str(DEFAULT_LOCALE),
1880
1881
        "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
1882
        "features": {
1883
1884
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1885
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
Timothy J. Baek committed
1886
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
1887
            "enable_image_generation": images_app.state.config.ENABLED,
1888
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
1889
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
1890
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1891
1892
1893
1894
1895
1896
1897
1898
1899
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
1900
1901
1902
1903
1904
1905
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1906
1907
1908
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1909
1910
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
1911
    return {
1912
1913
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1914
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1915
1916
1917
1918
1919
1920
1921
1922


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
1923
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
1924
1925
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1926
1927
    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
1928

1929
    return {
1930
1931
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1932
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1933
1934


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1935
1936
1937
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
1938
1939
1940
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
1941
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
1942
1943
1944
1945
1946
1947
1948
1949
1950
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
1951
1952
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
1953
    return {"url": app.state.config.WEBHOOK_URL}
1954
1955


1956
1957
1958
1959
1960
1961
1962
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1963
1964
@app.get("/api/changelog")
async def get_app_changelog():
1965
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
1966
1967


1968
1969
1970
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
1971
        async with aiohttp.ClientSession(trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1972
1973
1974
1975
1976
1977
1978
1979
1980
            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:
1981
1982
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1983
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
1984
1985
        )

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

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
############################
# OAuth Login & Callback
############################

oauth = OAuth()

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

# SessionMiddleware is used by authlib for oauth
if len(OAUTH_PROVIDERS) > 0:
    app.add_middleware(
2007
2008
2009
2010
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
2011
        https_only=WEBUI_SESSION_COOKIE_SECURE,
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
    )


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


2023
2024
2025
2026
2027
2028
# 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
2029
@app.get("/oauth/{provider}/callback")
2030
async def oauth_callback(provider: str, request: Request, response: Response):
2031
2032
2033
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
2034
2035
2036
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
2037
        log.warning(f"OAuth callback error: {e}")
2038
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2039
2040
2041
2042
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
2043
        log.warning(f"OAuth callback failed, sub is missing: {user_data}")
2044
2045
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"
2046
2047
2048
    email = user_data.get("email", "").lower()
    # We currently mandate that email addresses are provided
    if not email:
2049
        log.warning(f"OAuth callback failed, email is missing: {user_data}")
2050
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
2051
2052
2053
2054
2055
2056

    # 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
2057
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
2058
            # Check if the user exists by email
2059
            user = Users.get_user_by_email(email)
2060
2061
2062
2063
2064
2065
2066
            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:
2067
2068
2069
2070
2071
            # 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)

2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
            picture_url = user_data.get("picture", "")
            if picture_url:
                # Download the profile image into a base64 string
                try:
                    async with aiohttp.ClientSession() as session:
                        async with session.get(picture_url) as resp:
                            picture = await resp.read()
                            base64_encoded_picture = base64.b64encode(picture).decode(
                                "utf-8"
                            )
                            guessed_mime_type = mimetypes.guess_type(picture_url)[0]
                            if guessed_mime_type is None:
                                # assume JPG, browsers are tolerant enough of image formats
                                guessed_mime_type = "image/jpeg"
                            picture_url = f"data:{guessed_mime_type};base64,{base64_encoded_picture}"
                except Exception as e:
2088
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
2089
2090
2091
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
2092
2093
2094
2095
2096
            role = (
                "admin"
                if Users.get_num_users() == 0
                else webui_app.state.config.DEFAULT_USER_ROLE
            )
2097
            user = Auths.insert_new_auth(
2098
                email=email,
2099
2100
2101
2102
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
                name=user_data.get("name", "User"),
2103
                profile_image_url=picture_url,
2104
                role=role,
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
                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:
2119
2120
2121
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
2122
2123
2124
2125
2126
2127

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

2128
2129
2130
    # Set the cookie token
    response.set_cookie(
        key="token",
2131
        value=jwt_token,
2132
2133
2134
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

2135
2136
2137
2138
2139
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


2140
2141
2142
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
2143
2144
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
2145
2146
2147
2148
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2149
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2150
2151
    }

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

2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
@app.get("/opensearch.xml")
async def get_opensearch_xml():
    xml_content = rf"""
    <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
    <ShortName>{WEBUI_NAME}</ShortName>
    <Description>Search {WEBUI_NAME}</Description>
    <InputEncoding>UTF-8</InputEncoding>
    <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/favicon.png</Image>
    <Url type="text/html" method="get" template="{WEBUI_URL}/?q={"{searchTerms}"}"/>
    <moz:SearchForm>{WEBUI_URL}</moz:SearchForm>
    </OpenSearchDescription>
    """
    return Response(content=xml_content, media_type="application/xml")


Timothy J. Baek's avatar
Timothy J. Baek committed
2168
2169
2170
2171
2172
@app.get("/health")
async def healthcheck():
    return {"status": True}


2173
2174
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2175

2176
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2177
    mimetypes.add_type("text/javascript", ".js")
2178
2179
2180
2181
2182
2183
2184
2185
2186
    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."
    )