"scripts/deprecated/convert_yi_vl.sh" did not exist on "864425300fb52782d3f410db248371eb0451cf26"
main.py 66 KB
Newer Older
1
import base64
2
import uuid
3
from contextlib import asynccontextmanager
4
5
6

from authlib.integrations.starlette_client import OAuth
from authlib.oidc.core import UserInfo
Timothy J. Baek's avatar
Timothy J. Baek committed
7
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
36

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

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


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

142

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

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

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

171
172
173
174
175
176
177
178
@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
179

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

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

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

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


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

app.state.MODELS = {}

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

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

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


Timothy J. Baek's avatar
Timothy J. Baek committed
216
217
218
async def get_function_call_response(
    messages, files, tool_id, template, task_model_id, user
):
Timothy J. Baek's avatar
Timothy J. Baek committed
219
220
221
    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
222

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
223
224
225
226
227
    user_message = get_last_user_message(messages)
    prompt = (
        "History:\n"
        + "\n".join(
            [
Timothy J. Baek's avatar
Timothy J. Baek committed
228
                f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
229
230
231
232
233
234
235
236
                for message in messages[::-1][:4]
            ]
        )
        + f"\nQuery: {user_message}"
    )

    print(prompt)

Timothy J. Baek's avatar
Timothy J. Baek committed
237
238
239
240
241
242
243
244
245
    payload = {
        "model": task_model_id,
        "messages": [
            {"role": "system", "content": content},
            {"role": "user", "content": f"Query: {prompt}"},
        ],
        "stream": False,
    }

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
246
247
248
249
250
    try:
        payload = filter_pipeline(payload, user)
    except Exception as e:
        raise e

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

Timothy J. Baek's avatar
Timothy J. Baek committed
253
    response = None
Timothy J. Baek's avatar
Timothy J. Baek committed
254
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
255
        response = await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
256
257
258

        content = None

Timothy J. Baek's avatar
Timothy J. Baek committed
259
260
261
262
263
264
265
266
267
268
        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
269
270
271

        # Parse the function response
        if content is not None:
Timothy J. Baek's avatar
Timothy J. Baek committed
272
            print(f"content: {content}")
Timothy J. Baek's avatar
Timothy J. Baek committed
273
274
275
            result = json.loads(content)
            print(result)

Timothy J. Baek's avatar
Timothy J. Baek committed
276
            citation = None
Timothy J. Baek's avatar
Timothy J. Baek committed
277
278
279
280
281
            # Call the function
            if "name" in result:
                if tool_id in webui_app.state.TOOLS:
                    toolkit_module = webui_app.state.TOOLS[tool_id]
                else:
282
                    toolkit_module, frontmatter = load_toolkit_module_by_id(tool_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
283
284
                    webui_app.state.TOOLS[tool_id] = toolkit_module

285
286
287
288
289
290
                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
291
292
293
                if hasattr(toolkit_module, "valves") and hasattr(
                    toolkit_module, "Valves"
                ):
Timothy J. Baek's avatar
Timothy J. Baek committed
294
                    valves = Tools.get_tool_valves_by_id(tool_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
295
                    toolkit_module.valves = toolkit_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
296
                        **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
297
298
                    )

Timothy J. Baek's avatar
Timothy J. Baek committed
299
300
301
                function = getattr(toolkit_module, result["name"])
                function_result = None
                try:
Timothy J. Baek's avatar
Timothy J. Baek committed
302
303
                    # Get the signature of the function
                    sig = inspect.signature(function)
304
305
                    params = result["parameters"]

Timothy J. Baek's avatar
Timothy J. Baek committed
306
307
                    if "__user__" in sig.parameters:
                        # Call the function with the '__user__' parameter included
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
308
309
310
311
312
                        __user__ = {
                            "id": user.id,
                            "email": user.email,
                            "name": user.name,
                            "role": user.role,
313
314
                        }

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
315
316
317
318
319
320
321
322
323
324
325
                        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__}
326
327
328
329
330
331
332
                    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
333
334
335
336
337
338
339
                    if "__files__" in sig.parameters:
                        # Call the function with the '__files__' parameter included
                        params = {
                            **params,
                            "__files__": files,
                        }

340
341
342
343
344
345
346
                    if "__model__" in sig.parameters:
                        # Call the function with the '__model__' parameter included
                        params = {
                            **params,
                            "__model__": model,
                        }

