main.py 38.7 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
4
5
6
7
8
9
10
11
from fastapi import (
    FastAPI,
    Request,
    Response,
    HTTPException,
    Depends,
    status,
    UploadFile,
    File,
    BackgroundTasks,
)
12
13
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import StreamingResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
14
from fastapi.concurrency import run_in_threadpool
Timothy J. Baek's avatar
Timothy J. Baek committed
15

Timothy J. Baek's avatar
Timothy J. Baek committed
16
from pydantic import BaseModel, ConfigDict
17

Timothy J. Baek's avatar
Timothy J. Baek committed
18
import os
19
import re
Timothy J. Baek's avatar
Timothy J. Baek committed
20
import copy
21
import random
Timothy J. Baek's avatar
Timothy J. Baek committed
22
23
import requests
import json
24
import uuid
25
26
import aiohttp
import asyncio
27
import logging
28
import time
Timothy J. Baek's avatar
Timothy J. Baek committed
29
30
31
from urllib.parse import urlparse
from typing import Optional, List, Union

32
33
from starlette.background import BackgroundTask

34
35
from apps.webui.models.models import Models
from apps.webui.models.users import Users
36
from constants import ERROR_MESSAGES
37
38
39
40
41
42
from utils.utils import (
    decode_token,
    get_current_user,
    get_verified_user,
    get_admin_user,
)
Timothy J. Baek's avatar
Timothy J. Baek committed
43

Timothy J. Baek's avatar
Timothy J. Baek committed
44
45
from utils.models import get_model_id_from_custom_model_id

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

Timothy J. Baek's avatar
Timothy J. Baek committed
47
48
49
from config import (
    SRC_LOG_LEVELS,
    OLLAMA_BASE_URLS,
Timothy J. Baek's avatar
Timothy J. Baek committed
50
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
Timothy J. Baek committed
51
    ENABLE_MODEL_FILTER,
Timothy J. Baek's avatar
Timothy J. Baek committed
52
53
    MODEL_FILTER_LIST,
    UPLOAD_DIR,
54
    AppConfig,
Timothy J. Baek's avatar
Timothy J. Baek committed
55
)
56
from utils.misc import calculate_sha256
57

58
59
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
60

61
62
63
64
65
66
67
68
app = FastAPI()
app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)
Timothy J. Baek's avatar
Timothy J. Baek committed
69

70
app.state.config = AppConfig()
Timothy J. Baek's avatar
Timothy J. Baek committed
71

Timothy J. Baek's avatar
Timothy J. Baek committed
72
73
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
74
75

app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
76
app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
77
app.state.MODELS = {}
Timothy J. Baek's avatar
Timothy J. Baek committed
78
79


Timothy J. Baek's avatar
Timothy J. Baek committed
80
81
82
83
84
# TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
# Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
# least connections, or least response time for better resource utilization and performance optimization.


85
86
87
88
89
90
91
92
93
94
95
@app.middleware("http")
async def check_url(request: Request, call_next):
    if len(app.state.MODELS) == 0:
        await get_all_models()
    else:
        pass

    response = await call_next(request)
    return response


Timothy J. Baek's avatar
Timothy J. Baek committed
96
97
98
99
100
101
@app.head("/")
@app.get("/")
async def get_status():
    return {"status": True}


Timothy J. Baek's avatar
Timothy J. Baek committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
@app.get("/config")
async def get_config(user=Depends(get_admin_user)):
    return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}


class OllamaConfigForm(BaseModel):
    enable_ollama_api: Optional[bool] = None


@app.post("/config/update")
async def update_config(form_data: OllamaConfigForm, user=Depends(get_admin_user)):
    app.state.config.ENABLE_OLLAMA_API = form_data.enable_ollama_api
    return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}


117
118
@app.get("/urls")
async def get_ollama_api_urls(user=Depends(get_admin_user)):
119
    return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
120

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

122
class UrlUpdateForm(BaseModel):
123
    urls: List[str]
124
125


126
@app.post("/urls/update")
Timothy J. Baek's avatar
Timothy J. Baek committed
127
async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
128
    app.state.config.OLLAMA_BASE_URLS = form_data.urls
129

130
131
    log.info(f"app.state.config.OLLAMA_BASE_URLS: {app.state.config.OLLAMA_BASE_URLS}")
    return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
Timothy J. Baek's avatar
Timothy J. Baek committed
132
133


134
async def fetch_url(url):
Timothy J. Baek's avatar
Timothy J. Baek committed
135
    timeout = aiohttp.ClientTimeout(total=5)
136
    try:
Timothy J. Baek's avatar
Timothy J. Baek committed
137
        async with aiohttp.ClientSession(timeout=timeout) as session:
