main.py 37.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,
)
43
from utils.task import prompt_template
Timothy J. Baek's avatar
Timothy J. Baek committed
44

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

Timothy J. Baek's avatar
Timothy J. Baek committed
46
47
48
from config import (
    SRC_LOG_LEVELS,
    OLLAMA_BASE_URLS,
Timothy J. Baek's avatar
Timothy J. Baek committed
49
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
50
    AIOHTTP_CLIENT_TIMEOUT,
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
)
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
56
from utils.misc import calculate_sha256, add_or_update_system_message
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:
137
        async with aiohttp.ClientSession(timeout=timeout, trust_env=True) 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, stream: bool = True):
157
158
    r = None
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
159
160
161
        session = aiohttp.ClientSession(
            trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
        )
162
163
164
        r = await session.post(url, data=payload)
        r.raise_for_status()

165
166
167
168
169
170
171
172
173
174
175
176
177
178
        if stream:
            return StreamingResponse(
                r.content,
                status_code=r.status,
                headers=dict(r.headers),
                background=BackgroundTask(
                    cleanup_response, response=r, session=session
                ),
            )
        else:
            res = await r.json()
            await cleanup_response(r, session)
            return res

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    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,
        )


195
196
197
198
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
199
200
201
202
203
204
205
206
        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)
207
208
209
210
211

    return list(merged_models.values())


async def get_all_models():
212
    log.info("get_all_models()")
Timothy J. Baek's avatar
Timothy J. Baek committed
213
214
215
216
217
218
219
220
221
222
223
224

    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
                )
225
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
226
227
228
229
        }

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

231
232
233
234
235
236
237
238
    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(
239
    url_idx: Optional[int] = None, user=Depends(get_verified_user)
240
241
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
242
        models = await get_all_models()
243

Timothy J. Baek's avatar
Timothy J. Baek committed
244
        if app.state.config.ENABLE_MODEL_FILTER:
Timothy J. Baek's avatar
Timothy J. Baek committed
245
            if user.role == "user":
246
247
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
248
249
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
250
251
                        models["models"],
                    )
Timothy J. Baek's avatar
Timothy J. Baek committed
252
253
254
                )
                return models
        return models
255
    else:
256
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
257
258

        r = None
259
260
261
262
263
264
        try:
            r = requests.request(method="GET", url=f"{url}/api/tags")
            r.raise_for_status()

            return r.json()
        except Exception as e:
265
            log.exception(e)
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
            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):
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
    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("."))
                    ),
                )
302

303
304
305
306
307
308
                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
309
        else:
310
            url = app.state.config.OLLAMA_BASE_URLS[url_idx]
311

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
            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}
335
336
337
338
339
340
341
342
343
344
345


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

349
350
    r = None

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

354
    return await post_streaming_url(f"{url}/api/pull", json.dumps(payload))
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375


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
376
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
377
378
            )

379
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
380
    log.debug(f"url: {url}")
381

382
383
384
    return await post_streaming_url(
        f"{url}/api/push", form_data.model_dump_json(exclude_none=True).encode()
    )
385
386
387
388
389
390
391
392
393
394
395
396
397
398


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)
):
399
    log.debug(f"form_data: {form_data}")
400
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
401
    log.info(f"url: {url}")
402

403
404
405
    return await post_streaming_url(
        f"{url}/api/create", form_data.model_dump_json(exclude_none=True).encode()
    )
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425


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
426
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
427
428
            )

429
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
430
    log.info(f"url: {url}")
431
432
433
434
435

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

440
        log.debug(f"r.text: {r.text}")
441
442
443

        return True
    except Exception as e:
444
        log.exception(e)
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
        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
473
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
474
475
            )

476
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
477
    log.info(f"url: {url}")
478
479
480
481
482

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

487
        log.debug(f"r.text: {r.text}")
488
489
490

        return True
    except Exception as e:
491
        log.exception(e)
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
        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")
508
async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
509
510
511
    if form_data.name not in app.state.MODELS:
        raise HTTPException(
            status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
512
            detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
513
514
515
        )

    url_idx = random.choice(app.state.MODELS[form_data.name]["urls"])
516
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
517
    log.info(f"url: {url}")