347
348
349
350
351
352
353
                    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
354
355
356
357
                    if inspect.iscoroutinefunction(function):
                        function_result = await function(**params)
                    else:
                        function_result = function(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
358
359
360
361
362
363
364

                    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
365
366
367
368
                except Exception as e:
                    print(e)

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

Timothy J. Baek's avatar
Timothy J. Baek committed
374
    return None, None, False
Timothy J. Baek's avatar
Timothy J. Baek committed
375
376
377


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

Timothy J. Baek's avatar
Timothy J. Baek committed
381
382
383
        show_citations = False
        citations = []

Timothy J. Baek's avatar
Timothy J. Baek committed
384
385
386
        if request.method == "POST" and any(
            endpoint in request.url.path
            for endpoint in ["/ollama/api/chat", "/chat/completions"]
387
        ):
388
            log.debug(f"request.url.path: {request.url.path}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
389

Timothy J. Baek's avatar
Timothy J. Baek committed
390
391
392
393
            # Read the original request body
            body = await request.body()
            body_str = body.decode("utf-8")
            data = json.loads(body_str) if body_str else {}
Timothy J. Baek's avatar
Timothy J. Baek committed
394

Timothy J. Baek's avatar
Timothy J. Baek committed
395
            user = get_current_user(
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
396
                request,
397
                get_http_authorization_cred(request.headers.get("Authorization")),
Timothy J. Baek's avatar
Timothy J. Baek committed
398
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
399
400
            # Flag to skip RAG completions if file_handler is present in tools/functions
            skip_files = False
Timothy J. Baek's avatar
Timothy J. Baek committed
401
402
403
            if data.get("citations"):
                show_citations = True
                del data["citations"]
Timothy J. Baek's avatar
Timothy J. Baek committed
404
405
406

            model_id = data["model"]
            if model_id not in app.state.MODELS:
Timothy J. Baek's avatar
Timothy J. Baek committed
407
408
409
410
                raise HTTPException(
                    status_code=status.HTTP_404_NOT_FOUND,
                    detail="Model not found",
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
411
412
            model = app.state.MODELS[model_id]

413
414
415
416
417
418
419
420
            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
421
422
423
            filter_ids = [
                function.id for function in Functions.get_global_filter_functions()
            ]
Timothy J. Baek's avatar
Timothy J. Baek committed
424
            if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
425
                filter_ids.extend(model["info"]["meta"].get("filterIds", []))
Timothy J. Baek's avatar
Timothy J. Baek committed
426
427
                filter_ids = list(set(filter_ids))

Timothy J. Baek's avatar
Timothy J. Baek committed
428
429
430
431
432
433
434
435
436
437
            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
            ]

438
            filter_ids.sort(key=get_priority)
Timothy J. Baek's avatar
Timothy J. Baek committed
439
440
441
442
443
444
            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:
445
446
                        function_module, function_type, frontmatter = (
                            load_function_module_by_id(filter_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
447
448
                        )
                        webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
Timothy J. Baek committed
449

Timothy J. Baek's avatar
Timothy J. Baek committed
450
451
452
                    # Check if the function has a file_handler variable
                    if hasattr(function_module, "file_handler"):
                        skip_files = function_module.file_handler
Timothy J. Baek's avatar
Timothy J. Baek committed
453

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
454
455
456
                    if hasattr(function_module, "valves") and hasattr(
                        function_module, "Valves"
                    ):
Timothy J. Baek's avatar
Timothy J. Baek committed
457
                        valves = Functions.get_function_valves_by_id(filter_id)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
458
                        function_module.valves = function_module.Valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
459
                            **(valves if valves else {})
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
460
461
                        )

Timothy J. Baek's avatar
Timothy J. Baek committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
                    try:
                        if hasattr(function_module, "inlet"):
                            inlet = function_module.inlet

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

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

                                try:
                                    if hasattr(function_module, "UserValves"):
                                        __user__["valves"] = function_module.UserValves(
                                            **Functions.get_user_valves_by_id_and_user_id(
                                                filter_id, user.id
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
483
                                            )
Timothy J. Baek's avatar
Timothy J. Baek committed
484
485
486
                                        )
                                except Exception as e:
                                    print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
487

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

Timothy J. Baek's avatar
Timothy J. Baek committed
490
491
492
493
494
                            if "__id__" in sig.parameters:
                                params = {
                                    **params,
                                    "__id__": filter_id,
                                }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
495

Timothy J. Baek's avatar
Timothy J. Baek committed
496
497
498
499
                            if inspect.iscoroutinefunction(inlet):
                                data = await inlet(**params)
                            else:
                                data = inlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
500

Timothy J. Baek's avatar
Timothy J. Baek committed
501
502
503
504
505
506
                    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
507
508
509
510

            # Set the task model
            task_model_id = data["model"]
            # Check if the user has a custom task model and use that model
Timothy J. Baek's avatar
Timothy J. Baek committed
511
512
513
514
515
516
517
518
519
520
521
522
523
            if app.state.MODELS[task_model_id]["owned_by"] == "ollama":
                if (
                    app.state.config.TASK_MODEL
                    and app.state.config.TASK_MODEL in app.state.MODELS
                ):
                    task_model_id = app.state.config.TASK_MODEL
            else:
                if (
                    app.state.config.TASK_MODEL_EXTERNAL
                    and app.state.config.TASK_MODEL_EXTERNAL in app.state.MODELS
                ):
                    task_model_id = app.state.config.TASK_MODEL_EXTERNAL

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
524
            prompt = get_last_user_message(data["messages"])
Timothy J. Baek's avatar
Timothy J. Baek committed
525
526
527
            context = ""

            # If tool_ids field is present, call the functions
Timothy J. Baek's avatar
Timothy J. Baek committed
528
            if "tool_ids" in data:
Timothy J. Baek's avatar
Timothy J. Baek committed
529
                print(data["tool_ids"])
Timothy J. Baek's avatar
Timothy J. Baek committed
530
                for tool_id in data["tool_ids"]:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
531
                    print(tool_id)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
532
                    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
533
534
535
536
537
538
539
540
541
                        response, citation, file_handler = (
                            await get_function_call_response(
                                messages=data["messages"],
                                files=data.get("files", []),
                                tool_id=tool_id,
                                template=app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
                                task_model_id=task_model_id,
                                user=user,
                            )
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
542
                        )
Timothy J. Baek's avatar
Timothy J. Baek committed
543

544
                        print(file_handler)
545
                        if isinstance(response, str):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
546
                            context += ("\n" if context != "" else "") + response
547

Timothy J. Baek's avatar
Timothy J. Baek committed
548
549
550
551
                        if citation:
                            citations.append(citation)
                            show_citations = True

552
553
554
                        if file_handler:
                            skip_files = True

Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
555
556
                    except Exception as e:
                        print(f"Error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
557
558
                del data["tool_ids"]

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

Timothy J. Baek's avatar
Timothy J. Baek committed
561
            # If files field is present, generate RAG completions
562
            # If skip_files is True, skip the RAG completions
Timothy J. Baek's avatar
Timothy J. Baek committed
563
            if "files" in data:
564
565
                if not skip_files:
                    data = {**data}
Timothy J. Baek's avatar
Timothy J. Baek committed
566
                    rag_context, rag_citations = get_rag_context(
567
568
569
570
571
572
573
574
575
576
                        files=data["files"],
                        messages=data["messages"],
                        embedding_function=rag_app.state.EMBEDDING_FUNCTION,
                        k=rag_app.state.config.TOP_K,
                        reranking_function=rag_app.state.sentence_transformer_rf,
                        r=rag_app.state.config.RELEVANCE_THRESHOLD,
                        hybrid_search=rag_app.state.config.ENABLE_RAG_HYBRID_SEARCH,
                    )
                    if rag_context:
                        context += ("\n" if context != "" else "") + rag_context
Timothy J. Baek's avatar
Timothy J. Baek committed
577

578
                    log.debug(f"rag_context: {rag_context}, citations: {citations}")
579

Timothy J. Baek's avatar
Timothy J. Baek committed
580
581
                    if rag_citations:
                        citations.extend(rag_citations)
Timothy J. Baek's avatar
Timothy J. Baek committed
582

Timothy J. Baek's avatar
Timothy J. Baek committed
583
                del data["files"]
Timothy J. Baek's avatar
Timothy J. Baek committed
584

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

Timothy J. Baek's avatar
Timothy J. Baek committed
588
589
590
591
592
593
            if context != "":
                system_prompt = rag_template(
                    rag_app.state.config.RAG_TEMPLATE, context, prompt
                )
                print(system_prompt)
                data["messages"] = add_or_update_system_message(
594
                    system_prompt, data["messages"]
595
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
596

Timothy J. Baek's avatar
Timothy J. Baek committed
597
            modified_body_bytes = json.dumps(data).encode("utf-8")
Timothy J. Baek's avatar
Timothy J. Baek committed
598
599
600
601
602
603
604
605
606
607
608
            # 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
609

Timothy J. Baek's avatar
Timothy J. Baek committed
610
            response = await call_next(request)
611
612
613
614
615
            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(
616
                        self.openai_stream_wrapper(response.body_iterator, data_items),
617
618
619
                    )
                if "application/x-ndjson" in content_type:
                    return StreamingResponse(
620
                        self.ollama_stream_wrapper(response.body_iterator, data_items),
621
                    )
622
623

                return response
Timothy J. Baek's avatar
Timothy J. Baek committed
624
625
            else:
                return response
626

Timothy J. Baek's avatar
Timothy J. Baek committed
627
628
        # 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
629
630
631
632
633
        return response

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

634
635
636
637
    async def openai_stream_wrapper(self, original_generator, data_items):
        for item in data_items:
            yield f"data: {json.dumps(item)}\n\n"

638
639
640
        async for data in original_generator:
            yield data

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

645
646
647
        async for data in original_generator:
            yield data

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

Timothy J. Baek's avatar
Timothy J. Baek committed
649
app.add_middleware(ChatCompletionMiddleware)
Timothy J. Baek's avatar
Timothy J. Baek committed
650

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
651
652
653
654
655
656
##################################
#
# Pipeline Middleware
#
##################################

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

Timothy J. Baek's avatar
Timothy J. Baek committed
658
def filter_pipeline(payload, user):
659
    user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
Timothy J. Baek's avatar
Timothy J. Baek committed
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
    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
712
713
                if "detail" in res:
                    raise Exception(r.status_code, res["detail"])
Timothy J. Baek's avatar
Timothy J. Baek committed
714
715
716
717
718
719
720
721
722
723

            else:
                pass

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

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
725
726
727
        if "task" in payload:
            del payload["task"]

Timothy J. Baek's avatar
Timothy J. Baek committed
728
729
730
    return payload


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

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

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


Timothy J. Baek's avatar
Timothy J. Baek committed
791
792
@app.middleware("http")
async def check_url(request: Request, call_next):
Timothy J. Baek's avatar
Timothy J. Baek committed
793
794
795
796
797
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

Timothy J. Baek's avatar
Timothy J. Baek committed
798
799
800
801
802
803
804
805
    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
806
807
808
809
810
811
@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
812

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

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

816
app.mount("/ollama", ollama_app)
817
app.mount("/openai", openai_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
818

Timothy J. Baek's avatar
Timothy J. Baek committed
819
app.mount("/images/api/v1", images_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
820
app.mount("/audio/api/v1", audio_app)
Timothy J. Baek's avatar
Timothy J. Baek committed
821
822
app.mount("/rag/api/v1", rag_app)

Timothy J. Baek's avatar
Timothy J. Baek committed
823
824
825
826
app.mount("/api/v1", webui_app)

webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION

827

Timothy J. Baek's avatar
Timothy J. Baek committed
828
async def get_all_models():
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
829
    pipe_models = []
830
831
832
    openai_models = []
    ollama_models = []

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
833
834
    pipe_models = await get_pipe_models()

835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
    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
853
    models = pipe_models + openai_models + ollama_models
854

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
855
    custom_models = Models.get_all_models()
856
857
858
    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
859
860
861
862
                if (
                    custom_model.id == model["id"]
                    or custom_model.id == model["id"].split(":")[0]
                ):
863
864
865
                    model["name"] = custom_model.name
                    model["info"] = custom_model.model_dump()
        else:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
866
867
            owned_by = "openai"
            for model in models:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
868
869
870
871
                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
872
873
874
                    owned_by = model["owned_by"]
                    break

875
876
877
878
879
880
            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
881
                    "owned_by": owned_by,
882
                    "info": custom_model.model_dump(),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
883
                    "preset": True,
884
885
886
                }
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
887
888
889
890
891
892
893
894
895
896
    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
897

898
    # Filter out filter pipelines
Timothy J. Baek's avatar
Timothy J. Baek committed
899
900
901
    models = [
        model
        for model in models
Timothy J. Baek's avatar
Timothy J. Baek committed
902
        if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
Timothy J. Baek's avatar
Timothy J. Baek committed
903
904
    ]

905
906
907
908
909
910
911
912
913
914
915
916
917
    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
918
919
920
921
922
923
924
925
926
927
928
@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
929
930
    pipe = model.get("pipe")
    if pipe:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
931
        return await generate_function_chat_completion(form_data, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
932
933
934
935
936
937
938
939
940
941
    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
942
943
944
945
946
947
    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
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963

    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
964
965
966
    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
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981

    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
982
983
984
985
986
987
                        "user": {
                            "id": user.id,
                            "name": user.name,
                            "email": user.email,
                            "role": user.role,
                        },
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
                        "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

1012
1013
1014
1015
1016
1017
    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
1018
    filter_ids = [function.id for function in Functions.get_global_filter_functions()]
Timothy J. Baek's avatar
Timothy J. Baek committed
1019
    if "info" in model and "meta" in model["info"]:
Timothy J. Baek's avatar
Timothy J. Baek committed
1020
        filter_ids.extend(model["info"]["meta"].get("filterIds", []))
1021
        filter_ids = list(set(filter_ids))
Timothy J. Baek's avatar
Timothy J. Baek committed
1022

Timothy J. Baek's avatar
Timothy J. Baek committed
1023
1024
1025
1026
1027
1028
1029
1030
    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
    ]

1031
1032
    # 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
1033

1034
1035
1036
1037
1038
1039
    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:
1040
1041
1042
                function_module, function_type, frontmatter = (
                    load_function_module_by_id(filter_id)
                )
1043
                webui_app.state.FUNCTIONS[filter_id] = function_module
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1044

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
            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
1074
                                    )
1075
1076
1077
                                )
                        except Exception as e:
                            print(e)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1078

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

1081
1082
1083
1084
1085
                    if "__id__" in sig.parameters:
                        params = {
                            **params,
                            "__id__": filter_id,
                        }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1086

1087
1088
1089
1090
                    if inspect.iscoroutinefunction(outlet):
                        data = await outlet(**params)
                    else:
                        data = outlet(**params)
Timothy J. Baek's avatar
Timothy J. Baek committed
1091

1092
1093
1094
1095
1096
1097
            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
1098

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
    return data


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


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


Timothy J. Baek's avatar
Timothy J. Baek committed
1112
1113
1114
1115
1116
1117
1118
@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
1119
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1120
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1121
1122
1123
1124
1125
1126
1127
1128
    }


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
1129
    SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD: int
Timothy J. Baek's avatar
Timothy J. Baek committed
1130
    TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
Timothy J. Baek's avatar
Timothy J. Baek committed
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142


@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
1143
1144
1145
    app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD = (
        form_data.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1146
1147
1148
    app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
        form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
    )
Timothy J. Baek's avatar
Timothy J. Baek committed
1149
1150
1151
1152
1153
1154

    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
1155
        "SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD": app.state.config.SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD,
Timothy J. Baek's avatar
Timothy J. Baek committed
1156
        "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1157
1158
1159
    }


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

Timothy J. Baek's avatar
Timothy J. Baek committed
1164
1165
1166
1167
1168
1169
1170
    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
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
    # 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
1185
1186
1187
1188
1189
    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
1190
1191
1192
1193
1194
1195
        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
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
    )

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

1207
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1208
1209
1210
1211
1212
1213
1214
1215

    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
1216

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1217
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1218
1219


Timothy J. Baek's avatar
Timothy J. Baek committed
1220
1221
1222
1223
@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
1224
1225
1226
1227
1228
1229
    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
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
    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
1256
        template, form_data["prompt"], {"name": user.name}
Timothy J. Baek's avatar
Timothy J. Baek committed
1257
1258
1259
1260
1261
1262
1263
    )

    payload = {
        "model": model_id,
        "messages": [{"role": "user", "content": content}],
        "stream": False,
        "max_tokens": 30,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
        "task": True,
    }

    print(payload)

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

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1277
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307