138
139
140
141
            async with session.get(url) as response:
                return await response.json()
    except Exception as e:
        # Handle connection error here
142
        log.error(f"Connection error: {e}")
143
144
145
        return None


146
147
148
149
150
151
152
153
154
155
async def cleanup_response(
    response: Optional[aiohttp.ClientResponse],
    session: Optional[aiohttp.ClientSession],
):
    if response:
        response.close()
    if session:
        await session.close()


156
async def post_streaming_url(url: str, payload: str):
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    r = None
    try:
        session = aiohttp.ClientSession()
        r = await session.post(url, data=payload)
        r.raise_for_status()

        return StreamingResponse(
            r.content,
            status_code=r.status,
            headers=dict(r.headers),
            background=BackgroundTask(cleanup_response, response=r, session=session),
        )
    except Exception as e:
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = await r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise HTTPException(
            status_code=r.status if r else 500,
            detail=error_detail,
        )


185
186
187
188
def merge_models_lists(model_lists):
    merged_models = {}

    for idx, model_list in enumerate(model_lists):
Timothy J. Baek's avatar
Timothy J. Baek committed
189
190
191
192
193
194
195
196
        if model_list is not None:
            for model in model_list:
                digest = model["digest"]
                if digest not in merged_models:
                    model["urls"] = [idx]
                    merged_models[digest] = model
                else:
                    merged_models[digest]["urls"].append(idx)
197
198
199
200
201
202
203
204

    return list(merged_models.values())


# user=Depends(get_current_user)


async def get_all_models():
205
    log.info("get_all_models()")
Timothy J. Baek's avatar
Timothy J. Baek committed
206
207
208
209
210
211
212
213
214
215
216
217

    if app.state.config.ENABLE_OLLAMA_API:
        tasks = [
            fetch_url(f"{url}/api/tags") for url in app.state.config.OLLAMA_BASE_URLS
        ]
        responses = await asyncio.gather(*tasks)

        models = {
            "models": merge_models_lists(
                map(
                    lambda response: response["models"] if response else None, responses
                )
218
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
219
220
221
222
        }

    else:
        models = {"models": []}
Timothy J. Baek's avatar
Timothy J. Baek committed
223

224
225
226
227
228
229
230
231
    app.state.MODELS = {model["model"]: model for model in models["models"]}

    return models


@app.get("/api/tags")
@app.get("/api/tags/{url_idx}")
async def get_ollama_tags(
232
    url_idx: Optional[int] = None, user=Depends(get_verified_user)
233
234
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
235
        models = await get_all_models()
236

Timothy J. Baek's avatar
Timothy J. Baek committed
237
        if app.state.config.ENABLE_MODEL_FILTER:
Timothy J. Baek's avatar
Timothy J. Baek committed
238
            if user.role == "user":
239
240
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
241
242
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
243
244
                        models["models"],
                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
245
246
247
                )
                return models
        return models
248
    else:
249
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
250
251

        r = None
252
253
254
255
256
257
        try:
            r = requests.request(method="GET", url=f"{url}/api/tags")
            r.raise_for_status()

            return r.json()
        except Exception as e:
258
            log.exception(e)
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
            error_detail = "Open WebUI: Server Connection Error"
            if r is not None:
                try:
                    res = r.json()
                    if "error" in res:
                        error_detail = f"Ollama: {res['error']}"
                except:
                    error_detail = f"Ollama: {e}"

            raise HTTPException(
                status_code=r.status_code if r else 500,
                detail=error_detail,
            )


@app.get("/api/version")
@app.get("/api/version/{url_idx}")
async def get_ollama_versions(url_idx: Optional[int] = None):

    if url_idx == None:

        # returns lowest version
281
        tasks = [
282
            fetch_url(f"{url}/api/version") for url in app.state.config.OLLAMA_BASE_URLS
283
        ]
284
285
286
        responses = await asyncio.gather(*tasks)
        responses = list(filter(lambda x: x is not None, responses))

Timothy J. Baek's avatar
Timothy J. Baek committed
287
288
        if len(responses) > 0:
            lowest_version = min(
Timothy J. Baek's avatar
Timothy J. Baek committed
289
                responses,
290
291
292
                key=lambda x: tuple(
                    map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
                ),
Timothy J. Baek's avatar
Timothy J. Baek committed
293
            )
294

Timothy J. Baek's avatar
Timothy J. Baek committed
295
296
297
298
299
300
            return {"version": lowest_version["version"]}
        else:
            raise HTTPException(
                status_code=500,
                detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
            )
301
    else:
302
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
303
304

        r = None
305
306
307
308
309
310
        try:
            r = requests.request(method="GET", url=f"{url}/api/version")
            r.raise_for_status()

            return r.json()
        except Exception as e:
311
            log.exception(e)
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
            error_detail = "Open WebUI: Server Connection Error"
            if r is not None:
                try:
                    res = r.json()
                    if "error" in res:
                        error_detail = f"Ollama: {res['error']}"
                except:
                    error_detail = f"Ollama: {e}"

            raise HTTPException(
                status_code=r.status_code if r else 500,
                detail=error_detail,
            )


class ModelNameForm(BaseModel):
    name: str


@app.post("/api/pull")
@app.post("/api/pull/{url_idx}")
async def pull_model(
    form_data: ModelNameForm, url_idx: int = 0, user=Depends(get_admin_user)
):
336
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
337
    log.info(f"url: {url}")
338

339
340
    r = None

Timothy J. Baek's avatar
Timothy J. Baek committed
341
342
343
    # Admin should be able to pull models from any source
    payload = {**form_data.model_dump(exclude_none=True), "insecure": True}

344
    return await post_streaming_url(f"{url}/api/pull", json.dumps(payload))
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365


class PushModelForm(BaseModel):
    name: str
    insecure: Optional[bool] = None
    stream: Optional[bool] = None


@app.delete("/api/push")
@app.delete("/api/push/{url_idx}")
async def push_model(
    form_data: PushModelForm,
    url_idx: Optional[int] = None,
    user=Depends(get_admin_user),
):
    if url_idx == None:
        if form_data.name in app.state.MODELS:
            url_idx = app.state.MODELS[form_data.name]["urls"][0]
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
366
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
367
368
            )