518
519
520
521
522

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/show",
Timothy J. Baek's avatar
Timothy J. Baek committed
523
            data=form_data.model_dump_json(exclude_none=True).encode(),
524
525
526
527
528
        )
        r.raise_for_status()

        return r.json()
    except Exception as e:
529
        log.exception(e)
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
        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,
557
    user=Depends(get_verified_user),
558
559
):
    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
560
561
562
563
564
565
        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
566
            url_idx = random.choice(app.state.MODELS[model]["urls"])
567
568
569
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
570
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
571
572
            )

573
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
574
    log.info(f"url: {url}")
575
576
577
578
579

    try:
        r = requests.request(
            method="POST",
            url=f"{url}/api/embeddings",
Timothy J. Baek's avatar
Timothy J. Baek committed
580
            data=form_data.model_dump_json(exclude_none=True).encode(),
581
582
583
584
585
        )
        r.raise_for_status()

        return r.json()
    except Exception as e:
586
        log.exception(e)
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
        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,
        )


602
603
604
605
def generate_ollama_embeddings(
    form_data: GenerateEmbeddingsForm,
    url_idx: Optional[int] = None,
):
Timothy J. Baek's avatar
Timothy J. Baek committed
606

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

609
610
611
612
613
614
615
616
617
618
619
620
621
622
    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),
            )

623
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
624
625
626
627
628
629
630
631
632
633
634
635
    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()

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

638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
        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


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
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,
675
    user=Depends(get_verified_user),
676
677
678
):

    if url_idx == None:
Timothy J. Baek's avatar
Timothy J. Baek committed
679
680
681
682
683
684
        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
685
            url_idx = random.choice(app.state.MODELS[model]["urls"])
686
687
688
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
689
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
690
691
            )

692
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
693
    log.info(f"url: {url}")
694

695
696
697
    return await post_streaming_url(
        f"{url}/api/generate", form_data.model_dump_json(exclude_none=True).encode()
    )
698
699
700
701
702
703
704
705
706
707
708
709
710
711


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
712
    stream: Optional[bool] = None
713
714
715
716
717
    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
718
async def generate_chat_completion(
719
720
    form_data: GenerateChatCompletionForm,
    url_idx: Optional[int] = None,
721
    user=Depends(get_verified_user),
722
):
Timothy J. Baek's avatar
Timothy J. Baek committed
723
724
725
726
727
728
729
730

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

    payload = {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
731
        **form_data.model_dump(exclude_none=True, exclude=["metadata"]),
Timothy J. Baek's avatar
Timothy J. Baek committed
732
    }
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
733
734
    if "metadata" in payload:
        del payload["metadata"]
Timothy J. Baek's avatar
Timothy J. Baek committed
735
736
737
738
739
740
741
742
743
744
745

    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:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
746
747
            if payload.get("options") is None:
                payload["options"] = {}
Timothy J. Baek's avatar
Timothy J. Baek committed
748

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
749
750
751
752
            if (
                model_info.params.get("mirostat", None)
                and payload["options"].get("mirostat") is None
            ):
