open-webui/backend/open_webui/apps/ollama/main.py

1121 lines
32 KiB
Python
Raw Normal View History

2024-03-05 08:59:35 +00:00
import asyncio
2024-08-27 22:10:27 +00:00
import json
import logging
2024-08-27 22:10:27 +00:00
import os
import random
import re
import time
2024-08-14 12:58:37 +00:00
from typing import Optional, Union
2024-08-27 22:10:27 +00:00
from urllib.parse import urlparse
2024-03-22 06:45:00 +00:00
2024-08-27 22:10:27 +00:00
import aiohttp
import requests
from open_webui.apps.webui.models.models import Models
from open_webui.config import (
2024-08-27 22:10:27 +00:00
CORS_ALLOW_ORIGIN,
ENABLE_MODEL_FILTER,
2024-08-27 22:10:27 +00:00
ENABLE_OLLAMA_API,
2024-03-31 08:13:39 +00:00
MODEL_FILTER_LIST,
2024-08-27 22:10:27 +00:00
OLLAMA_BASE_URLS,
2024-03-31 08:13:39 +00:00
UPLOAD_DIR,
AppConfig,
2024-03-31 08:13:39 +00:00
)
2024-09-30 14:32:38 +00:00
from open_webui.env import AIOHTTP_CLIENT_TIMEOUT
from open_webui.constants import ERROR_MESSAGES
from open_webui.env import SRC_LOG_LEVELS
2024-08-27 22:10:27 +00:00
from fastapi import Depends, FastAPI, File, HTTPException, Request, UploadFile
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import StreamingResponse
from pydantic import BaseModel, ConfigDict
from starlette.background import BackgroundTask
2024-09-07 02:09:57 +00:00
from open_webui.utils.misc import (
2024-09-07 02:09:57 +00:00
calculate_sha256,
)
from open_webui.utils.payload import (
2024-08-13 10:21:17 +00:00
apply_model_params_to_body_ollama,
2024-08-06 10:31:45 +00:00
apply_model_params_to_body_openai,
apply_model_system_prompt_to_body,
)
from open_webui.utils.utils import get_admin_user, get_verified_user
2024-03-05 08:59:35 +00:00
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
2024-03-05 08:59:35 +00:00
2024-01-04 21:06:31 +00:00
app = FastAPI()
app.add_middleware(
CORSMiddleware,
2024-08-18 21:17:26 +00:00
allow_origins=CORS_ALLOW_ORIGIN,
2024-01-04 21:06:31 +00:00
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
2023-11-15 00:28:51 +00:00
app.state.config = AppConfig()
2024-03-10 05:19:20 +00:00
2024-05-18 02:11:14 +00:00
app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
2024-05-22 06:58:42 +00:00
app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
2024-03-05 08:59:35 +00:00
app.state.MODELS = {}
2023-11-15 00:28:51 +00:00
2024-03-05 09:21:50 +00:00
# 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.
2024-03-05 08:59:35 +00:00
@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
2024-04-02 09:03:13 +00:00
@app.head("/")
@app.get("/")
async def get_status():
return {"status": True}
2024-05-22 06:58:42 +00:00
@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}
2024-03-05 08:59:35 +00:00
@app.get("/urls")
async def get_ollama_api_urls(user=Depends(get_admin_user)):
return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
2024-01-04 21:06:31 +00:00
2023-11-15 00:28:51 +00:00
2024-01-04 21:06:31 +00:00
class UrlUpdateForm(BaseModel):
2024-08-14 12:46:31 +00:00
urls: list[str]
2024-01-04 21:06:31 +00:00
2024-03-05 08:59:35 +00:00
@app.post("/urls/update")
2024-02-17 07:30:38 +00:00
async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
app.state.config.OLLAMA_BASE_URLS = form_data.urls
2024-03-05 08:59:35 +00:00
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}
2024-01-05 09:25:34 +00:00
2024-03-05 08:59:35 +00:00
async def fetch_url(url):
2024-09-30 14:32:38 +00:00
timeout = aiohttp.ClientTimeout(total=3)
2024-03-05 08:59:35 +00:00
try:
async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
2024-03-05 08:59:35 +00:00
async with session.get(url) as response:
return await response.json()
except Exception as e:
# Handle connection error here
log.error(f"Connection error: {e}")
2024-03-05 08:59:35 +00:00
return None
async def cleanup_response(
response: Optional[aiohttp.ClientResponse],
session: Optional[aiohttp.ClientSession],
):
if response:
response.close()
if session:
await session.close()
async def post_streaming_url(
url: str, payload: Union[str, bytes], stream: bool = True, content_type=None
):
r = None
try:
2024-06-14 07:10:52 +00:00
session = aiohttp.ClientSession(
trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
)
r = await session.post(
url,
data=payload,
headers={"Content-Type": "application/json"},
)
r.raise_for_status()
2024-06-30 08:30:19 +00:00
if stream:
headers = dict(r.headers)
if content_type:
headers["Content-Type"] = content_type
2024-06-30 08:30:19 +00:00
return StreamingResponse(
r.content,
status_code=r.status,
headers=headers,
2024-06-30 08:30:19 +00:00
background=BackgroundTask(
cleanup_response, response=r, session=session
),
)
else:
res = await r.json()
await cleanup_response(r, session)
return res
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status if r else 500,
detail=error_detail,
)
2024-03-05 08:59:35 +00:00
def merge_models_lists(model_lists):
merged_models = {}
for idx, model_list in enumerate(model_lists):
2024-03-18 08:11:48 +00:00
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)
2024-03-05 08:59:35 +00:00
return list(merged_models.values())
async def get_all_models():
log.info("get_all_models()")
2024-05-22 06:58:42 +00:00
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
)
)
2024-05-22 06:58:42 +00:00
}
else:
models = {"models": []}
2024-03-12 07:26:14 +00:00
2024-03-05 08:59:35 +00:00
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(
2024-05-04 08:31:08 +00:00
url_idx: Optional[int] = None, user=Depends(get_verified_user)
2024-03-05 08:59:35 +00:00
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-10 05:19:20 +00:00
models = await get_all_models()
2024-05-18 02:11:14 +00:00
if app.state.config.ENABLE_MODEL_FILTER:
2024-03-10 05:19:20 +00:00
if user.role == "user":
models["models"] = list(
filter(
2024-05-18 02:11:14 +00:00
lambda model: model["name"]
in app.state.config.MODEL_FILTER_LIST,
models["models"],
)
2024-03-10 05:19:20 +00:00
)
return models
return models
2024-03-05 08:59:35 +00:00
else:
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
2024-05-29 08:12:25 +00:00
r = None
2024-03-05 08:59:35 +00:00
try:
r = requests.request(method="GET", url=f"{url}/api/tags")
r.raise_for_status()
return r.json()
except Exception as e:
log.exception(e)
2024-03-05 08:59:35 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-03-05 08:59:35 +00:00
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status_code if r else 500,
detail=error_detail,
)
@app.get("/api/version")
@app.get("/api/version/{url_idx}")
async def get_ollama_versions(url_idx: Optional[int] = None):
if app.state.config.ENABLE_OLLAMA_API:
2024-08-06 09:15:29 +00:00
if url_idx is 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("."))
),
)
2024-03-05 08:59:35 +00:00
return {"version": lowest_version["version"]}
else:
raise HTTPException(
status_code=500,
detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
)
2024-03-12 07:26:14 +00:00
else:
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
2024-05-29 08:12:25 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status_code if r else 500,
detail=error_detail,
)
else:
return {"version": False}
2024-03-05 08:59:35 +00:00
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)
):
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 10:12:55 +00:00
2024-05-26 08:31:17 +00:00
# Admin should be able to pull models from any source
payload = {**form_data.model_dump(exclude_none=True), "insecure": True}
return await post_streaming_url(f"{url}/api/pull", json.dumps(payload))
2024-03-05 08:59:35 +00:00
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),
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-05 08:59:35 +00:00
if form_data.name in app.state.MODELS:
url_idx = app.state.MODELS[form_data.name]["urls"][0]
else:
raise HTTPException(
status_code=400,
2024-03-05 09:07:59 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
2024-03-05 08:59:35 +00:00
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.debug(f"url: {url}")
2024-03-05 08:59:35 +00:00
return await post_streaming_url(
f"{url}/api/push", form_data.model_dump_json(exclude_none=True).encode()
)
2024-03-05 08:59:35 +00:00
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)
):
log.debug(f"form_data: {form_data}")
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 10:19:25 +00:00
return await post_streaming_url(
f"{url}/api/create", form_data.model_dump_json(exclude_none=True).encode()
)
2024-03-05 08:59:35 +00:00
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),
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-05 08:59:35 +00:00
if form_data.source in app.state.MODELS:
url_idx = app.state.MODELS[form_data.source]["urls"][0]
else:
raise HTTPException(
status_code=400,
2024-03-05 09:07:59 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
2024-03-05 08:59:35 +00:00
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-08-06 09:50:22 +00:00
r = requests.request(
method="POST",
url=f"{url}/api/copy",
headers={"Content-Type": "application/json"},
2024-08-06 09:50:22 +00:00
data=form_data.model_dump_json(exclude_none=True).encode(),
)
2024-03-05 08:59:35 +00:00
try:
r.raise_for_status()
log.debug(f"r.text: {r.text}")
2024-03-05 08:59:35 +00:00
return True
except Exception as e:
log.exception(e)
2024-03-05 08:59:35 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-03-05 08:59:35 +00:00
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),
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-05 08:59:35 +00:00
if form_data.name in app.state.MODELS:
url_idx = app.state.MODELS[form_data.name]["urls"][0]
else:
raise HTTPException(
status_code=400,
2024-03-05 09:07:59 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
2024-03-05 08:59:35 +00:00
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 08:59:35 +00:00
2024-08-06 09:50:22 +00:00
r = requests.request(
method="DELETE",
url=f"{url}/api/delete",
headers={"Content-Type": "application/json"},
2024-08-06 09:50:22 +00:00
data=form_data.model_dump_json(exclude_none=True).encode(),
)
2024-03-05 08:59:35 +00:00
try:
r.raise_for_status()
log.debug(f"r.text: {r.text}")
2024-03-05 08:59:35 +00:00
return True
except Exception as e:
log.exception(e)
2024-03-05 08:59:35 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-03-05 08:59:35 +00:00
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status_code if r else 500,
detail=error_detail,
)
@app.post("/api/show")
2024-05-04 08:31:08 +00:00
async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
2024-03-05 08:59:35 +00:00
if form_data.name not in app.state.MODELS:
raise HTTPException(
status_code=400,
2024-03-05 09:07:59 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
2024-03-05 08:59:35 +00:00
)
url_idx = random.choice(app.state.MODELS[form_data.name]["urls"])
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 08:59:35 +00:00
2024-08-06 09:50:22 +00:00
r = requests.request(
method="POST",
url=f"{url}/api/show",
headers={"Content-Type": "application/json"},
2024-08-06 09:50:22 +00:00
data=form_data.model_dump_json(exclude_none=True).encode(),
)
2024-03-05 08:59:35 +00:00
try:
r.raise_for_status()
return r.json()
except Exception as e:
log.exception(e)
2024-03-05 08:59:35 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-03-05 08:59:35 +00:00
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
2024-09-25 20:34:02 +00:00
class GenerateEmbedForm(BaseModel):
model: str
2024-10-21 01:38:06 +00:00
input: list[str] | str
truncate: Optional[bool] = None
2024-09-25 20:34:02 +00:00
options: Optional[dict] = None
keep_alive: Optional[Union[int, str]] = None
2024-09-07 04:12:46 +00:00
@app.post("/api/embed")
@app.post("/api/embed/{url_idx}")
async def generate_embeddings(
2024-09-25 20:34:02 +00:00
form_data: GenerateEmbedForm,
url_idx: Optional[int] = None,
user=Depends(get_verified_user),
):
return generate_ollama_batch_embeddings(form_data, url_idx)
2024-03-05 08:59:35 +00:00
@app.post("/api/embeddings")
@app.post("/api/embeddings/{url_idx}")
async def generate_embeddings(
form_data: GenerateEmbeddingsForm,
url_idx: Optional[int] = None,
2024-05-04 08:31:08 +00:00
user=Depends(get_verified_user),
2024-03-05 08:59:35 +00:00
):
return generate_ollama_embeddings(form_data=form_data, url_idx=url_idx)
def generate_ollama_embeddings(
form_data: GenerateEmbeddingsForm,
url_idx: Optional[int] = None,
):
log.info(f"generate_ollama_embeddings {form_data}")
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-04-14 20:51:13 +00:00
model = form_data.model
if ":" not in model:
model = f"{model}:latest"
if model in app.state.MODELS:
2024-04-14 20:52:59 +00:00
url_idx = random.choice(app.state.MODELS[model]["urls"])
2024-03-05 08:59:35 +00:00
else:
raise HTTPException(
status_code=400,
2024-03-05 09:07:59 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
2024-03-05 08:59:35 +00:00
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 08:59:35 +00:00
2024-08-06 09:50:22 +00:00
r = requests.request(
method="POST",
url=f"{url}/api/embeddings",
headers={"Content-Type": "application/json"},
2024-08-06 09:50:22 +00:00
data=form_data.model_dump_json(exclude_none=True).encode(),
)
2024-03-05 08:59:35 +00:00
try:
r.raise_for_status()
data = r.json()
log.info(f"generate_ollama_embeddings {data}")
if "embedding" in data:
return data
else:
raise Exception("Something went wrong :/")
2024-03-05 08:59:35 +00:00
except Exception as e:
log.exception(e)
2024-03-05 08:59:35 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-03-05 08:59:35 +00:00
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status_code if r else 500,
detail=error_detail,
)
def generate_ollama_batch_embeddings(
form_data: GenerateEmbedForm,
2024-04-14 21:55:00 +00:00
url_idx: Optional[int] = None,
):
log.info(f"generate_ollama_batch_embeddings {form_data}")
2024-04-14 22:47:45 +00:00
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-04-14 21:55:00 +00:00
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),
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
2024-04-14 21:55:00 +00:00
log.info(f"url: {url}")
2024-08-06 09:50:22 +00:00
r = requests.request(
method="POST",
url=f"{url}/api/embed",
headers={"Content-Type": "application/json"},
2024-08-06 09:50:22 +00:00
data=form_data.model_dump_json(exclude_none=True).encode(),
)
2024-04-14 21:55:00 +00:00
try:
r.raise_for_status()
data = r.json()
log.info(f"generate_ollama_batch_embeddings {data}")
2024-04-14 22:47:45 +00:00
if "embeddings" in data:
return data
2024-04-14 21:55:00 +00:00
else:
2024-08-06 09:15:29 +00:00
raise Exception("Something went wrong :/")
2024-04-14 21:55:00 +00:00
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
2024-04-14 21:55:00 +00:00
error_detail = f"Ollama: {e}"
2024-08-06 09:15:29 +00:00
raise Exception(error_detail)
2024-04-14 21:55:00 +00:00
2024-03-05 08:59:35 +00:00
class GenerateCompletionForm(BaseModel):
model: str
prompt: str
2024-08-14 12:46:31 +00:00
images: Optional[list[str]] = None
2024-03-05 08:59:35 +00:00
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,
2024-05-04 08:31:08 +00:00
user=Depends(get_verified_user),
2024-03-05 08:59:35 +00:00
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-04-14 20:51:13 +00:00
model = form_data.model
if ":" not in model:
model = f"{model}:latest"
if model in app.state.MODELS:
2024-04-14 20:52:59 +00:00
url_idx = random.choice(app.state.MODELS[model]["urls"])
2024-03-05 08:59:35 +00:00
else:
raise HTTPException(
status_code=400,
2024-03-31 20:40:57 +00:00
detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
2024-03-05 08:59:35 +00:00
)
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
log.info(f"url: {url}")
2024-03-05 08:59:35 +00:00
return await post_streaming_url(
f"{url}/api/generate", form_data.model_dump_json(exclude_none=True).encode()
)
2024-03-05 08:59:35 +00:00
class ChatMessage(BaseModel):
role: str
content: str
2024-08-14 12:46:31 +00:00
images: Optional[list[str]] = None
2024-03-05 08:59:35 +00:00
class GenerateChatCompletionForm(BaseModel):
model: str
2024-08-14 12:46:31 +00:00
messages: list[ChatMessage]
2024-03-05 08:59:35 +00:00
format: Optional[str] = None
options: Optional[dict] = None
template: Optional[str] = None
2024-03-19 01:14:05 +00:00
stream: Optional[bool] = None
2024-03-05 08:59:35 +00:00
keep_alive: Optional[Union[int, str]] = None
2024-08-06 10:31:45 +00:00
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
2024-03-05 08:59:35 +00:00
@app.post("/api/chat")
@app.post("/api/chat/{url_idx}")
2024-03-05 09:41:22 +00:00
async def generate_chat_completion(
2024-03-05 08:59:35 +00:00
form_data: GenerateChatCompletionForm,
url_idx: Optional[int] = None,
2024-05-04 08:31:08 +00:00
user=Depends(get_verified_user),
2024-03-05 08:59:35 +00:00
):
2024-08-19 10:03:55 +00:00
payload = {**form_data.model_dump(exclude_none=True)}
log.debug(f"generate_chat_completion() - 1.payload = {payload}")
2024-08-20 14:41:49 +00:00
if "metadata" in payload:
del payload["metadata"]
2024-05-25 09:05:05 +00:00
model_id = form_data.model
2024-08-26 12:24:56 +00:00
if app.state.config.ENABLE_MODEL_FILTER:
if user.role == "user" and model_id not in app.state.config.MODEL_FILTER_LIST:
raise HTTPException(
status_code=403,
detail="Model not found",
)
2024-05-25 09:05:05 +00:00
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
2024-08-06 09:50:22 +00:00
params = model_info.params.model_dump()
2024-05-25 09:05:05 +00:00
2024-08-06 09:50:22 +00:00
if params:
2024-07-17 08:16:27 +00:00
if payload.get("options") is None:
payload["options"] = {}
2024-05-25 09:05:05 +00:00
2024-08-06 10:31:45 +00:00
payload["options"] = apply_model_params_to_body_ollama(
params, payload["options"]
)
2024-08-06 10:31:45 +00:00
payload = apply_model_system_prompt_to_body(params, payload, user)
2024-08-06 10:31:45 +00:00
if ":" not in payload["model"]:
payload["model"] = f"{payload['model']}:latest"
2024-03-05 08:59:35 +00:00
2024-08-06 10:31:45 +00:00
url = get_ollama_url(url_idx, payload["model"])
log.info(f"url: {url}")
log.debug(f"generate_chat_completion() - 2.payload = {payload}")
2024-05-25 05:21:57 +00:00
return await post_streaming_url(
2024-09-19 14:54:34 +00:00
f"{url}/api/chat",
json.dumps(payload),
stream=form_data.stream,
content_type="application/x-ndjson",
)
2024-03-05 09:41:22 +00:00
# TODO: we should update this part once Ollama supports other types
class OpenAIChatMessageContent(BaseModel):
type: str
model_config = ConfigDict(extra="allow")
2024-03-05 09:41:22 +00:00
class OpenAIChatMessage(BaseModel):
role: str
content: Union[str, OpenAIChatMessageContent]
2024-03-05 09:41:22 +00:00
model_config = ConfigDict(extra="allow")
class OpenAIChatCompletionForm(BaseModel):
model: str
2024-08-14 12:46:31 +00:00
messages: list[OpenAIChatMessage]
2024-03-05 09:41:22 +00:00
model_config = ConfigDict(extra="allow")
@app.post("/v1/chat/completions")
@app.post("/v1/chat/completions/{url_idx}")
async def generate_openai_chat_completion(
2024-06-18 17:26:53 +00:00
form_data: dict,
2024-03-05 09:41:22 +00:00
url_idx: Optional[int] = None,
2024-05-04 08:31:08 +00:00
user=Depends(get_verified_user),
2024-03-05 09:41:22 +00:00
):
2024-08-06 10:31:45 +00:00
completion_form = OpenAIChatCompletionForm(**form_data)
payload = {**completion_form.model_dump(exclude_none=True, exclude=["metadata"])}
2024-08-08 11:30:07 +00:00
if "metadata" in payload:
del payload["metadata"]
2024-03-05 09:41:22 +00:00
2024-08-06 10:31:45 +00:00
model_id = completion_form.model
2024-08-26 12:24:56 +00:00
if app.state.config.ENABLE_MODEL_FILTER:
if user.role == "user" and model_id not in app.state.config.MODEL_FILTER_LIST:
raise HTTPException(
status_code=403,
detail="Model not found",
)
2024-05-25 09:05:05 +00:00
model_info = Models.get_model_by_id(model_id)
2024-04-14 20:51:13 +00:00
2024-05-25 09:05:05 +00:00
if model_info:
if model_info.base_model_id:
payload["model"] = model_info.base_model_id
2024-08-06 10:31:45 +00:00
params = model_info.params.model_dump()
2024-05-25 09:05:05 +00:00
2024-08-06 10:31:45 +00:00
if params:
payload = apply_model_params_to_body_openai(params, payload)
payload = apply_model_system_prompt_to_body(params, payload, user)
2024-05-25 09:05:05 +00:00
2024-08-06 10:31:45 +00:00
if ":" not in payload["model"]:
payload["model"] = f"{payload['model']}:latest"
2024-03-05 09:41:22 +00:00
2024-08-06 10:31:45 +00:00
url = get_ollama_url(url_idx, payload["model"])
log.info(f"url: {url}")
2024-03-05 09:41:22 +00:00
2024-06-30 08:30:19 +00:00
return await post_streaming_url(
f"{url}/v1/chat/completions",
json.dumps(payload),
stream=payload.get("stream", False),
)
2024-03-05 08:59:35 +00:00
@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),
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
models = await get_all_models()
2024-05-18 02:11:14 +00:00
if app.state.config.ENABLE_MODEL_FILTER:
if user.role == "user":
models["models"] = list(
filter(
2024-05-18 02:11:14 +00:00
lambda model: model["name"]
in app.state.config.MODEL_FILTER_LIST,
models["models"],
)
)
return {
"data": [
{
"id": model["model"],
"object": "model",
"created": int(time.time()),
"owned_by": "openai",
}
for model in models["models"]
],
"object": "list",
}
else:
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
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']}"
2024-08-06 09:15:29 +00:00
except Exception:
error_detail = f"Ollama: {e}"
raise HTTPException(
status_code=r.status_code if r else 500,
detail=error_detail,
)
2024-03-22 06:45:00 +00:00
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
async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
2024-03-22 06:45:00 +00:00
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)
2024-03-22 07:10:55 +00:00
2024-03-22 06:45:00 +00:00
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,
2024-06-17 06:36:21 +00:00
user=Depends(get_admin_user),
2024-03-22 06:45:00 +00:00
):
2024-04-01 21:01:05 +00:00
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.",
)
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-22 06:45:00 +00:00
url_idx = 0
url = app.state.config.OLLAMA_BASE_URLS[url_idx]
2024-03-22 06:45:00 +00:00
file_name = parse_huggingface_url(form_data.url)
if file_name:
file_path = f"{UPLOAD_DIR}/{file_name}"
2024-04-01 21:01:05 +00:00
2024-03-22 06:45:00 +00:00
return StreamingResponse(
2024-03-22 07:10:55 +00:00
download_file_stream(url, form_data.url, file_path, file_name),
2024-03-22 06:45:00 +00:00
)
else:
return None
@app.post("/models/upload")
@app.post("/models/upload/{url_idx}")
2024-06-17 06:36:21 +00:00
def upload_model(
file: UploadFile = File(...),
url_idx: Optional[int] = None,
user=Depends(get_admin_user),
):
2024-08-06 09:15:29 +00:00
if url_idx is None:
2024-03-22 06:45:00 +00:00
url_idx = 0
ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
2024-03-22 06:45:00 +00:00
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)
2024-03-22 07:58:38 +00:00
url = f"{ollama_url}/api/blobs/sha256:{hashed}"
2024-03-22 06:45:00 +00:00
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")