369
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
370
    log.debug(f"url: {url}")
371

372
373
374
    return await post_streaming_url(
        f"{url}/api/push", form_data.model_dump_json(exclude_none=True).encode()
    )
375
376
377
378
379
380
381
382
383
384
385
386
387
388


class CreateModelForm(BaseModel):
    name: str
    modelfile: Optional[str] = None
    stream: Optional[bool] = None
    path: Optional[str] = None


@app.post("/api/create")
@app.post("/api/create/{url_idx}")
async def create_model(
    form_data: CreateModelForm, url_idx: int = 0, user=Depends(get_admin_user)
):
389
    log.debug(f"form_data: {form_data}")
390
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
391
    log.info(f"url: {url}")
392

393
394
395
    return await post_streaming_url(
        f"{url}/api/create", form_data.model_dump_json(exclude_none=True).encode()
    )
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415


class CopyModelForm(BaseModel):
    source: str
    destination: str


@app.post("/api/copy")
@app.post("/api/copy/{url_idx}")
async def copy_model(
    form_data: CopyModelForm,
    url_idx: Optional[int] = None,
    user=Depends(get_admin_user),
):
    if url_idx == None:
        if form_data.source in app.state.MODELS:
            url_idx = app.state.MODELS[form_data.source]["urls"][0]
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
416
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
417
418
            )

419
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
420
    log.info(f"url: {url}")
421
422
423
424
425

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/copy",
Timothy J. Baek's avatar
Timothy J. Baek committed
426
            data=form_data.model_dump_json(exclude_none=True).encode(),
427
428
429
        )
        r.raise_for_status()

430
        log.debug(f"r.text: {r.text}")
431
432
433

        return True
    except Exception as e:
434
        log.exception(e)
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise HTTPException(
            status_code=r.status_code if r else 500,
            detail=error_detail,
        )


@app.delete("/api/delete")
@app.delete("/api/delete/{url_idx}")
async def delete_model(
    form_data: ModelNameForm,
    url_idx: Optional[int] = None,
    user=Depends(get_admin_user),
):
    if url_idx == None:
        if form_data.name in app.state.MODELS:
            url_idx = app.state.MODELS[form_data.name]["urls"][0]
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
463
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
464
465
            )

466
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
467
    log.info(f"url: {url}")
468
469
470
471
472

    try:
        r = requests.request(
            method="DELETE",
            url=f"{url}/api/delete",
Timothy J. Baek's avatar
Timothy J. Baek committed
473
            data=form_data.model_dump_json(exclude_none=True).encode(),
474
475
476
        )
        r.raise_for_status()

477
        log.debug(f"r.text: {r.text}")
478
479
480

        return True
    except Exception as e:
481
        log.exception(e)
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise HTTPException(
            status_code=r.status_code if r else 500,
            detail=error_detail,
        )


@app.post("/api/show")
498
async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
499
500
501
    if form_data.name not in app.state.MODELS:
        raise HTTPException(
            status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
502
            detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
503
504
505
        )

    url_idx = random.choice(app.state.MODELS[form_data.name]["urls"])
506
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
507
    log.info(f"url: {url}")
508
509
510
511
512

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/show",
Timothy J. Baek's avatar
Timothy J. Baek committed
513
            data=form_data.model_dump_json(exclude_none=True).encode(),
