main.py 41 KB

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