@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
1308
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
1309
1310
1311
1312
1313

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

    content = title_generation_template(
Timothy J. Baek's avatar
Timothy J. Baek committed
1314
1315
1316
1317
1318
1319
        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
1320
1321
1322
1323
1324
1325
1326
1327
1328
    )

    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
1329
1330
    }

1331
    log.debug(payload)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1332
1333
1334
1335
1336
1337
1338
1339

    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
1340

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1341
    return await generate_chat_completions(form_data=payload, user=user)
Timothy J. Baek's avatar
Timothy J. Baek committed
1342
1343


Timothy J. Baek's avatar
Timothy J. Baek committed
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
@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
1371
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1372
        context, citation, file_handler = await get_function_call_response(
Timothy J. Baek's avatar
Timothy J. Baek committed
1373
1374
1375
1376
1377
1378
            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
1379
1380
1381
1382
1383
1384
1385
        )
        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
1386
1387


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1388
1389
1390
1391
1392
##################################
#
# Pipelines Endpoints
#
##################################
1393
1394


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1395
# TODO: Refactor pipelines API endpoints below into a separate file
1396
1397


1398
1399
@app.get("/api/pipelines/list")
async def get_pipelines_list(user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1400
1401
1402
    responses = await get_openai_models(raw=True)

    print(responses)
Timothy J. Baek's avatar
Timothy J. Baek committed
1403
1404
1405
1406
1407
    urlIdxs = [
        idx
        for idx, response in enumerate(responses)
        if response != None and "pipelines" in response
    ]
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419

    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
1420
1421
1422
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
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
@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
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
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
1563
@app.get("/api/pipelines")
1564
async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
Timothy J. Baek's avatar
Timothy J. Baek committed
1565
1566
1567
    r = None
    try:
        urlIdx
1568

Timothy J. Baek's avatar
Timothy J. Baek committed
1569
1570
        url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
        key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
1571

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1575
1576
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1577

Timothy J. Baek's avatar
Timothy J. Baek committed
1578
1579
1580
1581
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1582

Timothy J. Baek's avatar
Timothy J. Baek committed
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
        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
1596
1597


Timothy J. Baek's avatar
Timothy J. Baek committed
1598
1599
1600
1601
1602
1603
1604
@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
1605

Timothy J. Baek's avatar
Timothy J. Baek committed
1606
1607
        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
1608

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

Timothy J. Baek's avatar
Timothy J. Baek committed
1612
1613
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1614

Timothy J. Baek's avatar
Timothy J. Baek committed
1615
1616
1617
1618
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
1619

Timothy J. Baek's avatar
Timothy J. Baek committed
1620
        detail = "Pipeline not found"
1621

Timothy J. Baek's avatar
Timothy J. Baek committed
1622
1623
1624
1625
1626
1627
1628
        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
1629
1630

        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1631
1632
            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
1633
1634
1635
1636
        )


