main.py 39.1 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

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

56
57
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
58

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

68
app.state.config = AppConfig()
Timothy J. Baek's avatar
Timothy J. Baek committed
69

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

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


Timothy J. Baek's avatar
Timothy J. Baek committed
78
79
80
81
82
# 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.


83
84
85
86
87
88
89
90
91
92
93
@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
94
95
96
97
98
99
@app.head("/")
@app.get("/")
async def get_status():
    return {"status": True}


Timothy J. Baek's avatar
Timothy J. Baek committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
@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}


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

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

120
class UrlUpdateForm(BaseModel):
121
    urls: List[str]
122
123


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

128
129
    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
130
131


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


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


154
async def post_streaming_url(url: str, payload: str):
155
156
    r = None
    try:
157
        session = aiohttp.ClientSession(trust_env=True)
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
        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,
        )


183
184
185
186
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
187
188
189
190
191
192
193
194
        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)
195
196
197
198
199
200
201
202

    return list(merged_models.values())


# user=Depends(get_current_user)


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

    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
                )
216
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
217
218
219
220
        }

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

222
223
224
225
226
227
228
229
    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(
230
    url_idx: Optional[int] = None, user=Depends(get_verified_user)
231
232
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
233
        models = await get_all_models()
234

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

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

            return r.json()
        except Exception as e:
256
            log.exception(e)
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
            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):
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    if app.state.config.ENABLE_OLLAMA_API:
        if url_idx == None:

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

            if len(responses) > 0:
                lowest_version = min(
                    responses,
                    key=lambda x: tuple(
                        map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
                    ),
                )
293

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

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
            r = None
            try:
                r = requests.request(method="GET", url=f"{url}/api/version")
                r.raise_for_status()

                return r.json()
            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,
                )
    else:
        return {"version": False}
326
327
328
329
330
331
332
333
334
335
336


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)
):
337
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
338
    log.info(f"url: {url}")
339

340
341
    r = None

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

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


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
367
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
368
369
            )

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

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


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)
):
390
    log.debug(f"form_data: {form_data}")
391
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
392
    log.info(f"url: {url}")
393

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


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
417
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
418
419
            )

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

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

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

        return True
    except Exception as e:
435
        log.exception(e)
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
463
        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
464
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
465
466
            )

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

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

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

        return True
    except Exception as e:
482
        log.exception(e)
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
        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")
499
async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
500
501
502
    if form_data.name not in app.state.MODELS:
        raise HTTPException(
            status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
503
            detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
504
505
506
        )

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

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

        return r.json()
    except Exception as e:
520
        log.exception(e)
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
547
        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,
548
    user=Depends(get_verified_user),
549
550
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
551
552
553
554
555
556
        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
557
            url_idx = random.choice(app.state.MODELS[model]["urls"])
558
559
560
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
561
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
562
563
            )

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

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

        return r.json()
    except Exception as e:
577
        log.exception(e)
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
        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,
        )


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

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

600
601
602
603
604
605
606
607
608
609
610
611
612
613
    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),
            )

614
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
615
616
617
618
619
620
621
622
623
624
625
626
    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()

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

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
        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


647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
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,
666
    user=Depends(get_verified_user),
667
668
669
):

    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
670
671
672
673
674
675
        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
676
            url_idx = random.choice(app.state.MODELS[model]["urls"])
677
678
679
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
680
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
681
682
            )

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

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


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
703
    stream: Optional[bool] = None
704
705
706
707
708
    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
709
async def generate_chat_completion(
710
711
    form_data: GenerateChatCompletionForm,
    url_idx: Optional[int] = None,
712
    user=Depends(get_verified_user),
713
):
Timothy J. Baek's avatar
Timothy J. Baek committed
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:
        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
            if model_info.params.get("temperature", None) is not None:
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
                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


# TODO: we should update this part once Ollama supports other types
849
850
851
852
853
class OpenAIChatMessageContent(BaseModel):
    type: str
    model_config = ConfigDict(extra="allow")


Timothy J. Baek's avatar
Timothy J. Baek committed
854
855
class OpenAIChatMessage(BaseModel):
    role: str
856
    content: Union[str, OpenAIChatMessageContent]
Timothy J. Baek's avatar
Timothy J. Baek committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872

    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,
873
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
874
875
):

Timothy J. Baek's avatar
Timothy J. Baek committed
876
877
878
    payload = {
        **form_data.model_dump(exclude_none=True),
    }
Timothy J. Baek's avatar
Timothy J. Baek committed
879

Timothy J. Baek's avatar
Timothy J. Baek committed
880
881
    model_id = form_data.model
    model_info = Models.get_model_by_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
882

Timothy J. Baek's avatar
Timothy J. Baek committed
883
884
885
886
887
888
889
890
891
892
893
894
895
896
    if 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