753
                payload["options"]["mirostat"] = model_info.params.get("mirostat", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
754

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
755
756
757
758
            if (
                model_info.params.get("mirostat_eta", None)
                and payload["options"].get("mirostat_eta") is None
            ):
759
760
761
                payload["options"]["mirostat_eta"] = model_info.params.get(
                    "mirostat_eta", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
762

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
763
764
765
766
            if (
                model_info.params.get("mirostat_tau", None)
                and payload["options"].get("mirostat_tau") is None
            ):
767
768
769
                payload["options"]["mirostat_tau"] = model_info.params.get(
                    "mirostat_tau", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
770

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
771
772
773
774
            if (
                model_info.params.get("num_ctx", None)
                and payload["options"].get("num_ctx") is None
            ):
775
776
                payload["options"]["num_ctx"] = model_info.params.get("num_ctx", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
777
778
779
780
            if (
                model_info.params.get("num_batch", None)
                and payload["options"].get("num_batch") is None
            ):
Sam McLeod's avatar
Sam McLeod committed
781
782
783
784
                payload["options"]["num_batch"] = model_info.params.get(
                    "num_batch", None
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
785
786
787
788
            if (
                model_info.params.get("num_keep", None)
                and payload["options"].get("num_keep") is None
            ):
Sam McLeod's avatar
Sam McLeod committed
789
790
                payload["options"]["num_keep"] = model_info.params.get("num_keep", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
791
792
793
794
            if (
                model_info.params.get("repeat_last_n", None)
                and payload["options"].get("repeat_last_n") is None
            ):
795
796
797
798
                payload["options"]["repeat_last_n"] = model_info.params.get(
                    "repeat_last_n", None
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
799
800
801
802
            if (
                model_info.params.get("frequency_penalty", None)
                and payload["options"].get("frequency_penalty") is None
            ):
803
804
805
                payload["options"]["repeat_penalty"] = model_info.params.get(
                    "frequency_penalty", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
806

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
807
            if (
808
                model_info.params.get("temperature", None) is not None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
809
810
                and payload["options"].get("temperature") is None
            ):
811
812
813
814
                payload["options"]["temperature"] = model_info.params.get(
                    "temperature", None
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
815
            if (
816
                model_info.params.get("seed", None) is not None
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
817
818
                and payload["options"].get("seed") is None
            ):
819
820
                payload["options"]["seed"] = model_info.params.get("seed", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
821
822
823
824
            if (
                model_info.params.get("stop", None)
                and payload["options"].get("stop") is None
            ):
825
826
827
828
829
830
831
832
833
                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
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
834
835
836
837
            if (
                model_info.params.get("tfs_z", None)
                and payload["options"].get("tfs_z") is None
            ):
838
839
                payload["options"]["tfs_z"] = model_info.params.get("tfs_z", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
840
841
842
843
            if (
                model_info.params.get("max_tokens", None)
                and payload["options"].get("max_tokens") is None
            ):
844
845
846
847
                payload["options"]["num_predict"] = model_info.params.get(
                    "max_tokens", None
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
848
849
850
851
            if (
                model_info.params.get("top_k", None)
                and payload["options"].get("top_k") is None
            ):
852
853
                payload["options"]["top_k"] = model_info.params.get("top_k", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
854
855
856
857
            if (
                model_info.params.get("top_p", None)
                and payload["options"].get("top_p") is None
            ):
858
859
                payload["options"]["top_p"] = model_info.params.get("top_p", None)

Timothy J. Baek's avatar
Timothy J. Baek committed
860
861
862
863
864
865
            if (
                model_info.params.get("min_p", None)
                and payload["options"].get("min_p") is None
            ):
                payload["options"]["min_p"] = model_info.params.get("min_p", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
866
867
868
869
            if (
                model_info.params.get("use_mmap", None)
                and payload["options"].get("use_mmap") is None
            ):
870
871
                payload["options"]["use_mmap"] = model_info.params.get("use_mmap", None)

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
872
873
874
875
            if (
                model_info.params.get("use_mlock", None)
                and payload["options"].get("use_mlock") is None
            ):
876
877
878
879
                payload["options"]["use_mlock"] = model_info.params.get(
                    "use_mlock", None
                )

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
880
881
882
883
            if (
                model_info.params.get("num_thread", None)
                and payload["options"].get("num_thread") is None
            ):
884
885
886
                payload["options"]["num_thread"] = model_info.params.get(
                    "num_thread", None
                )
Timothy J. Baek's avatar
Timothy J. Baek committed
887

888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
        system = model_info.params.get("system", None)
        if system:
            system = prompt_template(
                system,
                **(
                    {
                        "user_name": user.name,
                        "user_location": (
                            user.info.get("location") if user.info else None
                        ),
                    }
                    if user
                    else {}
                ),
            )

Timothy J. Baek's avatar
Timothy J. Baek committed
904
            if payload.get("messages"):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
905
906
907
                payload["messages"] = add_or_update_system_message(
                    system, payload["messages"]
                )
908
909

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

Timothy J. Baek's avatar
Timothy J. Baek committed
913
914
        if payload["model"] in app.state.MODELS:
            url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
915
916
917
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
918
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
919
920
            )

921
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
922
    log.info(f"url: {url}")
923
    log.debug(payload)
Timothy J. Baek's avatar
Timothy J. Baek committed
924

925
    return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
Timothy J. Baek's avatar
Timothy J. Baek committed
926
927
928


# TODO: we should update this part once Ollama supports other types
929
930
931
932
933
class OpenAIChatMessageContent(BaseModel):
    type: str
    model_config = ConfigDict(extra="allow")


Timothy J. Baek's avatar
Timothy J. Baek committed
934
935
class OpenAIChatMessage(BaseModel):
    role: str
936
    content: Union[str, OpenAIChatMessageContent]
Timothy J. Baek's avatar
Timothy J. Baek committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950

    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(
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
951
    form_data: dict,
Timothy J. Baek's avatar
Timothy J. Baek committed
952
    url_idx: Optional[int] = None,
953
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
954
):
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
955
    form_data = OpenAIChatCompletionForm(**form_data)
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
956
    payload = {**form_data.model_dump(exclude_none=True, exclude=["metadata"])}
Timothy J. Baek's avatar
Timothy J. Baek committed
957

Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
958
959
    if "metadata" in payload:
        del payload["metadata"]
Timothy J. Baek's avatar
Timothy J. Baek committed
960

Timothy J. Baek's avatar
Timothy J. Baek committed
961
962
    model_id = form_data.model
    model_info = Models.get_model_by_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
963

Timothy J. Baek's avatar
Timothy J. Baek committed
964
965
966
967
968
969
970
971
972
973
974
975
976
977
    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
978
979
980
981
982
983
984
985
            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
986

987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
        system = model_info.params.get("system", None)

        if system:
            system = prompt_template(
                system,
                **(
                    {
                        "user_name": user.name,
                        "user_location": (
                            user.info.get("location") if user.info else None
                        ),
                    }
                    if user
                    else {}
                ),
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
1003
1004
1005
1006
1007
            # 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":
1008
                        message["content"] = system + message["content"]
Timothy J. Baek's avatar
Timothy J. Baek committed
1009
1010
1011
1012
1013
1014
                        break
                else:
                    payload["messages"].insert(
                        0,
                        {
                            "role": "system",
1015
                            "content": system,
Timothy J. Baek's avatar
Timothy J. Baek committed
1016
1017
1018
1019
1020
1021
1022
1023
1024
                        },
                    )

    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
1025
1026
1027
1028
1029
1030
        else:
            raise HTTPException(
                status_code=400,
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
            )

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

1034
1035
1036
1037
1038
    return await post_streaming_url(
        f"{url}/v1/chat/completions",
        json.dumps(payload),
        stream=payload.get("stream", False),
    )
1039
1040


1041
1042
1043
1044
1045
1046
1047
1048
1049
@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
1050
        if app.state.config.ENABLE_MODEL_FILTER:
1051
1052
1053
            if user.role == "user":
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
1054
1055
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
                        models["models"],
                    )
                )

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

    else:
1074
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
        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
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
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

1150
    async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
        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
1161

Timothy J. Baek's avatar
Timothy J. Baek committed
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
                    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."


# 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
fix  
Timothy J. Baek committed
1191
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
1192
1193
):

Timothy J. Baek's avatar
Timothy J. Baek committed
1194
1195
1196
1197
1198
1199
1200
1201
    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
1202
1203
    if url_idx == None:
        url_idx = 0
1204
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1205
1206
1207
1208
1209

    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
1210

Timothy J. Baek's avatar
Timothy J. Baek committed
1211
        return StreamingResponse(
Timothy J. Baek's avatar
Timothy J. Baek committed
1212
            download_file_stream(url, form_data.url, file_path, file_name),
Timothy J. Baek's avatar
Timothy J. Baek committed
1213
1214
1215
1216
1217
1218
1219
        )
    else:
        return None


@app.post("/models/upload")
@app.post("/models/upload/{url_idx}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
1220
1221
1222
1223
1224
def upload_model(
    file: UploadFile = File(...),
    url_idx: Optional[int] = None,
    user=Depends(get_admin_user),
):
Timothy J. Baek's avatar
Timothy J. Baek committed
1225
1226
    if url_idx == None:
        url_idx = 0
1227
    ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265

    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
1266
                    url = f"{ollama_url}/api/blobs/sha256:{hashed}"
Timothy J. Baek's avatar
Timothy J. Baek committed
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
                    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")