main.py 30 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
4
5
6
7
8
from fastapi import (
    FastAPI,
    Request,
    HTTPException,
    Depends,
    UploadFile,
    File,
)
9
10
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import StreamingResponse
Timothy J. Baek's avatar
Timothy J. Baek committed
11

Timothy J. Baek's avatar
Timothy J. Baek committed
12
from pydantic import BaseModel, ConfigDict
13

Timothy J. Baek's avatar
Timothy J. Baek committed
14
import os
15
import re
16
import random
Timothy J. Baek's avatar
Timothy J. Baek committed
17
18
import requests
import json
19
20
import aiohttp
import asyncio
21
import logging
22
import time
Timothy J. Baek's avatar
Timothy J. Baek committed
23
24
25
from urllib.parse import urlparse
from typing import Optional, List, Union

26
27
from starlette.background import BackgroundTask

28
from apps.webui.models.models import Models
29
from constants import ERROR_MESSAGES
30
31
32
33
from utils.utils import (
    get_verified_user,
    get_admin_user,
)
34
from utils.task import prompt_template
Timothy J. Baek's avatar
Timothy J. Baek committed
35

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

Timothy J. Baek's avatar
Timothy J. Baek committed
37
38
39
from config import (
    SRC_LOG_LEVELS,
    OLLAMA_BASE_URLS,
Timothy J. Baek's avatar
Timothy J. Baek committed
40
    ENABLE_OLLAMA_API,
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
41
    AIOHTTP_CLIENT_TIMEOUT,
Timothy J. Baek's avatar
Timothy J. Baek committed
42
    ENABLE_MODEL_FILTER,
Timothy J. Baek's avatar
Timothy J. Baek committed
43
44
    MODEL_FILTER_LIST,
    UPLOAD_DIR,
45
    AppConfig,
Timothy J. Baek's avatar
Timothy J. Baek committed
46
)
Michael Poluektov's avatar
Michael Poluektov committed
47
48
49
50
51
52
53
from utils.misc import (
    apply_model_params_to_body_ollama,
    calculate_sha256,
    add_or_update_system_message,
    apply_model_params_to_body_openai,
    apply_model_system_prompt_to_body,
)
54

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

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

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

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

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


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


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


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


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

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

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


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

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


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


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


153
async def post_streaming_url(url: str, payload: str, stream: bool = True):
154
155
    r = None
    try:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
156
157
158
        session = aiohttp.ClientSession(
            trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
        )
159
160
161
        r = await session.post(url, data=payload)
        r.raise_for_status()

162
163
164
165
166
167
168
169
170
171
172
173
174
175
        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

176
177
178
179
180
181
182
    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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
183
            except Exception:
184
185
186
187
188
189
190
191
                error_detail = f"Ollama: {e}"

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


192
193
194
195
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
196
197
198
199
200
201
202
203
        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)
204
205
206
207
208

    return list(merged_models.values())


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

    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
                )
222
            )
Timothy J. Baek's avatar
Timothy J. Baek committed
223
224
225
226
        }

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

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

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

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

            return r.json()
        except Exception as e:
262
            log.exception(e)
263
264
265
266
267
268
            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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
269
                except Exception:
270
271
272
273
274
275
276
277
278
279
280
                    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):
281
    if app.state.config.ENABLE_OLLAMA_API:
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
282
        if url_idx is None:
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
            # 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("."))
                    ),
                )
298

299
300
301
302
303
304
                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
305
        else:
306
            url = app.state.config.OLLAMA_BASE_URLS[url_idx]
307

308
309
310
311
312
313
314
315
316
317
318
319
320
321
            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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
322
                    except Exception:
323
324
325
326
327
328
329
330
                        error_detail = f"Ollama: {e}"

                raise HTTPException(
                    status_code=r.status_code if r else 500,
                    detail=error_detail,
                )
    else:
        return {"version": False}
331
332
333
334
335
336
337
338
339
340
341


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

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

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


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),
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
364
    if url_idx is None:
365
366
367
368
369
        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
370
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
371
372
            )

373
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
374
    log.debug(f"url: {url}")
375

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


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

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


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),
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
414
    if url_idx is None:
415
416
417
418
419
        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
420
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
421
422
            )

423
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
424
    log.info(f"url: {url}")
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
425
426
427
428
429
    r = requests.request(
        method="POST",
        url=f"{url}/api/copy",
        data=form_data.model_dump_json(exclude_none=True).encode(),
    )
430
431
432
433

    try:
        r.raise_for_status()

434
        log.debug(f"r.text: {r.text}")
435
436
437

        return True
    except Exception as e:
438
        log.exception(e)
439
440
441
442
443
444
        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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
445
            except Exception:
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
                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),
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
461
    if url_idx is None:
462
463
464
465
466
        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
467
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
468
469
            )

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

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
473
474
475
476
477
    r = requests.request(
        method="DELETE",
        url=f"{url}/api/delete",
        data=form_data.model_dump_json(exclude_none=True).encode(),
    )
478
479
480
    try:
        r.raise_for_status()

481
        log.debug(f"r.text: {r.text}")
482
483
484

        return True
    except Exception as e:
485
        log.exception(e)
486
487
488
489
490
491
        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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
492
            except Exception:
493
494
495
496
497
498
499
500
501
                error_detail = f"Ollama: {e}"

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


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

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

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
513
514
515
516
517
    r = requests.request(
        method="POST",
        url=f"{url}/api/show",
        data=form_data.model_dump_json(exclude_none=True).encode(),
    )
518
519
520
521
522
    try:
        r.raise_for_status()

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

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

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
570
571
572
573
574
    r = requests.request(
        method="POST",
        url=f"{url}/api/embeddings",
        data=form_data.model_dump_json(exclude_none=True).encode(),
    )
575
576
577
578
579
    try:
        r.raise_for_status()

        return r.json()
    except Exception as e:
580
        log.exception(e)
581
582
583
584
585
586
        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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
587
            except Exception:
588
589
590
591
592
593
594
595
                error_detail = f"Ollama: {e}"

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


596
597
598
599
def generate_ollama_embeddings(
    form_data: GenerateEmbeddingsForm,
    url_idx: Optional[int] = None,
):
600
    log.info(f"generate_ollama_embeddings {form_data}")
Timothy J. Baek's avatar
Timothy J. Baek committed
601

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
602
    if url_idx is None:
603
604
605
606
607
608
609
610
611
612
613
614
615
        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),
            )

616
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
617
618
    log.info(f"url: {url}")

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
619
620
621
622
623
    r = requests.request(
        method="POST",
        url=f"{url}/api/embeddings",
        data=form_data.model_dump_json(exclude_none=True).encode(),
    )
624
625
626
627
628
    try:
        r.raise_for_status()

        data = r.json()

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

631
632
633
        if "embedding" in data:
            return data["embedding"]
        else:
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
634
            raise Exception("Something went wrong :/")
635
636
637
638
639
640
641
642
    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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
643
            except Exception:
644
645
                error_detail = f"Ollama: {e}"

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
646
        raise Exception(error_detail)
647
648


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
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,
668
    user=Depends(get_verified_user),
669
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
670
    if url_idx is None:
Timothy J. Baek's avatar
Timothy J. Baek committed
671
672
673
674
675
676
        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
677
            url_idx = random.choice(app.state.MODELS[model]["urls"])
678
679
680
        else:
            raise HTTPException(
                status_code=400,
Timothy J. Baek's avatar
Timothy J. Baek committed
681
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
682
683
            )

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

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


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
704
    stream: Optional[bool] = None
705
706
707
    keep_alive: Optional[Union[int, str]] = None


Michael Poluektov's avatar
Michael Poluektov committed
708
709
710
711
712
713
714
715
716
717
718
719
def get_ollama_url(url_idx: Optional[int], model: str):
    if url_idx is None:
        if model not in app.state.MODELS:
            raise HTTPException(
                status_code=400,
                detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
            )
        url_idx = random.choice(app.state.MODELS[model]["urls"])
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
    return url


720
721
@app.post("/api/chat")
@app.post("/api/chat/{url_idx}")
Timothy J. Baek's avatar
Timothy J. Baek committed
722
async def generate_chat_completion(
723
724
    form_data: GenerateChatCompletionForm,
    url_idx: Optional[int] = None,
725
    user=Depends(get_verified_user),
726
):
Michael Poluektov's avatar
Michael Poluektov committed
727
    log.debug(f"{form_data.model_dump_json(exclude_none=True).encode()}=")
Timothy J. Baek's avatar
Timothy J. Baek committed
728
729

    payload = {
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
730
        **form_data.model_dump(exclude_none=True, exclude=["metadata"]),
Timothy J. Baek's avatar
Timothy J. Baek committed
731
    }