897
898
899
900
901
902
903
904
            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
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930

        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
931
932
933
934
935
936
        else:
            raise HTTPException(
                status_code=400,
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
            )

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

940
    return await post_streaming_url(f"{url}/v1/chat/completions", json.dumps(payload))
941
942


943
944
945
946
947
948
949
950
951
@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
952
        if app.state.config.ENABLE_MODEL_FILTER:
953
954
955
            if user.role == "user":
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
956
957
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
                        models["models"],
                    )
                )

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

    else:
976
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
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
1009
1010
1011
1012
        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
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
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

1052
    async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
        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
1063

Timothy J. Baek's avatar
Timothy J. Baek committed
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
                    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
1087
1088
1089
1090
1091
# def number_generator():
#     for i in range(1, 101):
#         yield f"data: {i}\n"


Timothy J. Baek's avatar
Timothy J. Baek committed
1092
1093
1094
1095
1096
1097
1098
1099
# 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
1100
1101
1102
1103
1104
1105
1106
1107
    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
1108
1109
    if url_idx == None:
        url_idx = 0
1110
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1111
1112
1113
1114
1115

    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
1116

Timothy J. Baek's avatar
Timothy J. Baek committed
1117
        return StreamingResponse(
Timothy J. Baek's avatar
Timothy J. Baek committed
1118
            download_file_stream(url, form_data.url, file_path, file_name),
Timothy J. Baek's avatar
Timothy J. Baek committed
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
        )
    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
1129
    ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
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
1164
1165
1166
1167

    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
1168
                    url = f"{ollama_url}/api/blobs/sha256:{hashed}"
Timothy J. Baek's avatar
Timothy J. Baek committed
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
                    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
1191
1192
1193
# async def upload_model(file: UploadFile = File(), url_idx: Optional[int] = None):
#     if url_idx == None:
#         url_idx = 0
1194
#     url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
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
1223
1224
1225
1226

#     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"
#     )


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

    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
1240
                raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1241
1242
                    status_code=status.HTTP_401_UNAUTHORIZED,
                    detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
Timothy J. Baek's avatar
Timothy J. Baek committed
1243
                )
1244
    else:
Timothy J. Baek's avatar
Timothy J. Baek committed
1245
1246
1247
1248
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
        )
1249

1250
1251
1252
1253
    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
1254

Timothy J. Baek's avatar
Timothy J. Baek committed
1255
1256
1257
1258
    r = None

    def get_request():
        nonlocal r
1259
1260

        request_id = str(uuid.uuid4())
Timothy J. Baek's avatar
Timothy J. Baek committed
1261
        try:
1262
1263
1264
1265
            REQUEST_POOL.append(request_id)

            def stream_content():
                try:
1266
1267
1268
                    if path == "generate":
                        data = json.loads(body.decode("utf-8"))

1269
                        if data.get("stream", True):
1270
1271
1272
                            yield json.dumps({"id": request_id, "done": False}) + "\n"

                    elif path == "chat":
1273
1274
1275
1276
1277
1278
                        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:
1279
                            log.warning("User: canceled request")
1280
1281
1282
1283
                            break
                finally:
                    if hasattr(r, "close"):
                        r.close()
1284
1285
                        if request_id in REQUEST_POOL:
                            REQUEST_POOL.remove(request_id)
1286

Timothy J. Baek's avatar
Timothy J. Baek committed
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
            r = requests.request(
                method=request.method,
                url=target_url,
                data=body,
                headers=headers,
                stream=True,
            )

            r.raise_for_status()

1297
1298
            # r.close()

Timothy J. Baek's avatar
Timothy J. Baek committed
1299
            return StreamingResponse(
1300
                stream_content(),
Timothy J. Baek's avatar
Timothy J. Baek committed
1301
1302
1303
1304
1305
                status_code=r.status_code,
                headers=dict(r.headers),
            )
        except Exception as e:
            raise e
1306

Timothy J. Baek's avatar
Timothy J. Baek committed
1307
1308
    try:
        return await run_in_threadpool(get_request)
1309
    except Exception as e:
Timothy J. Baek's avatar
Timothy J. Baek committed
1310
        error_detail = "Open WebUI: Server Connection Error"
Timothy J. Baek's avatar
Timothy J. Baek committed
1311
        if r is not None:
1312
            try:
Timothy J. Baek's avatar
Timothy J. Baek committed
1313
                res = r.json()
1314
1315
1316
1317
1318
                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
1319
        raise HTTPException(
Timothy J. Baek's avatar
Timothy J. Baek committed
1320
            status_code=r.status_code if r else 500,
Timothy J. Baek's avatar
Timothy J. Baek committed
1321
1322
            detail=error_detail,
        )