@app.get("/api/pipelines/{pipeline_id}/valves/spec")
Timothy J. Baek's avatar
Timothy J. Baek committed
1637
1638
1639
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
1640
1641
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1642
1643
1644
1645
    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
1646

Timothy J. Baek's avatar
Timothy J. Baek committed
1647
1648
        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
1649

Timothy J. Baek's avatar
Timothy J. Baek committed
1650
1651
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1652

Timothy J. Baek's avatar
Timothy J. Baek committed
1653
1654
1655
1656
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1657

Timothy J. Baek's avatar
Timothy J. Baek committed
1658
1659
1660
1661
1662
1663
1664
1665
        detail = "Pipeline not found"
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1666

Timothy J. Baek's avatar
Timothy J. Baek committed
1667
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1668
1669
            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
1670
1671
1672
1673
1674
        )


@app.post("/api/pipelines/{pipeline_id}/valves/update")
async def update_pipeline_valves(
Timothy J. Baek's avatar
Timothy J. Baek committed
1675
1676
1677
1678
    urlIdx: Optional[int],
    pipeline_id: str,
    form_data: dict,
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1679
1680
1681
):
    models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
1682
1683
1684
1685
    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
1686

Timothy J. Baek's avatar
Timothy J. Baek committed
1687
1688
1689
1690
1691
1692
        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