514
515
516
517
518
        )
        r.raise_for_status()

        return r.json()
    except Exception as e:
519
        log.exception(e)
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise HTTPException(
            status_code=r.status_code if r else 500,
            detail=error_detail,
        )


class GenerateEmbeddingsForm(BaseModel):
    model: str
    prompt: str
    options: Optional[dict] = None
    keep_alive: Optional[Union[int, str]] = None


@app.post("/api/embeddings")
@app.post("/api/embeddings/{url_idx}")
async def generate_embeddings(
    form_data: GenerateEmbeddingsForm,
    url_idx: Optional[int] = None,
547
    user=Depends(get_verified_user),
548
549
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
550
551
552
553
554
555
        model = form_data.model

        if ":" not in model:
            model = f"{model}:latest"

        if model in app.state.MODELS:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
556
            url_idx = random.choice(app.state.MODELS[model]["urls"])
557
558
559
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
560
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
561
562
            )

563
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
564
    log.info(f"url: {url}")
565
566
567
568
569

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/embeddings",
Timothy J. Baek's avatar
Timothy J. Baek committed
570
            data=form_data.model_dump_json(exclude_none=True).encode(),
571
572
573
574
575
        )
        r.raise_for_status()

        return r.json()
    except Exception as e:
576
        log.exception(e)
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise HTTPException(
            status_code=r.status_code if r else 500,
            detail=error_detail,
        )


592
593
594
595
def generate_ollama_embeddings(
    form_data: GenerateEmbeddingsForm,
    url_idx: Optional[int] = None,
):
Timothy J. Baek's avatar
Timothy J. Baek committed
596

597
    log.info(f"generate_ollama_embeddings {form_data}")
Timothy J. Baek's avatar
Timothy J. Baek committed
598

599
600
601
602
603
604
605
606
607
608
609
610
611
612
    if url_idx == None:
        model = form_data.model

        if ":" not in model:
            model = f"{model}:latest"

        if model in app.state.MODELS:
            url_idx = random.choice(app.state.MODELS[model]["urls"])
        else:
            raise HTTPException(
                status_code=400,
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
            )

613
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
614
615
616
617
618
619
620
621
622
623
624
625
    log.info(f"url: {url}")

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/embeddings",
            data=form_data.model_dump_json(exclude_none=True).encode(),
        )
        r.raise_for_status()

        data = r.json()

626
        log.info(f"generate_ollama_embeddings {data}")
Timothy J. Baek's avatar
Timothy J. Baek committed
627

628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
        if "embedding" in data:
            return data["embedding"]
        else:
            raise "Something went wrong :/"
    except Exception as e:
        log.exception(e)
        error_detail = "Open WebUI: Server Connection Error"
        if r is not None:
            try:
                res = r.json()
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

        raise error_detail


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
class GenerateCompletionForm(BaseModel):
    model: str
    prompt: str
    images: Optional[List[str]] = None
    format: Optional[str] = None
    options: Optional[dict] = None
    system: Optional[str] = None
    template: Optional[str] = None
    context: Optional[str] = None
    stream: Optional[bool] = True
    raw: Optional[bool] = None
    keep_alive: Optional[Union[int, str]] = None


@app.post("/api/generate")
@app.post("/api/generate/{url_idx}")
async def generate_completion(
    form_data: GenerateCompletionForm,
    url_idx: Optional[int] = None,
665
    user=Depends(get_verified_user),
666
667
668
):

    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
669
670
671
672
673
674
        model = form_data.model

        if ":" not in model:
            model = f"{model}:latest"

        if model in app.state.MODELS:
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
675
            url_idx = random.choice(app.state.MODELS[model]["urls"])
676
677
678
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
679
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
680
681
            )

682
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
683
    log.info(f"url: {url}")
684

685
686
687
    return await post_streaming_url(
        f"{url}/api/generate", form_data.model_dump_json(exclude_none=True).encode()
    )
688
689
690
691
692
693
694
695
696
697
698
699
700
701


class ChatMessage(BaseModel):
    role: str
    content: str
    images: Optional[List[str]] = None


class GenerateChatCompletionForm(BaseModel):
    model: str
    messages: List[ChatMessage]
    format: Optional[str] = None
    options: Optional[dict] = None
    template: Optional[str] = None
Timothy J. Baek's avatar
Timothy J. Baek committed
702
    stream: Optional[bool] = None
703
704
705
706
707
    keep_alive: Optional[Union[int, str]] = None


