main.py 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195
  1. from fastapi import (
  2. FastAPI,
  3. Request,
  4. Response,
  5. HTTPException,
  6. Depends,
  7. status,
  8. UploadFile,
  9. File,
  10. BackgroundTasks,
  11. )
  12. from fastapi.middleware.cors import CORSMiddleware
  13. from fastapi.responses import StreamingResponse
  14. from fastapi.concurrency import run_in_threadpool
  15. from pydantic import BaseModel, ConfigDict
  16. import os
  17. import re
  18. import copy
  19. import random
  20. import requests
  21. import json
  22. import uuid
  23. import aiohttp
  24. import asyncio
  25. import logging
  26. import time
  27. from urllib.parse import urlparse
  28. from typing import Optional, List, Union
  29. from starlette.background import BackgroundTask
  30. from apps.webui.models.models import Models
  31. from apps.webui.models.users import Users
  32. from constants import ERROR_MESSAGES
  33. from utils.utils import (
  34. decode_token,
  35. get_current_user,
  36. get_verified_user,
  37. get_admin_user,
  38. )
  39. from config import (
  40. SRC_LOG_LEVELS,
  41. OLLAMA_BASE_URLS,
  42. ENABLE_OLLAMA_API,
  43. AIOHTTP_CLIENT_TIMEOUT,
  44. ENABLE_MODEL_FILTER,
  45. MODEL_FILTER_LIST,
  46. UPLOAD_DIR,
  47. AppConfig,
  48. )
  49. from utils.misc import calculate_sha256
  50. log = logging.getLogger(__name__)
  51. log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
  52. app = FastAPI()
  53. app.add_middleware(
  54. CORSMiddleware,
  55. allow_origins=["*"],
  56. allow_credentials=True,
  57. allow_methods=["*"],
  58. allow_headers=["*"],
  59. )
  60. app.state.config = AppConfig()
  61. app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
  62. app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
  63. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  64. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  65. app.state.MODELS = {}
  66. # TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
  67. # Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
  68. # least connections, or least response time for better resource utilization and performance optimization.
  69. @app.middleware("http")
  70. async def check_url(request: Request, call_next):
  71. if len(app.state.MODELS) == 0:
  72. await get_all_models()
  73. else:
  74. pass
  75. response = await call_next(request)
  76. return response
  77. @app.head("/")
  78. @app.get("/")
  79. async def get_status():
  80. return {"status": True}
  81. @app.get("/config")
  82. async def get_config(user=Depends(get_admin_user)):
  83. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  84. class OllamaConfigForm(BaseModel):
  85. enable_ollama_api: Optional[bool] = None
  86. @app.post("/config/update")
  87. async def update_config(form_data: OllamaConfigForm, user=Depends(get_admin_user)):
  88. app.state.config.ENABLE_OLLAMA_API = form_data.enable_ollama_api
  89. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  90. @app.get("/urls")
  91. async def get_ollama_api_urls(user=Depends(get_admin_user)):
  92. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  93. class UrlUpdateForm(BaseModel):
  94. urls: List[str]
  95. @app.post("/urls/update")
  96. async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
  97. app.state.config.OLLAMA_BASE_URLS = form_data.urls
  98. log.info(f"app.state.config.OLLAMA_BASE_URLS: {app.state.config.OLLAMA_BASE_URLS}")
  99. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  100. async def fetch_url(url):
  101. timeout = aiohttp.ClientTimeout(total=5)
  102. try:
  103. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  104. async with session.get(url) as response:
  105. return await response.json()
  106. except Exception as e:
  107. # Handle connection error here
  108. log.error(f"Connection error: {e}")
  109. return None
  110. async def cleanup_response(
  111. response: Optional[aiohttp.ClientResponse],
  112. session: Optional[aiohttp.ClientSession],
  113. ):
  114. if response:
  115. response.close()
  116. if session:
  117. await session.close()
  118. async def post_streaming_url(url: str, payload: str):
  119. r = None
  120. try:
  121. session = aiohttp.ClientSession(
  122. trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
  123. )
  124. r = await session.post(url, data=payload)
  125. r.raise_for_status()
  126. return StreamingResponse(
  127. r.content,
  128. status_code=r.status,
  129. headers=dict(r.headers),
  130. background=BackgroundTask(cleanup_response, response=r, session=session),
  131. )
  132. except Exception as e:
  133. error_detail = "Open WebUI: Server Connection Error"
  134. if r is not None:
  135. try:
  136. res = await r.json()
  137. if "error" in res:
  138. error_detail = f"Ollama: {res['error']}"
  139. except:
  140. error_detail = f"Ollama: {e}"
  141. raise HTTPException(
  142. status_code=r.status if r else 500,
  143. detail=error_detail,
  144. )
  145. def merge_models_lists(model_lists):
  146. merged_models = {}
  147. for idx, model_list in enumerate(model_lists):
  148. if model_list is not None:
  149. for model in model_list:
  150. digest = model["digest"]
  151. if digest not in merged_models:
  152. model["urls"] = [idx]
  153. merged_models[digest] = model
  154. else:
  155. merged_models[digest]["urls"].append(idx)
  156. return list(merged_models.values())
  157. async def get_all_models():
  158. log.info("get_all_models()")
  159. if app.state.config.ENABLE_OLLAMA_API:
  160. tasks = [
  161. fetch_url(f"{url}/api/tags") for url in app.state.config.OLLAMA_BASE_URLS
  162. ]
  163. responses = await asyncio.gather(*tasks)
  164. models = {
  165. "models": merge_models_lists(
  166. map(
  167. lambda response: response["models"] if response else None, responses
  168. )
  169. )
  170. }
  171. else:
  172. models = {"models": []}
  173. app.state.MODELS = {model["model"]: model for model in models["models"]}
  174. return models
  175. @app.get("/api/tags")
  176. @app.get("/api/tags/{url_idx}")
  177. async def get_ollama_tags(
  178. url_idx: Optional[int] = None, user=Depends(get_verified_user)
  179. ):
  180. if url_idx == None:
  181. models = await get_all_models()
  182. if app.state.config.ENABLE_MODEL_FILTER:
  183. if user.role == "user":
  184. models["models"] = list(
  185. filter(
  186. lambda model: model["name"]
  187. in app.state.config.MODEL_FILTER_LIST,
  188. models["models"],
  189. )
  190. )
  191. return models
  192. return models
  193. else:
  194. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  195. r = None
  196. try:
  197. r = requests.request(method="GET", url=f"{url}/api/tags")
  198. r.raise_for_status()
  199. return r.json()
  200. except Exception as e:
  201. log.exception(e)
  202. error_detail = "Open WebUI: Server Connection Error"
  203. if r is not None:
  204. try:
  205. res = r.json()
  206. if "error" in res:
  207. error_detail = f"Ollama: {res['error']}"
  208. except:
  209. error_detail = f"Ollama: {e}"
  210. raise HTTPException(
  211. status_code=r.status_code if r else 500,
  212. detail=error_detail,
  213. )
  214. @app.get("/api/version")
  215. @app.get("/api/version/{url_idx}")
  216. async def get_ollama_versions(url_idx: Optional[int] = None):
  217. if app.state.config.ENABLE_OLLAMA_API:
  218. if url_idx == None:
  219. # returns lowest version
  220. tasks = [
  221. fetch_url(f"{url}/api/version")
  222. for url in app.state.config.OLLAMA_BASE_URLS
  223. ]
  224. responses = await asyncio.gather(*tasks)
  225. responses = list(filter(lambda x: x is not None, responses))
  226. if len(responses) > 0:
  227. lowest_version = min(
  228. responses,
  229. key=lambda x: tuple(
  230. map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
  231. ),
  232. )
  233. return {"version": lowest_version["version"]}
  234. else:
  235. raise HTTPException(
  236. status_code=500,
  237. detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
  238. )
  239. else:
  240. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  241. r = None
  242. try:
  243. r = requests.request(method="GET", url=f"{url}/api/version")
  244. r.raise_for_status()
  245. return r.json()
  246. except Exception as e:
  247. log.exception(e)
  248. error_detail = "Open WebUI: Server Connection Error"
  249. if r is not None:
  250. try:
  251. res = r.json()
  252. if "error" in res:
  253. error_detail = f"Ollama: {res['error']}"
  254. except:
  255. error_detail = f"Ollama: {e}"
  256. raise HTTPException(
  257. status_code=r.status_code if r else 500,
  258. detail=error_detail,
  259. )
  260. else:
  261. return {"version": False}
  262. class ModelNameForm(BaseModel):
  263. name: str
  264. @app.post("/api/pull")
  265. @app.post("/api/pull/{url_idx}")
  266. async def pull_model(
  267. form_data: ModelNameForm, url_idx: int = 0, user=Depends(get_admin_user)
  268. ):
  269. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  270. log.info(f"url: {url}")
  271. r = None
  272. # Admin should be able to pull models from any source
  273. payload = {**form_data.model_dump(exclude_none=True), "insecure": True}
  274. return await post_streaming_url(f"{url}/api/pull", json.dumps(payload))
  275. class PushModelForm(BaseModel):
  276. name: str
  277. insecure: Optional[bool] = None
  278. stream: Optional[bool] = None
  279. @app.delete("/api/push")
  280. @app.delete("/api/push/{url_idx}")
  281. async def push_model(
  282. form_data: PushModelForm,
  283. url_idx: Optional[int] = None,
  284. user=Depends(get_admin_user),
  285. ):
  286. if url_idx == None:
  287. if form_data.name in app.state.MODELS:
  288. url_idx = app.state.MODELS[form_data.name]["urls"][0]
  289. else:
  290. raise HTTPException(
  291. status_code=400,
  292. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  293. )
  294. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  295. log.debug(f"url: {url}")
  296. return await post_streaming_url(
  297. f"{url}/api/push", form_data.model_dump_json(exclude_none=True).encode()
  298. )
  299. class CreateModelForm(BaseModel):
  300. name: str
  301. modelfile: Optional[str] = None
  302. stream: Optional[bool] = None
  303. path: Optional[str] = None
  304. @app.post("/api/create")
  305. @app.post("/api/create/{url_idx}")
  306. async def create_model(
  307. form_data: CreateModelForm, url_idx: int = 0, user=Depends(get_admin_user)
  308. ):
  309. log.debug(f"form_data: {form_data}")
  310. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  311. log.info(f"url: {url}")
  312. return await post_streaming_url(
  313. f"{url}/api/create", form_data.model_dump_json(exclude_none=True).encode()
  314. )
  315. class CopyModelForm(BaseModel):
  316. source: str
  317. destination: str
  318. @app.post("/api/copy")
  319. @app.post("/api/copy/{url_idx}")
  320. async def copy_model(
  321. form_data: CopyModelForm,
  322. url_idx: Optional[int] = None,
  323. user=Depends(get_admin_user),
  324. ):
  325. if url_idx == None:
  326. if form_data.source in app.state.MODELS:
  327. url_idx = app.state.MODELS[form_data.source]["urls"][0]
  328. else:
  329. raise HTTPException(
  330. status_code=400,
  331. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
  332. )
  333. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  334. log.info(f"url: {url}")
  335. try:
  336. r = requests.request(
  337. method="POST",
  338. url=f"{url}/api/copy",
  339. data=form_data.model_dump_json(exclude_none=True).encode(),
  340. )
  341. r.raise_for_status()
  342. log.debug(f"r.text: {r.text}")
  343. return True
  344. except Exception as e:
  345. log.exception(e)
  346. error_detail = "Open WebUI: Server Connection Error"
  347. if r is not None:
  348. try:
  349. res = r.json()
  350. if "error" in res:
  351. error_detail = f"Ollama: {res['error']}"
  352. except:
  353. error_detail = f"Ollama: {e}"
  354. raise HTTPException(
  355. status_code=r.status_code if r else 500,
  356. detail=error_detail,
  357. )
  358. @app.delete("/api/delete")
  359. @app.delete("/api/delete/{url_idx}")
  360. async def delete_model(
  361. form_data: ModelNameForm,
  362. url_idx: Optional[int] = None,
  363. user=Depends(get_admin_user),
  364. ):
  365. if url_idx == None:
  366. if form_data.name in app.state.MODELS:
  367. url_idx = app.state.MODELS[form_data.name]["urls"][0]
  368. else:
  369. raise HTTPException(
  370. status_code=400,
  371. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  372. )
  373. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  374. log.info(f"url: {url}")
  375. try:
  376. r = requests.request(
  377. method="DELETE",
  378. url=f"{url}/api/delete",
  379. data=form_data.model_dump_json(exclude_none=True).encode(),
  380. )
  381. r.raise_for_status()
  382. log.debug(f"r.text: {r.text}")
  383. return True
  384. except Exception as e:
  385. log.exception(e)
  386. error_detail = "Open WebUI: Server Connection Error"
  387. if r is not None:
  388. try:
  389. res = r.json()
  390. if "error" in res:
  391. error_detail = f"Ollama: {res['error']}"
  392. except:
  393. error_detail = f"Ollama: {e}"
  394. raise HTTPException(
  395. status_code=r.status_code if r else 500,
  396. detail=error_detail,
  397. )
  398. @app.post("/api/show")
  399. async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
  400. if form_data.name not in app.state.MODELS:
  401. raise HTTPException(
  402. status_code=400,
  403. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  404. )
  405. url_idx = random.choice(app.state.MODELS[form_data.name]["urls"])
  406. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  407. log.info(f"url: {url}")
  408. try:
  409. r = requests.request(
  410. method="POST",
  411. url=f"{url}/api/show",
  412. data=form_data.model_dump_json(exclude_none=True).encode(),
  413. )
  414. r.raise_for_status()
  415. return r.json()
  416. except Exception as e:
  417. log.exception(e)
  418. error_detail = "Open WebUI: Server Connection Error"
  419. if r is not None:
  420. try:
  421. res = r.json()
  422. if "error" in res:
  423. error_detail = f"Ollama: {res['error']}"
  424. except:
  425. error_detail = f"Ollama: {e}"
  426. raise HTTPException(
  427. status_code=r.status_code if r else 500,
  428. detail=error_detail,
  429. )
  430. class GenerateEmbeddingsForm(BaseModel):
  431. model: str
  432. prompt: str
  433. options: Optional[dict] = None
  434. keep_alive: Optional[Union[int, str]] = None
  435. @app.post("/api/embeddings")
  436. @app.post("/api/embeddings/{url_idx}")
  437. async def generate_embeddings(
  438. form_data: GenerateEmbeddingsForm,
  439. url_idx: Optional[int] = None,
  440. user=Depends(get_verified_user),
  441. ):
  442. if url_idx == None:
  443. model = form_data.model
  444. if ":" not in model:
  445. model = f"{model}:latest"
  446. if model in app.state.MODELS:
  447. url_idx = random.choice(app.state.MODELS[model]["urls"])
  448. else:
  449. raise HTTPException(
  450. status_code=400,
  451. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  452. )
  453. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  454. log.info(f"url: {url}")
  455. try:
  456. r = requests.request(
  457. method="POST",
  458. url=f"{url}/api/embeddings",
  459. data=form_data.model_dump_json(exclude_none=True).encode(),
  460. )
  461. r.raise_for_status()
  462. return r.json()
  463. except Exception as e:
  464. log.exception(e)
  465. error_detail = "Open WebUI: Server Connection Error"
  466. if r is not None:
  467. try:
  468. res = r.json()
  469. if "error" in res:
  470. error_detail = f"Ollama: {res['error']}"
  471. except:
  472. error_detail = f"Ollama: {e}"
  473. raise HTTPException(
  474. status_code=r.status_code if r else 500,
  475. detail=error_detail,
  476. )
  477. def generate_ollama_embeddings(
  478. form_data: GenerateEmbeddingsForm,
  479. url_idx: Optional[int] = None,
  480. ):
  481. log.info(f"generate_ollama_embeddings {form_data}")
  482. if url_idx == None:
  483. model = form_data.model
  484. if ":" not in model:
  485. model = f"{model}:latest"
  486. if model in app.state.MODELS:
  487. url_idx = random.choice(app.state.MODELS[model]["urls"])
  488. else:
  489. raise HTTPException(
  490. status_code=400,
  491. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  492. )
  493. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  494. log.info(f"url: {url}")
  495. try:
  496. r = requests.request(
  497. method="POST",
  498. url=f"{url}/api/embeddings",
  499. data=form_data.model_dump_json(exclude_none=True).encode(),
  500. )
  501. r.raise_for_status()
  502. data = r.json()
  503. log.info(f"generate_ollama_embeddings {data}")
  504. if "embedding" in data:
  505. return data["embedding"]
  506. else:
  507. raise "Something went wrong :/"
  508. except Exception as e:
  509. log.exception(e)
  510. error_detail = "Open WebUI: Server Connection Error"
  511. if r is not None:
  512. try:
  513. res = r.json()
  514. if "error" in res:
  515. error_detail = f"Ollama: {res['error']}"
  516. except:
  517. error_detail = f"Ollama: {e}"
  518. raise error_detail
  519. class GenerateCompletionForm(BaseModel):
  520. model: str
  521. prompt: str
  522. images: Optional[List[str]] = None
  523. format: Optional[str] = None
  524. options: Optional[dict] = None
  525. system: Optional[str] = None
  526. template: Optional[str] = None
  527. context: Optional[str] = None
  528. stream: Optional[bool] = True
  529. raw: Optional[bool] = None
  530. keep_alive: Optional[Union[int, str]] = None
  531. @app.post("/api/generate")
  532. @app.post("/api/generate/{url_idx}")
  533. async def generate_completion(
  534. form_data: GenerateCompletionForm,
  535. url_idx: Optional[int] = None,
  536. user=Depends(get_verified_user),
  537. ):
  538. if url_idx == None:
  539. model = form_data.model
  540. if ":" not in model:
  541. model = f"{model}:latest"
  542. if model in app.state.MODELS:
  543. url_idx = random.choice(app.state.MODELS[model]["urls"])
  544. else:
  545. raise HTTPException(
  546. status_code=400,
  547. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  548. )
  549. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  550. log.info(f"url: {url}")
  551. return await post_streaming_url(
  552. f"{url}/api/generate", form_data.model_dump_json(exclude_none=True).encode()
  553. )
  554. class ChatMessage(BaseModel):
  555. role: str
  556. content: str
  557. images: Optional[List[str]] = None
  558. class GenerateChatCompletionForm(BaseModel):
  559. model: str
  560. messages: List[ChatMessage]
  561. format: Optional[str] = None
  562. options: Optional[dict] = None
  563. template: Optional[str] = None
  564. stream: Optional[bool] = None
  565. keep_alive: Optional[Union[int, str]] = None
  566. @app.post("/api/chat")
  567. @app.post("/api/chat/{url_idx}")
  568. async def generate_chat_completion(
  569. form_data: GenerateChatCompletionForm,
  570. url_idx: Optional[int] = None,
  571. user=Depends(get_verified_user),
  572. ):
  573. log.debug(
  574. "form_data.model_dump_json(exclude_none=True).encode(): {0} ".format(
  575. form_data.model_dump_json(exclude_none=True).encode()
  576. )
  577. )
  578. payload = {
  579. **form_data.model_dump(exclude_none=True),
  580. }
  581. model_id = form_data.model
  582. model_info = Models.get_model_by_id(model_id)
  583. if model_info:
  584. if model_info.base_model_id:
  585. payload["model"] = model_info.base_model_id
  586. model_info.params = model_info.params.model_dump()
  587. if model_info.params:
  588. payload["options"] = {}
  589. if model_info.params.get("mirostat", None):
  590. payload["options"]["mirostat"] = model_info.params.get("mirostat", None)
  591. if model_info.params.get("mirostat_eta", None):
  592. payload["options"]["mirostat_eta"] = model_info.params.get(
  593. "mirostat_eta", None
  594. )
  595. if model_info.params.get("mirostat_tau", None):
  596. payload["options"]["mirostat_tau"] = model_info.params.get(
  597. "mirostat_tau", None
  598. )
  599. if model_info.params.get("num_ctx", None):
  600. payload["options"]["num_ctx"] = model_info.params.get("num_ctx", None)
  601. if model_info.params.get("num_batch", None):
  602. payload["options"]["num_batch"] = model_info.params.get(
  603. "num_batch", None
  604. )
  605. if model_info.params.get("num_keep", None):
  606. payload["options"]["num_keep"] = model_info.params.get("num_keep", None)
  607. if model_info.params.get("repeat_last_n", None):
  608. payload["options"]["repeat_last_n"] = model_info.params.get(
  609. "repeat_last_n", None
  610. )
  611. if model_info.params.get("frequency_penalty", None):
  612. payload["options"]["repeat_penalty"] = model_info.params.get(
  613. "frequency_penalty", None
  614. )
  615. if model_info.params.get("temperature", None) is not None:
  616. payload["options"]["temperature"] = model_info.params.get(
  617. "temperature", None
  618. )
  619. if model_info.params.get("seed", None):
  620. payload["options"]["seed"] = model_info.params.get("seed", None)
  621. if model_info.params.get("stop", None):
  622. payload["options"]["stop"] = (
  623. [
  624. bytes(stop, "utf-8").decode("unicode_escape")
  625. for stop in model_info.params["stop"]
  626. ]
  627. if model_info.params.get("stop", None)
  628. else None
  629. )
  630. if model_info.params.get("tfs_z", None):
  631. payload["options"]["tfs_z"] = model_info.params.get("tfs_z", None)
  632. if model_info.params.get("max_tokens", None):
  633. payload["options"]["num_predict"] = model_info.params.get(
  634. "max_tokens", None
  635. )
  636. if model_info.params.get("top_k", None):
  637. payload["options"]["top_k"] = model_info.params.get("top_k", None)
  638. if model_info.params.get("top_p", None):
  639. payload["options"]["top_p"] = model_info.params.get("top_p", None)
  640. if model_info.params.get("use_mmap", None):
  641. payload["options"]["use_mmap"] = model_info.params.get("use_mmap", None)
  642. if model_info.params.get("use_mlock", None):
  643. payload["options"]["use_mlock"] = model_info.params.get(
  644. "use_mlock", None
  645. )
  646. if model_info.params.get("num_thread", None):
  647. payload["options"]["num_thread"] = model_info.params.get(
  648. "num_thread", None
  649. )
  650. if model_info.params.get("system", None):
  651. # Check if the payload already has a system message
  652. # If not, add a system message to the payload
  653. if payload.get("messages"):
  654. for message in payload["messages"]:
  655. if message.get("role") == "system":
  656. message["content"] = (
  657. model_info.params.get("system", None) + message["content"]
  658. )
  659. break
  660. else:
  661. payload["messages"].insert(
  662. 0,
  663. {
  664. "role": "system",
  665. "content": model_info.params.get("system", None),
  666. },
  667. )
  668. if url_idx == None:
  669. if ":" not in payload["model"]:
  670. payload["model"] = f"{payload['model']}:latest"
  671. if payload["model"] in app.state.MODELS:
  672. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  673. else:
  674. raise HTTPException(
  675. status_code=400,
  676. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  677. )
  678. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  679. log.info(f"url: {url}")
  680. log.debug(payload)
  681. return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
  682. # TODO: we should update this part once Ollama supports other types
  683. class OpenAIChatMessageContent(BaseModel):
  684. type: str
  685. model_config = ConfigDict(extra="allow")
  686. class OpenAIChatMessage(BaseModel):
  687. role: str
  688. content: Union[str, OpenAIChatMessageContent]
  689. model_config = ConfigDict(extra="allow")
  690. class OpenAIChatCompletionForm(BaseModel):
  691. model: str
  692. messages: List[OpenAIChatMessage]
  693. model_config = ConfigDict(extra="allow")
  694. @app.post("/v1/chat/completions")
  695. @app.post("/v1/chat/completions/{url_idx}")
  696. async def generate_openai_chat_completion(
  697. form_data: OpenAIChatCompletionForm,
  698. url_idx: Optional[int] = None,
  699. user=Depends(get_verified_user),
  700. ):
  701. payload = {
  702. **form_data.model_dump(exclude_none=True),
  703. }
  704. model_id = form_data.model
  705. model_info = Models.get_model_by_id(model_id)
  706. if model_info:
  707. if model_info.base_model_id:
  708. payload["model"] = model_info.base_model_id
  709. model_info.params = model_info.params.model_dump()
  710. if model_info.params:
  711. payload["temperature"] = model_info.params.get("temperature", None)
  712. payload["top_p"] = model_info.params.get("top_p", None)
  713. payload["max_tokens"] = model_info.params.get("max_tokens", None)
  714. payload["frequency_penalty"] = model_info.params.get(
  715. "frequency_penalty", None
  716. )
  717. payload["seed"] = model_info.params.get("seed", None)
  718. payload["stop"] = (
  719. [
  720. bytes(stop, "utf-8").decode("unicode_escape")
  721. for stop in model_info.params["stop"]
  722. ]
  723. if model_info.params.get("stop", None)
  724. else None
  725. )
  726. if model_info.params.get("system", None):
  727. # Check if the payload already has a system message
  728. # If not, add a system message to the payload
  729. if payload.get("messages"):
  730. for message in payload["messages"]:
  731. if message.get("role") == "system":
  732. message["content"] = (
  733. model_info.params.get("system", None) + message["content"]
  734. )
  735. break
  736. else:
  737. payload["messages"].insert(
  738. 0,
  739. {
  740. "role": "system",
  741. "content": model_info.params.get("system", None),
  742. },
  743. )
  744. if url_idx == None:
  745. if ":" not in payload["model"]:
  746. payload["model"] = f"{payload['model']}:latest"
  747. if payload["model"] in app.state.MODELS:
  748. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  749. else:
  750. raise HTTPException(
  751. status_code=400,
  752. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  753. )
  754. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  755. log.info(f"url: {url}")
  756. return await post_streaming_url(f"{url}/v1/chat/completions", json.dumps(payload))
  757. @app.get("/v1/models")
  758. @app.get("/v1/models/{url_idx}")
  759. async def get_openai_models(
  760. url_idx: Optional[int] = None,
  761. user=Depends(get_verified_user),
  762. ):
  763. if url_idx == None:
  764. models = await get_all_models()
  765. if app.state.config.ENABLE_MODEL_FILTER:
  766. if user.role == "user":
  767. models["models"] = list(
  768. filter(
  769. lambda model: model["name"]
  770. in app.state.config.MODEL_FILTER_LIST,
  771. models["models"],
  772. )
  773. )
  774. return {
  775. "data": [
  776. {
  777. "id": model["model"],
  778. "object": "model",
  779. "created": int(time.time()),
  780. "owned_by": "openai",
  781. }
  782. for model in models["models"]
  783. ],
  784. "object": "list",
  785. }
  786. else:
  787. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  788. try:
  789. r = requests.request(method="GET", url=f"{url}/api/tags")
  790. r.raise_for_status()
  791. models = r.json()
  792. return {
  793. "data": [
  794. {
  795. "id": model["model"],
  796. "object": "model",
  797. "created": int(time.time()),
  798. "owned_by": "openai",
  799. }
  800. for model in models["models"]
  801. ],
  802. "object": "list",
  803. }
  804. except Exception as e:
  805. log.exception(e)
  806. error_detail = "Open WebUI: Server Connection Error"
  807. if r is not None:
  808. try:
  809. res = r.json()
  810. if "error" in res:
  811. error_detail = f"Ollama: {res['error']}"
  812. except:
  813. error_detail = f"Ollama: {e}"
  814. raise HTTPException(
  815. status_code=r.status_code if r else 500,
  816. detail=error_detail,
  817. )
  818. class UrlForm(BaseModel):
  819. url: str
  820. class UploadBlobForm(BaseModel):
  821. filename: str
  822. def parse_huggingface_url(hf_url):
  823. try:
  824. # Parse the URL
  825. parsed_url = urlparse(hf_url)
  826. # Get the path and split it into components
  827. path_components = parsed_url.path.split("/")
  828. # Extract the desired output
  829. user_repo = "/".join(path_components[1:3])
  830. model_file = path_components[-1]
  831. return model_file
  832. except ValueError:
  833. return None
  834. async def download_file_stream(
  835. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  836. ):
  837. done = False
  838. if os.path.exists(file_path):
  839. current_size = os.path.getsize(file_path)
  840. else:
  841. current_size = 0
  842. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  843. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  844. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  845. async with session.get(file_url, headers=headers) as response:
  846. total_size = int(response.headers.get("content-length", 0)) + current_size
  847. with open(file_path, "ab+") as file:
  848. async for data in response.content.iter_chunked(chunk_size):
  849. current_size += len(data)
  850. file.write(data)
  851. done = current_size == total_size
  852. progress = round((current_size / total_size) * 100, 2)
  853. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  854. if done:
  855. file.seek(0)
  856. hashed = calculate_sha256(file)
  857. file.seek(0)
  858. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  859. response = requests.post(url, data=file)
  860. if response.ok:
  861. res = {
  862. "done": done,
  863. "blob": f"sha256:{hashed}",
  864. "name": file_name,
  865. }
  866. os.remove(file_path)
  867. yield f"data: {json.dumps(res)}\n\n"
  868. else:
  869. raise "Ollama: Could not create blob, Please try again."
  870. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  871. @app.post("/models/download")
  872. @app.post("/models/download/{url_idx}")
  873. async def download_model(
  874. form_data: UrlForm,
  875. url_idx: Optional[int] = None,
  876. user=Depends(get_admin_user),
  877. ):
  878. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  879. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  880. raise HTTPException(
  881. status_code=400,
  882. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  883. )
  884. if url_idx == None:
  885. url_idx = 0
  886. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  887. file_name = parse_huggingface_url(form_data.url)
  888. if file_name:
  889. file_path = f"{UPLOAD_DIR}/{file_name}"
  890. return StreamingResponse(
  891. download_file_stream(url, form_data.url, file_path, file_name),
  892. )
  893. else:
  894. return None
  895. @app.post("/models/upload")
  896. @app.post("/models/upload/{url_idx}")
  897. def upload_model(
  898. file: UploadFile = File(...),
  899. url_idx: Optional[int] = None,
  900. user=Depends(get_admin_user),
  901. ):
  902. if url_idx == None:
  903. url_idx = 0
  904. ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  905. file_path = f"{UPLOAD_DIR}/{file.filename}"
  906. # Save file in chunks
  907. with open(file_path, "wb+") as f:
  908. for chunk in file.file:
  909. f.write(chunk)
  910. def file_process_stream():
  911. nonlocal ollama_url
  912. total_size = os.path.getsize(file_path)
  913. chunk_size = 1024 * 1024
  914. try:
  915. with open(file_path, "rb") as f:
  916. total = 0
  917. done = False
  918. while not done:
  919. chunk = f.read(chunk_size)
  920. if not chunk:
  921. done = True
  922. continue
  923. total += len(chunk)
  924. progress = round((total / total_size) * 100, 2)
  925. res = {
  926. "progress": progress,
  927. "total": total_size,
  928. "completed": total,
  929. }
  930. yield f"data: {json.dumps(res)}\n\n"
  931. if done:
  932. f.seek(0)
  933. hashed = calculate_sha256(f)
  934. f.seek(0)
  935. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  936. response = requests.post(url, data=f)
  937. if response.ok:
  938. res = {
  939. "done": done,
  940. "blob": f"sha256:{hashed}",
  941. "name": file.filename,
  942. }
  943. os.remove(file_path)
  944. yield f"data: {json.dumps(res)}\n\n"
  945. else:
  946. raise Exception(
  947. "Ollama: Could not create blob, Please try again."
  948. )
  949. except Exception as e:
  950. res = {"error": str(e)}
  951. yield f"data: {json.dumps(res)}\n\n"
  952. return StreamingResponse(file_process_stream(), media_type="text/event-stream")