1693

Timothy J. Baek's avatar
Timothy J. Baek committed
1694
1695
        r.raise_for_status()
        data = r.json()
Timothy J. Baek's avatar
Timothy J. Baek committed
1696

Timothy J. Baek's avatar
Timothy J. Baek committed
1697
1698
1699
1700
        return {**data}
    except Exception as e:
        # Handle connection error here
        print(f"Connection error: {e}")
Timothy J. Baek's avatar
Timothy J. Baek committed
1701

Timothy J. Baek's avatar
Timothy J. Baek committed
1702
        detail = "Pipeline not found"
1703

Timothy J. Baek's avatar
Timothy J. Baek committed
1704
1705
1706
1707
1708
1709
1710
        if r is not None:
            try:
                res = r.json()
                if "detail" in res:
                    detail = res["detail"]
            except:
                pass
1711

Timothy J. Baek's avatar
Timothy J. Baek committed
1712
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1713
            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
1714
            detail=detail,
Timothy J. Baek's avatar
Timothy J. Baek committed
1715
1716
1717
        )


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1718
1719
1720
1721
1722
1723
1724
##################################
#
# Config Endpoints
#
##################################


Timothy J. Baek's avatar
Timothy J. Baek committed
1725
1726
1727
1728
@app.get("/api/config")
async def get_app_config():
    return {
        "status": True,
1729
        "name": WEBUI_NAME,
Timothy J. Baek's avatar
Timothy J. Baek committed
1730
        "version": VERSION,
Timothy J. Baek's avatar
Timothy J. Baek committed
1731
        "default_locale": str(DEFAULT_LOCALE),
1732
1733
        "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
1734
        "features": {
1735
1736
            "auth": WEBUI_AUTH,
            "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1737
            "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
Timothy J. Baek's avatar
Timothy J. Baek committed
1738
            "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
1739
            "enable_image_generation": images_app.state.config.ENABLED,
1740
            "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
1741
            "enable_admin_export": ENABLE_ADMIN_EXPORT,
1742
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1743
1744
1745
1746
1747
1748
1749
1750
1751
        "audio": {
            "tts": {
                "engine": audio_app.state.config.TTS_ENGINE,
                "voice": audio_app.state.config.TTS_VOICE,
            },
            "stt": {
                "engine": audio_app.state.config.STT_ENGINE,
            },
        },
1752
1753
1754
1755
1756
1757
        "oauth": {
            "providers": {
                name: config.get("name", name)
                for name, config in OAUTH_PROVIDERS.items()
            }
        },
Timothy J. Baek's avatar
Timothy J. Baek committed
1758
1759
1760
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1761
1762
@app.get("/api/config/model/filter")
async def get_model_filter_config(user=Depends(get_admin_user)):
1763
    return {
1764
1765
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1766
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1767
1768
1769
1770
1771
1772
1773
1774


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


@app.post("/api/config/model/filter")
Timothy J. Baek's avatar
Timothy J. Baek committed
1775
async def update_model_filter_config(
Timothy J. Baek's avatar
Timothy J. Baek committed
1776
1777
    form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
):
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1778
1779
    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
1780

1781
    return {
1782
1783
        "enabled": app.state.config.ENABLE_MODEL_FILTER,
        "models": app.state.config.MODEL_FILTER_LIST,
1784
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
1785
1786


Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1787
1788
1789
# TODO: webhook endpoint should be under config endpoints


Timothy J. Baek's avatar
Timothy J. Baek committed
1790
1791
1792
@app.get("/api/webhook")
async def get_webhook_url(user=Depends(get_admin_user)):
    return {
1793
        "url": app.state.config.WEBHOOK_URL,
Timothy J. Baek's avatar
Timothy J. Baek committed
1794
1795
1796
1797
1798
1799
1800
1801
1802
    }


class UrlForm(BaseModel):
    url: str


@app.post("/api/webhook")
async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
1803
1804
    app.state.config.WEBHOOK_URL = form_data.url
    webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
1805
    return {"url": app.state.config.WEBHOOK_URL}
1806
1807


1808
1809
1810
1811
1812
1813
1814
@app.get("/api/version")
async def get_app_config():
    return {
        "version": VERSION,
    }


Timothy J. Baek's avatar
Timothy J. Baek committed
1815
1816
@app.get("/api/changelog")
async def get_app_changelog():
1817
    return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
Timothy J. Baek's avatar
Timothy J. Baek committed
1818
1819


1820
1821
1822
@app.get("/api/version/updates")
async def get_app_latest_release_version():
    try:
1823
        async with aiohttp.ClientSession(trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1824
1825
1826
1827
1828
1829
1830
1831
1832
            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:
1833
1834
        raise HTTPException(
            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
Timothy J. Baek's avatar
Timothy J. Baek committed
1835
            detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
1836
1837
        )

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

1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
############################
# 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(
1859
1860
1861
1862
        SessionMiddleware,
        secret_key=WEBUI_SECRET_KEY,
        session_cookie="oui-session",
        same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
1863
        https_only=WEBUI_SESSION_COOKIE_SECURE,
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
    )


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


1875
1876
1877
1878
1879
1880
# 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
1881
@app.get("/oauth/{provider}/callback")
1882
async def oauth_callback(provider: str, request: Request, response: Response):
1883
1884
1885
    if provider not in OAUTH_PROVIDERS:
        raise HTTPException(404)
    client = oauth.create_client(provider)
1886
1887
1888
    try:
        token = await client.authorize_access_token(request)
    except Exception as e:
1889
        log.warning(f"OAuth callback error: {e}")
1890
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1891
1892
1893
1894
    user_data: UserInfo = token["userinfo"]

    sub = user_data.get("sub")
    if not sub:
1895
        log.warning(f"OAuth callback failed, sub is missing: {user_data}")
1896
1897
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
    provider_sub = f"{provider}@{sub}"
1898
1899
1900
    email = user_data.get("email", "").lower()
    # We currently mandate that email addresses are provided
    if not email:
1901
        log.warning(f"OAuth callback failed, email is missing: {user_data}")
1902
        raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
1903
1904
1905
1906
1907
1908

    # 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
1909
        if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
1910
            # Check if the user exists by email
1911
            user = Users.get_user_by_email(email)
1912
1913
1914
1915
1916
1917
1918
            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:
1919
1920
1921
1922
1923
            # 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)

1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
            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:
1940
                    log.error(f"Error downloading profile image '{picture_url}': {e}")
1941
1942
1943
                    picture_url = ""
            if not picture_url:
                picture_url = "/user.png"
1944
1945
1946
1947
1948
            role = (
                "admin"
                if Users.get_num_users() == 0
                else webui_app.state.config.DEFAULT_USER_ROLE
            )
1949
            user = Auths.insert_new_auth(
1950
                email=email,
1951
1952
1953
1954
                password=get_password_hash(
                    str(uuid.uuid4())
                ),  # Random password, not used
                name=user_data.get("name", "User"),
1955
                profile_image_url=picture_url,
1956
                role=role,
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
                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:
1971
1972
1973
            raise HTTPException(
                status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
            )
1974
1975
1976
1977
1978
1979

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

1980
1981
1982
    # Set the cookie token
    response.set_cookie(
        key="token",
1983
        value=jwt_token,
1984
1985
1986
        httponly=True,  # Ensures the cookie is not accessible via JavaScript
    )

1987
1988
1989
1990
1991
    # Redirect back to the frontend with the JWT token
    redirect_url = f"{request.base_url}auth#token={jwt_token}"
    return RedirectResponse(url=redirect_url)


1992
1993
1994
@app.get("/manifest.json")
async def get_manifest_json():
    return {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
1995
1996
        "name": WEBUI_NAME,
        "short_name": WEBUI_NAME,
1997
1998
1999
2000
        "start_url": "/",
        "display": "standalone",
        "background_color": "#343541",
        "orientation": "portrait-primary",
Timothy J. Baek's avatar
Timothy J. Baek committed
2001
        "icons": [{"src": "/static/logo.png", "type": "image/png", "sizes": "500x500"}],
2002
2003
    }

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

2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
@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
2020
2021
2022
2023
2024
@app.get("/health")
async def healthcheck():
    return {"status": True}


2025
2026
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
2027

2028
if os.path.exists(FRONTEND_BUILD_DIR):
Timothy J. Baek's avatar
Timothy J. Baek committed
2029
    mimetypes.add_type("text/javascript", ".js")
2030
2031
2032
2033
2034
2035
2036
2037
2038
    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."
    )