@app.post("/api/chat")
@app.post("/api/chat/{url_idx}")
Timothy J. Baek's avatar
Timothy J. Baek committed
708
async def generate_chat_completion(
709
710
    form_data: GenerateChatCompletionForm,
    url_idx: Optional[int] = None,
711
    user=Depends(get_verified_user),
712
):
Timothy J. Baek's avatar
Timothy J. Baek committed
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736

    log.debug(
        "form_data.model_dump_json(exclude_none=True).encode(): {0} ".format(
            form_data.model_dump_json(exclude_none=True).encode()
        )
    )

    payload = {
        **form_data.model_dump(exclude_none=True),
    }

    model_id = form_data.model
    model_info = Models.get_model_by_id(model_id)

    if model_info:
        print(model_info)
        if model_info.base_model_id:
            payload["model"] = model_info.base_model_id

        model_info.params = model_info.params.model_dump()

        if model_info.params:
            payload["options"] = {}

737
738
            if model_info.params.get("mirostat", None):
                payload["options"]["mirostat"] = model_info.params.get("mirostat", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
739

740
741
742
743
            if model_info.params.get("mirostat_eta", None):
                payload["options"]["mirostat_eta"] = model_info.params.get(
                    "mirostat_eta", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
744

745
            if model_info.params.get("mirostat_tau", None):
Timothy J. Baek's avatar
Timothy J. Baek committed
746

747
748
749
                payload["options"]["mirostat_tau"] = model_info.params.get(
                    "mirostat_tau", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
750

751
752
753
754
755
756
757
758
759
760
761
762
            if model_info.params.get("num_ctx", None):
                payload["options"]["num_ctx"] = model_info.params.get("num_ctx", None)

            if model_info.params.get("repeat_last_n", None):
                payload["options"]["repeat_last_n"] = model_info.params.get(
                    "repeat_last_n", None
                )

            if model_info.params.get("frequency_penalty", None):
                payload["options"]["repeat_penalty"] = model_info.params.get(
                    "frequency_penalty", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
763

764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
            if model_info.params.get("temperature", None):
                payload["options"]["temperature"] = model_info.params.get(
                    "temperature", None
                )

            if model_info.params.get("seed", None):
                payload["options"]["seed"] = model_info.params.get("seed", None)

            if model_info.params.get("stop", None):
                payload["options"]["stop"] = (
                    [
                        bytes(stop, "utf-8").decode("unicode_escape")
                        for stop in model_info.params["stop"]
                    ]
                    if model_info.params.get("stop", None)
                    else None
                )

            if model_info.params.get("tfs_z", None):
                payload["options"]["tfs_z"] = model_info.params.get("tfs_z", None)

            if model_info.params.get("max_tokens", None):
                payload["options"]["num_predict"] = model_info.params.get(
                    "max_tokens", None
                )

            if model_info.params.get("top_k", None):
                payload["options"]["top_k"] = model_info.params.get("top_k", None)

            if model_info.params.get("top_p", None):
                payload["options"]["top_p"] = model_info.params.get("top_p", None)

            if model_info.params.get("use_mmap", None):
                payload["options"]["use_mmap"] = model_info.params.get("use_mmap", None)

            if model_info.params.get("use_mlock", None):
                payload["options"]["use_mlock"] = model_info.params.get(
                    "use_mlock", None
                )

            if model_info.params.get("num_thread", None):
                payload["options"]["num_thread"] = model_info.params.get(
                    "num_thread", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826

        if model_info.params.get("system", None):
            # Check if the payload already has a system message
            # If not, add a system message to the payload
            if payload.get("messages"):
                for message in payload["messages"]:
                    if message.get("role") == "system":
                        message["content"] = (
                            model_info.params.get("system", None) + message["content"]
                        )
                        break
                else:
                    payload["messages"].insert(
                        0,
                        {
                            "role": "system",
                            "content": model_info.params.get("system", None),
                        },
                    )
827
828

    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
829
830
        if ":" not in payload["model"]:
            payload["model"] = f"{payload['model']}:latest"
Timothy J. Baek's avatar
Timothy J. Baek committed
831

Timothy J. Baek's avatar
Timothy J. Baek committed
832
833
        if payload["model"] in app.state.MODELS:
            url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
834
835
836
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
837
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
838
839
            )

840
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
841
    log.info(f"url: {url}")
842

Timothy J. Baek's avatar
Timothy J. Baek committed
843
    print(payload)
Timothy J. Baek's avatar
Timothy J. Baek committed
844

845
    return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
Timothy J. Baek's avatar
Timothy J. Baek committed
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867


# TODO: we should update this part once Ollama supports other types
class OpenAIChatMessage(BaseModel):
    role: str
    content: str

    model_config = ConfigDict(extra="allow")


class OpenAIChatCompletionForm(BaseModel):
    model: str
    messages: List[OpenAIChatMessage]

    model_config = ConfigDict(extra="allow")


@app.post("/v1/chat/completions")
@app.post("/v1/chat/completions/{url_idx}")
async def generate_openai_chat_completion(
    form_data: OpenAIChatCompletionForm,
    url_idx: Optional[int] = None,
868
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
869
870
):

Timothy J. Baek's avatar
Timothy J. Baek committed
871
872
873
    payload = {
        **form_data.model_dump(exclude_none=True),
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
874

Timothy J. Baek's avatar
Timothy J. Baek committed
875
876
    model_id = form_data.model
    model_info = Models.get_model_by_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
877

Timothy J. Baek's avatar
Timothy J. Baek committed
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
    if model_info:
        print(model_info)
        if model_info.base_model_id:
            payload["model"] = model_info.base_model_id

        model_info.params = model_info.params.model_dump()

        if model_info.params:
            payload["temperature"] = model_info.params.get("temperature", None)
            payload["top_p"] = model_info.params.get("top_p", None)
            payload["max_tokens"] = model_info.params.get("max_tokens", None)
            payload["frequency_penalty"] = model_info.params.get(
                "frequency_penalty", None
            )
            payload["seed"] = model_info.params.get("seed", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
893
894
895
896
897
898
899
900
            payload["stop"] = (
                [
                    bytes(stop, "utf-8").decode("unicode_escape")
                    for stop in model_info.params["stop"]
                ]
                if model_info.params.get("stop", None)
                else None
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926

        if model_info.params.get("system", None):
            # Check if the payload already has a system message
            # If not, add a system message to the payload
            if payload.get("messages"):
                for message in payload["messages"]:
                    if message.get("role") == "system":
                        message["content"] = (
                            model_info.params.get("system", None) + message["content"]
                        )
                        break
                else:
                    payload["messages"].insert(
                        0,
                        {
                            "role": "system",
                            "content": model_info.params.get("system", None),
                        },
                    )

    if url_idx == None:
        if ":" not in payload["model"]:
            payload["model"] = f"{payload['model']}:latest"

        if payload["model"] in app.state.MODELS:
            url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
Timothy J. Baek's avatar
Timothy J. Baek committed
927
928
929
930
931
932
        else:
            raise HTTPException(
                status_code=400,
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
            )

933
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
934
    log.info(f"url: {url}")
Timothy J. Baek's avatar
Timothy J. Baek committed
935

936
    return await post_streaming_url(f"{url}/v1/chat/completions", json.dumps(payload))
937
938


939
940
941
942
943
944
945
946
947
@app.get("/v1/models")
@app.get("/v1/models/{url_idx}")
async def get_openai_models(
    url_idx: Optional[int] = None,
    user=Depends(get_verified_user),
):
    if url_idx == None:
        models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
948
        if app.state.config.ENABLE_MODEL_FILTER:
949
950
951
            if user.role == "user":
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
952
953
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
                        models["models"],
                    )
                )

        return {
            "data": [
                {
                    "id": model["model"],
                    "object": "model",
                    "created": int(time.time()),
                    "owned_by": "openai",
                }
                for model in models["models"]
            ],
            "object": "list",
        }

    else:
972
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
        try:
            r = requests.request(method="GET", url=f"{url}/api/tags")
            r.raise_for_status()

            models = r.json()

            return {
                "data": [
                    {
                        "id": model["model"],
                        "object": "model",
                        "created": int(time.time()),
                        "owned_by": "openai",
                    }
                    for model in models["models"]
                ],
                "object": "list",
            }

        except Exception as e:
            log.exception(e)
            error_detail = "Open WebUI: Server Connection Error"
            if r is not None:
                try:
                    res = r.json()
                    if "error" in res:
                        error_detail = f"Ollama: {res['error']}"
                except:
                    error_detail = f"Ollama: {e}"

            raise HTTPException(
                status_code=r.status_code if r else 500,
                detail=error_detail,
            )


Timothy J. Baek's avatar
Timothy J. Baek committed
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
class UrlForm(BaseModel):
    url: str


class UploadBlobForm(BaseModel):
    filename: str


def parse_huggingface_url(hf_url):
    try:
        # Parse the URL
        parsed_url = urlparse(hf_url)

        # Get the path and split it into components
        path_components = parsed_url.path.split("/")

        # Extract the desired output
        user_repo = "/".join(path_components[1:3])
        model_file = path_components[-1]

        return model_file
    except ValueError:
        return None


async def download_file_stream(
    ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
):
    done = False

    if os.path.exists(file_path):
        current_size = os.path.getsize(file_path)
    else:
        current_size = 0

    headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}

    timeout = aiohttp.ClientTimeout(total=600)  # Set the timeout

    async with aiohttp.ClientSession(timeout=timeout) as session:
        async with session.get(file_url, headers=headers) as response:
            total_size = int(response.headers.get("content-length", 0)) + current_size

            with open(file_path, "ab+") as file:
                async for data in response.content.iter_chunked(chunk_size):
                    current_size += len(data)
                    file.write(data)

                    done = current_size == total_size
                    progress = round((current_size / total_size) * 100, 2)
Timothy J. Baek's avatar
Timothy J. Baek committed
1059

Timothy J. Baek's avatar
Timothy J. Baek committed
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
                    yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'

                if done:
                    file.seek(0)
                    hashed = calculate_sha256(file)
                    file.seek(0)

                    url = f"{ollama_url}/api/blobs/sha256:{hashed}"
                    response = requests.post(url, data=file)

                    if response.ok:
                        res = {
                            "done": done,
                            "blob": f"sha256:{hashed}",
                            "name": file_name,
                        }
                        os.remove(file_path)

                        yield f"data: {json.dumps(res)}\n\n"
                    else:
                        raise "Ollama: Could not create blob, Please try again."


Timothy J. Baek's avatar
Timothy J. Baek committed
1083
1084
1085
1086
1087
# def number_generator():
#     for i in range(1, 101):
#         yield f"data: {i}\n"


Timothy J. Baek's avatar
Timothy J. Baek committed
1088
1089
1090
1091
1092
1093
1094
1095
# url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
@app.post("/models/download")
@app.post("/models/download/{url_idx}")
async def download_model(
    form_data: UrlForm,
    url_idx: Optional[int] = None,
):

Timothy J. Baek's avatar
Timothy J. Baek committed
1096
1097
1098
1099
1100
1101
1102
1103
    allowed_hosts = ["https://huggingface.co/", "https://github.com/"]

    if not any(form_data.url.startswith(host) for host in allowed_hosts):
        raise HTTPException(
            status_code=400,
            detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
        )

Timothy J. Baek's avatar
Timothy J. Baek committed
1104
1105
    if url_idx == None:
        url_idx = 0
1106
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1107
1108
1109
1110
1111

    file_name = parse_huggingface_url(form_data.url)

    if file_name:
        file_path = f"{UPLOAD_DIR}/{file_name}"
Timothy J. Baek's avatar
Timothy J. Baek committed
1112

Timothy J. Baek's avatar
Timothy J. Baek committed
1113
        return StreamingResponse(
Timothy J. Baek's avatar
Timothy J. Baek committed
1114
            download_file_stream(url, form_data.url, file_path, file_name),
Timothy J. Baek's avatar
Timothy J. Baek committed
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
        )
    else:
        return None


@app.post("/models/upload")
@app.post("/models/upload/{url_idx}")
def upload_model(file: UploadFile = File(...), url_idx: Optional[int] = None):
    if url_idx == None:
        url_idx = 0
1125
    ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163

    file_path = f"{UPLOAD_DIR}/{file.filename}"

    # Save file in chunks
    with open(file_path, "wb+") as f:
        for chunk in file.file:
            f.write(chunk)

    def file_process_stream():
        nonlocal ollama_url
        total_size = os.path.getsize(file_path)
        chunk_size = 1024 * 1024
        try:
            with open(file_path, "rb") as f:
                total = 0
                done = False

                while not done:
                    chunk = f.read(chunk_size)
                    if not chunk:
                        done = True
                        continue

                    total += len(chunk)
                    progress = round((total / total_size) * 100, 2)

                    res = {
                        "progress": progress,
                        "total": total_size,
                        "completed": total,
                    }
                    yield f"data: {json.dumps(res)}\n\n"

                if done:
                    f.seek(0)
                    hashed = calculate_sha256(f)
                    f.seek(0)

Timothy J. Baek's avatar
Timothy J. Baek committed
1164
                    url = f"{ollama_url}/api/blobs/sha256:{hashed}"
Timothy J. Baek's avatar
Timothy J. Baek committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
                    response = requests.post(url, data=f)

                    if response.ok:
                        res = {
                            "done": done,
                            "blob": f"sha256:{hashed}",
                            "name": file.filename,
                        }
                        os.remove(file_path)
                        yield f"data: {json.dumps(res)}\n\n"
                    else:
                        raise Exception(
                            "Ollama: Could not create blob, Please try again."
                        )

        except Exception as e:
            res = {"error": str(e)}
            yield f"data: {json.dumps(res)}\n\n"

    return StreamingResponse(file_process_stream(), media_type="text/event-stream")


Timothy J. Baek's avatar
Timothy J. Baek committed
1187
1188
1189
# async def upload_model(file: UploadFile = File(), url_idx: Optional[int] = None):
#     if url_idx == None:
#         url_idx = 0
1190
#     url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222

#     file_location = os.path.join(UPLOAD_DIR, file.filename)
#     total_size = file.size

#     async def file_upload_generator(file):
#         print(file)
#         try:
#             async with aiofiles.open(file_location, "wb") as f:
#                 completed_size = 0
#                 while True:
#                     chunk = await file.read(1024*1024)
#                     if not chunk:
#                         break
#                     await f.write(chunk)
#                     completed_size += len(chunk)
#                     progress = (completed_size / total_size) * 100

#                     print(progress)
#                     yield f'data: {json.dumps({"status": "uploading", "percentage": progress, "total": total_size, "completed": completed_size, "done": False})}\n'
#         except Exception as e:
#             print(e)
#             yield f"data: {json.dumps({'status': 'error', 'message': str(e)})}\n"
#         finally:
#             await file.close()
#             print("done")
#             yield f'data: {json.dumps({"status": "completed", "percentage": 100, "total": total_size, "completed": completed_size, "done": True})}\n'

#     return StreamingResponse(
#         file_upload_generator(copy.deepcopy(file)), media_type="text/event-stream"
#     )


1223
@app.api_route("/{path:path}", methods=["GET", "POST", "PUT", "DELETE"])
1224
1225
1226
async def deprecated_proxy(
    path: str, request: Request, user=Depends(get_verified_user)
):
1227
    url = app.state.config.OLLAMA_BASE_URLS[0]
1228
    target_url = f"{url}/{path}"
1229
1230
1231
1232
1233
1234
1235

    body = await request.body()
    headers = dict(request.headers)

    if user.role in ["user", "admin"]:
        if path in ["pull", "delete", "push", "copy", "create"]:
            if user.role != "admin":
Timothy J. Baek's avatar
Timothy J. Baek committed
1236
                raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1237
1238
                    status_code=status.HTTP_401_UNAUTHORIZED,
                    detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
Timothy J. Baek's avatar
Timothy J. Baek committed
1239
                )
1240
    else:
Timothy J. Baek's avatar
Timothy J. Baek committed
1241
1242
1243
1244
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
        )
1245

1246
1247
1248
1249
    headers.pop("host", None)
    headers.pop("authorization", None)
    headers.pop("origin", None)
    headers.pop("referer", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
1250

Timothy J. Baek's avatar
Timothy J. Baek committed
1251
1252
1253
1254
    r = None

    def get_request():
        nonlocal r
1255
1256

        request_id = str(uuid.uuid4())
Timothy J. Baek's avatar
Timothy J. Baek committed
1257
        try:
1258
1259
1260
1261
            REQUEST_POOL.append(request_id)

            def stream_content():
                try:
1262
1263
1264
                    if path == "generate":
                        data = json.loads(body.decode("utf-8"))

1265
                        if data.get("stream", True):
1266
1267
1268
                            yield json.dumps({"id": request_id, "done": False}) + "\n"

                    elif path == "chat":
1269
1270
1271
1272
1273
1274
                        yield json.dumps({"id": request_id, "done": False}) + "\n"

                    for chunk in r.iter_content(chunk_size=8192):
                        if request_id in REQUEST_POOL:
                            yield chunk
                        else:
1275
                            log.warning("User: canceled request")
1276
1277
1278
1279
                            break
                finally:
                    if hasattr(r, "close"):
                        r.close()
1280
1281
                        if request_id in REQUEST_POOL:
                            REQUEST_POOL.remove(request_id)
1282

Timothy J. Baek's avatar
Timothy J. Baek committed
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
            r = requests.request(
                method=request.method,
                url=target_url,
                data=body,
                headers=headers,
                stream=True,
            )

            r.raise_for_status()

1293
1294
            # r.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1295
            return StreamingResponse(
1296
                stream_content(),
Timothy J. Baek's avatar
Timothy J. Baek committed
1297
1298
1299
1300
1301
                status_code=r.status_code,
                headers=dict(r.headers),
            )
        except Exception as e:
            raise e
1302

Timothy J. Baek's avatar
Timothy J. Baek committed
1303
1304
    try:
        return await run_in_threadpool(get_request)
1305
    except Exception as e:
Timothy J. Baek's avatar
Timothy J. Baek committed
1306
        error_detail = "Open WebUI: Server Connection Error"
Timothy J. Baek's avatar
Timothy J. Baek committed
1307
        if r is not None:
1308
            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1309
                res = r.json()
1310
1311
1312
1313
1314
                if "error" in res:
                    error_detail = f"Ollama: {res['error']}"
            except:
                error_detail = f"Ollama: {e}"

Timothy J. Baek's avatar
Timothy J. Baek committed
1315
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1316
            status_code=r.status_code if r else 500,
Timothy J. Baek's avatar
Timothy J. Baek committed
1317
1318
            detail=error_detail,
        )