Michael Poluektov's avatar
Michael Poluektov committed
732
    payload.pop("metadata", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
733
734
735
736
737
738
739
740

    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

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
741
        params = model_info.params.model_dump()
Timothy J. Baek's avatar
Timothy J. Baek committed
742

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
743
        if params:
Timothy J. Baek's avatar
refac  
Timothy J. Baek committed
744
745
            if payload.get("options") is None:
                payload["options"] = {}
Timothy J. Baek's avatar
Timothy J. Baek committed
746

Michael Poluektov's avatar
Michael Poluektov committed
747
748
            payload["options"] = apply_model_params_to_body_ollama(
                params, payload["options"]
749
            )
Michael Poluektov's avatar
Michael Poluektov committed
750
            payload = apply_model_system_prompt_to_body(params, payload, user)
751

Michael Poluektov's avatar
Michael Poluektov committed
752
753
    if ":" not in payload["model"]:
        payload["model"] = f"{payload['model']}:latest"
754

Michael Poluektov's avatar
Michael Poluektov committed
755
    url = get_ollama_url(url_idx, payload["model"])
756
    log.info(f"url: {url}")
757
    log.debug(payload)
Timothy J. Baek's avatar
Timothy J. Baek committed
758

759
    return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
Timothy J. Baek's avatar
Timothy J. Baek committed
760
761
762


# TODO: we should update this part once Ollama supports other types
763
764
765
766
767
class OpenAIChatMessageContent(BaseModel):
    type: str
    model_config = ConfigDict(extra="allow")


Timothy J. Baek's avatar
Timothy J. Baek committed
768
769
class OpenAIChatMessage(BaseModel):
    role: str
770
    content: Union[str, OpenAIChatMessageContent]
Timothy J. Baek's avatar
Timothy J. Baek committed
771
772
773
774
775
776
777
778
779
780
781
782
783
784

    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
785
    form_data: dict,
Timothy J. Baek's avatar
Timothy J. Baek committed
786
    url_idx: Optional[int] = None,
787
    user=Depends(get_verified_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
788
):
Michael Poluektov's avatar
Michael Poluektov committed
789
790
    completion_form = OpenAIChatCompletionForm(**form_data)
    payload = {**completion_form.model_dump(exclude_none=True, exclude=["metadata"])}
Michael Poluektov's avatar
Michael Poluektov committed
791
    payload.pop("metadata", None)
Timothy J. Baek's avatar
Timothy J. Baek committed
792

Michael Poluektov's avatar
Michael Poluektov committed
793
    model_id = completion_form.model
Timothy J. Baek's avatar
Timothy J. Baek committed
794
    model_info = Models.get_model_by_id(model_id)
Timothy J. Baek's avatar
Timothy J. Baek committed
795

Timothy J. Baek's avatar
Timothy J. Baek committed
796
797
798
799
    if model_info:
        if model_info.base_model_id:
            payload["model"] = model_info.base_model_id

Michael Poluektov's avatar
Michael Poluektov committed
800
        params = model_info.params.model_dump()
Timothy J. Baek's avatar
Timothy J. Baek committed
801

Michael Poluektov's avatar
Michael Poluektov committed
802
803
804
        if params:
            payload = apply_model_params_to_body_openai(params, payload)
            payload = apply_model_system_prompt_to_body(params, payload, user)
Timothy J. Baek's avatar
Timothy J. Baek committed
805

Michael Poluektov's avatar
Michael Poluektov committed
806
807
    if ":" not in payload["model"]:
        payload["model"] = f"{payload['model']}:latest"
Timothy J. Baek's avatar
Timothy J. Baek committed
808

Michael Poluektov's avatar
Michael Poluektov committed
809
    url = get_ollama_url(url_idx, payload["model"])
810
    log.info(f"url: {url}")
Timothy J. Baek's avatar
Timothy J. Baek committed
811

812
813
814
815
816
    return await post_streaming_url(
        f"{url}/v1/chat/completions",
        json.dumps(payload),
        stream=payload.get("stream", False),
    )
817
818


819
820
821
822
823
824
@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),
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
825
    if url_idx is None:
826
827
        models = await get_all_models()

Timothy J. Baek's avatar
Timothy J. Baek committed
828
        if app.state.config.ENABLE_MODEL_FILTER:
829
830
831
            if user.role == "user":
                models["models"] = list(
                    filter(
Timothy J. Baek's avatar
Timothy J. Baek committed
832
833
                        lambda model: model["name"]
                        in app.state.config.MODEL_FILTER_LIST,
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
                        models["models"],
                    )
                )

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

    else:
852
        url = app.state.config.OLLAMA_BASE_URLS[url_idx]
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
        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']}"
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
880
                except Exception:
881
882
883
884
885
886
887
888
                    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
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
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
        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

927
    async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
Timothy J. Baek's avatar
Timothy J. Baek committed
928
929
930
931
932
933
934
935
936
937
        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
938

Timothy J. Baek's avatar
Timothy J. Baek committed
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
                    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
968
    user=Depends(get_admin_user),
Timothy J. Baek's avatar
Timothy J. Baek committed
969
):
Timothy J. Baek's avatar
Timothy J. Baek committed
970
971
972
973
974
975
976
977
    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.",
        )

Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
978
    if url_idx is None:
Timothy J. Baek's avatar
Timothy J. Baek committed
979
        url_idx = 0
980
    url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
981
982
983
984
985

    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
986

Timothy J. Baek's avatar
Timothy J. Baek committed
987
        return StreamingResponse(
Timothy J. Baek's avatar
Timothy J. Baek committed
988
            download_file_stream(url, form_data.url, file_path, file_name),
Timothy J. Baek's avatar
Timothy J. Baek committed
989
990
991
992
993
994
995
        )
    else:
        return None


@app.post("/models/upload")
@app.post("/models/upload/{url_idx}")
Timothy J. Baek's avatar
fix  
Timothy J. Baek committed
996
997
998
999
1000
def upload_model(
    file: UploadFile = File(...),
    url_idx: Optional[int] = None,
    user=Depends(get_admin_user),
):
Michael Poluektov's avatar
cleanup  
Michael Poluektov committed
1001
    if url_idx is None:
Timothy J. Baek's avatar
Timothy J. Baek committed
1002
        url_idx = 0
1003
    ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
Timothy J. Baek's avatar
Timothy J. Baek committed
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041

    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
1042
                    url = f"{ollama_url}/api/blobs/sha256:{hashed}"
Timothy J. Baek's avatar
Timothy J. Baek committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
                    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")